[DOC-CVS] [doc-en] master: PHP-8.4: LDAP changes (#4066)
[email protected] (Gina Peter Banyard via GitHub) Fri, 22 May 2026 18:20:42 +0000
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias) Committer: GitHub (web-flow) Pusher: jordikroon Date: 2026-05-22T20:20:39+02:00 Commit: https://github.com/php/doc-en/commit/9faf0215daa7a2b5d84525d7d2b3d6b066cc85ec Raw diff: https://github.com/php/doc-en/commit/9faf0215daa7a2b5d84525d7d2b3d6b066cc85ec.diff PHP-8.4: LDAP changes (#4066) * PHP-8.4: LDAP changes --------- Co-authored-by: Jordi Kroon <[email protected]> Co-authored-by: Christoph M. Becker <[email protected]> Co-authored-by: Jordi Kroon <[email protected]> Changed paths: M reference/ldap/functions/ldap-exop-sync.xml M reference/ldap/functions/ldap-exop.xml Diff: diff --git a/reference/ldap/functions/ldap-exop-sync.xml b/reference/ldap/functions/ldap-exop-sync.xml index 9c4bef742dc7..9b3880822707 100644 --- a/reference/ldap/functions/ldap-exop-sync.xml +++ b/reference/ldap/functions/ldap-exop-sync.xml @@ -16,84 +16,96 @@ <methodparam choice="opt"><type>string</type><parameter role="reference">response_data</parameter><initializer>&null;</initializer></methodparam> <methodparam choice="opt"><type>string</type><parameter role="reference">response_oid</parameter><initializer>&null;</initializer></methodparam> </methodsynopsis> - <para> - - </para> - - &warn.undocumented.func; - + <simpara> + Performs an extended operation on the specified <parameter>ldap</parameter> with + <parameter>request_oid</parameter> the <acronym>OID</acronym> of the operation and + <parameter>request_data</parameter> the data. + </simpara> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>ldap</parameter></term> - <listitem> - <para> - &ldap.parameter.ldap; - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>request_oid</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>request_data</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>controls</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>response_data</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>response_oid</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> + <variablelist> + <varlistentry> + <term><parameter>ldap</parameter></term> + <listitem> + <simpara> + &ldap.parameter.ldap; + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>request_oid</parameter></term> + <listitem> + <simpara> + The extended operation request <acronym>OID</acronym>. + Can be one of the + <constant>LDAP_EXOP_<replaceable>*</replaceable></constant> + constants, + or a string with the <acronym>OID</acronym> of the operation. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>request_data</parameter></term> + <listitem> + <simpara> + The extended operation request data. + May be &null; for some operations like <constant>LDAP_EXOP_WHO_AM_I</constant>, + may also need to be <acronym>BER</acronym> encoded. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>controls</parameter></term> + <listitem> + <simpara> + Array of <link linkend="ldap.controls">LDAP Controls</link> to send with the request. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>response_data</parameter></term> + <listitem> + <simpara> + Will be filled with the extended operation response data if provided. + If not provided <function>ldap_parse_exop</function> may be used on the + result object later to get this data. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>response_oid</parameter></term> + <listitem> + <simpara> + Will be filled with the response <acronym>OID</acronym> if provided, + usually equal to the request <acronym>OID</acronym>. + </simpara> + </listitem> + </varlistentry> + </variablelist> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para> - - </para> + <simpara> + When used with <parameter>response_data</parameter>, + returns &true; on success or &false; on error. + When used without <parameter>response_data</parameter>, + returns a result identifier or &false; on error. + </simpara> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; - <para> - <simplelist> - <member><function>ldap_exop</function></member> - </simplelist> - </para> + <simplelist> + <member><function>ldap_exop</function></member> + <member><function>ldap_exop_whoami</function></member> + <member><function>ldap_exop_refresh</function></member> + <member><function>ldap_exop_passwd</function></member> + <member><function>ldap_parse_result</function></member> + <member><function>ldap_parse_exop</function></member> + </simplelist> </refsect1> </refentry> diff --git a/reference/ldap/functions/ldap-exop.xml b/reference/ldap/functions/ldap-exop.xml index 720febcaa0cc..0b76e094b9ac 100644 --- a/reference/ldap/functions/ldap-exop.xml +++ b/reference/ldap/functions/ldap-exop.xml @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> <!-- $Revision$ --> - <refentry xml:id="function.ldap-exop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>ldap_exop</refname> @@ -18,11 +17,17 @@ <methodparam choice="opt"><type>string</type><parameter role="reference">response_data</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter role="reference">response_oid</parameter></methodparam> </methodsynopsis> - <para> + <simpara> Performs an extended operation on the specified <parameter>ldap</parameter> with - <parameter>request_oid</parameter> the OID of the operation and + <parameter>request_oid</parameter> the <acronym>OID</acronym> of the operation and <parameter>request_data</parameter> the data. - </para> + </simpara> + <warning> + <simpara> + Using more than 4 parameters has been deprecated, + use <function>ldap_exop_sync</function> instead. + </simpara> + </warning> </refsect1> <refsect1 role="parameters"> @@ -31,51 +36,57 @@ <varlistentry> <term><parameter>ldap</parameter></term> <listitem> - <para> + <simpara> &ldap.parameter.ldap; - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>request_oid</parameter></term> <listitem> - <para> - The extended operation request OID. You may use one of <constant>LDAP_EXOP_START_TLS</constant>, <constant>LDAP_EXOP_MODIFY_PASSWD</constant>, <constant>LDAP_EXOP_REFRESH</constant>, <constant>LDAP_EXOP_WHO_AM_I</constant>, <constant>LDAP_EXOP_TURN</constant>, or a string with the OID of the operation you want to send. - </para> + <simpara> + The extended operation request <acronym>OID</acronym>. + Can be one of the + <constant>LDAP_EXOP_<replaceable>*</replaceable></constant> + constants, + or a string with the <acronym>OID</acronym> of the operation. + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>request_data</parameter></term> <listitem> - <para> - The extended operation request data. May be NULL for some operations like <constant>LDAP_EXOP_WHO_AM_I</constant>, may also need to be BER encoded. - </para> + <simpara> + The extended operation request data. May be NULL for some operations like + <constant>LDAP_EXOP_WHO_AM_I</constant>, may also need to be <acronym>BER</acronym> encoded. + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>controls</parameter></term> <listitem> - <para> + <simpara> Array of <link linkend="ldap.controls">LDAP Controls</link> to send with the request. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>response_data</parameter></term> <listitem> - <para> - Will be filled with the extended operation response data if provided. - If not provided you may use ldap_parse_exop on the result object - later to get this data. - </para> + <simpara> + Will be filled with the extended operation response data if provided. + If not provided <function>ldap_parse_exop</function> may be used on the + result object later to get this data. + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>response_oid</parameter></term> <listitem> - <para> - Will be filled with the response OID if provided, usually equal to the request OID. - </para> + <simpara> + Will be filled with the response <acronym>OID</acronym> if provided, + usually equal to the request <acronym>OID</acronym>. + </simpara> </listitem> </varlistentry> </variablelist> @@ -83,41 +94,45 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para> + <simpara> When used with <parameter>response_data</parameter>, returns &true; on success or &false; on error. When used without <parameter>response_data</parameter>, returns a result identifier or &false; on error. - </para> + </simpara> </refsect1> <refsect1 role="changelog"> &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - &ldap.changelog.ldap-object; - <row> - <entry>7.3.0</entry> - <entry> - Support for <parameter>controls</parameter> added - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>8.4.0</entry> + <entry> + Using more than 4 parameters has been deprecated, + use <function>ldap_exop_sync</function> instead. + </entry> + </row> + &ldap.changelog.ldap-object; + <row> + <entry>7.3.0</entry> + <entry> + Support for <parameter>controls</parameter> added + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </refsect1> <refsect1 role="examples"> &reftitle.examples; - <para> - <example> + <example> <title>Whoami extended operation</title> <programlisting role="php"> <![CDATA[ @@ -153,26 +168,22 @@ if ($ds) { ?> ]]> </programlisting> - </example> - </para> + </example> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; - <para> - <simplelist> - <member><function>ldap_parse_result</function></member> - <member><function>ldap_parse_exop</function></member> - <member><function>ldap_exop_whoami</function></member> - <member><function>ldap_exop_refresh</function></member> - <member><function>ldap_exop_passwd</function></member> - </simplelist> - </para> + <simplelist> + <member><function>ldap_exop_sync</function></member> + <member><function>ldap_exop_whoami</function></member> + <member><function>ldap_exop_refresh</function></member> + <member><function>ldap_exop_passwd</function></member> + <member><function>ldap_parse_result</function></member> + <member><function>ldap_parse_exop</function></member> + </simplelist> </refsect1> - </refentry> - <!-- Keep this comment at the end of the file Local variables: mode: sgml