Class Turba_Object_Group

Description

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

$Horde: turba/lib/Object/Group.php,v 1.9.2.5 2010/04/09 13:24:22 jan Exp $

Located in /lib/Object/Group.php (line 15)

Turba_Object
   |
   --Turba_Object_Group
Method Summary
 Turba_Object_Group Turba_Object_Group ( &$driver, [array $attributes = array()], Turba_Driver $driver)
 void addMember (string $contactId, [string $sourceId = null])
 integer count ()
 boolean isGroup ()
 Turba_List &listMembers ([array $sort = null])
 void removeMember (string $contactId, [string $sourceId = null])
 void url ([ $view = null], [ $full = false])
Variables
Methods
Constructor Turba_Object_Group (line 24)

Constructs a new Turba_Object_Group.

Turba_Object_Group Turba_Object_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 59)

Adds a new contact entry to this group.

  • since: Turba 1.2
void addMember (string $contactId, [string $sourceId = null])
  • string $contactId: The id of the contact to add.
  • string $sourceId: The source $contactId is from.
count (line 144)

Count the number of contacts in this group.

  • since: Turba 2.1.7
integer count ()
isGroup (line 35)

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 164)

Retrieve the Objects in this group

  • return: List containing the members of this group
  • since: Turba 1.2
Turba_List &listMembers ([array $sort = null])
  • array $sort: The requested sort order which is passed to Turba_List::sort().
removeMember (line 118)

Deletes a contact from this group.

  • since: Turba 1.2
void removeMember (string $contactId, [string $sourceId = null])
  • string $contactId: The id of the contact to remove.
  • string $sourceId: The source $contactId is from.
url (line 43)

Contact url.

void url ([ $view = null], [ $full = false])
  • $view
  • $full

Redefinition of:
Turba_Object::url()
Contact url.

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