sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Hack together some basic documentation for ldap_parse_result().

Browse source 
Fixes doc bug #54420 (missing documentation for ldap function
ldap_parse_result).


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333701 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Adam Harvey 2014-06-02 21:40:42 +00:00
parent 9ef056fc32
commit 8ac42c089d
1 changed files with 92 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

93
reference/ldap/functions/ldap-parse-result.xml
View file

@ -17,7 +17,98 @@
<methodparam choice="opt"><type>string</type><parameter role="reference">errmsg</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">referrals</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Parses an LDAP search result.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link</parameter></term>
<listitem>
<para>
An LDAP link identifier, returned by <function>ldap_connect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>result_identifier</parameter></term>
<listitem>
<para>
An LDAP result resource, returned by <function>ldap_list</function> or
<function>ldap_search</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>errcode</parameter></term>
<listitem>
<para>
A reference to a variable that will be set to the LDAP error code in
the result, or <literal>0</literal> if no error occurred.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>matcheddn</parameter></term>
<listitem>
<para>
A reference to a variable that will be set to a matched DN if one was
recognised within the request, otherwise it will be set to &null;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>errmsg</parameter></term>
<listitem>
<para>
A reference to a variable that will be set to the LDAP error message in
the result, or an empty string if no error occurred.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>referrals</parameter></term>
<listitem>
<para>
A reference to a variable that will be set to an <type>array</type> set
to all of the referral strings in the result, or an empty array if no
referrals were returned.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ldap_parse_result</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$result = ldap_search($link, "cn=userref,dc=my-domain,dc=com", "(cn=user*)");
$errcode = $dn = $errmsg = $refs = null;
if (ldap_parse_result($link, $result, $errcode, $dn, $errmsg, $refs)) {
// do something with $errcode, $dn, $errmsg and $refs
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>