php man page for ldap_read

LDAP_READ(3)								 1							      LDAP_READ(3)

ldap_read - Read an entry

SYNOPSIS
       resource  ldap_read  (resource	$link_identifier, string  $base_dn, string  $filter, [array  $attributes], [int  $attrsonly], [int  $size-
       limit], [int  $timelimit], [int	$deref])

DESCRIPTION
	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.

PARAMETERS
	      o $link_identifier
		- An LDAP link identifier, returned by ldap_connect(3).

	      o $base_dn
		- The base DN for the directory.

	      o $filter
		-  An  empty  filter  is  not  allowed. If you want to retrieve absolutely all information for this entry, use a filter of object-
		Class=*. If you know which entry types are used on the directory server, you might use	an  appropriate  filter  such  as  object-
		Class=inetOrgPerson.

	      o $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.

	      o $attrsonly
		-  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.

	      o $sizelimit
		- Enables you to limit the count of entries fetched. Setting this to 0 means no limit.

	      Note

		      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.

	      o $timelimit
		- Sets the number of seconds how long is spend on the search. Setting this to 0 means no limit.

	      Note

		      This parameter can NOT override server-side preset timelimit. You can set it lower though.

	      o $deref
		- Specifies how aliases should be handled during the search. It can be one of the following:

		     o LDAP_DEREF_NEVER - (default) aliases are never dereferenced.

		     o LDAP_DEREF_SEARCHING - aliases should be dereferenced during the search but not	when  locating	the  base  object  of  the
		       search.

		     o LDAP_DEREF_FINDING - aliases should be dereferenced when locating the base object but not during the search.

		     o LDAP_DEREF_ALWAYS - aliases should be dereferenced always.

RETURN VALUES
	Returns a search result identifier or FALSE on error.

CHANGELOG
       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 4.0.5	|						    |
       |	|						    |
       |	|  Parallel   searches	 support   was	added.	See |
       |	| ldap_search(3) for details.			    |
       |	|						    |
       +--------+---------------------------------------------------+
PHP Documentation Group 													      LDAP_READ(3)