documentation/manual/en/module_specs/Zend_Ldap-Tools.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.ldap.tools">
   4     <title>Tools</title>
   5
   6     <sect2 id="zend.ldap.tools.dn">
   7         <title>Creation and modification of DN strings</title>
   8         <para/>
   9     </sect2>
  10
  11     <sect2 id="zend.ldap.tools.filter">
  12         <title>Using the filter API to create search filters</title>
  13
  14         <example>
  15             <title>Create simple LDAP filters</title>
  16
  17             <programlisting language="php"><![CDATA[
  18 $f1  = Zend_Ldap_Filter::equals('name', 'value');         // (name=value)
  19 $f2  = Zend_Ldap_Filter::begins('name', 'value');         // (name=value*)
  20 $f3  = Zend_Ldap_Filter::ends('name', 'value');           // (name=*value)
  21 $f4  = Zend_Ldap_Filter::contains('name', 'value');       // (name=*value*)
  22 $f5  = Zend_Ldap_Filter::greater('name', 'value');        // (name>value)
  23 $f6  = Zend_Ldap_Filter::greaterOrEqual('name', 'value'); // (name>=value)
  24 $f7  = Zend_Ldap_Filter::less('name', 'value');           // (name<value)
  25 $f8  = Zend_Ldap_Filter::lessOrEqual('name', 'value');    // (name<=value)
  26 $f9  = Zend_Ldap_Filter::approx('name', 'value');         // (name~=value)
  27 $f10 = Zend_Ldap_Filter::any('name');                     // (name=*)
  28 ]]></programlisting>
  29         </example>
  30
  31         <example>
  32             <title>Create more complex LDAP filters</title>
  33
  34             <programlisting language="php"><![CDATA[
  35 $f1 = Zend_Ldap_Filter::ends('name', 'value')->negate(); // (!(name=*value))
  36
  37 $f2 = Zend_Ldap_Filter::equals('name', 'value');
  38 $f3 = Zend_Ldap_Filter::begins('name', 'value');
  39 $f4 = Zend_Ldap_Filter::ends('name', 'value');
  40
  41 // (&(name=value)(name=value*)(name=*value))
  42 $f5 = Zend_Ldap_Filter::andFilter($f2, $f3, $f4);
  43
  44 // (|(name=value)(name=value*)(name=*value))
  45 $f6 = Zend_Ldap_Filter::orFilter($f2, $f3, $f4);
  46 ]]></programlisting>
  47         </example>
  48     </sect2>
  49
  50     <sect2 id="zend.ldap.tools.attribute">
  51         <title>Modify LDAP entries using the Attribute API</title>
  52         <para/>
  53     </sect2>
  54 </sect1>