cvs: phpdoc /en/reference/ldap/functions ldap-8859-to-t61.xml ldap-add.xml ldap-bind.xml ldap-close.xml ldap-compare.xml ldap-connect.xml
ldap-count-entries.xml ldap-delete.xml ldap-dn2ufn.xml ldap-err2str.xml ldap-errno.xml ldap-error.xml ldap-explode-dn.xml ldap-first-attribute.xml
ldap-first-entry.xml ldap-first-reference.xml ldap-free-result.xml ldap-get-attributes.xml ldap-get-dn.xml ldap-get-entries.xml ldap-get-option.xml
ldap-get-values-len.xml ldap-get-values.xml ldap-list.xml ldap-mod-add.xml ldap-mod-del.xml ldap-mod-replace.xml ldap-modify.xml
ldap-next-attribute.xml ldap-next-entry.xml ldap-next-reference.xml ldap-parse-reference.xml ldap-parse-result.xml ldap-read.xml ldap-rename.xml
ldap-sasl-bind.xml ldap-search.xml ldap-set-option.xml ldap-set-rebind-proc.xml ldap-sort.xml ldap-start-tls.xml ldap-t61-to-8859.xml ldap-unbind.xml

From:	Mehdi Achour	Date:	Sun, 04 Feb 2007 22:48:23 +0000
Subject:	cvs: phpdoc /en/reference/ldap/functions ldap-8859-to-t61.xml ldap-add.xml ldap-bind.xml ldap-close.xml ldap-compare.xml ldap-connect.xml ldap-count-entries.xml ldap-delete.xml ldap-dn2ufn.xml ldap-err2str.xml ldap-errno.xml ldap-error.xml ldap-explode-dn.xml ldap-first-attribute.xml ldap-first-entry.xml ldap-first-reference.xml ldap-free-result.xml ldap-get-attributes.xml ldap-get-dn.xml ldap-get-entries.xml ldap-get-option.xml ldap-get-values-len.xml ldap-get-values.xml ldap-list.xml ldap-mod-add.xml ldap-mod-del.xml ldap-mod-replace.xml ldap-modify.xml ldap-next-attribute.xml ldap-next-entry.xml ldap-next-reference.xml ldap-parse-reference.xml ldap-parse-result.xml ldap-read.xml ldap-rename.xml ldap-sasl-bind.xml ldap-search.xml ldap-set-option.xml ldap-set-rebind-proc.xml ldap-sort.xml ldap-start-tls.xml ldap-t61-to-8859.xml ldap-unbind.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969375271@lists.php.net to get a copy of this message

