[PHP-DOC] cvs: phpdoc /en/functions ldap.xml From: Jani Taskinen (sniper <email protected>)
Date: 07/21/00

sniper Fri Jul 21 18:59:19 2000 EDT

  Modified files:
    /phpdoc/en/functions ldap.xml
  Log:
  Documentation updates for ldap_search/list/read() functions.
  #I hope I got these right..
  
  
Index: phpdoc/en/functions/ldap.xml
diff -u phpdoc/en/functions/ldap.xml:1.7 phpdoc/en/functions/ldap.xml:1.8
--- phpdoc/en/functions/ldap.xml:1.7 Sat Jul 8 03:52:08 2000
+++ phpdoc/en/functions/ldap.xml Fri Jul 21 18:59:19 2000
@@ -883,6 +883,18 @@
       <paramdef>string <parameter>filter</parameter></paramdef>
       <paramdef>array
        <parameter><optional>attributes</optional></parameter></paramdef>
+ <paramdef>int
+ <parameter><optional>attrsonly</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>sizelimit</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>timelimit</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>deref</optional></parameter>
+ </paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
@@ -896,8 +908,7 @@
      given in the call. (Equivalent to typing "ls" and getting a list
      of files and folders in the current working directory.)</para>
     <para>
- This call takes an optional fourth parameter which is an array of
- the attributes required. See <function>ldap_search</function>
+ This call takes 5 optional parameters. See <function>ldap_search</function>
      notes.
 
     <example>
@@ -1026,6 +1037,18 @@
       <paramdef>string <parameter>filter</parameter></paramdef>
       <paramdef>array
        <parameter><optional>attributes</optional></parameter></paramdef>
+ <paramdef>int
+ <parameter><optional>attrsonly</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>sizelimit</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>timelimit</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>deref</optional></parameter>
+ </paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
@@ -1042,8 +1065,7 @@
      directory server, you might use an appropriate filter such as
      "objectClass=inetOrgPerson".</para>
     <para>
- This call takes an optional fourth parameter which is an array of
- the attributes required. See <function>ldap_search</function>
+ This call takes 5 optional parameters. See <function>ldap_search</function>
      notes.</para>
    </refsect1>
   </refentry>
@@ -1063,7 +1085,20 @@
       <paramdef>string <parameter>base_dn</parameter></paramdef>
       <paramdef>string <parameter>filter</parameter></paramdef>
       <paramdef>array
- <parameter><optional>attributes</optional></parameter></paramdef>
+ <parameter><optional>attributes</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>attrsonly</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>sizelimit</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>timelimit</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>deref</optional></parameter>
+ </paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
@@ -1090,7 +1125,60 @@
      Note too that 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.</para>
+ results set. This occurs also if the sixth parameter
+ <parameter>sizelimit</parameter> has been used to limit the count
+ of fetched entries.
+ </para>
+ <para>
+ The fifth parameter <parameter>attrsonly</parameter> 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.
+ </para>
+ <para>
+ With the sixth parameter <parameter>sizelimit</parameter> it is
+ possible 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.
+ </para>
+ <para>
+ The seventh parameter <parameter>timelimit</parameter> 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.
+ </para>
+
+ <para>
+ The eigth parameter <parameter>deref</parameter> specifies how aliases
+ should be handled during the search. It can be one of the following:
+ <itemizedlist>
+ <listitem>
+ <simpara>
+ LDAP_DEREF_NEVER - (default) aliases are never dereferenced.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ LDAP_DEREF_SEARCHING - aliases should be dereferenced during the search
+ but not when locating the base object of the search.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ LDAP_DEREF_FINDING - aliases should be dereferenced when
+ locating the base object but not during the search.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ LDAP_DEREF_ALWAYS - aliases should be dereferenced always.
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+
     <para>
      The search filter can be simple or advanced, using boolean
      operators in the format described in the LDAP doumentation (see