Class Kolab_Group

Description

Located in /Group/Group/kolab.php (line 355)

DataTreeObject
   |
   --DataTreeObject_Group
      |
      --LDAP_Group
         |
         --Kolab_Group
Method Summary
 Kolab_Group Kolab_Group (string $name, [string $parent = null])
 void addUser (string $username, [ $update = true])
 void clearAuditLog ()
 void getAuditLog ()
 void getDn (string $name)
 string getId ()
 void removeUser (string $username, [ $update = true])
 void save ()
 void _fromAttributes ([array $attributes = array()])
 array _toAttributes ()
Variables
Methods
Constructor Kolab_Group (line 363)

Constructor.

Kolab_Group Kolab_Group (string $name, [string $parent = null])
  • string $name: The name of this group.
  • string $parent: The dn of the parent of this group.
addUser (line 392)

Adds a user to this group, and makes sure that the backend is updated as well.

void addUser (string $username, [ $update = true])
  • string $username: The user to add.
  • $update

Redefinition of:
DataTreeObject_Group::addUser()
Adds a user to this group, and makes sure that the backend is updated as well.
clearAuditLog (line 420)

Clears the audit log. To be called after group update.

void clearAuditLog ()

Redefinition of:
DataTreeObject_Group::clearAuditLog()
Clears the audit log. To be called after group update.
getAuditLog (line 412)

Get all the users recently added or removed from the group.

void getAuditLog ()

Redefinition of:
DataTreeObject_Group::getAuditLog()
Get all the users recently added or removed from the group.
getDn (line 429)

Sets the name of this object.

void getDn (string $name)
  • string $name: The name to set this object's name to.
getId (line 373)

Fetch the ID of this group

  • return: The group's ID
string getId ()

Redefinition of:
DataTreeObject_Group::getId()
Fetch the ID of this group
removeUser (line 404)

Removes a user from this group, and makes sure that the backend is updated as well.

void removeUser (string $username, [ $update = true])
  • string $username: The user to remove.
  • $update

Redefinition of:
DataTreeObject_Group::removeUser()
Removes a user from this group, and makes sure that the backend is updated as well.
save (line 381)

Save any changes to this object to the backend permanently.

void save ()

Redefinition of:
DataTreeObject_Group::save()
Save any changes to this object to the backend permanently.
_fromAttributes (line 440)

Take in a list of attributes from the backend and map it to our internal data array.

void _fromAttributes ([array $attributes = array()])
  • array $attributes: The list of attributes from the backend.

Redefinition of:
LDAP_Group::_fromAttributes()
Take in a list of attributes from the backend and map it to our internal data array.
_toAttributes (line 478)

Map this object's attributes from the data array into a format that can be stored in an LDAP entry.

  • return: The entry array.
array _toAttributes ()

Redefinition of:
LDAP_Group::_toAttributes()
Map this object's attributes from the data array into a format that can be stored in an LDAP entry.

Inherited Methods

Inherited From LDAP_Group

 LDAP_Group::LDAP_Group()
 LDAP_Group::listAllUsers()
 LDAP_Group::listUsers()
 LDAP_Group::_fromAttributes()
 LDAP_Group::_toAttributes()

Inherited From DataTreeObject_Group

 DataTreeObject_Group::DataTreeObject_Group()
 DataTreeObject_Group::addUser()
 DataTreeObject_Group::clearAuditLog()
 DataTreeObject_Group::getAuditLog()
 DataTreeObject_Group::getId()
 DataTreeObject_Group::listAllUsers()
 DataTreeObject_Group::listUsers()
 DataTreeObject_Group::removeUser()
 DataTreeObject_Group::save()
 DataTreeObject_Group::setGroupOb()
 DataTreeObject_Group::_fromAttributes()
 DataTreeObject_Group::_toAttributes()
 DataTreeObject_Group::__sleep()

Inherited From DataTreeObject

 DataTreeObject::DataTreeObject()
 DataTreeObject::delete()
 DataTreeObject::get()
 DataTreeObject::getChild()
 DataTreeObject::getData()
 DataTreeObject::getId()
 DataTreeObject::getName()
 DataTreeObject::getParent()
 DataTreeObject::getShortName()
 DataTreeObject::save()
 DataTreeObject::set()
 DataTreeObject::setData()
 DataTreeObject::setDataTree()
 DataTreeObject::setName()
 DataTreeObject::setOrder()

Documentation generated on Sun, 30 Jan 2011 05:18:48 +0000 by phpDocumentor 1.4.3