From 8ac42c089d13dfc5486897fd2e1b22b64d99754d Mon Sep 17 00:00:00 2001
From: Adam Harvey <aharvey@php.net>
Date: Mon, 2 Jun 2014 21:40:42 +0000
Subject: [PATCH] Hack together some basic documentation for
 ldap_parse_result().

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
---
 .../ldap/functions/ldap-parse-result.xml      | 93 ++++++++++++++++++-
 1 file changed, 92 insertions(+), 1 deletion(-)

diff --git a/reference/ldap/functions/ldap-parse-result.xml b/reference/ldap/functions/ldap-parse-result.xml
index d0de0ca20e..5248c50029 100644
--- a/reference/ldap/functions/ldap-parse-result.xml
+++ b/reference/ldap/functions/ldap-parse-result.xml
@@ -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>