cvs: phpdoc /en/reference/ldap/functions ldap-get-attributes.xml ldap-get-option.xml ldap-get-values.xml ldap-search.xml ldap-set-option.xml
| From: | Mehdi Achour | Date: | Wed, 16 Jul 2003 17:15:44 +0000 |
| Subject: | cvs: phpdoc /en/reference/ldap/functions ldap-get-attributes.xml ldap-get-option.xml ldap-get-values.xml ldap-search.xml ldap-set-option.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969355295@lists.php.net to get a copy of this message | ||
didou Wed Jul 16 13:15:44 2003 EDT
Modified files:
/phpdoc/en/reference/ldap/functions ldap-get-attributes.xml
ldap-get-option.xml
ldap-get-values.xml
ldap-search.xml
ldap-set-option.xml
Log:
adding PHP tags in the examples
Index: phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml diff -u phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml:1.2 Wed Apr 17 02:39:44 2002 +++ phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml Wed Jul 16 13:15:44 2003 @@ -1,5 +1,5 @@ <?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-attributes"> <refnamediv> @@ -40,11 +40,13 @@ return_value["attribute"][i] = (i+1)th value of the attribute </literallayout></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 // $sr is a valid search result from a prior call to @@ -58,14 +60,15 @@ for ($i=0; $i<$attrs["count"]; $i++) echo $attrs[$i]."<br>"; +?> ]]> -</programlisting> -</example></para> - - <para> - See also <function>ldap_first_attribute</function> and - <function>ldap_next_attribute</function></para> - + </programlisting> + </example> + </para> + <para> + See also <function>ldap_first_attribute</function> and + <function>ldap_next_attribute</function>. + </para> </refsect1> </refentry> Index: phpdoc/en/reference/ldap/functions/ldap-get-option.xml diff -u phpdoc/en/reference/ldap/functions/ldap-get-option.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-get-option.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-get-option.xml:1.2 Wed Apr 17 02:39:44 2002 +++ phpdoc/en/reference/ldap/functions/ldap-get-option.xml Wed Jul 16 13:15:44 2003 @@ -1,5 +1,5 @@ <?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.17 --> <refentry id="function.ldap-get-option"> <refnamediv> @@ -16,7 +16,8 @@ </methodsynopsis> <para> Sets <parameter>retval</parameter> to the value of the specified option. - &return.success;</para> + &return.success; + </para> <para> The parameter <parameter>option</parameter> can be one of: LDAP_OPT_DEREF, LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT, @@ -24,29 +25,31 @@ 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>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> + </note> + <para> <example> <title>Check protocol version</title> -<programlisting role="php"> + <programlisting role="php"> <![CDATA[ +<?php // $ds is a valid link identifier for a directory server if (ldap_get_option($ds, LDAP_OPT_PROTOCOL_VERSION, $version)) - echo "Using protocol version $version"; + echo "Using protocol version $version\n"; else - echo "Unable to determine protocol version"; + echo "Unable to determine protocol version\n"; +?> ]]> -</programlisting> + </programlisting> </example> - </para> - - <para> - See also <function>ldap_set_option</function>.</para> + </para> + <para> + See also <function>ldap_set_option</function>. + </para> </refsect1> </refentry> Index: phpdoc/en/reference/ldap/functions/ldap-get-values.xml diff -u phpdoc/en/reference/ldap/functions/ldap-get-values.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-get-values.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-get-values.xml:1.2 Wed Apr 17 02:39:44 2002 +++ phpdoc/en/reference/ldap/functions/ldap-get-values.xml Wed Jul 16 13:15:44 2003 @@ -1,5 +1,5 @@ <?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"> <refnamediv> @@ -50,8 +50,9 @@ <example> <title>List all values of the "mail" attribute for a directory entry </title> -<programlisting role="php"> + <programlisting role="php"> <![CDATA[ +<?php // $ds is a valid link identifier for a directory server // $sr is a valid search result from a prior call to @@ -66,10 +67,11 @@ for ($i=0; $i < $values["count"]; $i++) echo $values[$i]."<br>"; +?> ]]> -</programlisting> - </example></para> - + </programlisting> + </example> + </para> </refsect1> </refentry> Index: phpdoc/en/reference/ldap/functions/ldap-search.xml diff -u phpdoc/en/reference/ldap/functions/ldap-search.xml:1.3 phpdoc/en/reference/ldap/functions/ldap-search.xml:1.4 --- phpdoc/en/reference/ldap/functions/ldap-search.xml:1.3 Sun Jun 15 06:17:14 2003 +++ phpdoc/en/reference/ldap/functions/ldap-search.xml Wed Jul 16 13:15:44 2003 @@ -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.17 --> <refentry id="function.ldap-search"> <refnamediv> @@ -115,11 +115,11 @@ 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"> + <programlisting role="php"> <![CDATA[ +<?php // $ds is a valid link identifier for a directory server // $person is all or part of a person's name, eg "Jo" @@ -132,10 +132,12 @@ $info = ldap_get_entries($ds, $sr); -print $info["count"]." entries returned<p>"; +print $info["count"]." entries returned\n"; +?> ]]> -</programlisting> - </example></para> + </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, Index: phpdoc/en/reference/ldap/functions/ldap-set-option.xml diff -u phpdoc/en/reference/ldap/functions/ldap-set-option.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-set-option.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-set-option.xml:1.2 Wed Apr 17 02:39:46 2002 +++ phpdoc/en/reference/ldap/functions/ldap-set-option.xml Wed Jul 16 13:15:44 2003 @@ -1,5 +1,5 @@ <?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-set-option"> <refnamediv> @@ -54,20 +54,23 @@ <para> <example> <title>Set protocol version</title> -<programlisting role="php"> + <programlisting role="php"> <![CDATA[ +<?php // $ds is a valid link identifier for a directory server if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) echo "Using LDAPv3"; else echo "Failed to set protocol version to 3"; +?> ]]> -</programlisting> + </programlisting> </example> <example> <title>Set server controls</title> -<programlisting role="php"> + <programlisting role="php"> <![CDATA[ +<?php // $ds is a valid link identifier for a directory server // control with no value $ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => TRUE); @@ -76,12 +79,14 @@ // try to set both controls if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) echo "Failed to set server controls"; +?> ]]> -</programlisting> + </programlisting> </example> - </para> - <para> - See also <function>ldap_get_option</function>.</para> + </para> + <para> + See also <function>ldap_get_option</function>. + </para> </refsect1> </refentry>
Index: phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml diff -u phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml:1.2 Wed Apr 17 02:39:44 2002 +++ phpdoc/en/reference/ldap/functions/ldap-get-attributes.xml Wed Jul 16 13:15:44 2003 @@ -1,5 +1,5 @@ <?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-attributes"> <refnamediv> @@ -40,11 +40,13 @@ return_value["attribute"][i] = (i+1)th value of the attribute </literallayout></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 // $sr is a valid search result from a prior call to @@ -58,14 +60,15 @@ for ($i=0; $i<$attrs["count"]; $i++) echo $attrs[$i]."<br>"; +?> ]]> -</programlisting> -</example></para> - - <para> - See also <function>ldap_first_attribute</function> and - <function>ldap_next_attribute</function></para> - + </programlisting> + </example> + </para> + <para> + See also <function>ldap_first_attribute</function> and + <function>ldap_next_attribute</function>. + </para> </refsect1> </refentry> Index: phpdoc/en/reference/ldap/functions/ldap-get-option.xml diff -u phpdoc/en/reference/ldap/functions/ldap-get-option.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-get-option.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-get-option.xml:1.2 Wed Apr 17 02:39:44 2002 +++ phpdoc/en/reference/ldap/functions/ldap-get-option.xml Wed Jul 16 13:15:44 2003 @@ -1,5 +1,5 @@ <?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.17 --> <refentry id="function.ldap-get-option"> <refnamediv> @@ -16,7 +16,8 @@ </methodsynopsis> <para> Sets <parameter>retval</parameter> to the value of the specified option. - &return.success;</para> + &return.success; + </para> <para> The parameter <parameter>option</parameter> can be one of: LDAP_OPT_DEREF, LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT, @@ -24,29 +25,31 @@ 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>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> + </note> + <para> <example> <title>Check protocol version</title> -<programlisting role="php"> + <programlisting role="php"> <![CDATA[ +<?php // $ds is a valid link identifier for a directory server if (ldap_get_option($ds, LDAP_OPT_PROTOCOL_VERSION, $version)) - echo "Using protocol version $version"; + echo "Using protocol version $version\n"; else - echo "Unable to determine protocol version"; + echo "Unable to determine protocol version\n"; +?> ]]> -</programlisting> + </programlisting> </example> - </para> - - <para> - See also <function>ldap_set_option</function>.</para> + </para> + <para> + See also <function>ldap_set_option</function>. + </para> </refsect1> </refentry> Index: phpdoc/en/reference/ldap/functions/ldap-get-values.xml diff -u phpdoc/en/reference/ldap/functions/ldap-get-values.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-get-values.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-get-values.xml:1.2 Wed Apr 17 02:39:44 2002 +++ phpdoc/en/reference/ldap/functions/ldap-get-values.xml Wed Jul 16 13:15:44 2003 @@ -1,5 +1,5 @@ <?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"> <refnamediv> @@ -50,8 +50,9 @@ <example> <title>List all values of the "mail" attribute for a directory entry </title> -<programlisting role="php"> + <programlisting role="php"> <![CDATA[ +<?php // $ds is a valid link identifier for a directory server // $sr is a valid search result from a prior call to @@ -66,10 +67,11 @@ for ($i=0; $i < $values["count"]; $i++) echo $values[$i]."<br>"; +?> ]]> -</programlisting> - </example></para> - + </programlisting> + </example> + </para> </refsect1> </refentry> Index: phpdoc/en/reference/ldap/functions/ldap-search.xml diff -u phpdoc/en/reference/ldap/functions/ldap-search.xml:1.3 phpdoc/en/reference/ldap/functions/ldap-search.xml:1.4 --- phpdoc/en/reference/ldap/functions/ldap-search.xml:1.3 Sun Jun 15 06:17:14 2003 +++ phpdoc/en/reference/ldap/functions/ldap-search.xml Wed Jul 16 13:15:44 2003 @@ -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.17 --> <refentry id="function.ldap-search"> <refnamediv> @@ -115,11 +115,11 @@ 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"> + <programlisting role="php"> <![CDATA[ +<?php // $ds is a valid link identifier for a directory server // $person is all or part of a person's name, eg "Jo" @@ -132,10 +132,12 @@ $info = ldap_get_entries($ds, $sr); -print $info["count"]." entries returned<p>"; +print $info["count"]." entries returned\n"; +?> ]]> -</programlisting> - </example></para> + </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, Index: phpdoc/en/reference/ldap/functions/ldap-set-option.xml diff -u phpdoc/en/reference/ldap/functions/ldap-set-option.xml:1.2 phpdoc/en/reference/ldap/functions/ldap-set-option.xml:1.3 --- phpdoc/en/reference/ldap/functions/ldap-set-option.xml:1.2 Wed Apr 17 02:39:46 2002 +++ phpdoc/en/reference/ldap/functions/ldap-set-option.xml Wed Jul 16 13:15:44 2003 @@ -1,5 +1,5 @@ <?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-set-option"> <refnamediv> @@ -54,20 +54,23 @@ <para> <example> <title>Set protocol version</title> -<programlisting role="php"> + <programlisting role="php"> <![CDATA[ +<?php // $ds is a valid link identifier for a directory server if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) echo "Using LDAPv3"; else echo "Failed to set protocol version to 3"; +?> ]]> -</programlisting> + </programlisting> </example> <example> <title>Set server controls</title> -<programlisting role="php"> + <programlisting role="php"> <![CDATA[ +<?php // $ds is a valid link identifier for a directory server // control with no value $ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => TRUE); @@ -76,12 +79,14 @@ // try to set both controls if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) echo "Failed to set server controls"; +?> ]]> -</programlisting> + </programlisting> </example> - </para> - <para> - See also <function>ldap_get_option</function>.</para> + </para> + <para> + See also <function>ldap_get_option</function>. + </para> </refsect1> </refentry>