Class DataTreeObject_Group

Description

Extension of the DataTreeObject class for storing Group information in the Categories driver. If you want to store specialized Group information, you should extend this class instead of extending DataTreeObject directly.

Located in /Group/Group.php (line 724)

DataTreeObject
   |
   --DataTreeObject_Group
Direct descendents
Class Description
 class LDAP_Group Extension of the DataTreeObject_Group class for storing group information in an LDAP directory.
 class SQLObject_Group Extension of the SQLObject class for storing Group information in the Categories driver. If you want to store specialized Group information, you should extend this class instead of extending SQLObject directly.
Variable Summary
Method Summary
 DataTreeObject_Group DataTreeObject_Group (string $name)
 void addUser (string $username, [ $update = true])
 void clearAuditLog ()
 void getAuditLog ()
 string getId ()
 array listAllUsers ()
 array listUsers ()
 void removeUser (string $username, [ $update = true])
 void save ()
 void setGroupOb ( &$groupOb, Group $groupOb)
 void _fromAttributes (array $attributes)
 array _toAttributes ()
 array __sleep ()
Variables
array $_auditLog = array() (line 740)

This variable caches the users added or removed from the group for History logging of user-groups relationship.

Group $_groupOb (line 732)

The Group object which this group is associated with - needed for updating data in the backend to make changes stick, etc.

Inherited Variables

Inherited from DataTreeObject

DataTreeObject::$data
DataTreeObject::$datatree
DataTreeObject::$name
DataTreeObject::$order
Methods
Constructor DataTreeObject_Group (line 749)

The DataTreeObject_Group constructor. Just makes sure to call the parent constructor so that the group's name is set properly.

DataTreeObject_Group DataTreeObject_Group (string $name)
  • string $name: The name of the group.
addUser (line 802)

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

Redefined in descendants as:
clearAuditLog (line 859)

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

void clearAuditLog ()

Redefined in descendants as:
getAuditLog (line 851)

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

void getAuditLog ()

Redefined in descendants as:
getId (line 782)

Fetch the ID of this group

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

Redefinition of:
DataTreeObject::getId()
Gets the ID of this object.

Redefined in descendants as:
listAllUsers (line 843)

Get a list of every user that is a part of this group and any of it's subgroups

  • return: The complete user list
array listAllUsers ()

Redefined in descendants as:
listUsers (line 832)

Get a list of every user that is a part of this group (and only this group)

  • return: The user list
array listUsers ()

Redefined in descendants as:
removeUser (line 817)

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

Redefined in descendants as:
save (line 790)

Save any changes to this object to the backend permanently.

void save ()

Redefinition of:
DataTreeObject::save()
Saves any changes to this object to the backend permanently. New objects are added instead.

Redefined in descendants as:
setGroupOb (line 772)

Associates a Group object with this group.

void setGroupOb ( &$groupOb, Group $groupOb)
  • Group $groupOb: The Group object.
  • &$groupOb
_fromAttributes (line 897)

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

void _fromAttributes (array $attributes)
  • array $attributes: The list of attributes from the backend (attribute name, key, and value).

Redefined in descendants as:
_toAttributes (line 870)

Map this object's attributes from the data array into a format that we can store in the attributes storage backend.

  • return: The attributes array.
array _toAttributes ()

Redefined in descendants as:
__sleep (line 759)

Returns the properties that need to be serialized.

  • return: List of serializable properties.
array __sleep ()

Inherited Methods

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:17:52 +0000 by phpDocumentor 1.4.3