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

didou Sun Feb 4 22:46:34 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: WS, prepare for new docstyle

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-8859-to-t61.xml?r1=1.2&r2=1.3&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.2 phpdoc/en/reference/ldap/functions/ldap-8859-to-t61.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-8859-to-t61.xml:1.2 Wed Apr 17 06:39:42 2002 +++ phpdoc/en/reference/ldap/functions/ldap-8859-to-t61.xml Sun Feb 4 22:46:33 2007 @@ -1,24 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.39 --> - <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> - <methodsynopsis> - <type>string</type><methodname>ldap_8859_to_t61</methodname> - <methodparam><type>string</type><parameter>value</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<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> + <methodsynopsis> + <type>string</type><methodname>ldap_8859_to_t61</methodname> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-add.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-add.xml diff -u phpdoc/en/reference/ldap/functions/ldap-add.xml:1.7 phpdoc/en/reference/ldap/functions/ldap-add.xml:1.8 --- phpdoc/en/reference/ldap/functions/ldap-add.xml:1.7 Sun Jan 23 22:03:57 2005 +++ phpdoc/en/reference/ldap/functions/ldap-add.xml Sun Feb 4 22:46:33 2007 @@ -1,32 +1,33 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-add"> - <refnamediv> - <refname>ldap_add</refname> - <refpurpose>Add entries to LDAP directory</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ldap_add</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>string</type><parameter>dn</parameter></methodparam> - <methodparam><type>array</type><parameter>entry</parameter></methodparam> - </methodsynopsis> - <para> - &return.success; - </para><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"> +<refentry id="function.ldap-add"> + <refnamediv> + <refname>ldap_add</refname> + <refpurpose>Add entries to LDAP directory</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ldap_add</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>array</type><parameter>entry</parameter></methodparam> + </methodsynopsis> + <para> + &return.success; + </para> + <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[ <?php $entree["attribut1"] = "value"; @@ -34,11 +35,11 @@ $entree["attribut2"][1] = "value2"; ?> ]]> - </programlisting> - </informalexample> - <example> - <title>Complete example with authenticated bind</title> - <programlisting role="php"> + </programlisting> + </informalexample> + <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 @@ -58,17 +59,17 @@ ldap_close($ds); } else { - echo "Unable to connect to LDAP server"; + echo "Unable to connect to LDAP server"; } ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - &note.bin-safe; - - </refsect1> - </refentry> + &note.bin-safe; + + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-bind.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-bind.xml diff -u phpdoc/en/reference/ldap/functions/ldap-bind.xml:1.5 phpdoc/en/reference/ldap/functions/ldap-bind.xml:1.6 --- phpdoc/en/reference/ldap/functions/ldap-bind.xml:1.5 Mon Dec 9 20:25:54 2002 +++ phpdoc/en/reference/ldap/functions/ldap-bind.xml Sun Feb 4 22:46:33 2007 @@ -1,31 +1,33 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-bind"> - <refnamediv> - <refname>ldap_bind</refname> - <refpurpose>Bind to LDAP directory</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ldap_bind</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>bind_rdn</parameter></methodparam> - <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;</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. - </para> - <example> - <title>Using LDAP Bind</title> - <programlisting role="php"> +<refentry id="function.ldap-bind"> + <refnamediv> + <refname>ldap_bind</refname> + <refpurpose>Bind to LDAP directory</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ldap_bind</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>bind_rdn</parameter></methodparam> + <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; + </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. + </para> + <para> + <example> + <title>Using LDAP Bind</title> + <programlisting role="php"> <![CDATA[ <?php @@ -48,16 +50,16 @@ } else { echo "LDAP bind failed..."; } - + } ?> ]]> - </programlisting> - </example> - <example> - <title>Using LDAP Bind Anonymously</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Using LDAP Bind Anonymously</title> + <programlisting role="php"> <![CDATA[ <?php @@ -77,15 +79,16 @@ } else { echo "LDAP bind anonymous failed..."; } - + } - + ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-close.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-close.xml diff -u phpdoc/en/reference/ldap/functions/ldap-close.xml:1.3 phpdoc/en/reference/ldap/functions/ldap-close.xml:1.4 --- phpdoc/en/reference/ldap/functions/ldap-close.xml:1.3 Mon Apr 25 00:33:01 2005 +++ phpdoc/en/reference/ldap/functions/ldap-close.xml Sun Feb 4 22:46:33 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> <refentry id="function.ldap-close"> <refnamediv> @@ -10,8 +10,7 @@ <refsect1 role="description"> &reftitle.description; <simpara> - &info.function.alias; - <function>ldap_unbind</function>. + &info.function.alias; <function>ldap_unbind</function>. </simpara> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-compare.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-compare.xml diff -u phpdoc/en/reference/ldap/functions/ldap-compare.xml:1.4 phpdoc/en/reference/ldap/functions/ldap-compare.xml:1.5 --- phpdoc/en/reference/ldap/functions/ldap-compare.xml:1.4 Fri Jun 24 09:11:41 2005 +++ phpdoc/en/reference/ldap/functions/ldap-compare.xml Sun Feb 4 22:46:33 2007 @@ -1,49 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.12 --> - <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> - <methodsynopsis> - <type>mixed</type><methodname>ldap_compare</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>string</type><parameter>dn</parameter></methodparam> - <methodparam><type>string</type><parameter>attribute</parameter></methodparam> - <methodparam><type>string</type><parameter>value</parameter></methodparam> - </methodsynopsis> - <simpara> - Returns &true; if <parameter>value</parameter> matches otherwise returns &false;. Returns -1 on error. - </simpara> - <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>. - </para> - <simpara> - The following example demonstrates how to check whether or not given password matches - the one defined in DN specified entry. - </simpara> - <example> +<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> + <methodsynopsis> + <type>mixed</type><methodname>ldap_compare</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>string</type><parameter>attribute</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> + <para> + Returns &true; if <parameter>value</parameter> matches otherwise returns &false;. Returns -1 on error. + </para> + <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>. + </para> + <para> + The following example demonstrates how to check whether or not given password matches + the one defined in DN specified entry. + </para> + <para> + <example> <title>Complete example of password check</title> - <programlisting role="php"> + <programlisting role="php"> <![CDATA[ <?php $ds=ldap_connect("localhost"); // assuming the LDAP server is on this host - + if ($ds) { - // bind + // bind if (ldap_bind($ds)) { // prepare data $dn = "cn=Matti Meikku, ou=My Unit, o=My Company, c=FI"; $value = "secretpassword"; - $attr = "password"; + $attr = "password"; // compare value $r=ldap_compare($ds, $dn, $attr, $value); @@ -58,7 +59,7 @@ } else { echo "Unable to bind to LDAP server."; - } + } ldap_close($ds); @@ -68,20 +69,21 @@ ?> ]]> - </programlisting> - </example> - <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> + </programlisting> + </example> + </para> + <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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-connect.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-connect.xml diff -u phpdoc/en/reference/ldap/functions/ldap-connect.xml:1.5 phpdoc/en/reference/ldap/functions/ldap-connect.xml:1.6 --- phpdoc/en/reference/ldap/functions/ldap-connect.xml:1.5 Thu Aug 5 05:54:19 2004 +++ phpdoc/en/reference/ldap/functions/ldap-connect.xml Sun Feb 4 22:46:33 2007 @@ -1,48 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-connect"> - <refnamediv> - <refname>ldap_connect</refname> - <refpurpose>Connect to an LDAP server</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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 - <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> - <example> - <title>Example of connecting to LDAP server.</title> - <programlisting role="php"> +<refentry id="function.ldap-connect"> + <refnamediv> + <refname>ldap_connect</refname> + <refpurpose>Connect to an LDAP server</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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 + <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> + <para> + <example> + <title>Example of connecting to LDAP server.</title> + <programlisting role="php"> <![CDATA[ <?php @@ -51,16 +53,16 @@ $ldapport = 389; // your ldap server's port number // Connecting to LDAP -$ldapconn = ldap_connect($ldaphost, $ldapport) +$ldapconn = ldap_connect($ldaphost, $ldapport) or die("Could not connect to $ldaphost"); ?> ]]> - </programlisting> - </example> - <example> - <title>Example of connecting securely to LDAP server.</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Example of connecting securely to LDAP server.</title> + <programlisting role="php"> <![CDATA[ <?php @@ -69,19 +71,20 @@ $ldaphost = "ldaps://ldap.example.com/"; // Connecting to LDAP -$ldapconn = ldap_connect($ldaphost) +$ldapconn = ldap_connect($ldaphost) or die("Could not connect to {$ldaphost}"); ?> ]]> - </programlisting> - </example> - <para> - See also - <function>ldap_bind</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>ldap_bind</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-count-entries.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-count-entries.xml diff -u phpdoc/en/reference/ldap/functions/ldap-count-entries.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-count-entries.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-count-entries.xml:1.2 Wed Apr 17 06:39:43 2002 +++ phpdoc/en/reference/ldap/functions/ldap-count-entries.xml Sun Feb 4 22:46:33 2007 @@ -1,27 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <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> - <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.</para> - <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.</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> + <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. + </para> + <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. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-delete.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-delete.xml diff -u phpdoc/en/reference/ldap/functions/ldap-delete.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-delete.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-delete.xml:1.2 Wed Apr 17 06:39:43 2002 +++ phpdoc/en/reference/ldap/functions/ldap-delete.xml Sun Feb 4 22:46:33 2007 @@ -1,26 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-delete"> - <refnamediv> - <refname>ldap_delete</refname> - <refpurpose>Delete an entry from a directory</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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;</para> - <para> - <function>ldap_delete</function> function delete a particular - entry in LDAP directory specified by <parameter>dn</parameter>. - </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> + <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; + </para> + <para> + <function>ldap_delete</function> function delete a particular + entry in LDAP directory specified by <parameter>dn</parameter>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-dn2ufn.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-dn2ufn.xml diff -u phpdoc/en/reference/ldap/functions/ldap-dn2ufn.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-dn2ufn.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-dn2ufn.xml:1.2 Wed Apr 17 06:39:43 2002 +++ phpdoc/en/reference/ldap/functions/ldap-dn2ufn.xml Sun Feb 4 22:46:33 2007 @@ -1,24 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-dn2ufn"> - <refnamediv> - <refname>ldap_dn2ufn</refname> - <refpurpose>Convert DN to User Friendly Naming format</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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. - </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> + <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. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-err2str.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-err2str.xml diff -u phpdoc/en/reference/ldap/functions/ldap-err2str.xml:1.3 phpdoc/en/reference/ldap/functions/ldap-err2str.xml:1.4 --- phpdoc/en/reference/ldap/functions/ldap-err2str.xml:1.3 Mon Dec 15 16:51:21 2003 +++ phpdoc/en/reference/ldap/functions/ldap-err2str.xml Sun Feb 4 22:46:33 2007 @@ -1,34 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.12 --> - <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> - <methodsynopsis> - <type>string</type><methodname>ldap_err2str</methodname> - <methodparam><type>int</type><parameter>errno</parameter></methodparam> - </methodsynopsis> - <para> - Returns string error message.</para> - <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.</para> - <para> - See also <function>ldap_errno</function> and - <function>ldap_error</function>. - - <example> - <title>Enumerating all LDAP error messages</title> -<programlisting role="php"> +<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> + <methodsynopsis> + <type>string</type><methodname>ldap_err2str</methodname> + <methodparam><type>int</type><parameter>errno</parameter></methodparam> + </methodsynopsis> + <para> + Returns string error message. + </para> + <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. + </para> + <para> + See also <function>ldap_errno</function> and + <function>ldap_error</function>. + </para> + <para> + <example> + <title>Enumerating all LDAP error messages</title> + <programlisting role="php"> <![CDATA[ <?php for ($i=0; $i<100; $i++) { @@ -36,10 +37,11 @@ } ?> ]]> -</programlisting> - </example></para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-errno.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-errno.xml diff -u phpdoc/en/reference/ldap/functions/ldap-errno.xml:1.3 phpdoc/en/reference/ldap/functions/ldap-errno.xml:1.4 --- phpdoc/en/reference/ldap/functions/ldap-errno.xml:1.3 Mon Dec 15 16:51:21 2003 +++ phpdoc/en/reference/ldap/functions/ldap-errno.xml Sun Feb 4 22:46:33 2007 @@ -1,35 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.12 --> - <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> - <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.</para> - <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>.</para> - <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> +<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> + <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. + </para> + <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>. + </para> + <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"> <![CDATA[ <?php @@ -48,13 +48,15 @@ echo $info["count"] . " matching entries.<br />\n"; ?> ]]> -</programlisting> - </example></para> - <para> - See also <function>ldap_err2str</function> and - <function>ldap_error</function>.</para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>ldap_err2str</function> and + <function>ldap_error</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-error.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-error.xml diff -u phpdoc/en/reference/ldap/functions/ldap-error.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-error.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-error.xml:1.2 Wed Apr 17 06:39:43 2002 +++ phpdoc/en/reference/ldap/functions/ldap-error.xml Sun Feb 4 22:46:33 2007 @@ -1,39 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.12 --> - <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> - <methodsynopsis> - <type>string</type><methodname>ldap_error</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - <para> - Returns string error message.</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.</para> - <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.</para> - <para> - See also <function>ldap_err2str</function> and - <function>ldap_errno</function>.</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> + <methodsynopsis> + <type>string</type><methodname>ldap_error</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> + <para> + Returns string error message. + </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. + </para> + <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. + </para> + <para> + See also <function>ldap_err2str</function> and + <function>ldap_errno</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-explode-dn.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-explode-dn.xml diff -u phpdoc/en/reference/ldap/functions/ldap-explode-dn.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-explode-dn.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-explode-dn.xml:1.2 Wed Apr 17 06:39:43 2002 +++ phpdoc/en/reference/ldap/functions/ldap-explode-dn.xml Sun Feb 4 22:46:33 2007 @@ -1,31 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <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> - <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.</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> + <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. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-first-attribute.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-first-attribute.xml diff -u phpdoc/en/reference/ldap/functions/ldap-first-attribute.xml:1.4 phpdoc/en/reference/ldap/functions/ldap-first-attribute.xml:1.5 --- phpdoc/en/reference/ldap/functions/ldap-first-attribute.xml:1.4 Wed Nov 10 08:30:31 2004 +++ phpdoc/en/reference/ldap/functions/ldap-first-attribute.xml Sun Feb 4 22:46:33 2007 @@ -1,41 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-first-attribute"> - <refnamediv> - <refname>ldap_first_attribute</refname> - <refpurpose>Return first attribute</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ldap_first_attribute</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter role="reference">ber_identifier</parameter></methodparam> - </methodsynopsis> - <para> - Returns the first attribute in the entry on success and &false; on - error. - </para> - <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. - </para> - <para> - See also <function>ldap_get_attributes</function></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> + <methodsynopsis> + <type>string</type><methodname>ldap_first_attribute</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter role="reference">ber_identifier</parameter></methodparam> + </methodsynopsis> + <para> + Returns the first attribute in the entry on success and &false; on + error. + </para> + <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. + </para> + <para> + See also <function>ldap_get_attributes</function></para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-first-entry.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-first-entry.xml diff -u phpdoc/en/reference/ldap/functions/ldap-first-entry.xml:1.3 phpdoc/en/reference/ldap/functions/ldap-first-entry.xml:1.4 --- phpdoc/en/reference/ldap/functions/ldap-first-entry.xml:1.3 Mon Nov 11 15:14:26 2002 +++ phpdoc/en/reference/ldap/functions/ldap-first-entry.xml Sun Feb 4 22:46:33 2007 @@ -1,34 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-first-entry"> - <refnamediv> - <refname>ldap_first_entry</refname> - <refpurpose>Return first result id</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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.</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.</para> - <para> - See also <function>ldap_get_entries</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> + <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. + </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. + </para> + <para> + See also <function>ldap_get_entries</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-first-reference.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-first-reference.xml diff -u phpdoc/en/reference/ldap/functions/ldap-first-reference.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-first-reference.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-first-reference.xml:1.2 Wed Apr 17 06:39:44 2002 +++ phpdoc/en/reference/ldap/functions/ldap-first-reference.xml Sun Feb 4 22:46:33 2007 @@ -1,25 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.39 --> - <refentry id='function.ldap-first-reference'> - <refnamediv> - <refname>ldap_first_reference</refname> - <refpurpose> - Return first reference - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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> - </refsect1> - </refentry> +<refentry id='function.ldap-first-reference'> + <refnamediv> + <refname>ldap_first_reference</refname> + <refpurpose>Return first reference</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-free-result.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-free-result.xml diff -u phpdoc/en/reference/ldap/functions/ldap-free-result.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-free-result.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-free-result.xml:1.2 Wed Apr 17 06:39:44 2002 +++ phpdoc/en/reference/ldap/functions/ldap-free-result.xml Sun Feb 4 22:46:33 2007 @@ -1,32 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-free-result"> - <refnamediv> - <refname>ldap_free_result</refname> - <refpurpose>Free result memory</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ldap_free_result</methodname> - <methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam> - </methodsynopsis> - <para> - &return.success;</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.</para> - <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.</para> - </refsect1> - </refentry> +<refentry id="function.ldap-free-result"> + <refnamediv> + <refname>ldap_free_result</refname> + <refpurpose>Free result memory</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ldap_free_result</methodname> + <methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam> + </methodsynopsis> + <para> + &return.success; + </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. + </para> + <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. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml diff -u phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml:1.7 phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml:1.8 --- phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml:1.7 Sun Jan 23 22:03:57 2005 +++ phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml Sun Feb 4 22:46:33 2007 @@ -1,38 +1,40 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <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> - <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. - </para> - <para> - <informalexample> - <programlisting> +<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> + <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. + </para> + <para> + <informalexample> + <programlisting> <![CDATA[ return_value["count"] = number of attributes in the entry return_value[0] = first attribute @@ -42,14 +44,14 @@ return_value["attribute"][0] = first value of the attribute return_value["attribute"][i] = (i+1)th value of the attribute ]]> - </programlisting> - </informalexample> + </programlisting> + </informalexample> - <example> - <title> - Show the list of attributes held for a particular directory entry - </title> - <programlisting role="php"> + <example> + <title> + Show the list of attributes held for a particular directory entry + </title> + <programlisting role="php"> <![CDATA[ <?php // $ds is the link identifier for the directory @@ -68,15 +70,15 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>ldap_first_attribute</function> and - <function>ldap_next_attribute</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>ldap_first_attribute</function> and + <function>ldap_next_attribute</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-get-dn.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-get-dn.xml diff -u phpdoc/en/reference/ldap/functions/ldap-get-dn.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-get-dn.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-get-dn.xml:1.2 Wed Apr 17 06:39:44 2002 +++ phpdoc/en/reference/ldap/functions/ldap-get-dn.xml Sun Feb 4 22:46:33 2007 @@ -1,25 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <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> - <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.</para> - <para> - <function>ldap_get_dn</function> function is used to find out the - DN of an entry in the result.</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> + <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. + </para> + <para> + <function>ldap_get_dn</function> function is used to find out the + DN of an entry in the result. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-get-entries.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-get-entries.xml diff -u phpdoc/en/reference/ldap/functions/ldap-get-entries.xml:1.5 phpdoc/en/reference/ldap/functions/ldap-get-entries.xml:1.6 --- phpdoc/en/reference/ldap/functions/ldap-get-entries.xml:1.5 Sun Jan 23 22:03:57 2005 +++ phpdoc/en/reference/ldap/functions/ldap-get-entries.xml Sun Feb 4 22:46:33 2007 @@ -1,35 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-get-entries"> - <refnamediv> - <refname>ldap_get_entries</refname> - <refpurpose>Get all result entries</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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.</para> - <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.</para> - <para> - The attribute index is converted to lowercase. (Attributes are - case-insensitive for directory servers, but not when used as - array indices.) - <informalexample> - <programlisting> +<refentry id="function.ldap-get-entries"> + <refnamediv> + <refname>ldap_get_entries</refname> + <refpurpose>Get all result entries</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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. + </para> + <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. + </para> + <para> + The attribute index is converted to lowercase. (Attributes are + case-insensitive for directory servers, but not when used as + array indices.) + <informalexample> + <programlisting> <![CDATA[ return_value["count"] = number of entries in the result return_value[0] : refers to the details of first entry @@ -39,20 +41,20 @@ return_value[i]["count"] = number of attributes in ith entry return_value[i][j] = jth attribute in the ith entry in the result -return_value[i]["attribute"]["count"] = number of values for +return_value[i]["attribute"]["count"] = number of values for attribute in ith entry return_value[i]["attribute"][j] = jth value of attribute in ith entry ]]> - </programlisting> - </informalexample> - </para> - - <para> - See also <function>ldap_first_entry</function> and - <function>ldap_next_entry</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </informalexample> + </para> + + <para> + See also <function>ldap_first_entry</function> and + <function>ldap_next_entry</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-get-option.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-get-option.xml diff -u phpdoc/en/reference/ldap/functions/ldap-get-option.xml:1.6 phpdoc/en/reference/ldap/functions/ldap-get-option.xml:1.7 --- phpdoc/en/reference/ldap/functions/ldap-get-option.xml:1.6 Wed Nov 10 08:30:31 2004 +++ phpdoc/en/reference/ldap/functions/ldap-get-option.xml Sun Feb 4 22:46:33 2007 @@ -1,40 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.17 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>ldap_get_option</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>option</parameter></methodparam> - <methodparam><type>mixed</type><parameter role="reference">retval</parameter></methodparam> - </methodsynopsis> - <para> - Sets <parameter>retval</parameter> to the value of the specified option. - &return.success; - </para> - <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> - </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> - <para> - <example> - <title>Check protocol version</title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>bool</type><methodname>ldap_get_option</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>option</parameter></methodparam> + <methodparam><type>mixed</type><parameter role="reference">retval</parameter></methodparam> + </methodsynopsis> + <para> + Sets <parameter>retval</parameter> to the value of the specified option. + &return.success; + </para> + <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> + </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> + <para> + <example> + <title>Check protocol version</title> + <programlisting role="php"> <![CDATA[ <?php // $ds is a valid link identifier for a directory server @@ -45,14 +46,14 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>ldap_set_option</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>ldap_set_option</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-get-values-len.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-get-values-len.xml diff -u phpdoc/en/reference/ldap/functions/ldap-get-values-len.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-get-values-len.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-get-values-len.xml:1.2 Wed Apr 17 06:39:44 2002 +++ phpdoc/en/reference/ldap/functions/ldap-get-values-len.xml Sun Feb 4 22:46:33 2007 @@ -1,41 +1,44 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>array</type><methodname>ldap_get_values_len</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam> - <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_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.</para> - <para> - This function is used exactly like - <function>ldap_get_values</function> except that it handles - binary data and not string data.</para> - <note> - <para> - This function was added in 4.0. - </para> - </note> - </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> + <methodsynopsis> + <type>array</type><methodname>ldap_get_values_len</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam> + <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_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. + </para> + <para> + This function is used exactly like + <function>ldap_get_values</function> except that it handles + binary data and not string data. + </para> + <note> + <para> + This function was added in 4.0. + </para> + </note> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-get-values.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-get-values.xml diff -u phpdoc/en/reference/ldap/functions/ldap-get-values.xml:1.5 phpdoc/en/reference/ldap/functions/ldap-get-values.xml:1.6 --- phpdoc/en/reference/ldap/functions/ldap-get-values.xml:1.5 Thu Jan 15 12:42:44 2004 +++ phpdoc/en/reference/ldap/functions/ldap-get-values.xml Sun Feb 4 22:46:33 2007 @@ -1,56 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>array</type><methodname>ldap_get_values</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam> - <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.</para> - <para> - This call needs a <parameter>result_entry_identifier</parameter>, - so needs to be preceded by one of the ldap search calls and one - of the calls to get an individual entry.</para> - <para> - You application will either be hard coded to look for certain - attributes (such as "surname" or "mail") or you will have to use - the <function>ldap_get_attributes</function> call to work out - what attributes exist for a given entry.</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 -return_value[0] = first value of attribute -return_value[i] = ith value of attribute -</literallayout> - </informalexample> - - <example> - <title>List all values of the "mail" attribute for a - directory entry </title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>array</type><methodname>ldap_get_values</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam> + <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. + </para> + <para> + This call needs a <parameter>result_entry_identifier</parameter>, + so needs to be preceded by one of the ldap search calls and one + of the calls to get an individual entry. + </para> + <para> + You application will either be hard coded to look for certain + attributes (such as "surname" or "mail") or you will have to use + the <function>ldap_get_attributes</function> call to work out + what attributes exist for a given entry. + </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 + return_value[0] = first value of attribute + return_value[i] = ith value of attribute + </literallayout> + </informalexample> + <example> + <title>List all values of the "mail" attribute for a + directory entry </title> + <programlisting role="php"> <![CDATA[ <?php // $ds is a valid link identifier for a directory server @@ -70,11 +72,11 @@ } ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-list.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-list.xml diff -u phpdoc/en/reference/ldap/functions/ldap-list.xml:1.3 phpdoc/en/reference/ldap/functions/ldap-list.xml:1.4 --- phpdoc/en/reference/ldap/functions/ldap-list.xml:1.3 Thu Jan 15 12:42:44 2004 +++ phpdoc/en/reference/ldap/functions/ldap-list.xml Sun Feb 4 22:46:33 2007 @@ -1,52 +1,55 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-list"> - <refnamediv> - <refname>ldap_list</refname> - <refpurpose>Single-level search</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>ldap_list</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>string</type><parameter>base_dn</parameter></methodparam> - <methodparam><type>string</type><parameter>filter</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timelimit</parameter></methodparam> - <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_list</function> performs the search for a specified - <parameter>filter</parameter> on the directory with the scope - LDAP_SCOPE_ONELEVEL.</para> - <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.)</para> - <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> +<refentry id="function.ldap-list"> + <refnamediv> + <refname>ldap_list</refname> + <refpurpose>Single-level search</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>ldap_list</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>base_dn</parameter></methodparam> + <methodparam><type>string</type><parameter>filter</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timelimit</parameter></methodparam> + <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_list</function> performs the search for a specified + <parameter>filter</parameter> on the directory with the scope + LDAP_SCOPE_ONELEVEL. + </para> + <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.) + </para> + <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"> <![CDATA[ // $ds is a valid link identifier for a directory server @@ -63,16 +66,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> - </refentry> + </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> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-mod-add.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-mod-add.xml diff -u phpdoc/en/reference/ldap/functions/ldap-mod-add.xml:1.3 phpdoc/en/reference/ldap/functions/ldap-mod-add.xml:1.4 --- phpdoc/en/reference/ldap/functions/ldap-mod-add.xml:1.3 Thu Jul 22 22:51:12 2004 +++ phpdoc/en/reference/ldap/functions/ldap-mod-add.xml Sun Feb 4 22:46:33 2007 @@ -1,32 +1,33 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.12 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>ldap_mod_add</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>string</type><parameter>dn</parameter></methodparam> - <methodparam><type>array</type><parameter>entry</parameter></methodparam> - </methodsynopsis> - <para> - &return.success;</para> - <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. - </para> +<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> + <methodsynopsis> + <type>bool</type><methodname>ldap_mod_add</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>array</type><parameter>entry</parameter></methodparam> + </methodsynopsis> + <para> + &return.success; + </para> + <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. + </para> - &note.bin-safe; + &note.bin-safe; - </refsect1> - </refentry> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-mod-del.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-mod-del.xml diff -u phpdoc/en/reference/ldap/functions/ldap-mod-del.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-mod-del.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-mod-del.xml:1.2 Wed Apr 17 06:39:45 2002 +++ phpdoc/en/reference/ldap/functions/ldap-mod-del.xml Sun Feb 4 22:46:33 2007 @@ -1,29 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.12 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>ldap_mod_del</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>string</type><parameter>dn</parameter></methodparam> - <methodparam><type>array</type><parameter>entry</parameter></methodparam> - </methodsynopsis> - <para> - &return.success;</para> - <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. - </para> - </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> + <methodsynopsis> + <type>bool</type><methodname>ldap_mod_del</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>array</type><parameter>entry</parameter></methodparam> + </methodsynopsis> + <para> + &return.success; + </para> + <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. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-mod-replace.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-mod-replace.xml diff -u phpdoc/en/reference/ldap/functions/ldap-mod-replace.xml:1.4 phpdoc/en/reference/ldap/functions/ldap-mod-replace.xml:1.5 --- phpdoc/en/reference/ldap/functions/ldap-mod-replace.xml:1.4 Thu Jul 22 22:51:12 2004 +++ phpdoc/en/reference/ldap/functions/ldap-mod-replace.xml Sun Feb 4 22:46:33 2007 @@ -1,32 +1,33 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.12 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>ldap_mod_replace</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>string</type><parameter>dn</parameter></methodparam> - <methodparam><type>array</type><parameter>entry</parameter></methodparam> - </methodsynopsis> - <para> - &return.success;</para> - <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. - </para> +<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> + <methodsynopsis> + <type>bool</type><methodname>ldap_mod_replace</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>array</type><parameter>entry</parameter></methodparam> + </methodsynopsis> + <para> + &return.success; + </para> + <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. + </para> - &note.bin-safe; + &note.bin-safe; - </refsect1> - </refentry> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-modify.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-modify.xml diff -u phpdoc/en/reference/ldap/functions/ldap-modify.xml:1.3 phpdoc/en/reference/ldap/functions/ldap-modify.xml:1.4 --- phpdoc/en/reference/ldap/functions/ldap-modify.xml:1.3 Thu Jul 22 22:51:12 2004 +++ phpdoc/en/reference/ldap/functions/ldap-modify.xml Sun Feb 4 22:46:33 2007 @@ -1,31 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-modify"> - <refnamediv> - <refname>ldap_modify</refname> - <refpurpose>Modify an LDAP entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ldap_modify</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>string</type><parameter>dn</parameter></methodparam> - <methodparam><type>array</type><parameter>entry</parameter></methodparam> - </methodsynopsis> - <para> - &return.success;</para> - <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>. - </para> +<refentry id="function.ldap-modify"> + <refnamediv> + <refname>ldap_modify</refname> + <refpurpose>Modify an LDAP entry</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ldap_modify</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>array</type><parameter>entry</parameter></methodparam> + </methodsynopsis> + <para> + &return.success; + </para> + <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>. + </para> - &note.bin-safe; + &note.bin-safe; - </refsect1> - </refentry> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-next-attribute.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-next-attribute.xml diff -u phpdoc/en/reference/ldap/functions/ldap-next-attribute.xml:1.4 phpdoc/en/reference/ldap/functions/ldap-next-attribute.xml:1.5 --- phpdoc/en/reference/ldap/functions/ldap-next-attribute.xml:1.4 Wed Nov 10 08:30:31 2004 +++ phpdoc/en/reference/ldap/functions/ldap-next-attribute.xml Sun Feb 4 22:46:33 2007 @@ -1,34 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>string</type><methodname>ldap_next_attribute</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam> - <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 - <function>ldap_next_attribute</function> is made with the - <parameter>result_entry_identifier</parameter> returned from - <function>ldap_first_attribute</function>.</para> - <para> - See also <function>ldap_get_attributes</function></para> - </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> + <methodsynopsis> + <type>string</type><methodname>ldap_next_attribute</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam> + <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 + <function>ldap_next_attribute</function> is made with the + <parameter>result_entry_identifier</parameter> returned from + <function>ldap_first_attribute</function>. + </para> + <para> + See also <function>ldap_get_attributes</function> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-next-entry.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-next-entry.xml diff -u phpdoc/en/reference/ldap/functions/ldap-next-entry.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-next-entry.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-next-entry.xml:1.2 Wed Apr 17 06:39:45 2002 +++ phpdoc/en/reference/ldap/functions/ldap-next-entry.xml Sun Feb 4 22:46:33 2007 @@ -1,37 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-next-entry"> - <refnamediv> - <refname>ldap_next_entry</refname> - <refpurpose>Get next result entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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;.</para> - <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>. - </para> - <para> - See also <function>ldap_get_entries</function></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> + <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;. + </para> + <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>. + </para> + <para> + See also <function>ldap_get_entries</function> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-next-reference.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-next-reference.xml diff -u phpdoc/en/reference/ldap/functions/ldap-next-reference.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-next-reference.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-next-reference.xml:1.2 Wed Apr 17 06:39:45 2002 +++ phpdoc/en/reference/ldap/functions/ldap-next-reference.xml Sun Feb 4 22:46:33 2007 @@ -1,25 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.39 --> - <refentry id='function.ldap-next-reference'> - <refnamediv> - <refname>ldap_next_reference</refname> - <refpurpose> - Get next reference - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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> - </refsect1> - </refentry> +<refentry id='function.ldap-next-reference'> + <refnamediv> + <refname>ldap_next_reference</refname> + <refpurpose>Get next reference</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-parse-reference.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-parse-reference.xml diff -u phpdoc/en/reference/ldap/functions/ldap-parse-reference.xml:1.4 phpdoc/en/reference/ldap/functions/ldap-parse-reference.xml:1.5 --- phpdoc/en/reference/ldap/functions/ldap-parse-reference.xml:1.4 Wed Nov 10 08:30:31 2004 +++ phpdoc/en/reference/ldap/functions/ldap-parse-reference.xml Sun Feb 4 22:46:33 2007 @@ -1,26 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.39 --> - <refentry id='function.ldap-parse-reference'> - <refnamediv> - <refname>ldap_parse_reference</refname> - <refpurpose> - Extract information from reference entry - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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> - </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> + <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> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-parse-result.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-parse-result.xml diff -u phpdoc/en/reference/ldap/functions/ldap-parse-result.xml:1.5 phpdoc/en/reference/ldap/functions/ldap-parse-result.xml:1.6 --- phpdoc/en/reference/ldap/functions/ldap-parse-result.xml:1.5 Wed Nov 10 08:30:32 2004 +++ phpdoc/en/reference/ldap/functions/ldap-parse-result.xml Sun Feb 4 22:46:33 2007 @@ -1,29 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.39 --> - <refentry id='function.ldap-parse-result'> - <refnamediv> - <refname>ldap_parse_result</refname> - <refpurpose> - Extract information from result - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ldap_parse_result</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - <methodparam><type>int</type><parameter role="reference">errcode</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter role="reference">matcheddn</parameter></methodparam> - <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> - </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> + <methodsynopsis> + <type>bool</type><methodname>ldap_parse_result</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter role="reference">errcode</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter role="reference">matcheddn</parameter></methodparam> + <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> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-read.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-read.xml diff -u phpdoc/en/reference/ldap/functions/ldap-read.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-read.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-read.xml:1.2 Wed Apr 17 06:39:45 2002 +++ phpdoc/en/reference/ldap/functions/ldap-read.xml Sun Feb 4 22:46:33 2007 @@ -1,57 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-read"> - <refnamediv> - <refname>ldap_read</refname> - <refpurpose>Read an entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>ldap_read</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>string</type><parameter>base_dn</parameter></methodparam> - <methodparam><type>string</type><parameter>filter</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timelimit</parameter></methodparam> - <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.</para> - <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".</para> - <para> - This call takes 5 optional parameters. See <function>ldap_search</function> - notes. - </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> - From 4.0.5 on it's also possible to do parallel searches. See - <function>ldap_search</function> for details. - </para> - - </refsect1> - </refentry> +<refentry id="function.ldap-read"> + <refnamediv> + <refname>ldap_read</refname> + <refpurpose>Read an entry</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>ldap_read</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>base_dn</parameter></methodparam> + <methodparam><type>string</type><parameter>filter</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timelimit</parameter></methodparam> + <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. + </para> + <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". + </para> + <para> + This call takes 5 optional parameters. See <function>ldap_search</function> + notes. + </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> + From 4.0.5 on it's also possible to do parallel searches. See + <function>ldap_search</function> for details. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-rename.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-rename.xml diff -u phpdoc/en/reference/ldap/functions/ldap-rename.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-rename.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-rename.xml:1.2 Wed Apr 17 06:39:46 2002 +++ phpdoc/en/reference/ldap/functions/ldap-rename.xml Sun Feb 4 22:46:33 2007 @@ -1,39 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.24 --> - <refentry id="function.ldap-rename"> - <refnamediv> - <refname>ldap_rename</refname> - <refpurpose>Modify the name of an entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ldap_rename</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>string</type><parameter>dn</parameter></methodparam> - <methodparam><type>string</type><parameter>newrdn</parameter></methodparam> - <methodparam><type>string</type><parameter>newparent</parameter></methodparam> - <methodparam><type>bool</type><parameter>deleteoldrdn</parameter></methodparam> - </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> - <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> - </note> - </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> + <methodsynopsis> + <type>bool</type><methodname>ldap_rename</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>string</type><parameter>newrdn</parameter></methodparam> + <methodparam><type>string</type><parameter>newparent</parameter></methodparam> + <methodparam><type>bool</type><parameter>deleteoldrdn</parameter></methodparam> + </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> + <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> + </note> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-sasl-bind.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-sasl-bind.xml diff -u phpdoc/en/reference/ldap/functions/ldap-sasl-bind.xml:1.3 phpdoc/en/reference/ldap/functions/ldap-sasl-bind.xml:1.4 --- phpdoc/en/reference/ldap/functions/ldap-sasl-bind.xml:1.3 Wed May 4 09:39:11 2005 +++ phpdoc/en/reference/ldap/functions/ldap-sasl-bind.xml Sun Feb 4 22:46:33 2007 @@ -1,39 +1,37 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> - <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> - <methodsynopsis> - <type>bool</type><methodname>ldap_sasl_bind</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>binddn</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>sasl_mech</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>sasl_realm</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>sasl_authz_id</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>props</parameter></methodparam> - </methodsynopsis> +<!-- $Revision: 1.4 $ --> +<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> + <methodsynopsis> + <type>bool</type><methodname>ldap_sasl_bind</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>binddn</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>sasl_mech</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>sasl_realm</parameter></methodparam> + <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; + &warn.undocumented.func; - <note> - <title>Requirement</title> - <simpara> - <function>ldap_sasl_bind</function> requires <acronym>SASL</acronym> - support (<filename>sasl.h</filename>). Be sure - <literal>--with-ldap-sasl</literal> is used when configuring PHP - otherwise this function will be undefined. - </simpara> - </note> + <note> + <title>Requirement</title> + <simpara> + <function>ldap_sasl_bind</function> requires <acronym>SASL</acronym> + support (<filename>sasl.h</filename>). Be sure + <literal>--with-ldap-sasl</literal> is used when configuring PHP + otherwise this function will be undefined. + </simpara> + </note> - </refsect1> - </refentry> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-search.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-search.xml diff -u phpdoc/en/reference/ldap/functions/ldap-search.xml:1.7 phpdoc/en/reference/ldap/functions/ldap-search.xml:1.8 --- phpdoc/en/reference/ldap/functions/ldap-search.xml:1.7 Wed Dec 17 14:32:39 2003 +++ phpdoc/en/reference/ldap/functions/ldap-search.xml Sun Feb 4 22:46:33 2007 @@ -1,123 +1,128 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.17 --> - <refentry id="function.ldap-search"> - <refnamediv> - <refname>ldap_search</refname> - <refpurpose>Search LDAP tree</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>ldap_search</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>string</type><parameter>base_dn</parameter></methodparam> - <methodparam><type>string</type><parameter>filter</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timelimit</parameter></methodparam> - <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_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).</para> - <para> - The example below retrieves the organizational unit, surname, - given name and email address for all people in "My Company" where - the surname or given name contains the substring $person. This - example uses a boolean filter to tell the server to look for - information in more than one attribute. - <example> - <title>LDAP search</title> - <programlisting role="php"> +<refentry id="function.ldap-search"> + <refnamediv> + <refname>ldap_search</refname> + <refpurpose>Search LDAP tree</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>ldap_search</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>base_dn</parameter></methodparam> + <methodparam><type>string</type><parameter>filter</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timelimit</parameter></methodparam> + <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_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). + </para> + <para> + The example below retrieves the organizational unit, surname, + given name and email address for all people in "My Company" where + the surname or given name contains the substring $person. This + example uses a boolean filter to tell the server to look for + information in more than one attribute. + <example> + <title>LDAP search</title> + <programlisting role="php"> <![CDATA[ <?php // $ds is a valid link identifier for a directory server @@ -135,27 +140,27 @@ echo $info["count"]." entries returned\n"; ?> ]]> - </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> + </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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-set-option.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-set-option.xml diff -u phpdoc/en/reference/ldap/functions/ldap-set-option.xml:1.4 phpdoc/en/reference/ldap/functions/ldap-set-option.xml:1.5 --- phpdoc/en/reference/ldap/functions/ldap-set-option.xml:1.4 Mon Dec 15 16:51:21 2003 +++ phpdoc/en/reference/ldap/functions/ldap-set-option.xml Sun Feb 4 22:46:33 2007 @@ -1,60 +1,63 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>ldap_set_option</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>option</parameter></methodparam> - <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.</para> - <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.</para> - <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. - </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> - <para> - <example> - <title>Set protocol version</title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>bool</type><methodname>ldap_set_option</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>option</parameter></methodparam> + <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. + </para> + <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. + </para> + <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. + </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> + <para> + <example> + <title>Set protocol version</title> + <programlisting role="php"> <![CDATA[ <?php // $ds is a valid link identifier for a directory server @@ -65,11 +68,11 @@ } ?> ]]> - </programlisting> - </example> - <example> - <title>Set server controls</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Set server controls</title> + <programlisting role="php"> <![CDATA[ <?php // $ds is a valid link identifier for a directory server @@ -82,14 +85,14 @@ echo "Failed to set server controls"; ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>ldap_get_option</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>ldap_get_option</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-set-rebind-proc.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-set-rebind-proc.xml diff -u phpdoc/en/reference/ldap/functions/ldap-set-rebind-proc.xml:1.4 phpdoc/en/reference/ldap/functions/ldap-set-rebind-proc.xml:1.5 --- phpdoc/en/reference/ldap/functions/ldap-set-rebind-proc.xml:1.4 Fri Aug 20 09:36:59 2004 +++ phpdoc/en/reference/ldap/functions/ldap-set-rebind-proc.xml Sun Feb 4 22:46:33 2007 @@ -1,25 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.39 --> - <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> - <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> - </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> + <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> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-sort.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-sort.xml diff -u phpdoc/en/reference/ldap/functions/ldap-sort.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-sort.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-sort.xml:1.2 Wed Apr 17 06:39:46 2002 +++ phpdoc/en/reference/ldap/functions/ldap-sort.xml Sun Feb 4 22:46:33 2007 @@ -1,26 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.39 --> - <refentry id='function.ldap-sort'> - <refnamediv> - <refname>ldap_sort</refname> - <refpurpose> - Sort LDAP result entries - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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> - </refsect1> - </refentry> +<refentry id='function.ldap-sort'> + <refnamediv> + <refname>ldap_sort</refname> + <refpurpose>Sort LDAP result entries</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-start-tls.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-start-tls.xml diff -u phpdoc/en/reference/ldap/functions/ldap-start-tls.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-start-tls.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-start-tls.xml:1.2 Wed Apr 17 06:39:46 2002 +++ phpdoc/en/reference/ldap/functions/ldap-start-tls.xml Sun Feb 4 22:46:33 2007 @@ -1,24 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.39 --> - <refentry id='function.ldap-start-tls'> - <refnamediv> - <refname>ldap_start_tls</refname> - <refpurpose> - Start TLS - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ldap_start_tls</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<refentry id='function.ldap-start-tls'> + <refnamediv> + <refname>ldap_start_tls</refname> + <refpurpose>Start TLS</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ldap_start_tls</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-t61-to-8859.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-t61-to-8859.xml diff -u phpdoc/en/reference/ldap/functions/ldap-t61-to-8859.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-t61-to-8859.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-t61-to-8859.xml:1.2 Wed Apr 17 06:39:46 2002 +++ phpdoc/en/reference/ldap/functions/ldap-t61-to-8859.xml Sun Feb 4 22:46:33 2007 @@ -1,24 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.39 --> - <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> - <methodsynopsis> - <type>string</type><methodname>ldap_t61_to_8859</methodname> - <methodparam><type>string</type><parameter>value</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </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> + <methodsynopsis> + <type>string</type><methodname>ldap_t61_to_8859</methodname> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ldap/functions/ldap-unbind.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ldap/functions/ldap-unbind.xml diff -u phpdoc/en/reference/ldap/functions/ldap-unbind.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-unbind.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-unbind.xml:1.2 Wed Apr 17 06:39:46 2002 +++ phpdoc/en/reference/ldap/functions/ldap-unbind.xml Sun Feb 4 22:46:33 2007 @@ -1,24 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 --> - <refentry id="function.ldap-unbind"> - <refnamediv> - <refname>ldap_unbind</refname> - <refpurpose>Unbind from LDAP directory</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ldap_unbind</methodname> - <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - <para> - &return.success;</para> - <para> - <function>ldap_unbind</function> function unbinds from the LDAP - directory.</para> - </refsect1> - </refentry> +<refentry id="function.ldap-unbind"> + <refnamediv> + <refname>ldap_unbind</refname> + <refpurpose>Unbind from LDAP directory</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ldap_unbind</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> + <para> + &return.success; + </para> + <para> + <function>ldap_unbind</function> function unbinds from the LDAP + directory. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: