# The VarnishAdmin class

(PECL varnish >= 0.3)

## Introduction

## Class synopsis

VarnishAdmin {
/* Methods */
public auth ( void ) : bool
public ban ( string `$vcl_regex` ) : int
public banUrl ( string `$vcl_regex` ) : int
public clearPanic ( void ) : int
public connect ( void ) : bool
public __construct ([ array `$args` ] )
public disconnect ( void ) : bool
public getPanic ( void ) : string
public getParams ( void ) : array
public isRunning ( void ) : bool
public setCompat ( int `$compat` ) : void
public setHost ( string `$host` ) : void
public setIdent ( string `$ident` ) : void
public setParam ( string `$name` , string|integer `$value` ) : int
public setPort ( int `$port` ) : void
public setSecret ( string `$secret` ) : void
public setTimeout ( int `$timeout` ) : void
public start ( void ) : int
public stop ( void ) : int
}

## Table of Contents

- VarnishAdmin::auth — Authenticate on a varnish instance
- VarnishAdmin::ban — Ban URLs using a VCL expression
- VarnishAdmin::banUrl — Ban an URL using a VCL expression
- VarnishAdmin::clearPanic — Clear varnish instance panic messages
- VarnishAdmin::connect — Connect to a varnish instance administration interface
- VarnishAdmin::__construct — VarnishAdmin constructor
- VarnishAdmin::disconnect — Disconnect from a varnish instance administration interface
- VarnishAdmin::getPanic — Get the last panic message on a varnish instance
- VarnishAdmin::getParams — Fetch current varnish instance configuration parameters
- VarnishAdmin::isRunning — Check if the varnish slave process is currently running
- VarnishAdmin::setCompat — Set the class compat configuration param
- VarnishAdmin::setHost — Set the class host configuration param
- VarnishAdmin::setIdent — Set the class ident configuration param
- VarnishAdmin::setParam — Set configuration param on the current varnish instance
- VarnishAdmin::setPort — Set the class port configuration param
- VarnishAdmin::setSecret — Set the class secret configuration param
- VarnishAdmin::setTimeout — Set the class timeout configuration param
- VarnishAdmin::start — Start varnish worker process
- VarnishAdmin::stop — Stop varnish worker process