<!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>Sets the acl associated with a node synchronously</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="zookeeper.set.html">Zookeeper::set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="zookeeper.setdebuglevel.html">Zookeeper::setDebugLevel</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.setacl" class="refentry">
<div class="refnamediv">
<h1 class="refname">Zookeeper::setAcl</h1>
<p class="verinfo">(PECL zookeeper >= 0.1.0)</p><p class="refpurpose"><span class="refname">Zookeeper::setAcl</span> — <span class="dc-title">Sets the acl associated with a node synchronously</span></p>
</div>
<div class="refsect1 description" id="refsect1-zookeeper.setacl-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::setAcl</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>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$acl</code></span>
)</div>
</div>
<div class="refsect1 parameters" id="refsect1-zookeeper.setacl-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 path.
</p>
</dd>
<dt>
<code class="parameter">acl</code></dt>
<dd>
<p class="para">
The acl to be set on the path.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-zookeeper.setacl-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.setacl-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 set ACL for a 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.setacl-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-5846">
<p><strong>Example #1 <span class="methodname"><strong>Zookeeper::setAcl()</strong></span> example</strong></p>
<div class="example-contents"><p>
Set ACL for a 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">$aclArray </span><span style="color: #007700">= array(<br /> array(<br /> </span><span style="color: #DD0000">'perms' </span><span style="color: #007700">=> </span><span style="color: #0000BB">Zookeeper</span><span style="color: #007700">::</span><span style="color: #0000BB">PERM_ALL</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'scheme' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'world'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'id' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'anyone'</span><span style="color: #007700">,<br /> )<br />);<br /></span><span style="color: #0000BB">$path </span><span style="color: #007700">= </span><span style="color: #DD0000">'/path/to/newnode'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$zookeeper</span><span style="color: #007700">-></span><span style="color: #0000BB">setAcl</span><span style="color: #007700">(</span><span style="color: #0000BB">$path</span><span style="color: #007700">, </span><span style="color: #0000BB">$aclArray</span><span style="color: #007700">);<br /><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">getAcl</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 /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$r</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>
array(1) {
[0]=>
array(3) {
["perms"]=>
int(31)
["scheme"]=>
string(5) "world"
["id"]=>
string(6) "anyone"
}
}
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-zookeeper.setacl-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.getacl.html" class="methodname" rel="rdfs-seeAlso">Zookeeper::getAcl()</a> - Gets the acl associated with a node synchronously</span></li>
<li class="member"><a href="class.zookeeper.html#zookeeper.class.constants.perms" class="link">ZooKeeper Permissions</a></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.set.html">Zookeeper::set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="zookeeper.setdebuglevel.html">Zookeeper::setDebugLevel</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>
