diff --git a/language-snippets.ent b/language-snippets.ent index 6f20a51ad3..32525b7ac5 100644 --- a/language-snippets.ent +++ b/language-snippets.ent @@ -1180,6 +1180,14 @@ Passing untrusted data to this parameter is insecure, unles '> LDAP\Result instance,&return.falseforfailure;.'> +LDAP\Result instance, an array of LDAP\Result instances,&return.falseforfailure;.'> + +It is also possible to perform parallel searches. In this case, the first argument should be an array of +LDAP\Connection instances, rather than a single one. +If the searches should not all use the same base DN and filter, an array of base DNs and/or an array of filters can be passed as arguments instead. +These arrays must be of the same size as the LDAP\Connection instances 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 LDAP\Result instances is returned, except in case of error, when the return value will be &false;.'> diff --git a/reference/ldap/functions/ldap-list.xml b/reference/ldap/functions/ldap-list.xml index f9bbe92abf..5dff72294c 100644 --- a/reference/ldap/functions/ldap-list.xml +++ b/reference/ldap/functions/ldap-list.xml @@ -31,6 +31,7 @@ (Equivalent to typing "ls" and getting a list of files and folders in the current working directory.) + &ldap.return-result-array-info; @@ -173,7 +174,7 @@ &reftitle.returnvalues; - &ldap.return-result; + &ldap.return-result-array; diff --git a/reference/ldap/functions/ldap-read.xml b/reference/ldap/functions/ldap-read.xml index d6b683028a..c4af90a9a4 100644 --- a/reference/ldap/functions/ldap-read.xml +++ b/reference/ldap/functions/ldap-read.xml @@ -25,6 +25,7 @@ directory with the scope LDAP_SCOPE_BASE. So it is equivalent to reading an entry from the directory. + &ldap.return-result-array-info; @@ -172,7 +173,7 @@ &reftitle.returnvalues; - &ldap.return-result; + &ldap.return-result-array; diff --git a/reference/ldap/functions/ldap-search.xml b/reference/ldap/functions/ldap-search.xml index 871063d685..2acbf2bcc4 100644 --- a/reference/ldap/functions/ldap-search.xml +++ b/reference/ldap/functions/ldap-search.xml @@ -25,22 +25,7 @@ of LDAP_SCOPE_SUBTREE. This is equivalent to searching the entire directory. - - 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. - + &ldap.return-result-array-info; @@ -187,7 +172,7 @@ &reftitle.returnvalues; - &ldap.return-result; + &ldap.return-result-array;