reference/ldap/functions/ldap-first-entry.xml
fbc6f9055f47d18f8ffb30513b772a32eda1526e
...
...
@@ -9,9 +9,9 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>ldap_first_entry</methodname>
13
-
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
14
-
<methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam>
12
+
<type class="union"><type>LDAP\ResultEntry</type><type>false</type></type><methodname>ldap_first_entry</methodname>
13
+
<methodparam><type>LDAP\Connection</type><parameter>ldap</parameter></methodparam>
14
+
<methodparam><type>LDAP\Result</type><parameter>result</parameter></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
17
Returns the entry identifier for first entry in the result. This entry
...
...
@@ -30,17 +30,18 @@
30
30
<para>
31
31
<variablelist>
32
32
<varlistentry>
33
-
<term><parameter>link_identifier</parameter></term>
33
+
<term><parameter>ldap</parameter></term>
34
34
<listitem>
35
35
<para>
36
-
An LDAP link identifier, returned by <function>ldap_connect</function>.
36
+
&ldap.parameter.ldap;
37
37
</para>
38
38
</listitem>
39
39
</varlistentry>
40
40
<varlistentry>
41
-
<term><parameter>result_identifier</parameter></term>
41
+
<term><parameter>result</parameter></term>
42
42
<listitem>
43
43
<para>
44
+
&ldap.parameter.result;
44
45
</para>
45
46
</listitem>
46
47
</varlistentry>
...
...
@@ -51,11 +52,29 @@
51
52
<refsect1 role="returnvalues">
52
53
&reftitle.returnvalues;
53
54
<para>
54
-
Returns the result entry identifier for the first entry on success and
55
-
&false; on error.
55
+
Returns an <classname>LDAP\ResultEntry</classname> instance,&return.falseforfailure;.
56
56
</para>
57
57
</refsect1>
58
58

59
+
<refsect1 role="changelog">
60
+
&reftitle.changelog;
61
+
<informaltable>
62
+
<tgroup cols="2">
63
+
<thead>
64
+
<row>
65
+
<entry>&Version;</entry>
66
+
<entry>&Description;</entry>
67
+
</row>
68
+
</thead>
69
+
<tbody>
70
+
&ldap.changelog.ldap-object;
71
+
&ldap.changelog.result-object;
72
+
&ldap.changelog.return-result-entry-object;
73
+
</tbody>
74
+
</tgroup>
75
+
</informaltable>
76
+
</refsect1>
77
+

59
78
<refsect1 role="seealso">
60
79
&reftitle.seealso;
61
80
<para>
...
...
@@ -66,7 +85,6 @@
66
85
</refsect1>
67
86

68
87
</refentry>
69
-

70
88
<!-- Keep this comment at the end of the file
71
89
Local variables:
72
90
mode: sgml
73
91