[doc-en] master: ldap: fix parameter and return value descriptions (#5913)

Author: Louis-Arnaud (lacatoire) Committer: GitHub (web-flow) Pusher: lacatoire Date: 2026-10-13T10:20:31+02:00 Commit: https://github.com/php/doc-en/commit/7ed0fb685924d5064f325a565e97872f9fc3ad50 Raw diff: https://github.com/php/doc-en/commit/7ed0fb685924d5064f325a565e97872f9fc3ad50.diff ldap: fix parameter and return value descriptions (#5913) * ldap: fix parameter and return value descriptions Describe the entry and attribute parameters, correct the matched_dn default and the ldap_exop_sync return value, fix the ldap_next_entry changelog entity and add see also links. * ldap: drop the para wrapper around the see also lists Changed paths: M reference/ldap/functions/ldap-exop-sync.xml M reference/ldap/functions/ldap-get-values.xml M reference/ldap/functions/ldap-mod-del.xml M reference/ldap/functions/ldap-next-entry.xml M reference/ldap/functions/ldap-parse-result.xml Diff: diff --git a/reference/ldap/functions/ldap-exop-sync.xml b/reference/ldap/functions/ldap-exop-sync.xml index 9b3880822707..64fa5a3c713f 100644 --- a/reference/ldap/functions/ldap-exop-sync.xml +++ b/reference/ldap/functions/ldap-exop-sync.xml @@ -89,10 +89,9 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <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. + Returns &true; on success or &false; on error. + The operation is always performed synchronously, + so no result object is returned. </simpara> </refsect1> diff --git a/reference/ldap/functions/ldap-get-values.xml b/reference/ldap/functions/ldap-get-values.xml index d7c0d4dd57fa..74ad97951ce1 100644 --- a/reference/ldap/functions/ldap-get-values.xml +++ b/reference/ldap/functions/ldap-get-values.xml @@ -53,8 +53,9 @@ <varlistentry> <term><parameter>attribute</parameter></term> <listitem> - <para> - </para> + <simpara> + The attribute name, for example <literal>"cn"</literal>. + </simpara> </listitem> </varlistentry> </variablelist> @@ -133,11 +134,11 @@ for ($i=0; $i < $values["count"]; $i++) { <refsect1 role="seealso"> &reftitle.seealso; - <para> - <simplelist> - <member><function>ldap_get_values_len</function></member> - </simplelist> - </para> + <simplelist> + <member><function>ldap_get_values_len</function></member> + <member><function>ldap_get_attributes</function></member> + <member><function>ldap_first_attribute</function></member> + </simplelist> </refsect1> </refentry> diff --git a/reference/ldap/functions/ldap-mod-del.xml b/reference/ldap/functions/ldap-mod-del.xml index 5888e2496426..dbbcb0b9aa56 100644 --- a/reference/ldap/functions/ldap-mod-del.xml +++ b/reference/ldap/functions/ldap-mod-del.xml @@ -45,8 +45,13 @@ <varlistentry> <term><parameter>entry</parameter></term> <listitem> - <para> - </para> + <simpara> + An associative array listing the attributes to modify, where each key is an attribute name + and each value is a single value or an array of values to remove from that attribute. + Sending an empty array as value will remove the whole attribute. + Removing a value or an attribute that the entry does not hold fails. + The array must not be empty, otherwise a <exceptionname>ValueError</exceptionname> is thrown. + </simpara> </listitem> </varlistentry> <varlistentry> diff --git a/reference/ldap/functions/ldap-next-entry.xml b/reference/ldap/functions/ldap-next-entry.xml index 67dde6fe5b12..08edaa3e60d9 100644 --- a/reference/ldap/functions/ldap-next-entry.xml +++ b/reference/ldap/functions/ldap-next-entry.xml @@ -69,7 +69,7 @@ <tbody> &ldap.changelog.ldap-object; &ldap.changelog.entry-object; - &ldap.changelog.return-result-object; + &ldap.changelog.return-result-entry-object; </tbody> </tgroup> </informaltable> diff --git a/reference/ldap/functions/ldap-parse-result.xml b/reference/ldap/functions/ldap-parse-result.xml index bed24f71e202..9f78eeb0fbd7 100644 --- a/reference/ldap/functions/ldap-parse-result.xml +++ b/reference/ldap/functions/ldap-parse-result.xml @@ -55,10 +55,10 @@ <varlistentry> <term><parameter>matched_dn</parameter></term> <listitem> - <para> + <simpara> A reference to a variable that will be set to a matched DN if one was - recognised within the request, otherwise it will be set to &null;. - </para> + recognised within the request, otherwise it will be set to an empty string. + </simpara> </listitem> </varlistentry> <varlistentry> @@ -145,6 +145,15 @@ if (ldap_parse_result($ldap, $result, $errcode, $dn, $errmsg, $refs)) { </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <simplelist> + <member><function>ldap_err2str</function></member> + <member><function>ldap_error</function></member> + <member><function>ldap_parse_exop</function></member> + </simplelist> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file Local variables: