ldap_read(3) [php man page]

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)

Check Out this Related Man Page

LDAP_GET_ATTRIBUTES(3)							 1						    LDAP_GET_ATTRIBUTES(3)

ldap_get_attributes - Get attributes from a search result entry

SYNOPSIS

       array ldap_get_attributes (resource  $link_identifier, resource	$result_entry_identifier)

DESCRIPTION

	Reads attributes and values from an entry in the search result.

	Having	located  a specific entry in the directory, you can find out what information is held for that entry by using this call. You would
       use this call for an application which "browses" directory entries and/or where you do not know the structure of the directory entries.	In
       many  applications  you will be searching for a specific attribute such as an email address or a surname, and won't care what other data is
       held.

       return_value["count"] = number of attributes in the entry
       return_value[0] = first attribute
       return_value[n] = nth attribute

       return_value["attribute"]["count"] = number of values for attribute
       return_value["attribute"][0] = first value of the attribute
       return_value["attribute"][i] = (i+1)th value of the attribute

PARAMETERS

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

	      o $result_entry_identifier
		-

RETURN VALUES

	Returns a complete entry information in a multi-dimensional array on success and FALSE on error.

EXAMPLES

       Example #1

	       Show the list of attributes held for a particular directory entry

	      <?php
	      // $ds is the link identifier for the directory

	      // $sr is a valid search result from a prior call to
	      // one of the ldap directory search calls

	      $entry = ldap_first_entry($ds, $sr);

	      $attrs = ldap_get_attributes($ds, $entry);

	      echo $attrs["count"] . " attributes held for this entry:<p>";

	      for ($i=0; $i < $attrs["count"]; $i++) {
		  echo $attrs[$i] . "<br />";
	      }
	      ?>

SEE ALSO

       ldap_first_attribute(3), ldap_next_attribute(3).

PHP Documentation Group 												    LDAP_GET_ATTRIBUTES(3)

Linux and UNIX Man Pages

ldap_read(3) [php man page]

Check Out this Related Man Page