<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Read an entry</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ldap-parse-result.html">ldap_parse_result</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-rename.html">ldap_rename</a></div>
<div class="up"><a href="ref.ldap.html">LDAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ldap-read" class="refentry">
<div class="refnamediv">
<h1 class="refname">ldap_read</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ldap_read</span> — <span class="dc-title">Read an entry</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ldap-read-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>ldap_read</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$link_identifier</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$base_dn</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$filter</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$attributes</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$attrsonly</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$sizelimit</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timelimit</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$deref</code></span>
]]]]] )</div>
<p class="para rdfs-comment">
Performs the search for a specified <em><code class="parameter">filter</code></em> on the
directory with the scope <strong><code>LDAP_SCOPE_BASE</code></strong>. So it is
equivalent to reading an entry from the directory.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ldap-read-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">link_identifier</code></em></span>
<dd>
<p class="para">
An LDAP link identifier, returned by <span class="function"><a href="function.ldap-connect.html" class="function">ldap_connect()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">base_dn</code></em></span>
<dd>
<p class="para">
The base DN for the directory.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">filter</code></em></span>
<dd>
<p class="para">
An empty filter is not allowed. If you want to retrieve absolutely all
information for this entry, use a filter of
<em>objectClass=*</em>. If you know which entry types are
used on the directory server, you might use an appropriate filter such
as <em>objectClass=inetOrgPerson</em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">attributes</code></em></span>
<dd>
<p class="para">
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.
</p>
<p class="para">
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.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">attrsonly</code></em></span>
<dd>
<p class="para">
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.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">sizelimit</code></em></span>
<dd>
<p class="para">
Enables you to limit the count of entries fetched. Setting this to 0
means no limit.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This parameter can NOT override server-side preset sizelimit. You can
set it lower though.
</p>
<p class="para">
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.
</p>
</p></blockquote>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">timelimit</code></em></span>
<dd>
<p class="para">
Sets the number of seconds how long is spend on the search. Setting
this to 0 means no limit.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This parameter can NOT override server-side preset timelimit. You can
set it lower though.
</p>
</p></blockquote>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">deref</code></em></span>
<dd>
<p class="para">
Specifies how aliases should be handled during the search. It can be
one of the following:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<strong><code>LDAP_DEREF_NEVER</code></strong> - (default) aliases are never
dereferenced.
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>LDAP_DEREF_SEARCHING</code></strong> - aliases should be
dereferenced during the search but not when locating the base object
of the search.
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>LDAP_DEREF_FINDING</code></strong> - aliases should be
dereferenced when locating the base object but not during the search.
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>LDAP_DEREF_ALWAYS</code></strong> - aliases should be dereferenced
always.
</span>
</li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ldap-read-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a search result identifier or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.ldap-read-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>4.0.5</td>
<td>
Parallel searches support was added.
See <span class="function"><a href="function.ldap-search.html" class="function">ldap_search()</a></span> for details.
</td>
</tr>
<tr>
<td>4.0.2</td>
<td>
The <em><code class="parameter">attrsonly</code></em>, <em><code class="parameter">sizelimit</code></em>,
<em><code class="parameter">timelimit</code></em> and <em><code class="parameter">deref</code></em> were
added.
</td>
</tr>
</tbody>
</table>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ldap-parse-result.html">ldap_parse_result</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-rename.html">ldap_rename</a></div>
<div class="up"><a href="ref.ldap.html">LDAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
