/
setacl.xml
149 lines (139 loc) · 3.5 KB
/
setacl.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="zookeeper.setacl" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Zookeeper::setAcl</refname>
<refpurpose>Sets the acl associated with a node synchronously</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier>
<type>bool</type><methodname>Zookeeper::setAcl</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>int</type><parameter>version</parameter></methodparam>
<methodparam><type>array</type><parameter>acl</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
The name of the node. Expressed as a file name with slashes separating ancestors of the node.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>version</parameter></term>
<listitem>
<para>
The expected version of the path.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>acl</parameter></term>
<listitem>
<para>
The acl to be set on the path.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
This method emits PHP error/warning when parameters count or types are wrong or fail to set ACL for a node.
</para>
<caution>
<para>
Since version 0.3.0, this method emits <classname>ZookeeperException</classname> and it's derivatives.
</para>
</caution>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="zookeeper.setacl.example.basic">
<title><methodname>Zookeeper::setAcl</methodname> example</title>
<para>
Set ACL for a node.
</para>
<programlisting role="php">
<![CDATA[
<?php
$zookeeper = new Zookeeper('locahost:2181');
$aclArray = array(
array(
'perms' => Zookeeper::PERM_ALL,
'scheme' => 'world',
'id' => 'anyone',
)
);
$path = '/path/to/newnode';
$zookeeper->setAcl($path, $aclArray);
$r = $zookeeper->getAcl($path);
if ($r)
var_dump($r);
else
echo 'ERR';
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(1) {
[0]=>
array(3) {
["perms"]=>
int(31)
["scheme"]=>
string(5) "world"
["id"]=>
string(6) "anyone"
}
}
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>Zookeeper::create</methodname></member>
<member><methodname>Zookeeper::getAcl</methodname></member>
<member><link linkend="zookeeper.constants.perms">ZooKeeper Permissions</link></member>
<member><classname>ZookeeperException</classname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->