Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > by-pkgid > 05cd670d8a02b2b4a0ffb1756f2e8308 > files > 2198

php-manual-zh-5.2.4-1mdv2008.1.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>ldap_search</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_sasl_bind"
HREF="function.ldap-sasl-bind.html"><LINK
REL="NEXT"
TITLE="ldap_set_option"
HREF="function.ldap-set-option.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-sasl-bind.html"
ACCESSKEY="P"
>上一页</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.ldap-set-option.html"
ACCESSKEY="N"
>下一页</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.ldap-search"
></A
>ldap_search</H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN105830"
></A
><P
>    (PHP 3, PHP 4, PHP 5)</P
>ldap_search&nbsp;--&nbsp;Search LDAP tree</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN105833"
></A
><H2
>说明</H2
>resource <B
CLASS="methodname"
>ldap_search</B
> ( resource link_identifier, string base_dn, string filter [, array attributes [, int attrsonly [, int sizelimit [, int timelimit [, int deref]]]]] )<BR
></BR
><P
>&#13;   Performs the search for a specified filter on the directory with the scope
   of <TT
CLASS="constant"
><B
>LDAP_SCOPE_SUBTREE</B
></TT
>. This is equivalent to searching
   the entire directory.
  </P
><P
>&#13;   From 4.0.5 on it's also possible to do parallel searches. To do this
   you use an array of link identifiers, rather than a single identifier,
   as the first argument. If you don't want the same base DN and the
   same filter for all the searches, you can also use an array of base DNs
   and/or an array of filters. Those arrays must be of the same size as
   the link identifier array since the first entries of the arrays are
   used for one search, the second entries are used for another, and so
   on. When doing parallel searches an array of search result
   identifiers is returned, except in case of error, then the entry
   corresponding to the search will be <TT
CLASS="constant"
><B
>FALSE</B
></TT
>. This is very much like
   the value normally returned, except that a result identifier is always
   returned when a search was made. There are some rare cases where the
   normal search returns <TT
CLASS="constant"
><B
>FALSE</B
></TT
> while the parallel search returns an
   identifier.
  </P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN105867"
></A
><H2
>参数</H2
><P
>&#13;   <P
></P
><DIV
CLASS="variablelist"
><DL
><DT
><CODE
CLASS="parameter"
>link_identifier</CODE
></DT
><DD
><P
>&#13;       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
>&#13;       The base DN for the directory.
      </P
></DD
><DT
><CODE
CLASS="parameter"
>filter</CODE
></DT
><DD
><P
>&#13;       The search filter can be simple or advanced, using boolean operators in
       the format described in the LDAP documentation (see the <A
HREF="http://www.mozilla.org/directory/csdk-docs/filter.htm"
TARGET="_top"
>Netscape Directory SDK</A
> for full
       information on filters).
      </P
></DD
><DT
><CODE
CLASS="parameter"
>attributes</CODE
></DT
><DD
><P
>&#13;       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
>&#13;       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
>&#13;       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
>&#13;       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
>&#13;        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
>&#13;       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
>&#13;       Specifies how aliases should be handled during the search. It can be
       one of the following:
       <P
></P
><UL
><LI
><P
>&#13;          <TT
CLASS="constant"
><B
>LDAP_DEREF_NEVER</B
></TT
> - (default) aliases are never
          dereferenced.
         </P
></LI
><LI
><P
>&#13;          <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
>&#13;          <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
>&#13;          <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="AEN105932"
></A
><H2
>返回值</H2
><P
>&#13;   Returns a search result identifier or <TT
CLASS="constant"
><B
>FALSE</B
></TT
> on error.
  </P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN105936"
></A
><H2
>更新日志</H2
><P
>&#13;   <DIV
CLASS="informaltable"
><P
></P
><A
NAME="AEN105939"
></A
><TABLE
BORDER="1"
CLASS="CALSTABLE"
><COL><COL><THEAD
><TR
><TH
>版本</TH
><TH
>说明</TH
></TR
></THEAD
><TBODY
><TR
><TD
>4.0.5</TD
><TD
>&#13;        Parallel searches support was added.
       </TD
></TR
><TR
><TD
>4.0.2</TD
><TD
>&#13;        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="refsect1"
><A
NAME="AEN105956"
></A
><H2
>范例</H2
><P
>&#13;   The example below retrieves the organizational unit, surname,
   given name and email address for all people in "My Company" where
   the surname or given name contains the substring $person. This
   example uses a boolean filter to tell the server to look for
   information in more than one attribute.
   <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN105959"
></A
><P
><B
>例 1. LDAP search</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><code><font color="#000000">
<font color="#0000BB">&lt;?php<br /></font><font color="#FF8000">// $ds is a valid link identifier for a directory server<br /><br />// $person is all or part of a person's name, eg "Jo"<br /><br /></font><font color="#0000BB">$dn </font><font color="#007700">= </font><font color="#DD0000">"o=My Company, c=US"</font><font color="#007700">;<br /></font><font color="#0000BB">$filter</font><font color="#007700">=</font><font color="#DD0000">"(|(sn=$person*)(givenname=$person*))"</font><font color="#007700">;<br /></font><font color="#0000BB">$justthese </font><font color="#007700">= array(</font><font color="#DD0000">"ou"</font><font color="#007700">, </font><font color="#DD0000">"sn"</font><font color="#007700">, </font><font color="#DD0000">"givenname"</font><font color="#007700">, </font><font color="#DD0000">"mail"</font><font color="#007700">);<br /><br /></font><font color="#0000BB">$sr</font><font color="#007700">=</font><font color="#0000BB">ldap_search</font><font color="#007700">(</font><font color="#0000BB">$ds</font><font color="#007700">, </font><font color="#0000BB">$dn</font><font color="#007700">, </font><font color="#0000BB">$filter</font><font color="#007700">, </font><font color="#0000BB">$justthese</font><font color="#007700">);<br /><br /></font><font color="#0000BB">$info </font><font color="#007700">= </font><font color="#0000BB">ldap_get_entries</font><font color="#007700">(</font><font color="#0000BB">$ds</font><font color="#007700">, </font><font color="#0000BB">$sr</font><font color="#007700">);<br /><br />echo </font><font color="#0000BB">$info</font><font color="#007700">[</font><font color="#DD0000">"count"</font><font color="#007700">].</font><font color="#DD0000">" entries returned\n"</font><font color="#007700">;<br /></font><font color="#0000BB">?&gt;</font>
</font>
</code></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
  </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-sasl-bind.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-set-option.html"
ACCESSKEY="N"
>下一页</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>ldap_sasl_bind</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_set_option</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>