[Svn] r4271 - branches/devel-addressbook/program/include

[trac at roundcube.net]

Author: thomasb
Date: 2010-11-25 13:45:01 -0600 (Thu, 25 Nov 2010)
New Revision: 4271

Modified:
   branches/devel-addressbook/program/include/rcube_addressbook.php
   branches/devel-addressbook/program/include/rcube_contacts.php
Log:
Better documentation of rcube_addressbooks

Modified: branches/devel-addressbook/program/include/rcube_addressbook.php
===================================================================
--- branches/devel-addressbook/program/include/rcube_addressbook.php	2010-11-25 19:31:50 UTC (rev 4270)
+++ branches/devel-addressbook/program/include/rcube_addressbook.php	2010-11-25 19:45:01 UTC (rev 4271)
@@ -70,9 +70,11 @@
      * @param array   List of fields to search in
      * @param string  Search value
      * @param boolean True if results are requested, False if count only
-     * @return Indexed list of contact records and 'count' value
+     * @param boolean True to skip the count query (select only)
+     * @param array   List of fields that cannot be empty
+     * @return object rcube_result_set List of contact records and 'count' value
      */
-    abstract function search($fields, $value, $strict=false, $select=true);
+    abstract function search($fields, $value, $strict=false, $select=true, $nocount=false, $required=array());
 
     /**
      * Count number of available contacts in database
@@ -200,9 +202,10 @@
     /**
      * List all active contact groups of this source
      *
+     * @param string  Optional search string to match group name
      * @return array  Indexed list of contact groups, each a hash array
      */
-    function list_groups()
+    function list_groups($search = null)
     {
         /* empty for address books don't supporting groups */
         return array();

Modified: branches/devel-addressbook/program/include/rcube_contacts.php
===================================================================
--- branches/devel-addressbook/program/include/rcube_contacts.php	2010-11-25 19:31:50 UTC (rev 4270)
+++ branches/devel-addressbook/program/include/rcube_contacts.php	2010-11-25 19:45:01 UTC (rev 4271)
@@ -226,7 +226,7 @@
      * @param boolean True if results are requested, False if count only
      * @param boolean True to skip the count query (select only)
      * @param array   List of fields that cannot be empty
-     * @return Indexed list of contact records and 'count' value
+     * @return object rcube_result_set Contact records and 'count' value
      */
     function search($fields, $value, $strict=false, $select=true, $nocount=false, $required=array())
     {

_______________________________________________
http://lists.roundcube.net/mailman/listinfo/svn