didou Sun Feb 4 22:48:23 2007 UTC Modified files: /phpdoc/en/reference/ldap/functions ldap-8859-to-t61.xml ldap-add.xml ldap-bind.xml ldap-close.xml ldap-compare.xml ldap-connect.xml ldap-count-entries.xml ldap-delete.xml ldap-dn2ufn.xml ldap-err2str.xml ldap-errno.xml ldap-error.xml ldap-explode-dn.xml ldap-first-attribute.xml ldap-first-entry.xml ldap-first-reference.xml ldap-free-result.xml ldap-get-attributes.xml ldap-get-dn.xml ldap-get-entries.xml ldap-get-option.xml ldap-get-values-len.xml ldap-get-values.xml ldap-list.xml ldap-mod-add.xml ldap-mod-del.xml ldap-mod-replace.xml ldap-modify.xml ldap-next-attribute.xml ldap-next-entry.xml ldap-next-reference.xml ldap-parse-reference.xml ldap-parse-result.xml ldap-read.xml ldap-rename.xml ldap-sasl-bind.xml ldap-search.xml ldap-set-option.xml ldap-set-rebind-proc.xml ldap-sort.xml ldap-start-tls.xml ldap-t61-to-8859.xml ldap-unbind.xml Log: ref.ldap: switch to new style Also document the following functions thanks to user notes ldap_8859_to_t61()

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-8859-to-t61.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-8859-to-t61.xml diff -u phpdoc/en/reference/ldap/functions/ldap-8859-to-t61.xml:1.3 phpdoc/en/reference/ldap/functions/ldap-8859-to-t61.xml:1.4 --- phpdoc/en/reference/ldap/functions/ldap-8859-to-t61.xml:1.3 Sun Feb 4 22:46:33 2007 +++ phpdoc/en/reference/ldap/functions/ldap-8859-to-t61.xml Sun Feb 4 22:48:23 2007 @@ -1,21 +1,60 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - + <refentry id='function.ldap-8859-to-t61'> <refnamediv> <refname>ldap_8859_to_t61</refname> <refpurpose>Translate 8859 characters to t61 characters</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ldap_8859_to_t61</methodname> <methodparam><type>string</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - &warn.undocumented.func; + Translate <literal>ISO-8859</literal> characters to <literal>t61</literal> + characters. + </para> + <para> + This function is useful if you have to talk to a legacy + <literal>LDAPv2</literal> server. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + The text to be translated. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Return the <literal>t61</literal> translation of + <parameter>value</parameter>. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ldap_t61_to_8859</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id="function.ldap-add"> <refnamediv> <refname>ldap_add</refname> <refpurpose>Add entries to LDAP directory</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_add</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -15,47 +15,85 @@ <methodparam><type>array</type><parameter>entry</parameter></methodparam> </methodsynopsis> <para> - &return.success; + Add entries in the LDAP directory. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The <function>ldap_add</function> function is used to add entries - in the LDAP directory. The DN of the entry to be added is - specified by <parameter>dn</parameter>. - Array <parameter>entry</parameter> specifies the information about the - entry. The values in the entries are indexed by individual attributes. - In case of multiple values for an attribute, they are indexed using - integers starting with 0. - </para> - <informalexample> - <programlisting role="php"> -<![CDATA[ + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dn</parameter></term> + <listitem> + <para> + The distinguished name of an LDAP entity. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>entry</parameter></term> + <listitem> + <para> + An array that specifies the information about the entry. The values in + the entries are indexed by individual attributes. + In case of multiple values for an attribute, they are indexed using + integers starting with 0. + <informalexample> + <programlisting role="php"> + <![CDATA[ <?php $entree["attribut1"] = "value"; $entree["attribut2"][0] = "value1"; $entree["attribut2"][1] = "value2"; ?> -]]> - </programlisting> - </informalexample> - <example> - <title>Complete example with authenticated bind</title> - <programlisting role="php"> + ]]> + </programlisting> + </informalexample> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Complete example with authenticated bind</title> + <programlisting role="php"> <![CDATA[ <?php -$ds=ldap_connect("localhost"); // assuming the LDAP server is on this host +$ds = ldap_connect("localhost"); // assuming the LDAP server is on this host if ($ds) { // bind with appropriate dn to give update access - $r=ldap_bind($ds, "cn=root, o=My Company, c=US", "secret"); + $r = ldap_bind($ds, "cn=root, o=My Company, c=US", "secret"); // prepare data - $info["cn"]="John Jones"; - $info["sn"]="Jones"; - $info["mail"]="jonj@example.com"; - $info["objectclass"]="person"; + $info["cn"] = "John Jones"; + $info["sn"] = "Jones"; + $info["mail"] = "jonj@example.com"; + $info["objectclass"] = "person"; // add data to directory - $r=ldap_add($ds, "cn=John Jones, o=My Company, c=US", $info); + $r = ldap_add($ds, "cn=John Jones, o=My Company, c=US", $info); ldap_close($ds); } else { @@ -63,12 +101,16 @@ } ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.bin-safe; - </refsect1> + </refentry>  - + <refentry id="function.ldap-bind"> <refnamediv> <refname>ldap_bind</refname> <refpurpose>Bind to LDAP directory</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_bind</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -15,15 +15,53 @@ <methodparam choice="opt"><type>string</type><parameter>bind_password</parameter></methodparam> </methodsynopsis> <para> - Binds to the LDAP directory with specified RDN and - password. &return.success; + Binds to the LDAP directory with specified RDN and password. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>bind_rdn</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>bind_password</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> <para> - <function>ldap_bind</function> does a bind operation on the - directory. <parameter>bind_rdn</parameter> and - <parameter>bind_password</parameter> are optional. If not - specified, anonymous bind is attempted. + If <parameter>bind_rdn</parameter> and <parameter>bind_password</parameter> + are not specified, an anonymous bind is attempted. </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Using LDAP Bind</title> @@ -88,6 +126,7 @@ </example> </para> </refsect1> + </refentry>  - + <refentry id="function.ldap-close"> <refnamediv> <refname>ldap_close</refname> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-compare.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-compare.xml diff -u phpdoc/en/reference/ldap/functions/ldap-compare.xml:1.5 phpdoc/en/reference/ldap/functions/ldap-compare.xml:1.6 --- phpdoc/en/reference/ldap/functions/ldap-compare.xml:1.5 Sun Feb 4 22:46:33 2007 +++ phpdoc/en/reference/ldap/functions/ldap-compare.xml Sun Feb 4 22:48:23 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - + <refentry id="function.ldap-compare"> <refnamediv> <refname>ldap_compare</refname> <refpurpose>Compare value of attribute found in entry specified with DN</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>ldap_compare</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -16,13 +16,61 @@ <methodparam><type>string</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - Returns &true; if <parameter>value</parameter> matches otherwise returns &false;. Returns -1 on error. + Compare <parameter>value</parameter> of <parameter>attribute</parameter> + with value of same attribute in an LDAP directory entry. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>ldap_compare</function> is used to compare <parameter>value</parameter> - of <parameter>attribute</parameter> to value of same attribute in LDAP directory - entry specified with <parameter>dn</parameter>. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dn</parameter></term> + <listitem> + <para> + The distinguished name of an LDAP entity. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attribute</parameter></term> + <listitem> + <para> + The attribute name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + The compared value. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if <parameter>value</parameter> matches otherwise returns + &false;. Returns -1 on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> The following example demonstrates how to check whether or not given password matches the one defined in DN specified entry. @@ -72,17 +120,17 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <warning> <para> <function>ldap_compare</function> can NOT be used to compare BINARY values! </para> </warning> - <note> - <para> - This function was added in 4.0.2. - </para> - </note> </refsect1> + </refentry>  - + <refentry id="function.ldap-connect"> <refnamediv> <refname>ldap_connect</refname> <refpurpose>Connect to an LDAP server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ldap_connect</methodname> <methodparam choice="opt"><type>string</type><parameter>hostname</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> </methodsynopsis> <para> - Returns a positive LDAP link identifier on success, or &false; on - error. When OpenLDAP 2.x.x is used, <function>ldap_connect</function> - will always return a <type>resource</type> as it does not actually - connect but just initializes the connecting parameters. The actual - connect happens with the next calls to ldap_* funcs, usually with + Establishes a connection to a LDAP server on a specified + <parameter>hostname</parameter> and <parameter>port</parameter>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hostname</parameter></term> + <listitem> + <para> + If you are using OpenLDAP 2.x.x you can specify a URL instead of the + hostname. To use LDAP with SSL, compile OpenLDAP 2.x.x with SSL + support, configure PHP with SSL, and set this parameter as + <literal>ldaps://hostname/</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>port</parameter></term> + <listitem> + <para> + The port to connect to. Not used when using URLs. Defaults to 389. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a positive LDAP link identifier on success, or &false; on error. + When OpenLDAP 2.x.x is used, <function>ldap_connect</function> will always + return a <type>resource</type> as it does not actually connect but just + initializes the connecting parameters. The actual connect happens with + the next calls to ldap_* funcs, usually with <function>ldap_bind</function>. </para> <para> - <function>ldap_connect</function> establishes a connection to a - LDAP server on a specified <parameter>hostname</parameter> and - <parameter>port</parameter>. Both the arguments are optional. If - no arguments are specified then the link identifier of the - already opened link will be returned. If only - <parameter>hostname</parameter> is specified, then the port - defaults to 389. - </para> - <para> - If you are using OpenLDAP 2.x.x you can specify a URL instead of the - hostname. To use LDAP with SSL, compile OpenLDAP 2.x.x with SSL - support, configure PHP with SSL, and use ldaps://hostname/ as - host parameter. The port parameter is not used when using URLs. - </para> - <note> - <simpara> - URL and SSL support were added in 4.0.4. - </simpara> - </note> + If no arguments are specified then the link identifier of the already + opened link will be returned. + </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.0.4</entry> + <entry> + URL and SSL support was added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Example of connecting to LDAP server.</title> @@ -79,11 +126,17 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>ldap_bind</function>. + <simplelist> + <member><function>ldap_bind</function></member> + </simplelist> </para> </refsect1> + </refentry>  - + <refentry id="function.ldap-count-entries"> <refnamediv> <refname>ldap_count_entries</refname> <refpurpose>Count the number of entries in a search</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ldap_count_entries</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> <methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam> </methodsynopsis> <para> - Returns number of entries in the result or &false; on error. + Returns the number of entries stored in the result of previous search + operations. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>ldap_count_entries</function> returns the number of - entries stored in the result of previous search - operations. <parameter>result_identifier</parameter> identifies - the internal ldap result. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</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> + The internal LDAP result. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns number of entries in the result or &false; on error. + </para> + </refsect1> + </refentry>  - + <refentry id="function.ldap-delete"> <refnamediv> <refname>ldap_delete</refname> <refpurpose>Delete an entry from a directory</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_delete</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> <methodparam><type>string</type><parameter>dn</parameter></methodparam> </methodsynopsis> <para> - &return.success; + Deletes a particular entry in LDAP directory. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>ldap_delete</function> function delete a particular - entry in LDAP directory specified by <parameter>dn</parameter>. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dn</parameter></term> + <listitem> + <para> + The distinguished name of an LDAP entity. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + </refentry>  - + <refentry id="function.ldap-dn2ufn"> <refnamediv> <refname>ldap_dn2ufn</refname> <refpurpose>Convert DN to User Friendly Naming format</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ldap_dn2ufn</methodname> <methodparam><type>string</type><parameter>dn</parameter></methodparam> </methodsynopsis> <para> - <function>ldap_dn2ufn</function> function is used to turn a DN, - specified by <parameter>dn</parameter>, into a more user-friendly form, - stripping off type names. + Turns the specified <parameter>dn</parameter>, into a more user-friendly + form, stripping off type names. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dn</parameter></term> + <listitem> + <para> + The distinguished name of an LDAP entity. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the user friendly name. + </para> + </refsect1> + </refentry>  - + <refentry id="function.ldap-err2str"> <refnamediv> <refname>ldap_err2str</refname> <refpurpose>Convert LDAP error number into string error message</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ldap_err2str</methodname> <methodparam><type>int</type><parameter>errno</parameter></methodparam> </methodsynopsis> <para> - Returns string error message. + Returns the string error message explaining the error number + <parameter>errno</parameter>. While LDAP errno numbers are standardized, + different libraries return different or even localized textual error + messages. Never check for a specific error message text, but always use an + error number to check. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function returns the string error message explaining the - error number <parameter>errno</parameter>. While LDAP errno numbers - are standardized, different libraries return different or even localized - textual error messages. Never check for a specific error message text, - but always use an error number to check. + <variablelist> + <varlistentry> + <term><parameter>errno</parameter></term> + <listitem> + <para> + The error number. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>ldap_errno</function> and - <function>ldap_error</function>. + Returns the error message, as a string. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Enumerating all LDAP error messages</title> @@ -41,6 +61,17 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ldap_errno</function></member> + <member><function>ldap_error</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id="function.ldap-errno"> <refnamediv> <refname>ldap_errno</refname> <refpurpose>Return the LDAP error number of the last LDAP command</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ldap_errno</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - Return the LDAP error number of the last LDAP command for this - link. + Returns the standardized error number returned by the last LDAP command. + This number can be converted into a textual error message using + <function>ldap_err2str</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function returns the standardized error number returned by - the last LDAP command for the given - <parameter>link_identifier</parameter>. This number - can be converted into a textual error message using - <function>ldap_err2str</function>. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Unless you lower your warning level in your &php.ini; sufficiently - or prefix your LDAP commands with @ (at) characters to suppress - warning output, the errors generated will also show up in your - HTML output. + Return the LDAP error number of the last LDAP command for this + link. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + Unless you lower your warning level in your &php.ini; sufficiently or + prefix your LDAP commands with @ (at) characters to suppress warning + output, the errors generated will also show up in your HTML output. <example> <title>Generating and catching an error</title> <programlisting role="php"> @@ -51,11 +72,18 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>ldap_err2str</function> and - <function>ldap_error</function>. + <simplelist> + <member><function>ldap_err2str</function></member> + <member><function>ldap_error</function></member> + </simplelist> </para> </refsect1> + </refentry>  - + <refentry id="function.ldap-error"> <refnamediv> <refname>ldap_error</refname> <refpurpose>Return the LDAP error message of the last LDAP command</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ldap_error</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - Returns string error message. + Returns the string error message explaining the error generated by the + last LDAP command for the given <parameter>link_identifier</parameter>. + While LDAP errno numbers are standardized, different libraries return + different or even localized textual error messages. Never check for a + specific error message text, but always use an error number to check. </para> <para> - This function returns the string error message explaining the - error generated by the last LDAP command for the given - <parameter>link_identifier</parameter> While LDAP errno numbers - are standardized, different libraries return different or even - localized textual error messages. Never check for a specific error - message text, but always use an error number to check. + Unless you lower your warning level in your &php.ini; sufficiently or + prefix your LDAP commands with <literal>@</literal> (at) characters to + suppress warning output, the errors generated will also show up in your + HTML output. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Unless you lower your warning level in your - &php.ini; sufficiently or prefix your LDAP - commands with <literal>@</literal> (at) characters to suppress - warning output, the errors generated will also show up in your - HTML output. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>ldap_err2str</function> and - <function>ldap_errno</function>. + Returns string error message. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ldap_err2str</function></member> + <member><function>ldap_errno</function></member> + </simplelist> </para> </refsect1> + </refentry>  - + <refentry id="function.ldap-explode-dn"> <refnamediv> <refname>ldap_explode_dn</refname> <refpurpose>Splits DN into its component parts</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>ldap_explode_dn</methodname> <methodparam><type>string</type><parameter>dn</parameter></methodparam> <methodparam><type>int</type><parameter>with_attrib</parameter></methodparam> </methodsynopsis> <para> - <function>ldap_explode_dn</function> function is used to split - the DN returned by <function>ldap_get_dn</function> and breaks - it up into its component parts. Each part is known as Relative - Distinguished Name, or RDN. <function>ldap_explode_dn</function> - returns an array of all those components. - <parameter>with_attrib</parameter> is used to request if the RDNs - are returned with only values or their attributes as well. To - get RDNs with the attributes (i.e. in attribute=value format) set - <parameter>with_attrib</parameter> to 0 and to get only values - set it to 1. + Splits the DN returned by <function>ldap_get_dn</function> and breaks it + up into its component parts. Each part is known as Relative Distinguished + Name, or RDN. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dn</parameter></term> + <listitem> + <para> + The distinguished name of an LDAP entity. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>with_attrib</parameter></term> + <listitem> + <para> + Used to request if the RDNs are returned with only values or their + attributes as well. To get RDNs with the attributes (i.e. in + attribute=value format) set <parameter>with_attrib</parameter> to 0 + and to get only values set it to 1. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of all DN components. + </para> + </refsect1> + </refentry>  - + <refentry id="function.ldap-first-attribute"> <refnamediv> <refname>ldap_first_attribute</refname> <refpurpose>Return first attribute</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ldap_first_attribute</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -15,26 +15,68 @@ <methodparam><type>int</type><parameter role="reference">ber_identifier</parameter></methodparam> </methodsynopsis> <para> + Gets the first attribute in the given entry. Remaining attributes are + retrieved by calling <function>ldap_next_attribute</function> successively. + </para> + <para> + Similar to reading entries, attributes are also read one by one from a + particular entry. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result_entry_identifier</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ber_identifier</parameter></term> + <listitem> + <para> + <parameter>ber_identifier</parameter> is the identifier to internal + memory location pointer. It is passed by reference. The same + <parameter>ber_identifier</parameter> is passed to + <function>ldap_next_attribute</function> , which modifies that + pointer. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns the first attribute in the entry on success and &false; on error. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - Similar to reading entries, attributes are also read one by one - from a particular entry. - <function>ldap_first_attribute</function> returns the first - attribute in the entry pointed by the - <parameter>result_entry_identifier</parameter>. - Remaining attributes are retrieved by calling - <function>ldap_next_attribute</function> successively. - <parameter>ber_identifier</parameter> is the identifier to - internal memory location pointer. It is passed by reference. The - same <parameter>ber_identifier</parameter> is passed to the - <function>ldap_next_attribute</function> function, which modifies - that pointer. + <simplelist> + <member><function>ldap_next_attribute</function></member> + <member><function>ldap_get_attributes</function></member> + </simplelist> </para> - <para> - See also <function>ldap_get_attributes</function></para> </refsect1> + </refentry>  - + <refentry id="function.ldap-first-entry"> <refnamediv> <refname>ldap_first_entry</refname> <refpurpose>Return first result id</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ldap_first_entry</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> <methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam> </methodsynopsis> <para> - Returns the result entry identifier for the first entry on - success and &false; on error. + Returns the entry identifier for first entry in the result. This entry + identifier is then supplied to <function>ldap_next_entry</function> + routine to get successive entries from the result. </para> <para> Entries in the LDAP result are read sequentially using the <function>ldap_first_entry</function> and - <function>ldap_next_entry</function> - functions. <function>ldap_first_entry</function> returns the - entry identifier for first entry in the result. This entry - identifier is then supplied to - <function>ldap_next_entry</function> routine to get successive - entries from the result. + <function>ldap_next_entry</function> functions. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link_identifier</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> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>ldap_get_entries</function>. + Returns the result entry identifier for the first entry on success and + &false; on error. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ldap_get_entries</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id='function.ldap-first-reference'> <refnamediv> <refname>ldap_first_reference</refname> <refpurpose>Return first reference</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ldap_first_reference</methodname> <methodparam><type>resource</type><parameter>link</parameter></methodparam> <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> - <para> - &warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> + </refentry>  - + <refentry id="function.ldap-free-result"> <refnamediv> <refname>ldap_free_result</refname> <refpurpose>Free result memory</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_free_result</methodname> <methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam> </methodsynopsis> <para> - &return.success; + Frees up the memory allocated internally to store the result. All result + memory will be automatically freed when the script terminates. </para> <para> - <function>ldap_free_result</function> frees up the memory - allocated internally to store the result and pointed by the - <parameter>result_identifier</parameter>. All result memory will - be automatically freed when the script terminates. + Typically all the memory allocated for the LDAP result gets freed at the + end of the script. In case the script is making successive searches which + return large result sets, <function>ldap_free_result</function> could be + called to keep the runtime memory usage by the script low. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Typically all the memory allocated for the ldap result gets freed - at the end of the script. In case the script is making successive - searches which return large result sets, - <function>ldap_free_result</function> could be called to keep the - runtime memory usage by the script low. + <variablelist> + <varlistentry> + <term><parameter>result_identifier</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + </refentry>  - + <refentry id="function.ldap-get-attributes"> <refnamediv> <refname>ldap_get_attributes</refname> <refpurpose>Get attributes from a search result entry</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>ldap_get_attributes</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> <methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam> </methodsynopsis> <para> - Returns a complete entry information in a multi-dimensional array - on success and &false; on error. - </para> - <para> - <function>ldap_get_attributes</function> function is used to - simplify reading the attributes and values from an entry in the - search result. The return value is a multi-dimensional array of - attributes and values. - </para> - <para> - Having located a specific entry in the directory, you can find - out what information is held for that entry by using this - call. You would use this call for an application which "browses" - directory entries and/or where you do not know the structure of - the directory entries. In many applications you will be searching - for a specific attribute such as an email address or a surname, - and won't care what other data is held. + Reads attributes and values from an entry in the search result. </para> <para> + Having located a specific entry in the directory, you can find out what + information is held for that entry by using this call. You would use this + call for an application which "browses" directory entries and/or where you + do not know the structure of the directory entries. In many applications + you will be searching for a specific attribute such as an email address or + a surname, and won't care what other data is held. <informalexample> <programlisting> <![CDATA[ @@ -46,7 +36,43 @@ ]]> </programlisting> </informalexample> + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result_entry_identifier</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a complete entry information in a multi-dimensional array + on success and &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> <title> Show the list of attributes held for a particular directory entry @@ -65,7 +91,7 @@ echo $attrs["count"] . " attributes held for this entry:<p>"; -for ($i=0; $i<$attrs["count"]; $i++) { +for ($i=0; $i < $attrs["count"]; $i++) { echo $attrs[$i] . "<br />"; } ?> @@ -73,11 +99,18 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>ldap_first_attribute</function> and - <function>ldap_next_attribute</function>. + <simplelist> + <member><function>ldap_first_attribute</function></member> + <member><function>ldap_next_attribute</function></member> + </simplelist> </para> </refsect1> + </refentry>  - + <refentry id="function.ldap-get-dn"> <refnamediv> <refname>ldap_get_dn</refname> <refpurpose>Get the DN of a result entry</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ldap_get_dn</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> <methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam> </methodsynopsis> <para> - Returns the DN of the result entry and &false; on error. + Finds out the DN of an entry in the result. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>ldap_get_dn</function> function is used to find out the - DN of an entry in the result. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result_entry_identifier</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the DN of the result entry and &false; on error. + </para> + </refsect1> + </refentry>  - + <refentry id="function.ldap-get-entries"> <refnamediv> <refname>ldap_get_entries</refname> <refpurpose>Get all result entries</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>ldap_get_entries</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> <methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam> </methodsynopsis> <para> - Returns a complete result information in a multi-dimensional - array on success and &false; on error. + Reads multiple entries from the given result, and then reading the + attributes and multiple values. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link_identifier</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> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>ldap_get_entries</function> function is used to - simplify reading multiple entries from the result, specified with - <parameter>result_identifier</parameter>, and then - reading the attributes and multiple values. The entire - information is returned by one function call in a - multi-dimensional array. The structure of the array is as - follows. + Returns a complete result information in a multi-dimensional array on + success and &false; on error. </para> <para> + The structure of the array is as follows. The attribute index is converted to lowercase. (Attributes are case-insensitive for directory servers, but not when used as array indices.) @@ -48,12 +71,18 @@ </programlisting> </informalexample> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>ldap_first_entry</function> and - <function>ldap_next_entry</function>. + <simplelist> + <member><function>ldap_first_entry</function></member> + <member><function>ldap_next_entry</function></member> + </simplelist> </para> </refsect1> + </refentry>  - + <refentry id="function.ldap-get-option"> <refnamediv> <refname>ldap_get_option</refname> <refpurpose>Get the current value for given option</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_get_option</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -16,22 +16,110 @@ </methodsynopsis> <para> Sets <parameter>retval</parameter> to the value of the specified option. - &return.success; </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The parameter <parameter>option</parameter> can be one of: - LDAP_OPT_DEREF, LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT, - LDAP_OPT_PROTOCOL_VERSION, LDAP_OPT_ERROR_NUMBER, LDAP_OPT_REFERRALS, - LDAP_OPT_RESTART, LDAP_OPT_HOST_NAME, LDAP_OPT_ERROR_STRING, - LDAP_OPT_MATCHED_DN. These are described in - <ulink url="&url.ldap.openldap-c-api;">draft-ietf-ldapext-ldap-c-api-xx.txt</ulink> + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + The parameter <parameter>option</parameter> can be one of: + <informaltable> + <tgroup cols="3"> + <thead> + <row> + <entry>Option</entry> + <entry>Type</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>LDAP_OPT_DEREF</constant></entry> + <entry>integer</entry> + </row> + <row> + <entry><constant>LDAP_OPT_SIZELIMIT</constant></entry> + <entry>integer</entry> + </row> + <row> + <entry><constant>LDAP_OPT_TIMELIMIT</constant></entry> + <entry>integer</entry> + </row> + <row> + <entry><constant>LDAP_OPT_PROTOCOL_VERSION</constant></entry> + <entry>integer</entry> + </row> + <row> + <entry><constant>LDAP_OPT_ERROR_NUMBER</constant></entry> + <entry>integer</entry> + </row> + <row> + <entry><constant>LDAP_OPT_REFERRALS</constant></entry> + <entry>bool</entry> + </row> + <row> + <entry><constant>LDAP_OPT_RESTART</constant></entry> + <entry>bool</entry> + </row> + <row> + <entry><constant>LDAP_OPT_HOST_NAME</constant></entry> + <entry>string</entry> + </row> + <row> + <entry><constant>LDAP_OPT_ERROR_STRING</constant></entry> + <entry>string</entry> + </row> + <row> + <entry><constant>LDAP_OPT_MATCHED_DN</constant></entry> + <entry>string</entry> + </row> + <row> + <entry><constant>LDAP_OPT_SERVER_CONTROLS</constant></entry> + <entry>array</entry> + </row> + <row> + <entry><constant>LDAP_OPT_CLIENT_CONTROLS</constant></entry> + <entry>array</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>retval</parameter></term> + <listitem> + <para> + This will be set to the option value. + </para> + </listitem> + </varlistentry> + </variablelist> </para> - <note> - <para> - This function is only available when using OpenLDAP 2.x.x OR - Netscape Directory SDK x.x, and was added in PHP 4.0.4 - </para> - </note> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Check protocol version</title> @@ -49,10 +137,27 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function is only available when using OpenLDAP 2.x.x OR Netscape + Directory SDK x.x. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>ldap_set_option</function>. + <simplelist> + <member><function>ldap_set_option</function></member> + </simplelist> </para> </refsect1> + </refentry>  - + <refentry id="function.ldap-get-values-len"> <refnamediv> <refname>ldap_get_values_len</refname> <refpurpose>Get all binary values from a result entry</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>ldap_get_values_len</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -15,29 +15,54 @@ <methodparam><type>string</type><parameter>attribute</parameter></methodparam> </methodsynopsis> <para> - Returns an array of values for the attribute on success and &false; - on error. + Reads all the values of the attribute in the entry in the result. </para> <para> - <function>ldap_get_values_len</function> function is used to read all - the values of the attribute in the entry in the result. entry is - specified by the - <parameter>result_entry_identifier</parameter>. The number of - values can be found by indexing "count" in the resultant - array. Individual values are accessed by integer index in the - array. The first index is 0. + This function is used exactly like <function>ldap_get_values</function> + except that it handles binary data and not string data. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function is used exactly like - <function>ldap_get_values</function> except that it handles - binary data and not string data. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result_entry_identifier</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attribute</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> - <note> - <para> - This function was added in 4.0. - </para> - </note> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of values for the attribute on success and &false; on + error. Individual values are accessed by integer index in the array. The + first index is 0. The number of values can be found by indexing "count" + in the resultant array. + </para> + </refsect1> + </refentry>  - + <refentry id="function.ldap-get-values"> <refnamediv> <refname>ldap_get_values</refname> <refpurpose>Get all values from a result entry</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>ldap_get_values</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -15,17 +15,7 @@ <methodparam><type>string</type><parameter>attribute</parameter></methodparam> </methodsynopsis> <para> - Returns an array of values for the attribute on success and &false; - on error. - </para> - <para> - <function>ldap_get_values</function> function is used to read all - the values of the attribute in the entry in the result. entry is - specified by the - <parameter>result_entry_identifier</parameter>. The number of - values can be found by indexing "count" in the resultant - array. Individual values are accessed by integer index in the - array. The first index is 0. + Reads all the values of the attribute in the entry in the result. </para> <para> This call needs a <parameter>result_entry_identifier</parameter>, @@ -38,10 +28,50 @@ the <function>ldap_get_attributes</function> call to work out what attributes exist for a given entry. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result_entry_identifier</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attribute</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - LDAP allows more than one entry for an attribute, so it can, for - example, store a number of email addresses for one person's - directory entry all labeled with the attribute "mail" + Returns an array of values for the attribute on success and &false; on + error. The number of values can be found by indexing "count" in the + resultant array. Individual values are accessed by integer index in the + array. The first index is 0. + </para> + <para> + LDAP allows more than one entry for an attribute, so it can, for example, + store a number of email addresses for one person's directory entry all + labeled with the attribute "mail" <informalexample> <literallayout> return_value["count"] = number of values for attribute @@ -49,6 +79,12 @@ return_value[i] = ith value of attribute </literallayout> </informalexample> + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> <title>List all values of the "mail" attribute for a directory entry </title> @@ -76,6 +112,7 @@ </example> </para> </refsect1> + </refentry>  - + <refentry id="function.ldap-list"> <refnamediv> <refname>ldap_list</refname> <refpurpose>Single-level search</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ldap_list</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -20,37 +20,193 @@ <methodparam choice="opt"><type>int</type><parameter>deref</parameter></methodparam> </methodsynopsis> <para> - Returns a search result identifier or &false; on error. + Performs the search for a specified <parameter>filter</parameter> on the + directory with the scope <constant>LDAP_SCOPE_ONELEVEL</constant>. </para> <para> - <function>ldap_list</function> performs the search for a specified - <parameter>filter</parameter> on the directory with the scope - LDAP_SCOPE_ONELEVEL. + <constant>LDAP_SCOPE_ONELEVEL</constant> means that the search should only + return information that is at the level immediately below the + <parameter>base_dn</parameter> given in the call. + (Equivalent to typing "ls" and getting a list of files and folders in the + current working directory.) </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - LDAP_SCOPE_ONELEVEL means that the search should only return - information that is at the level immediately below the - <parameter>base_dn</parameter> given in the call. - (Equivalent to typing "ls" and getting a list - of files and folders in the current working directory.) + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>base_dn</parameter></term> + <listitem> + <para> + The base DN for the directory. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>filter</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attributes</parameter></term> + <listitem> + <para> + An array of the required attributes, e.g. array("mail", "sn", "cn"). + Note that the "dn" is always returned irrespective of which attributes + types are requested. + </para> + <para> + Using this parameter is much more efficient than the default action + (which is to return all attributes and their associated values). + The use of this parameter should therefore be considered good + practice. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrsonly</parameter></term> + <listitem> + <para> + Should be set to 1 if only attribute types are wanted. If set to 0 + both attributes types and attribute values are fetched which is the + default behaviour. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>sizelimit</parameter></term> + <listitem> + <para> + Enables you to limit the count of entries fetched. Setting this to 0 + means no limit. + </para> + <note> + <para> + This parameter can NOT override server-side preset sizelimit. You can + set it lower though. + </para> + <para> + Some directory server hosts will be configured to return no more than + a preset number of entries. If this occurs, the server will indicate + that it has only returned a partial results set. This also occurs if + you use this parameter to limit the count of fetched entries. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timelimit</parameter></term> + <listitem> + <para> + Sets the number of seconds how long is spend on the search. Setting + this to 0 means no limit. + </para> + <note> + <para> + This parameter can NOT override server-side preset sizelimit. You can + set it lower though. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>deref</parameter></term> + <listitem> + <para> + Specifies how aliases should be handled during the search. It can be + one of the following: + <itemizedlist> + <listitem> + <simpara> + <constant>LDAP_DEREF_NEVER</constant> - (default) aliases are never + dereferenced. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LDAP_DEREF_SEARCHING</constant> - aliases should be + dereferenced during the search but not when locating the base object + of the search. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LDAP_DEREF_FINDING</constant> - aliases should be + dereferenced when locating the base object but not during the search. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LDAP_DEREF_ALWAYS</constant> - aliases should be dereferenced + always. + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a search result identifier or &false; on error. </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.0.5</entry> + <entry> + Parallel searches support was added. See + <function>ldap_search</function> for details. + </entry> + </row> + <row> + <entry>4.0.2</entry> + <entry> + The <parameter>attrsonly</parameter>, <parameter>sizelimit</parameter>, + <parameter>timelimit</parameter> and <parameter>deref</parameter> were + added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> - This call takes 5 optional parameters. See <function>ldap_search</function> - notes. - <note> - <para> - These optional parameters were added in 4.0.2: - <parameter>attrsonly</parameter>, - <parameter>sizelimit</parameter>, - <parameter>timelimit</parameter>, - <parameter>deref</parameter>. - </para> - </note> - - <example> - <title>Produce a list of all organizational units of an organization - </title> -<programlisting role="php3"> + <example> + <title>Produce a list of all organizational units of an organization</title> + <programlisting role="php3"> <![CDATA[ // $ds is a valid link identifier for a directory server @@ -69,13 +225,17 @@ </programlisting> </example> </para> - <note> - <para> - From 4.0.5 on it's also possible to do parallel searches. See - <function>ldap_search</function> for details. - </para> - </note> -</refsect1> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ldap_search</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id="function.ldap-mod-add"> <refnamediv> <refname>ldap_mod_add</refname> <refpurpose>Add attribute values to current attributes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_mod_add</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -15,18 +15,56 @@ <methodparam><type>array</type><parameter>entry</parameter></methodparam> </methodsynopsis> <para> - &return.success; + Adds one or more attributes to the specified <parameter>dn</parameter>. + It performs the modification at the attribute level as opposed to the + object level. Object-level additions are done by the + <function>ldap_add</function> function. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function adds attribute(s) to the specified - <parameter>dn</parameter>. It performs the modification at the - attribute level as opposed to the object level. Object-level additions - are done by the <function>ldap_add</function> function. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dn</parameter></term> + <listitem> + <para> + The distinguished name of an LDAP entity. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>entry</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> - &note.bin-safe; + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &note.bin-safe; </refsect1> + </refentry>  - + <refentry id="function.ldap-mod-del"> <refnamediv> <refname>ldap_mod_del</refname> <refpurpose>Delete attribute values from current attributes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_mod_del</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -15,15 +15,51 @@ <methodparam><type>array</type><parameter>entry</parameter></methodparam> </methodsynopsis> <para> - &return.success; + Removes one or more attributes from the specified <parameter>dn</parameter>. + It performs the modification at the attribute level as opposed to the object + level. Object-level deletions are done by the + <function>ldap_delete</function> function. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function removes attribute(s) from the specified - <parameter>dn</parameter>. It performs the modification at the - attribute level as opposed to the object level. Object-level - deletions are done by the <function>ldap_delete</function> function. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dn</parameter></term> + <listitem> + <para> + The distinguished name of an LDAP entity. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>entry</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + </refentry>  - + <refentry id="function.ldap-mod-replace"> <refnamediv> <refname>ldap_mod_replace</refname> <refpurpose>Replace attribute values with new ones</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_mod_replace</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -15,18 +15,56 @@ <methodparam><type>array</type><parameter>entry</parameter></methodparam> </methodsynopsis> <para> - &return.success; + Replaces one or more attributes from the specified <parameter>dn</parameter>. + It performs the modification at the attribute level as opposed to the object + level. Object-level modifications are done by the + <function>ldap_modify</function> function. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function replaces attribute(s) from the specified - <parameter>dn</parameter>. It performs the modification at the attribute - level as opposed to the object level. Object-level modifications are done - by the <function>ldap_modify</function> function. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dn</parameter></term> + <listitem> + <para> + The distinguished name of an LDAP entity. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>entry</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> - &note.bin-safe; + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &note.bin-safe; </refsect1> + </refentry>  - + <refentry id="function.ldap-modify"> <refnamediv> <refname>ldap_modify</refname> <refpurpose>Modify an LDAP entry</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_modify</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -15,17 +15,54 @@ <methodparam><type>array</type><parameter>entry</parameter></methodparam> </methodsynopsis> <para> - &return.success; + Modify the existing entries in the LDAP directory. The structure of the + entry is same as in <function>ldap_add</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>ldap_modify</function> function is used to modify the - existing entries in the LDAP directory. The structure of the - entry is same as in <function>ldap_add</function>. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dn</parameter></term> + <listitem> + <para> + The distinguished name of an LDAP entity. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>entry</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> - &note.bin-safe; + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &note.bin-safe; </refsect1> + </refentry>  - + <refentry id="function.ldap-next-attribute"> <refnamediv> <refname>ldap_next_attribute</refname> <refpurpose>Get the next attribute in result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ldap_next_attribute</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -15,22 +15,61 @@ <methodparam><type>resource</type><parameter role="reference">ber_identifier</parameter></methodparam> </methodsynopsis> <para> - Returns the next attribute in an entry on success and &false; on - error. - </para> - <para> - <function>ldap_next_attribute</function> is called to retrieve - the attributes in an entry. The internal state of the pointer is - maintained by the <parameter>ber_identifier</parameter>. It is - passed by reference to the function. The first call to + Retrieves the attributes in an entry. The first call to <function>ldap_next_attribute</function> is made with the <parameter>result_entry_identifier</parameter> returned from <function>ldap_first_attribute</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - See also <function>ldap_get_attributes</function> + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result_entry_identifier</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ber_identifier</parameter></term> + <listitem> + <para> + The internal state of the pointer is maintained by this parameter. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the next attribute in an entry on success and &false; on + error. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ldap_get_attributes</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id="function.ldap-next-entry"> <refnamediv> <refname>ldap_next_entry</refname> <refpurpose>Get next result entry</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ldap_next_entry</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> <methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam> </methodsynopsis> <para> - Returns entry identifier for the next entry in the result whose - entries are being read starting with - <function>ldap_first_entry</function>. If there are no more - entries in the result then it returns &false;. + Retrieve the entries stored in the result. Successive calls to the + <function>ldap_next_entry</function> return entries one by one till there + are no more entries. The first call to <function>ldap_next_entry</function> + is made after the call to <function>ldap_first_entry</function> with the + <parameter>result_entry_identifier</parameter> as returned from the + <function>ldap_first_entry</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>ldap_next_entry</function> function is used to retrieve - the entries stored in the result. Successive calls to the - <function>ldap_next_entry</function> return entries one by one - till there are no more entries. The first call to - <function>ldap_next_entry</function> is made after the call to - <function>ldap_first_entry</function> with the - <parameter>result_entry_identifier</parameter> - as returned from the <function>ldap_first_entry</function>. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result_entry_identifier</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>ldap_get_entries</function> + Returns entry identifier for the next entry in the result whose entries + are being read starting with <function>ldap_first_entry</function>. If + there are no more entries in the result then it returns &false;. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ldap_get_entries</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id='function.ldap-next-reference'> <refnamediv> <refname>ldap_next_reference</refname> <refpurpose>Get next reference</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ldap_next_reference</methodname> <methodparam><type>resource</type><parameter>link</parameter></methodparam> <methodparam><type>resource</type><parameter>entry</parameter></methodparam> </methodsynopsis> - <para> - &warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> + </refentry>  - + <refentry id='function.ldap-parse-reference'> <refnamediv> <refname>ldap_parse_reference</refname> <refpurpose>Extract information from reference entry</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_parse_reference</methodname> <methodparam><type>resource</type><parameter>link</parameter></methodparam> <methodparam><type>resource</type><parameter>entry</parameter></methodparam> <methodparam><type>array</type><parameter role="reference">referrals</parameter></methodparam> </methodsynopsis> - <para> - &warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> + </refentry>  - + <refentry id='function.ldap-parse-result'> <refnamediv> <refname>ldap_parse_result</refname> <refpurpose>Extract information from result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_parse_result</methodname> <methodparam><type>resource</type><parameter>link</parameter></methodparam> @@ -17,10 +17,9 @@ <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> - <para> - &warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> + </refentry>  - + <refentry id="function.ldap-read"> <refnamediv> <refname>ldap_read</refname> <refpurpose>Read an entry</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ldap_read</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -20,39 +20,186 @@ <methodparam choice="opt"><type>int</type><parameter>deref</parameter></methodparam> </methodsynopsis> <para> - Returns a search result identifier or &false; on error. - </para> - <para> - <function>ldap_read</function> performs the search for a - specified <parameter>filter</parameter> on the directory with the scope - LDAP_SCOPE_BASE. So it is equivalent to reading an entry from the - directory. + Performs the search for a specified <parameter>filter</parameter> on the + directory with the scope <constant>LDAP_SCOPE_BASE</constant>. So it is + equivalent to reading an entry from the directory. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - An empty filter is not allowed. If you want to retrieve - absolutely all information for this entry, use a filter of - "objectClass=*". If you know which entry types are used on the - directory server, you might use an appropriate filter such as - "objectClass=inetOrgPerson". + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>base_dn</parameter></term> + <listitem> + <para> + The base DN for the directory. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>filter</parameter></term> + <listitem> + <para> + An empty filter is not allowed. If you want to retrieve absolutely all + information for this entry, use a filter of + <literal>objectClass=*</literal>. If you know which entry types are + used on the directory server, you might use an appropriate filter such + as <literal>objectClass=inetOrgPerson</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attributes</parameter></term> + <listitem> + <para> + An array of the required attributes, e.g. array("mail", "sn", "cn"). + Note that the "dn" is always returned irrespective of which attributes + types are requested. + </para> + <para> + Using this parameter is much more efficient than the default action + (which is to return all attributes and their associated values). + The use of this parameter should therefore be considered good + practice. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrsonly</parameter></term> + <listitem> + <para> + Should be set to 1 if only attribute types are wanted. If set to 0 + both attributes types and attribute values are fetched which is the + default behaviour. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>sizelimit</parameter></term> + <listitem> + <para> + Enables you to limit the count of entries fetched. Setting this to 0 + means no limit. + </para> + <note> + <para> + This parameter can NOT override server-side preset sizelimit. You can + set it lower though. + </para> + <para> + Some directory server hosts will be configured to return no more than + a preset number of entries. If this occurs, the server will indicate + that it has only returned a partial results set. This also occurs if + you use this parameter to limit the count of fetched entries. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timelimit</parameter></term> + <listitem> + <para> + Sets the number of seconds how long is spend on the search. Setting + this to 0 means no limit. + </para> + <note> + <para> + This parameter can NOT override server-side preset sizelimit. You can + set it lower though. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>deref</parameter></term> + <listitem> + <para> + Specifies how aliases should be handled during the search. It can be + one of the following: + <itemizedlist> + <listitem> + <simpara> + <constant>LDAP_DEREF_NEVER</constant> - (default) aliases are never + dereferenced. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LDAP_DEREF_SEARCHING</constant> - aliases should be + dereferenced during the search but not when locating the base object + of the search. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LDAP_DEREF_FINDING</constant> - aliases should be + dereferenced when locating the base object but not during the search. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LDAP_DEREF_ALWAYS</constant> - aliases should be dereferenced + always. + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - This call takes 5 optional parameters. See <function>ldap_search</function> - notes. + Returns a search result identifier or &false; on error. </para> - <note> - <para> - These optional parameters were added in 4.0.2: - <parameter>attrsonly</parameter>, - <parameter>sizelimit</parameter>, - <parameter>timelimit</parameter>, - <parameter>deref</parameter>. - </para> - </note> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; <para> - From 4.0.5 on it's also possible to do parallel searches. See - <function>ldap_search</function> for details. + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.0.5</entry> + <entry> + Parallel searches support was added. + See <function>ldap_search</function> for details. + </entry> + </row> + <row> + <entry>4.0.2</entry> + <entry> + The <parameter>attrsonly</parameter>, <parameter>sizelimit</parameter>, + <parameter>timelimit</parameter> and <parameter>deref</parameter> were + added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> </refsect1> + </refentry>  - + <refentry id="function.ldap-rename"> <refnamediv> <refname>ldap_rename</refname> <refpurpose>Modify the name of an entry</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_rename</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -18,21 +18,77 @@ </methodsynopsis> <para> The entry specified by <parameter>dn</parameter> is renamed/moved. - The new RDN is specified by <parameter>newrdn</parameter> and the - new parent/superior entry is specified - by <parameter>newparent</parameter>. If the parameter - <parameter>deleteoldrdn</parameter> is &true; the old RDN value(s) - is removed, else the old RDN value(s) is retained as - non-distinguished values of the entry. &return.success; </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dn</parameter></term> + <listitem> + <para> + The distinguished name of an LDAP entity. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>newrdn</parameter></term> + <listitem> + <para> + The new RDN. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>newparent</parameter></term> + <listitem> + <para> + The new parent/superior entry. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>deleteoldrdn</parameter></term> + <listitem> + <para> + If &true; the old RDN value(s) is removed, else the old RDN value(s) + is retained as non-distinguished values of the entry. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> - <para>This function currently only works with LDAPv3. You may have - to use <function>ldap_set_option</function> prior to binding to - use LDAPv3. This function is only available when using OpenLDAP 2.x.x OR - Netscape Directory SDK x.x, and was added in PHP 4.0.5. + <para> + This function currently only works with LDAPv3. You may have to use + <function>ldap_set_option</function> prior to binding to use LDAPv3. This + function is only available when using OpenLDAP 2.x.x OR Netscape + Directory SDK x.x. </para> </note> </refsect1> + </refentry>  + <refentry id="function.ldap-sasl-bind"> <refnamediv> <refname>ldap_sasl_bind</refname> <refpurpose>Bind to LDAP directory using SASL</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_sasl_bind</methodname> <methodparam><type>resource</type><parameter>link</parameter></methodparam> @@ -17,9 +18,18 @@ <methodparam choice="opt"><type>string</type><parameter>sasl_authz_id</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>props</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; <note> <title>Requirement</title> <simpara> @@ -29,8 +39,8 @@ otherwise this function will be undefined. </simpara> </note> - </refsect1> + </refentry>  - + <refentry id="function.ldap-search"> <refnamediv> <refname>ldap_search</refname> <refpurpose>Search LDAP tree</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ldap_search</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -20,100 +20,202 @@ <methodparam choice="opt"><type>int</type><parameter>deref</parameter></methodparam> </methodsynopsis> <para> + Performs the search for a specified filter on the directory with the scope + of <constant>LDAP_SCOPE_SUBTREE</constant>. This is equivalent to searching + the entire directory. + </para> + <para> + From 4.0.5 on it's also possible to do parallel searches. To do this + you use an array of link identifiers, rather than a single identifier, + as the first argument. If you don't want the same base DN and the + same filter for all the searches, you can also use an array of base DNs + and/or an array of filters. Those arrays must be of the same size as + the link identifier array since the first entries of the arrays are + used for one search, the second entries are used for another, and so + on. When doing parallel searches an array of search result + identifiers is returned, except in case of error, then the entry + corresponding to the search will be &false;. This is very much like + the value normally returned, except that a result identifier is always + returned when a search was made. There are some rare cases where the + normal search returns &false; while the parallel search returns an + identifier. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>base_dn</parameter></term> + <listitem> + <para> + The base DN for the directory. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>filter</parameter></term> + <listitem> + <para> + The search filter can be simple or advanced, using boolean operators in + the format described in the LDAP documentation (see the <ulink + url="&url.ldap.filters;">Netscape Directory SDK</ulink> for full + information on filters). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attributes</parameter></term> + <listitem> + <para> + An array of the required attributes, e.g. array("mail", "sn", "cn"). + Note that the "dn" is always returned irrespective of which attributes + types are requested. + </para> + <para> + Using this parameter is much more efficient than the default action + (which is to return all attributes and their associated values). + The use of this parameter should therefore be considered good + practice. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrsonly</parameter></term> + <listitem> + <para> + Should be set to 1 if only attribute types are wanted. If set to 0 + both attributes types and attribute values are fetched which is the + default behaviour. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>sizelimit</parameter></term> + <listitem> + <para> + Enables you to limit the count of entries fetched. Setting this to 0 + means no limit. + </para> + <note> + <para> + This parameter can NOT override server-side preset sizelimit. You can + set it lower though. + </para> + <para> + Some directory server hosts will be configured to return no more than + a preset number of entries. If this occurs, the server will indicate + that it has only returned a partial results set. This also occurs if + you use this parameter to limit the count of fetched entries. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timelimit</parameter></term> + <listitem> + <para> + Sets the number of seconds how long is spend on the search. Setting + this to 0 means no limit. + </para> + <note> + <para> + This parameter can NOT override server-side preset sizelimit. You can + set it lower though. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>deref</parameter></term> + <listitem> + <para> + Specifies how aliases should be handled during the search. It can be + one of the following: + <itemizedlist> + <listitem> + <simpara> + <constant>LDAP_DEREF_NEVER</constant> - (default) aliases are never + dereferenced. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LDAP_DEREF_SEARCHING</constant> - aliases should be + dereferenced during the search but not when locating the base object + of the search. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LDAP_DEREF_FINDING</constant> - aliases should be + dereferenced when locating the base object but not during the search. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>LDAP_DEREF_ALWAYS</constant> - aliases should be dereferenced + always. + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns a search result identifier or &false; on error. </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; <para> - <function>ldap_search</function> performs the search for a - specified filter on the directory with the scope of - LDAP_SCOPE_SUBTREE. This is equivalent to searching the entire - directory. <parameter>base_dn</parameter> specifies the base DN - for the directory. - </para> - <para> - There is an optional fourth parameter, that can be added to - restrict the attributes and values returned by the server to just - those required. This is much more efficient than the default - action (which is to return all attributes and their associated - values). The use of the fourth parameter should therefore be - considered good practice. - </para> - <para> - The fourth parameter is a standard PHP string array of the - required attributes, e.g. array("mail", "sn", "cn") Note that the - "dn" is always returned irrespective of which attributes types - are requested. - </para> - <para> - Note too that some directory server hosts will be configured to - return no more than a preset number of entries. If this occurs, - the server will indicate that it has only returned a partial - results set. This occurs also if the sixth parameter - <parameter>sizelimit</parameter> has been used to limit the count - of fetched entries. - </para> - <para> - The fifth parameter <parameter>attrsonly</parameter> should be - set to 1 if only attribute types are wanted. - If set to 0 both attributes types and attribute values are fetched - which is the default behaviour. - </para> - <para> - With the sixth parameter <parameter>sizelimit</parameter> it is - possible to limit the count of entries fetched. - Setting this to 0 means no limit. - NOTE: This parameter can NOT override server-side preset sizelimit. - You can set it lower though. - </para> - <para> - The seventh parameter <parameter>timelimit</parameter> sets the number - of seconds how long is spend on the search. - Setting this to 0 means no limit. - NOTE: This parameter can NOT override server-side preset timelimit. - You can set it lower though. - </para> - <para> - The eighth parameter <parameter>deref</parameter> specifies how aliases - should be handled during the search. It can be one of the following: - <itemizedlist> - <listitem> - <simpara> - LDAP_DEREF_NEVER - (default) aliases are never dereferenced. - </simpara> - </listitem> - <listitem> - <simpara> - LDAP_DEREF_SEARCHING - aliases should be dereferenced during the search - but not when locating the base object of the search. - </simpara> - </listitem> - <listitem> - <simpara> - LDAP_DEREF_FINDING - aliases should be dereferenced when - locating the base object but not during the search. - </simpara> - </listitem> - <listitem> - <simpara> - LDAP_DEREF_ALWAYS - aliases should be dereferenced always. - </simpara> - </listitem> - </itemizedlist> - </para> - <note> - <para> - These optional parameters were added in 4.0.2: - <parameter>attrsonly</parameter>, - <parameter>sizelimit</parameter>, - <parameter>timelimit</parameter>, - <parameter>deref</parameter>. - </para> - </note> - <para> - The search filter can be simple or advanced, using boolean - operators in the format described in the LDAP documentation (see - the <ulink url="&url.ldap.filters;">Netscape Directory SDK</ulink> - for full information on filters). + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.0.5</entry> + <entry> + Parallel searches support was added. + </entry> + </row> + <row> + <entry>4.0.2</entry> + <entry> + The <parameter>attrsonly</parameter>, <parameter>sizelimit</parameter>, + <parameter>timelimit</parameter> and <parameter>deref</parameter> were + added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> The example below retrieves the organizational unit, surname, given name and email address for all people in "My Company" where @@ -143,23 +245,8 @@ </programlisting> </example> </para> - <para> - From 4.0.5 on it's also possible to do parallel searches. To do this - you use an array of link identifiers, rather than a single identifier, - as the first argument. If you don't want the same base DN and the - same filter for all the searches, you can also use an array of base DNs - and/or an array of filters. Those arrays must be of the same size as - the link identifier array since the first entries of the arrays are - used for one search, the second entries are used for another, and so - on. When doing parallel searches an array of search result - identifiers is returned, except in case of error, then the entry - corresponding to the search will be &false;. This is very much like - the value normally returned, except that a result identifier is always - returned when a search was made. There are some rare cases where the - normal search returns &false; while the parallel search returns an - identifier. - </para> </refsect1> + </refentry>  - + <refentry id="function.ldap-set-option"> <refnamediv> <refname>ldap_set_option</refname> <refpurpose>Set the value of the given option</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_set_option</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> @@ -15,45 +15,127 @@ <methodparam><type>mixed</type><parameter>newval</parameter></methodparam> </methodsynopsis> <para> - Sets the value of the specified option to be - <parameter>newval</parameter>. &return.success; - on error. + Sets the value of the specified option to be <parameter>newval</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The parameter <parameter>option</parameter> can be one of: - LDAP_OPT_DEREF, LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT, - LDAP_OPT_PROTOCOL_VERSION, LDAP_OPT_ERROR_NUMBER, LDAP_OPT_REFERRALS, - LDAP_OPT_RESTART, LDAP_OPT_HOST_NAME, LDAP_OPT_ERROR_STRING, - LDAP_OPT_MATCHED_DN, LDAP_OPT_SERVER_CONTROLS, LDAP_OPT_CLIENT_CONTROLS. - Here's a brief description, see <ulink - url="&url.ldap.openldap-c-api;">draft-ietf-ldapext-ldap-c-api-xx.txt</ulink> - for details. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + An LDAP link identifier, returned by <function>ldap_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + The parameter <parameter>option</parameter> can be one of: + <informaltable> + <tgroup cols="3"> + <thead> + <row> + <entry>Option</entry> + <entry>Type</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>LDAP_OPT_DEREF</constant></entry> + <entry>integer</entry> + </row> + <row> + <entry><constant>LDAP_OPT_SIZELIMIT</constant></entry> + <entry>integer</entry> + </row> + <row> + <entry><constant>LDAP_OPT_TIMELIMIT</constant></entry> + <entry>integer</entry> + </row> + <row> + <entry><constant>LDAP_OPT_PROTOCOL_VERSION</constant></entry> + <entry>integer</entry> + </row> + <row> + <entry><constant>LDAP_OPT_ERROR_NUMBER</constant></entry> + <entry>integer</entry> + </row> + <row> + <entry><constant>LDAP_OPT_REFERRALS</constant></entry> + <entry>bool</entry> + </row> + <row> + <entry><constant>LDAP_OPT_RESTART</constant></entry> + <entry>bool</entry> + </row> + <row> + <entry><constant>LDAP_OPT_HOST_NAME</constant></entry> + <entry>string</entry> + </row> + <row> + <entry><constant>LDAP_OPT_ERROR_STRING</constant></entry> + <entry>string</entry> + </row> + <row> + <entry><constant>LDAP_OPT_MATCHED_DN</constant></entry> + <entry>string</entry> + </row> + <row> + <entry><constant>LDAP_OPT_SERVER_CONTROLS</constant></entry> + <entry>array</entry> + </row> + <row> + <entry><constant>LDAP_OPT_CLIENT_CONTROLS</constant></entry> + <entry>array</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + <constant>LDAP_OPT_SERVER_CONTROLS</constant> and + <constant>LDAP_OPT_CLIENT_CONTROLS</constant> require a list of + controls, this means that the value must be an array of controls. A + control consists of an <emphasis>oid</emphasis> identifying the control, + an optional <emphasis>value</emphasis>, and an optional flag for + <emphasis>criticality</emphasis>. In PHP a control is given by an + array containing an element with the key <emphasis>oid</emphasis> + and string value, and two optional elements. The optional + elements are key <emphasis>value</emphasis> with string value + and key <emphasis>iscritical</emphasis> with boolean value. + <emphasis>iscritical</emphasis> defaults to <emphasis>&false;</emphasis> + if not supplied. See <ulink + url="&url.ldap.openldap-c-api;">draft-ietf-ldapext-ldap-c-api-xx.txt</ulink> + for details. See also the second example below. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>newval</parameter></term> + <listitem> + <para> + The new value for the specified <parameter>option</parameter>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The options LDAP_OPT_DEREF, LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT, - LDAP_OPT_PROTOCOL_VERSION and LDAP_OPT_ERROR_NUMBER have integer value, - LDAP_OPT_REFERRALS and LDAP_OPT_RESTART have boolean value, and the - options LDAP_OPT_HOST_NAME, LDAP_OPT_ERROR_STRING and LDAP_OPT_MATCHED_DN - have string value. The first example illustrates their use. The options - LDAP_OPT_SERVER_CONTROLS and LDAP_OPT_CLIENT_CONTROLS require a list of - controls, this means that the value must be an array of controls. A - control consists of an <emphasis>oid</emphasis> identifying the control, - an optional <emphasis>value</emphasis>, and an optional flag for - <emphasis>criticality</emphasis>. In PHP a control is given by an - array containing an element with the key <emphasis>oid</emphasis> - and string value, and two optional elements. The optional - elements are key <emphasis>value</emphasis> with string value - and key <emphasis>iscritical</emphasis> with boolean value. - <emphasis>iscritical</emphasis> defaults to <emphasis>&false;</emphasis> - if not supplied. See also the second example below. + &return.success; </para> - <note> - <para> - This function is only available when using - OpenLDAP 2.x.x OR Netscape Directory SDK x.x, and was - added in PHP 4.0.4. - </para> - </note> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Set protocol version</title> @@ -81,17 +163,35 @@ // iscritical defaults to FALSE $ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic"); // try to set both controls -if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) +if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) { echo "Failed to set server controls"; +} ?> ]]> </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function is only available when using OpenLDAP 2.x.x OR Netscape + Directory SDK x.x. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>ldap_get_option</function>. + <simplelist> + <member><function>ldap_get_option</function></member> + </simplelist> </para> </refsect1> + </refentry>  - + <refentry id='function.ldap-set-rebind-proc'> <refnamediv> <refname>ldap_set_rebind_proc</refname> <refpurpose>Set a callback function to do re-binds on referral chasing</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_set_rebind_proc</methodname> <methodparam><type>resource</type><parameter>link</parameter></methodparam> <methodparam><type>callback</type><parameter>callback</parameter></methodparam> </methodsynopsis> - <para> - &warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> + </refentry>  - + <refentry id='function.ldap-sort'> <refnamediv> <refname>ldap_sort</refname> <refpurpose>Sort LDAP result entries</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_sort</methodname> <methodparam><type>resource</type><parameter>link</parameter></methodparam> <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>string</type><parameter>sortfilter</parameter></methodparam> </methodsynopsis> - <para> - &warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> + </refentry>  - + <refentry id='function.ldap-start-tls'> <refnamediv> <refname>ldap_start_tls</refname> <refpurpose>Start TLS</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_start_tls</methodname> <methodparam><type>resource</type><parameter>link</parameter></methodparam> </methodsynopsis> - <para> - &warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> + </refentry>  - + <refentry id='function.ldap-t61-to-8859'> <refnamediv> <refname>ldap_t61_to_8859</refname> <refpurpose>Translate t61 characters to 8859 characters</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ldap_t61_to_8859</methodname> <methodparam><type>string</type><parameter>value</parameter></methodparam> </methodsynopsis> - <para> - &warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> + </refentry>  - + <refentry id="function.ldap-unbind"> <refnamediv> <refname>ldap_unbind</refname> <refpurpose>Unbind from LDAP directory</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ldap_unbind</methodname> <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> <para> - &return.success; + Unbinds from the LDAP directory. </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>ldap_unbind</function> function unbinds from the LDAP - directory. + &return.success; </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file