File: function.ldap-list.html

package info (click to toggle)
php3 3%3A3.0.18-0potato1.1
links: PTS
area: main
in suites: potato
size: 17,736 kB
ctags: 11,198
sloc: ansic: 108,120; sh: 2,512; php: 2,024; yacc: 1,887; makefile: 1,038; perl: 537; pascal: 238; awk: 90; cpp: 28; sql: 11
file content (280 lines) | stat: -rw-r--r-- 4,006 bytes
parent folder | download | duplicates (3)
<HTML
><HEAD
><TITLE
>ldap_list</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="LDAP functions"
HREF="ref.ldap.html"><LINK
REL="PREVIOUS"
TITLE="ldap_get_values_len"
HREF="function.ldap-get-values-len.html"><LINK
REL="NEXT"
TITLE="ldap_modify"
HREF="function.ldap-modify.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.ldap-get-values-len.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.ldap-modify.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.ldap-list"
>ldap_list</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN19241"
></A
><P
>    (PHP3 , PHP4 )</P
>ldap_list&nbsp;--&nbsp;Single-level search</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN19244"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN19246"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="function"
>ldap_list</B
></CODE
> (int link_identifier, string base_dn, string filter [, array
       attributes [, int 
       attrsonly [, int 
       sizelimit [, int 
       timelimit [, int 
       deref]]]]])</CODE
></P
><P
></P
></DIV
><P
>&#13;     Returns a search result identifier or false on error.</P
><P
>&#13;     <B
CLASS="function"
>ldap_list()</B
> performs the search for a specified
     filter on the directory with the scope LDAP_SCOPE_ONELEVEL.</P
><P
>&#13;     LDAP_SCOPE_ONELEVEL means that the search should only return
     information that is at the level immediately below the base dn
     given in the call. (Equivalent to typing "ls" and getting a list
     of files and folders in the current working directory.)</P
><P
>&#13;     This call takes 5 optional parameters. See <A
HREF="function.ldap-search.html"
><B
CLASS="function"
>ldap_search()</B
></A
>
     notes.
    <DIV
CLASS="note"
><BLOCKQUOTE
CLASS="note"
><P
><B
>Note: </B
>
       These optional parameters were added in 4.0.2:
      <TT
CLASS="parameter"
><I
>attrsonly</I
></TT
>,
      <TT
CLASS="parameter"
><I
>sizelimit</I
></TT
>,
      <TT
CLASS="parameter"
><I
>timelimit</I
></TT
>,
      <TT
CLASS="parameter"
><I
>deref</I
></TT
>.
     </P
></BLOCKQUOTE
></DIV
>

    <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN19283"
></A
><P
><B
>Example 1. Produce a list of all organizational units of an organization 
       </B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
>&#13;// $ds is a valid link identifier for a directory server

$basedn = "o=My Company, c=US";
$justthese = array("ou");

$sr=ldap_list($ds, $basedn, "ou=*", $justthese);

$info = ldap_get_entries($ds, $sr);

for ($i=0; $i&#60;$info["count"]; $i++)
    echo $info[$i]["ou"][0] ;
</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.ldap-get-values-len.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.ldap-modify.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>ldap_get_values_len</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.ldap.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>ldap_modify</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>