Changeset 4145 in subversion

Timestamp:

Oct 27, 2010 3:23:57 AM (3 years ago)

Author:

alec

Message:

• Add rcube_addressbook::get_record_groups() (#1487089)

Location:

trunk/roundcubemail/program/include

Files:

• rcube_addressbook.php (modified) (10 diffs)
• rcube_contacts.php (modified) (2 diffs)

trunk/roundcubemail/program/include/rcube_addressbook.php

@@ -65 +65 @@
 
     /**
-     * List all active contact groups of this source
-     *
-     * @return array  Indexed list of contact groups, each a hash array
-     */
-    function list_groups() { }
-
-    /**
      * Search records
      *
@@ -100 +93 @@
      * @param mixed record identifier(s)
      * @param boolean True to return record as associative array, otherwise a result set is returned
+     *
      * @return mixed Result object with all record fields or False if not found
      */
@@ -131 +125 @@
         $this->page_size = (int)$size;
     }
-
-    /**
-     * Setter for the current group
-     * (empty, has to be re-implemented by extending class)
-     */
-    function set_group($gid) { }
 
     /**
@@ -181 +169 @@
 
     /**
+     * Setter for the current group
+     * (empty, has to be re-implemented by extending class)
+     */
+    function set_group($gid) { }
+
+    /**
+     * List all active contact groups of this source
+     *
+     * @return array  Indexed list of contact groups, each a hash array
+     */
+    function list_groups()
+    {
+        /* empty for address books don't supporting groups */
+        return array();
+    }
+
+    /**
      * Create a contact group with the given name
      *
@@ -191 +196 @@
         return false;
     }
-    
+
     /**
      * Delete the given group and all linked group members
@@ -203 +208 @@
         return false;
     }
-    
+
     /**
      * Rename a specific contact group
@@ -216 +221 @@
         return false;
     }
-    
+
     /**
      * Add the given contact records the a certain group
@@ -222 +227 @@
      * @param string  Group identifier
      * @param array   List of contact identifiers to be added
-     * @return int    Number of contacts added 
+     * @return int    Number of contacts added
      */
     function add_to_group($group_id, $ids)
@@ -229 +234 @@
         return 0;
     }
-    
+
     /**
      * Remove the given contact records from a certain group
@@ -242 +247 @@
         return 0;
     }
+
+    /**
+     * Get group assignments of a specific contact record
+     *
+     * @param mixed Record identifier
+     *
+     * @return array List of assigned groups as ID=>Name pairs
+     * @since 0.5-beta
+     */
+    function get_record_groups($id)
+    {
+        /* empty for address books don't supporting groups */
+        return array();
+    }
 }
+

trunk/roundcubemail/program/include/rcube_contacts.php

@@ -356 +356 @@
 
     /**
-     * Get group assignments of a specific contacr record
+     * Get group assignments of a specific contact record
      *
      * @param mixed Record identifier
-     * @param array List of assigned groups as ID=>Name pairs
+     * @return array List of assigned groups as ID=>Name pairs
      */
     function get_record_groups($id)
@@ -385 +385 @@
      * Create a new contact record
      *
-     * @param array Assoziative array with save data
+     * @param array Associative array with save data
      * @return integer|boolean The created record ID on success, False on error
      */