svn: /pear/peardoc/trunk/en/package/networking/net-ldap2/ filter.xml

--a71c34aebd1be0741b957438031626b3129be0b0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit

beni                                     Mon, 09 Dec 2013 10:09:35 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=332312

Log:
* Fixes in doc

Changed paths:
    U   pear/peardoc/trunk/en/package/networking/net-ldap2/filter.xml

Modified: pear/peardoc/trunk/en/package/networking/net-ldap2/filter.xml
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-ldap2/filter.xml	2013-12-09 09:25:34 UTC (rev 332311)
+++ pear/peardoc/trunk/en/package/networking/net-ldap2/filter.xml	2013-12-09 10:09:35 UTC (rev 332312)
@@ -247,10 +247,12 @@

             <para>
                 Since version 2.1.0 the filter class can filter entries client side. Just pass an entry
-                or an array of entries to the filter objects <function>matches</function>. With this you can
+                or an array of entries to the filter objects <function>matches</function> method. With this you can
                 check that an given entry matches some LDAP filter as well as select matching entries out of
-                an array containing many of them.
-                <table><title>supported features</title>
+                an array containing many of them. The method always returns the number of matched entries. If you want
+                to retrieve the filtered entries you have to provide some result array to which the matching entries are
+                appended.
+                <table><title>Supported features</title>

                     <tgroup cols="2">
                         <thead>
@@ -261,9 +263,9 @@
                             </row>
                         </thead>
                         <tbody>
-                            <row><entry>Matching Operators: <literal>equals</literal>, <literal>begins</literal>, <literal>ends</literal>, <literal>contains</literal>, <literal>present|any</literal></entry><entry>Matching of the basic "=" filter argument with wildcards in value</entry><entry>2.1.0</entry></row>
+                            <row><entry>Matching Operators: <literal>equals</literal>, <literal>begins</literal>, <literal>ends</literal>, <literal>contains</literal>, <literal>present|any</literal></entry><entry>Matching of the basic "=" filter argument with wildcards in value. As of 2.1.0, the match performed is not case sensitive (this will change once schema attribute syntax is honored).</entry><entry>2.1.0</entry></row>
                             <row><entry>Matching Operators: <literal>greater</literal>, <literal>greaterOrEqual</literal>, <literal>less</literal>, <literal>lessOrEqual</literal>, <literal>approx</literal></entry><entry>Comparisons and approximate literal matching</entry><entry>unsupported</entry></row>
-			    <row><entry>Matching rules of attribute syntax</entry><entry>Using of the matching rule of the schema attribute syntax (eg. date/time comparisons, case sensitiveness, etc)</entry><entry>unsupported</entry>
+			    <row><entry>Matching rules of attribute syntax</entry><entry>Using of the matching rule of the schema attribute syntax (eg. date/time comparisons, case sensitiveness, etc)</entry><entry>unsupported</entry></row>
                             <row><entry>Logical Operators: <literal>AND</literal>, <literal>OR</literal>, <literal>NOT</literal></entry><entry>Combining filters for more advanced expressions.</entry><entry>2.1.0</entry></row>

                         </tbody>
@@ -286,8 +288,8 @@
 // $matches_count contains again the number of matched entries, here 0 or n.

 // what entries do match exactly?
-$filteredEntries = array();
-$matches_count = $filter->matches($arrayOfEntries $filteredEntries);
+$filteredEntries = array(); // provide a results array (doesn't have to be empty)
+$matches_count = $filter->matches($arrayOfEntries, $filteredEntries);
 // $filteredEntries array contains now all matched entries, eg a filtered result.

 ]]></programlisting>

--a71c34aebd1be0741b957438031626b3129be0b0--