reference/ldap/functions/ldap-mod-replace.xml
b7cbd468cb4c46d55d43a44cade0eb4590d25dea
b7cbd468cb4c46d55d43a44cade0eb4590d25dea
...
...
@@ -10,15 +10,14 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>bool</type><methodname>ldap_mod_replace</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
15
<methodparam><type>array</type><parameter>entry</parameter></methodparam>
16
+
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
16
17
</methodsynopsis>
17
18
<para>
18
19
Replaces one or more attributes from the specified <parameter>dn</parameter>.
19
-
It performs the modification at the attribute level as opposed to the object
20
-
level. Object-level modifications are done by the
21
-
<function>ldap_modify</function> function.
20
+
It may also add or remove attributes.
22
21
</para>
23
22
</refsect1>
24
23
...
...
@@ -27,10 +26,10 @@
27
26
<para>
28
27
<variablelist>
29
28
<varlistentry>
30
-
<term><parameter>link_identifier</parameter></term>
29
+
<term><parameter>ldap</parameter></term>
31
30
<listitem>
32
31
<para>
33
-
An LDAP link identifier, returned by <function>ldap_connect</function>.
32
+
&ldap.parameter.ldap;
34
33
</para>
35
34
</listitem>
36
35
</varlistentry>
...
...
@@ -46,6 +45,15 @@
46
45
<term><parameter>entry</parameter></term>
47
46
<listitem>
48
47
<para>
48
+
An associative array listing the attributes to replace. Sending an empty array as value will remove the attribute, while sending an attribute not existing yet on this entry will add it.
49
+
</para>
50
+
</listitem>
51
+
</varlistentry>
52
+
<varlistentry>
53
+
<term><parameter>controls</parameter></term>
54
+
<listitem>
55
+
<para>
56
+
Array of <link linkend="ldap.controls">LDAP Controls</link> to send with the request.
49
57
</para>
50
58
</listitem>
51
59
</varlistentry>
...
...
@@ -60,6 +68,32 @@
60
68
</para>
61
69
</refsect1>
62
70
71
+
<refsect1 role="changelog">
72
+
&reftitle.changelog;
73
+
<para>
74
+
<informaltable>
75
+
<tgroup cols="2">
76
+
<thead>
77
+
<row>
78
+
<entry>&Version;</entry>
79
+
<entry>&Description;</entry>
80
+
</row>
81
+
</thead>
82
+
<tbody>
83
+
&ldap.changelog.ldap-object;
84
+
&ldap.changelog.controls-nullable;
85
+
<row>
86
+
<entry>7.3.0</entry>
87
+
<entry>
88
+
Support for <parameter>controls</parameter> added
89
+
</entry>
90
+
</row>
91
+
</tbody>
92
+
</tgroup>
93
+
</informaltable>
94
+
</para>
95
+
</refsect1>
96
+
63
97
<refsect1 role="notes">
64
98
&reftitle.notes;
65
99
¬e.bin-safe;
...
...
@@ -69,14 +103,15 @@
69
103
&reftitle.seealso;
70
104
<para>
71
105
<simplelist>
106
+
<member><function>ldap_mod_replace_ext</function></member>
72
107
<member><function>ldap_mod_del</function></member>
73
108
<member><function>ldap_mod_add</function></member>
109
+
<member><function>ldap_modify_batch</function></member>
74
110
</simplelist>
75
111
</para>
76
112
</refsect1>
77
113
78
114
</refentry>
79
-
80
115
<!-- Keep this comment at the end of the file
81
116
Local variables:
82
117
mode: sgml
83
118