Class Turba_Group

Description

The Turba_Group:: class provides a set of methods for dealing with contact groups.

$Horde: turba/lib/Group.php,v 1.23.10.3 2006/04/11 20:04:19 chuck Exp $

Located in /lib/Group.php (line 16)

Turba_Object
   |
   --Turba_Group
Method Summary
 Turba_Group Turba_Group ( &$driver, [array $attributes = array()], Turba_Driver $driver)
 void addMember (string $contactId)
 boolean isGroup ()
 Turba_List listMembers ([$sort_criteria $sort_criteria = 'lastname'], [$sort_direction $sort_direction = 0])
 void removeMember (string $contactId)
 Turba_List search ($search_criteria $search_criteria, [$sort_criteria $sort_criteria = 'lastname'])
Variables
Methods
Constructor Turba_Group (line 25)

Constructs a new Turba_Group object.

Turba_Group Turba_Group ( &$driver, [array $attributes = array()], Turba_Driver $driver)
  • Turba_Driver $driver: The driver object that this group comes from.
  • array $attributes: Hash of attributes for this group.
  • &$driver
addMember (line 48)

Adds a new contact entry to this group.

  • since: Turba 1.2
void addMember (string $contactId)
  • string $contactId: The id of the contact to add.
isGroup (line 36)

Returns true if this object is a group of multiple contacts.

  • return: True.
boolean isGroup ()

Redefinition of:
Turba_Object::isGroup()
Returns true if this object is a group of multiple contacts.
listMembers (line 102)

Retrieve the Objects in this group

  • return: List containing the members of this group
  • since: Turba 1.2
Turba_List listMembers ([$sort_criteria $sort_criteria = 'lastname'], [$sort_direction $sort_direction = 0])
  • $sort_criteria $sort_criteria: The requested sort order which is passed to Turba_List::sort().
  • $sort_direction $sort_direction: The requested sort direction which is passed to Turba_List::sort().
removeMember (line 76)

Deletes a contact from this group.

  • since: Turba 1.2
void removeMember (string $contactId)
  • string $contactId: The id of the contact to remove.
search (line 138)

Searches the group based on the provided criteria.

TODO: Allow $criteria to contain the comparison operator (<, =, >, 'like') and modify the drivers accordingly.

  • return: The sorted, filtered list of search results.
  • since: Turba 1.2
Turba_List search ($search_criteria $search_criteria, [$sort_criteria $sort_criteria = 'lastname'])
  • $search_criteria $search_criteria: Hash containing the search criteria.
  • $sort_criteria $sort_criteria: The requested sort order which is passed to Turba_List::sort().

Inherited Methods

Inherited From Turba_Object

 Turba_Object::Turba_Object()
 Turba_Object::addFile()
 Turba_Object::deleteFile()
 Turba_Object::deleteFiles()
 Turba_Object::getAttributes()
 Turba_Object::getGuid()
 Turba_Object::getSource()
 Turba_Object::getValue()
 Turba_Object::hasPermission()
 Turba_Object::hasValue()
 Turba_Object::isEditable()
 Turba_Object::isGroup()
 Turba_Object::listFiles()
 Turba_Object::setValue()
 Turba_Object::store()
 Turba_Object::url()
 Turba_Object::vfsDisplayUrl()
 Turba_Object::vfsEditUrl()
 Turba_Object::_vfsInit()

Documentation generated on Sun, 30 Jan 2011 05:39:23 +0000 by phpDocumentor 1.4.3