reference/ldap/functions/ldap-parse-result.xml
b7cbd468cb4c46d55d43a44cade0eb4590d25dea
b7cbd468cb4c46d55d43a44cade0eb4590d25dea
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xml:id='function.ldap-parse-result' xmlns="http://docbook.org/ns/docbook">
3
+
<refentry xml:id="function.ldap-parse-result" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>ldap_parse_result</refname>
6
6
<refpurpose>Extract information from result</refpurpose>
...
...
@@ -10,12 +10,13 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>bool</type><methodname>ldap_parse_result</methodname>
13
-
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
14
-
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
15
-
<methodparam><type>int</type><parameter role="reference">errcode</parameter></methodparam>
16
-
<methodparam choice="opt"><type>string</type><parameter role="reference">matcheddn</parameter></methodparam>
17
-
<methodparam choice="opt"><type>string</type><parameter role="reference">errmsg</parameter></methodparam>
18
-
<methodparam choice="opt"><type>array</type><parameter role="reference">referrals</parameter></methodparam>
13
+
<methodparam><type>LDAP\Connection</type><parameter>ldap</parameter></methodparam>
14
+
<methodparam><type>LDAP\Result</type><parameter>result</parameter></methodparam>
15
+
<methodparam><type>int</type><parameter role="reference">error_code</parameter></methodparam>
16
+
<methodparam choice="opt"><type>string</type><parameter role="reference">matched_dn</parameter><initializer>&null;</initializer></methodparam>
17
+
<methodparam choice="opt"><type>string</type><parameter role="reference">error_message</parameter><initializer>&null;</initializer></methodparam>
18
+
<methodparam choice="opt"><type>array</type><parameter role="reference">referrals</parameter><initializer>&null;</initializer></methodparam>
19
+
<methodparam choice="opt"><type>array</type><parameter role="reference">controls</parameter><initializer>&null;</initializer></methodparam>
19
20
</methodsynopsis>
20
21
<para>
21
22
Parses an LDAP search result.
...
...
@@ -27,24 +28,23 @@
27
28
<para>
28
29
<variablelist>
29
30
<varlistentry>
30
-
<term><parameter>link</parameter></term>
31
+
<term><parameter>ldap</parameter></term>
31
32
<listitem>
32
33
<para>
33
-
An LDAP link identifier, returned by <function>ldap_connect</function>.
34
+
&ldap.parameter.ldap;
34
35
</para>
35
36
</listitem>
36
37
</varlistentry>
37
38
<varlistentry>
38
-
<term><parameter>result_identifier</parameter></term>
39
+
<term><parameter>result</parameter></term>
39
40
<listitem>
40
41
<para>
41
-
An LDAP result resource, returned by <function>ldap_list</function> or
42
-
<function>ldap_search</function>.
42
+
&ldap.parameter.result;
43
43
</para>
44
44
</listitem>
45
45
</varlistentry>
46
46
<varlistentry>
47
-
<term><parameter>errcode</parameter></term>
47
+
<term><parameter>error_code</parameter></term>
48
48
<listitem>
49
49
<para>
50
50
A reference to a variable that will be set to the LDAP error code in
...
...
@@ -53,7 +53,7 @@
53
53
</listitem>
54
54
</varlistentry>
55
55
<varlistentry>
56
-
<term><parameter>matcheddn</parameter></term>
56
+
<term><parameter>matched_dn</parameter></term>
57
57
<listitem>
58
58
<para>
59
59
A reference to a variable that will be set to a matched DN if one was
...
...
@@ -62,7 +62,7 @@
62
62
</listitem>
63
63
</varlistentry>
64
64
<varlistentry>
65
-
<term><parameter>errmsg</parameter></term>
65
+
<term><parameter>error_message</parameter></term>
66
66
<listitem>
67
67
<para>
68
68
A reference to a variable that will be set to the LDAP error message in
...
...
@@ -80,6 +80,14 @@
80
80
</para>
81
81
</listitem>
82
82
</varlistentry>
83
+
<varlistentry>
84
+
<term><parameter>controls</parameter></term>
85
+
<listitem>
86
+
<para>
87
+
An <type>array</type> of LDAP Controls which have been sent with the response.
88
+
</para>
89
+
</listitem>
90
+
</varlistentry>
83
91
</variablelist>
84
92
</para>
85
93
</refsect1>
...
...
@@ -91,6 +99,32 @@
91
99
</para>
92
100
</refsect1>
93
101
102
+
<refsect1 role="changelog">
103
+
&reftitle.changelog;
104
+
<para>
105
+
<informaltable>
106
+
<tgroup cols="2">
107
+
<thead>
108
+
<row>
109
+
<entry>&Version;</entry>
110
+
<entry>&Description;</entry>
111
+
</row>
112
+
</thead>
113
+
<tbody>
114
+
&ldap.changelog.ldap-object;
115
+
&ldap.changelog.result-object;
116
+
<row>
117
+
<entry>7.3.0</entry>
118
+
<entry>
119
+
Support for <parameter>controls</parameter> added
120
+
</entry>
121
+
</row>
122
+
</tbody>
123
+
</tgroup>
124
+
</informaltable>
125
+
</para>
126
+
</refsect1>
127
+
94
128
<refsect1 role="examples">
95
129
&reftitle.examples;
96
130
<para>
...
...
@@ -99,9 +133,9 @@
99
133
<programlisting role="php">
100
134
<![CDATA[
101
135
<?php
102
-
$result = ldap_search($link, "cn=userref,dc=my-domain,dc=com", "(cn=user*)");
136
+
$result = ldap_search($ldap, "cn=userref,dc=my-domain,dc=com", "(cn=user*)");
103
137
$errcode = $dn = $errmsg = $refs = null;
104
-
if (ldap_parse_result($link, $result, $errcode, $dn, $errmsg, $refs)) {
138
+
if (ldap_parse_result($ldap, $result, $errcode, $dn, $errmsg, $refs)) {
105
139
// do something with $errcode, $dn, $errmsg and $refs
106
140
}
107
141
?>
...
...
@@ -112,7 +146,6 @@ if (ldap_parse_result($link, $result, $errcode, $dn, $errmsg, $refs)) {
112
146
</refsect1>
113
147
114
148
</refentry>
115
-
116
149
<!-- Keep this comment at the end of the file
117
150
Local variables:
118
151
mode: sgml
119
152