<!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>Delete a node in zookeeper synchronously</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="zookeeper.create.html">Zookeeper::create</a></div> <div class="next" style="text-align: right; float: right;"><a href="zookeeper.exists.html">Zookeeper::exists</a></div> <div class="up"><a href="class.zookeeper.html">Zookeeper</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="zookeeper.delete" class="refentry"> <div class="refnamediv"> <h1 class="refname">Zookeeper::delete</h1> <p class="verinfo">(PECL zookeeper >= 0.2.0)</p><p class="refpurpose"><span class="refname">Zookeeper::delete</span> — <span class="dc-title">Delete a node in zookeeper synchronously</span></p> </div> <div class="refsect1 description" id="refsect1-zookeeper.delete-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Zookeeper::delete</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$path</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$version</code><span class="initializer"> = -1</span></span> ] )</div> </div> <div class="refsect1 parameters" id="refsect1-zookeeper.delete-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">path</code></dt> <dd> <p class="para"> The name of the node. Expressed as a file name with slashes separating ancestors of the node. </p> </dd> <dt> <code class="parameter">version</code></dt> <dd> <p class="para"> The expected version of the node. The function will fail if the actual version of the node does not match the expected version. If -1 is used the version check will not take place. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-zookeeper.delete-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 errors" id="refsect1-zookeeper.delete-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> This method emits PHP error/warning when parameters count or types are wrong or fail to delete node. </p> <div class="caution"><strong class="caution">Caution</strong> <p class="para"> Since version 0.3.0, this method emits <strong class="classname">ZookeeperException</strong> and it's derivatives. </p> </div> </div> <div class="refsect1 examples" id="refsect1-zookeeper.delete-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-5840"> <p><strong>Example #1 <span class="methodname"><strong>Zookeeper::delete()</strong></span> example</strong></p> <div class="example-contents"><p> Delete a existing node. </p></div> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$zookeeper </span><span style="color: #007700">= new </span><span style="color: #0000BB">Zookeeper</span><span style="color: #007700">(</span><span style="color: #DD0000">'locahost:2181'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$path </span><span style="color: #007700">= </span><span style="color: #DD0000">'/path/to/node'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$r </span><span style="color: #007700">= </span><span style="color: #0000BB">$zookeeper</span><span style="color: #007700">-></span><span style="color: #0000BB">delete</span><span style="color: #007700">(</span><span style="color: #0000BB">$path</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$r</span><span style="color: #007700">)<br /> echo </span><span style="color: #DD0000">'SUCCESS'</span><span style="color: #007700">;<br />else<br /> echo </span><span style="color: #DD0000">'ERR'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> SUCCESS </pre></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-zookeeper.delete-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"><span class="methodname"><a href="zookeeper.create.html" class="methodname" rel="rdfs-seeAlso">Zookeeper::create()</a> - Create a node synchronously</span></li> <li class="member"><span class="methodname"><a href="zookeeper.getchildren.html" class="methodname" rel="rdfs-seeAlso">Zookeeper::getChildren()</a> - Lists the children of a node synchronously</span></li> <li class="member"><strong class="classname">ZookeeperException</strong></li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="zookeeper.create.html">Zookeeper::create</a></div> <div class="next" style="text-align: right; float: right;"><a href="zookeeper.exists.html">Zookeeper::exists</a></div> <div class="up"><a href="class.zookeeper.html">Zookeeper</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>