diff --git a/reference/ldap/functions/ldap-exop-sync.xml b/reference/ldap/functions/ldap-exop-sync.xml index 9c4bef742dc7..c626706471d6 100644 --- a/reference/ldap/functions/ldap-exop-sync.xml +++ b/reference/ldap/functions/ldap-exop-sync.xml @@ -16,84 +16,96 @@ stringresponse_data&null; stringresponse_oid&null; - - - - - &warn.undocumented.func; - + + Performs an extended operation on the specified ldap with + request_oid the OID of the operation and + request_data the data. + &reftitle.parameters; - - - - ldap - - - &ldap.parameter.ldap; - - - - - request_oid - - - - - - - - request_data - - - - - - - - controls - - - - - - - - response_data - - - - - - - - response_oid - - - - - - - - + + + ldap + + + &ldap.parameter.ldap; + + + + + request_oid + + + The extended operation request OID. + Can be one of the + LDAP_EXOP_* + constants, + or a string with the OID of the operation. + + + + + request_data + + + The extended operation request data. + May be NULL for some operations like LDAP_EXOP_WHO_AM_I, + may also need to be BER encoded. + + + + + controls + + + Array of LDAP Controls to send with the request. + + + + + response_data + + + Will be filled with the extended operation response data if provided. + If not provided ldap_parse_exop may be used on the + result object later to get this data. + + + + + response_oid + + + Will be filled with the response OID if provided, + usually equal to the request OID. + + + + &reftitle.returnvalues; - - - + + When used with response_data, + returns &true; on success or &false; on error. + When used without response_data, + returns a result identifier or &false; on error. + &reftitle.seealso; - - - ldap_exop - - + + ldap_exop + ldap_exop_whoami + ldap_exop_refresh + ldap_exop_passwd + ldap_parse_result + ldap_parse_exop + diff --git a/reference/ldap/functions/ldap-exop.xml b/reference/ldap/functions/ldap-exop.xml index 720febcaa0cc..3d73f69005c9 100644 --- a/reference/ldap/functions/ldap-exop.xml +++ b/reference/ldap/functions/ldap-exop.xml @@ -1,6 +1,5 @@ - ldap_exop @@ -23,6 +22,12 @@ request_oid the OID of the operation and request_data the data. + + + Using more than 4 parameters has been deprecated, + use ldap_exop_sync instead. + + @@ -40,7 +45,11 @@ request_oid - The extended operation request OID. You may use one of LDAP_EXOP_START_TLS, LDAP_EXOP_MODIFY_PASSWD, LDAP_EXOP_REFRESH, LDAP_EXOP_WHO_AM_I, LDAP_EXOP_TURN, or a string with the OID of the operation you want to send. + The extended operation request OID. + Can be one of the + LDAP_EXOP_* + constants, + or a string with the OID of the operation. @@ -64,9 +73,9 @@ response_data - 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. + Will be filled with the extended operation response data if provided. + If not provided ldap_parse_exop may be used on the + result object later to get this data. @@ -91,27 +100,32 @@ &reftitle.changelog; - - - - - - &Version; - &Description; - - - - &ldap.changelog.ldap-object; - - 7.3.0 - - Support for controls added - - - - - - + + + + + &Version; + &Description; + + + + + 8.4.0 + + Using more than 4 parameters has been deprecated, + use ldap_exop_sync instead. + + + &ldap.changelog.ldap-object; + + 7.3.0 + + Support for controls added + + + + + @@ -159,20 +173,17 @@ if ($ds) { &reftitle.seealso; - - - ldap_parse_result - ldap_parse_exop - ldap_exop_whoami - ldap_exop_refresh - ldap_exop_passwd - - + + ldap_exop_sync + ldap_exop_whoami + ldap_exop_refresh + ldap_exop_passwd + ldap_parse_result + ldap_parse_exop + - -