<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>ldap_read</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="PHP 手册"
HREF="index.html"><LINK
REL="UP"
TITLE="LDAP Functions"
HREF="ref.ldap.html"><LINK
REL="PREVIOUS"
TITLE="ldap_parse_result"
HREF="function.ldap-parse-result.html"><LINK
REL="NEXT"
TITLE="ldap_rename"
HREF="function.ldap-rename.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=UTF-8"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP 手册</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.ldap-parse-result.html"
ACCESSKEY="P"
>上一页</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.ldap-rename.html"
ACCESSKEY="N"
>下一页</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.ldap-read"
></A
>ldap_read</H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN105584"
></A
><P
> (PHP 3, PHP 4, PHP 5)</P
>ldap_read -- Read an entry</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN105587"
></A
><H2
>说明</H2
>resource <B
CLASS="methodname"
>ldap_read</B
> ( resource link_identifier, string base_dn, string filter [, array attributes [, int attrsonly [, int sizelimit [, int timelimit [, int deref]]]]] )<BR
></BR
><P
> Performs the search for a specified <CODE
CLASS="parameter"
>filter</CODE
> on the
directory with the scope <TT
CLASS="constant"
><B
>LDAP_SCOPE_BASE</B
></TT
>. So it is
equivalent to reading an entry from the directory.
</P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN105619"
></A
><H2
>参数</H2
><P
> <P
></P
><DIV
CLASS="variablelist"
><DL
><DT
><CODE
CLASS="parameter"
>link_identifier</CODE
></DT
><DD
><P
> An LDAP link identifier, returned by <A
HREF="function.ldap-connect.html"
><B
CLASS="function"
>ldap_connect()</B
></A
>.
</P
></DD
><DT
><CODE
CLASS="parameter"
>base_dn</CODE
></DT
><DD
><P
> The base DN for the directory.
</P
></DD
><DT
><CODE
CLASS="parameter"
>filter</CODE
></DT
><DD
><P
> An empty filter is not allowed. If you want to retrieve absolutely all
information for this entry, use a filter of
<TT
CLASS="literal"
>objectClass=*</TT
>. If you know which entry types are
used on the directory server, you might use an appropriate filter such
as <TT
CLASS="literal"
>objectClass=inetOrgPerson</TT
>.
</P
></DD
><DT
><CODE
CLASS="parameter"
>attributes</CODE
></DT
><DD
><P
> 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
> 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
><CODE
CLASS="parameter"
>attrsonly</CODE
></DT
><DD
><P
> 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
><CODE
CLASS="parameter"
>sizelimit</CODE
></DT
><DD
><P
> Enables you to limit the count of entries fetched. Setting this to 0
means no limit.
</P
><DIV
CLASS="note"
><BLOCKQUOTE
CLASS="note"
><P
><B
>注意: </B
>
This parameter can NOT override server-side preset sizelimit. You can
set it lower though.
</P
><P
> 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
></BLOCKQUOTE
></DIV
></DD
><DT
><CODE
CLASS="parameter"
>timelimit</CODE
></DT
><DD
><P
> Sets the number of seconds how long is spend on the search. Setting
this to 0 means no limit.
</P
><DIV
CLASS="note"
><BLOCKQUOTE
CLASS="note"
><P
><B
>注意: </B
>
This parameter can NOT override server-side preset timelimit. You can
set it lower though.
</P
></BLOCKQUOTE
></DIV
></DD
><DT
><CODE
CLASS="parameter"
>deref</CODE
></DT
><DD
><P
> Specifies how aliases should be handled during the search. It can be
one of the following:
<P
></P
><UL
><LI
><P
> <TT
CLASS="constant"
><B
>LDAP_DEREF_NEVER</B
></TT
> - (default) aliases are never
dereferenced.
</P
></LI
><LI
><P
> <TT
CLASS="constant"
><B
>LDAP_DEREF_SEARCHING</B
></TT
> - aliases should be
dereferenced during the search but not when locating the base object
of the search.
</P
></LI
><LI
><P
> <TT
CLASS="constant"
><B
>LDAP_DEREF_FINDING</B
></TT
> - aliases should be
dereferenced when locating the base object but not during the search.
</P
></LI
><LI
><P
> <TT
CLASS="constant"
><B
>LDAP_DEREF_ALWAYS</B
></TT
> - aliases should be dereferenced
always.
</P
></LI
></UL
>
</P
></DD
></DL
></DIV
>
</P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN105685"
></A
><H2
>返回值</H2
><P
> Returns a search result identifier or <TT
CLASS="constant"
><B
>FALSE</B
></TT
> on error.
</P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN105689"
></A
><H2
>更新日志</H2
><P
> <DIV
CLASS="informaltable"
><P
></P
><A
NAME="AEN105692"
></A
><TABLE
BORDER="1"
CLASS="CALSTABLE"
><COL><COL><THEAD
><TR
><TH
>版本</TH
><TH
>说明</TH
></TR
></THEAD
><TBODY
><TR
><TD
>4.0.5</TD
><TD
> Parallel searches support was added.
See <A
HREF="function.ldap-search.html"
><B
CLASS="function"
>ldap_search()</B
></A
> for details.
</TD
></TR
><TR
><TD
>4.0.2</TD
><TD
> The <CODE
CLASS="parameter"
>attrsonly</CODE
>, <CODE
CLASS="parameter"
>sizelimit</CODE
>,
<CODE
CLASS="parameter"
>timelimit</CODE
> and <CODE
CLASS="parameter"
>deref</CODE
> were
added.
</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
>
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.ldap-parse-result.html"
ACCESSKEY="P"
>上一页</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>起始页</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.ldap-rename.html"
ACCESSKEY="N"
>下一页</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>ldap_parse_result</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.ldap.html"
ACCESSKEY="U"
>上一级</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>ldap_rename</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
