Overview

Packages

  • Horde
    • Data
  • None
  • Turba

Classes

  • Turba
  • Turba_Api
  • Turba_Driver
  • Turba_Driver_Facebook
  • Turba_Driver_Favourites
  • Turba_Driver_Group
  • Turba_Driver_Imsp
  • Turba_Driver_Kolab
  • Turba_Driver_Ldap
  • Turba_Driver_Prefs
  • Turba_Driver_Share
  • Turba_Driver_Sql
  • Turba_Driver_Vbook
  • Turba_Exception
  • Turba_Factory_Driver
  • Turba_Form_AddContact
  • Turba_Form_Contact
  • Turba_Form_ContactBase
  • Turba_Form_CreateAddressBook
  • Turba_Form_DeleteAddressBook
  • Turba_Form_EditAddressBook
  • Turba_Form_EditContact
  • Turba_Form_EditContactGroup
  • Turba_List
  • Turba_LoginTasks_SystemTask_Upgrade
  • Turba_Object
  • Turba_Object_Group
  • Turba_Test
  • Turba_View_Browse
  • Turba_View_Contact
  • Turba_View_DeleteContact
  • Turba_View_Duplicates
  • Turba_View_EditContact
  • Turba_View_List
  • Overview
  • Package
  • Class
  • Tree

Class Turba_Object_Group

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

Turba_Object
Extended by Turba_Object_Group
Package: Turba
Author: Chuck Hagenbuch chuck@horde.org
Author: Jon Parise jon@csh.rit.edu
Located at Object/Group.php
Methods summary
public
# __construct( Turba_Driver $driver, array $attributes = array() )

Constructs a new Turba_Object_Group.

Constructs a new Turba_Object_Group.

Parameters

$driver
<p>The driver object that this group comes from.</p>
$attributes
Hash of attributes for this group.

Overrides

Turba_Object::__construct()
public boolean
# isGroup( )

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

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

Returns

boolean
True.

Overrides

Turba_Object::isGroup()
public Horde_Url
# url( string $view = null, boolean $full = false )

Contact url.

Contact url.

Parameters

$view
The view for the url
$full
Generate a full url?

Returns

Horde_Url

Overrides

Turba_Object::url()
public
# addMember( string $contactId, string $sourceId = null )

Adds a new contact entry to this group.

Adds a new contact entry to this group.

Parameters

$contactId
The id of the contact to add.
$sourceId
The source $contactId is from.

Throws

Turba_Exception
public
# removeMember( string $contactId, string $sourceId = null )

Deletes a contact from this group.

Deletes a contact from this group.

Parameters

$contactId
The id of the contact to remove.
$sourceId
The source $contactId is from.
public integer
# count( )

Count the number of contacts in this group.

Count the number of contacts in this group.

Returns

integer
public Turba_List
# listMembers( array $sort = null )

Retrieve the Objects in this group

Retrieve the Objects in this group

Parameters

$sort
<p>The requested sort order which is passed to Turba_List::sort().</p>

Returns

Turba_List
List containing the members of this group
Methods inherited from Turba_Object
addFile(), deleteFile(), deleteFiles(), getAttributes(), getGuid(), getHistory(), getSource(), getValue(), hasPermission(), hasValue(), isEditable(), lastModification(), listFiles(), merge(), setValue(), store(), vfsDisplayUrl(), vfsEditUrl()
Properties inherited from Turba_Object
$attributes, $driver, $sortValue
API documentation generated by ApiGen