reference/ldap/functions/ldap-rename.xml
b7cbd468cb4c46d55d43a44cade0eb4590d25dea
b7cbd468cb4c46d55d43a44cade0eb4590d25dea
...
...
@@ -10,11 +10,12 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>bool</type><methodname>ldap_rename</methodname>
13
-
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
13
+
<methodparam><type>LDAP\Connection</type><parameter>ldap</parameter></methodparam>
14
14
<methodparam><type>string</type><parameter>dn</parameter></methodparam>
15
-
<methodparam><type>string</type><parameter>newrdn</parameter></methodparam>
16
-
<methodparam><type>string</type><parameter>newparent</parameter></methodparam>
17
-
<methodparam><type>bool</type><parameter>deleteoldrdn</parameter></methodparam>
15
+
<methodparam><type>string</type><parameter>new_rdn</parameter></methodparam>
16
+
<methodparam><type>string</type><parameter>new_parent</parameter></methodparam>
17
+
<methodparam><type>bool</type><parameter>delete_old_rdn</parameter></methodparam>
18
+
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
18
19
</methodsynopsis>
19
20
<para>
20
21
The entry specified by <parameter>dn</parameter> is renamed/moved.
...
...
@@ -26,10 +27,10 @@
26
27
<para>
27
28
<variablelist>
28
29
<varlistentry>
29
-
<term><parameter>link_identifier</parameter></term>
30
+
<term><parameter>ldap</parameter></term>
30
31
<listitem>
31
32
<para>
32
-
An LDAP link identifier, returned by <function>ldap_connect</function>.
33
+
&ldap.parameter.ldap;
33
34
</para>
34
35
</listitem>
35
36
</varlistentry>
...
...
@@ -42,7 +43,7 @@
42
43
</listitem>
43
44
</varlistentry>
44
45
<varlistentry>
45
-
<term><parameter>newrdn</parameter></term>
46
+
<term><parameter>new_rdn</parameter></term>
46
47
<listitem>
47
48
<para>
48
49
The new RDN.
...
...
@@ -50,7 +51,7 @@
50
51
</listitem>
51
52
</varlistentry>
52
53
<varlistentry>
53
-
<term><parameter>newparent</parameter></term>
54
+
<term><parameter>new_parent</parameter></term>
54
55
<listitem>
55
56
<para>
56
57
The new parent/superior entry.
...
...
@@ -58,7 +59,7 @@
58
59
</listitem>
59
60
</varlistentry>
60
61
<varlistentry>
61
-
<term><parameter>deleteoldrdn</parameter></term>
62
+
<term><parameter>delete_old_rdn</parameter></term>
62
63
<listitem>
63
64
<para>
64
65
If &true; the old RDN value(s) is removed, else the old RDN value(s)
...
...
@@ -66,6 +67,14 @@
66
67
</para>
67
68
</listitem>
68
69
</varlistentry>
70
+
<varlistentry>
71
+
<term><parameter>controls</parameter></term>
72
+
<listitem>
73
+
<para>
74
+
Array of <link linkend="ldap.controls">LDAP Controls</link> to send with the request.
75
+
</para>
76
+
</listitem>
77
+
</varlistentry>
69
78
</variablelist>
70
79
</para>
71
80
</refsect1>
...
...
@@ -77,6 +86,32 @@
77
86
</para>
78
87
</refsect1>
79
88
89
+
<refsect1 role="changelog">
90
+
&reftitle.changelog;
91
+
<para>
92
+
<informaltable>
93
+
<tgroup cols="2">
94
+
<thead>
95
+
<row>
96
+
<entry>&Version;</entry>
97
+
<entry>&Description;</entry>
98
+
</row>
99
+
</thead>
100
+
<tbody>
101
+
&ldap.changelog.ldap-object;
102
+
&ldap.changelog.controls-nullable;
103
+
<row>
104
+
<entry>7.3.0</entry>
105
+
<entry>
106
+
Support for <parameter>controls</parameter> added
107
+
</entry>
108
+
</row>
109
+
</tbody>
110
+
</tgroup>
111
+
</informaltable>
112
+
</para>
113
+
</refsect1>
114
+
80
115
<refsect1 role="notes">
81
116
&reftitle.notes;
82
117
<note>
...
...
@@ -93,13 +128,13 @@
93
128
&reftitle.seealso;
94
129
<para>
95
130
<simplelist>
131
+
<member><function>ldap_rename_ext</function></member>
96
132
<member><function>ldap_modify</function></member>
97
133
</simplelist>
98
134
</para>
99
135
</refsect1>
100
136
101
137
</refentry>
102
-
103
138
<!-- Keep this comment at the end of the file
104
139
Local variables:
105
140
mode: sgml
106
141