<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The VarnishAdmin class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="varnish.example.log.html">Basic VarnishLog usage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="varnishadmin.auth.html">VarnishAdmin::auth</a></div>
<div class="up"><a href="book.varnish.html">Varnish</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.varnishadmin" class="reference">
<h1 class="title">The VarnishAdmin class</h1>
<div class="partintro"><p class="verinfo">(PECL varnish >= 0.3)</p>
<div class="section" id="varnishadmin.intro">
<h2 class="title">Introduction</h2>
<p class="para">
</p>
</div>
<div class="section" id="varnishadmin.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">VarnishAdmin</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="varnishadmin.auth.html" class="methodname">auth</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="varnishadmin.ban.html" class="methodname">ban</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$vcl_regex</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="varnishadmin.banurl.html" class="methodname">banUrl</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$vcl_regex</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="varnishadmin.clearpanic.html" class="methodname">clearPanic</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="varnishadmin.connect.html" class="methodname">connect</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="varnishadmin.construct.html" class="methodname">__construct</a></span>
([ <span class="methodparam"><span class="type">array</span> <code class="parameter">$args</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="varnishadmin.disconnect.html" class="methodname">disconnect</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="varnishadmin.getpanic.html" class="methodname">getPanic</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="varnishadmin.getparams.html" class="methodname">getParams</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="varnishadmin.isrunning.html" class="methodname">isRunning</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="varnishadmin.setcompat.html" class="methodname">setCompat</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$compat</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="varnishadmin.sethost.html" class="methodname">setHost</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="varnishadmin.setident.html" class="methodname">setIdent</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$ident</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="varnishadmin.setparam.html" class="methodname">setParam</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
, <span class="methodparam"><span class="type"><span class="type string|integer">string|integer</span></span> <code class="parameter">$value</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="varnishadmin.setport.html" class="methodname">setPort</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="varnishadmin.setsecret.html" class="methodname">setSecret</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$secret</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="varnishadmin.settimeout.html" class="methodname">setTimeout</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="varnishadmin.start.html" class="methodname">start</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="varnishadmin.stop.html" class="methodname">stop</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="varnishadmin.auth.html">VarnishAdmin::auth</a> — Authenticate on a varnish instance</li><li><a href="varnishadmin.ban.html">VarnishAdmin::ban</a> — Ban URLs using a VCL expression</li><li><a href="varnishadmin.banurl.html">VarnishAdmin::banUrl</a> — Ban an URL using a VCL expression</li><li><a href="varnishadmin.clearpanic.html">VarnishAdmin::clearPanic</a> — Clear varnish instance panic messages</li><li><a href="varnishadmin.connect.html">VarnishAdmin::connect</a> — Connect to a varnish instance administration interface</li><li><a href="varnishadmin.construct.html">VarnishAdmin::__construct</a> — VarnishAdmin constructor</li><li><a href="varnishadmin.disconnect.html">VarnishAdmin::disconnect</a> — Disconnect from a varnish instance administration interface</li><li><a href="varnishadmin.getpanic.html">VarnishAdmin::getPanic</a> — Get the last panic message on a varnish instance</li><li><a href="varnishadmin.getparams.html">VarnishAdmin::getParams</a> — Fetch current varnish instance configuration parameters</li><li><a href="varnishadmin.isrunning.html">VarnishAdmin::isRunning</a> — Check if the varnish slave process is currently running</li><li><a href="varnishadmin.setcompat.html">VarnishAdmin::setCompat</a> — Set the class compat configuration param</li><li><a href="varnishadmin.sethost.html">VarnishAdmin::setHost</a> — Set the class host configuration param</li><li><a href="varnishadmin.setident.html">VarnishAdmin::setIdent</a> — Set the class ident configuration param</li><li><a href="varnishadmin.setparam.html">VarnishAdmin::setParam</a> — Set configuration param on the current varnish instance</li><li><a href="varnishadmin.setport.html">VarnishAdmin::setPort</a> — Set the class port configuration param</li><li><a href="varnishadmin.setsecret.html">VarnishAdmin::setSecret</a> — Set the class secret configuration param</li><li><a href="varnishadmin.settimeout.html">VarnishAdmin::setTimeout</a> — Set the class timeout configuration param</li><li><a href="varnishadmin.start.html">VarnishAdmin::start</a> — Start varnish worker process</li><li><a href="varnishadmin.stop.html">VarnishAdmin::stop</a> — Stop varnish worker process</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="varnish.example.log.html">Basic VarnishLog usage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="varnishadmin.auth.html">VarnishAdmin::auth</a></div>
<div class="up"><a href="book.varnish.html">Varnish</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
