(PHP 4, PHP 5, PHP 7, PHP 8)
ldap_read — Read an entry
$ldap
,$base
,$filter
,$attributes
= [],$attributes_only
= 0,$sizelimit
= -1,$timelimit
= -1,$deref
= LDAP_DEREF_NEVER
,$controls
= null
Performs the search for a specified filter
on the
directory with the scope LDAP_SCOPE_BASE
. So it is
equivalent to reading an entry from the directory.
ldap
通过 ldap_connect() 返回的 LDAP\Connection 实例。
base
The base DN for the directory.
filter
An empty filter is not allowed. If you want to retrieve absolutely all
information for this entry, use a filter of
objectClass=*
. If you know which entry types are
used on the directory server, you might use an appropriate filter such
as objectClass=inetOrgPerson
.
attributes
An array of the required attributes, e.g. array("mail", "sn", "cn"). Note that the "dn" is always returned irrespective of which attributes types are requested.
Using this parameter is much more efficient than the default action (which is to return all attributes and their associated values). The use of this parameter should therefore be considered good practice.
attributes_only
Should be set to 1 if only attribute types are wanted. If set to 0 both attributes types and attribute values are fetched which is the default behaviour.
sizelimit
Enables you to limit the count of entries fetched. Setting this to 0 means no limit.
注意:
This parameter can NOT override server-side preset sizelimit. You can set it lower though.
Some directory server hosts will be configured to return no more than a preset number of entries. If this occurs, the server will indicate that it has only returned a partial results set. This also occurs if you use this parameter to limit the count of fetched entries.
timelimit
Sets the number of seconds how long is spend on the search. Setting this to 0 means no limit.
注意:
This parameter can NOT override server-side preset timelimit. You can set it lower though.
deref
Specifies how aliases should be handled during the search. It can be one of the following:
LDAP_DEREF_NEVER
- (default) aliases are never
dereferenced.
LDAP_DEREF_SEARCHING
- aliases should be
dereferenced during the search but not when locating the base object
of the search.
LDAP_DEREF_FINDING
- aliases should be
dereferenced when locating the base object but not during the search.
LDAP_DEREF_ALWAYS
- aliases should be dereferenced
always.
controls
Array of LDAP Controls to send with the request.
Returns an LDAP\Result instance, 或者在失败时返回 false
.
版本 | 说明 |
---|---|
8.1.0 |
现在 ldap 参数接受 LDAP\Connection
实例,之前接受 资源(resource)。
|
8.1.0 | Returns an LDAP\Result instance now; previously, a 资源(resource) was returned. |
8.0.0 |
controls is nullable now; previously, it defaulted to [] .
|
4.0.5 | Parallel searches support was added. See ldap_search() for details. |
7.3 |
Support for controls added
|