Changeset 4271 in subversion

Timestamp:

Nov 25, 2010 2:45:01 PM (2 years ago)

Author:

thomasb

Message:

Better documentation of rcube_addressbooks

Location:

branches/devel-addressbook/program/include

Files:

• rcube_addressbook.php (modified) (2 diffs)
• rcube_contacts.php (modified) (1 diff)

branches/devel-addressbook/program/include/rcube_addressbook.php

@@ -71 +71 @@
      * @param string  Search value
      * @param boolean True if results are requested, False if count only
-     * @return Indexed list of contact records and 'count' value
-     */
-    abstract function search($fields, $value, $strict=false, $select=true);
+     * @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, $nocount=false, $required=array());
 
     /**
@@ -201 +203 @@
      * 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 */

branches/devel-addressbook/program/include/rcube_contacts.php

@@ -227 +227 @@
      * @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())