reference/ldap/functions/ldap-compare.xml
b7cbd468cb4c46d55d43a44cade0eb4590d25dea
b7cbd468cb4c46d55d43a44cade0eb4590d25dea
...
...
@@ -9,11 +9,12 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>mixed</type><methodname>ldap_compare</methodname>
13
-
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
12
+
<type class="union"><type>bool</type><type>int</type></type><methodname>ldap_compare</methodname>
13
+
<methodparam><type>LDAP\Connection</type><parameter>ldap</parameter></methodparam>
14
14
<methodparam><type>string</type><parameter>dn</parameter></methodparam>
15
15
<methodparam><type>string</type><parameter>attribute</parameter></methodparam>
16
16
<methodparam><type>string</type><parameter>value</parameter></methodparam>
17
+
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
17
18
</methodsynopsis>
18
19
<para>
19
20
Compare <parameter>value</parameter> of <parameter>attribute</parameter>
...
...
@@ -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>
...
...
@@ -57,6 +58,14 @@
57
58
</para>
58
59
</listitem>
59
60
</varlistentry>
61
+
<varlistentry>
62
+
<term><parameter>controls</parameter></term>
63
+
<listitem>
64
+
<para>
65
+
Array of <link linkend="ldap.controls">LDAP Controls</link> to send with the request.
66
+
</para>
67
+
</listitem>
68
+
</varlistentry>
60
69
</variablelist>
61
70
</para>
62
71
</refsect1>
...
...
@@ -69,6 +78,32 @@
69
78
</para>
70
79
</refsect1>
71
80
81
+
<refsect1 role="changelog">
82
+
&reftitle.changelog;
83
+
<para>
84
+
<informaltable>
85
+
<tgroup cols="2">
86
+
<thead>
87
+
<row>
88
+
<entry>&Version;</entry>
89
+
<entry>&Description;</entry>
90
+
</row>
91
+
</thead>
92
+
<tbody>
93
+
&ldap.changelog.ldap-object;
94
+
&ldap.changelog.controls-nullable;
95
+
<row>
96
+
<entry>7.3.0</entry>
97
+
<entry>
98
+
Support for <parameter>controls</parameter> added
99
+
</entry>
100
+
</row>
101
+
</tbody>
102
+
</tgroup>
103
+
</informaltable>
104
+
</para>
105
+
</refsect1>
106
+
72
107
<refsect1 role="examples">
73
108
&reftitle.examples;
74
109
<para>
...
...
@@ -132,7 +167,6 @@ if ($ds) {
132
167
</refsect1>
133
168
134
169
</refentry>
135
-
136
170
<!-- Keep this comment at the end of the file
137
171
Local variables:
138
172
mode: sgml
139
173