Class SQLObject_Group

Description

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.

Located in /Group/Group/sql.php (line 775)

DataTreeObject
   |
   --DataTreeObject_Group
      |
      --SQLObject_Group
Variable Summary
 array $data
 integer $id
 string $name
Method Summary
 SQLObject_Group SQLObject_Group (string $name)
 mixed get (string $attribute)
 string getId ()
 string getName ()
 void save ()
 void set (string $attribute, mixed $value)
Variables
array $data = array() (line 801)

Key-value hash that will be serialized.


Redefinition of:
DataTreeObject::$data
Key-value hash that will be serialized.
integer $id (line 793)

The unique name of this object.

These names have the same requirements as other object names - they must be unique, etc.

string $name (line 784)

The unique name of this object.

These names have the same requirements as other object names - they must be unique, etc.


Redefinition of:
DataTreeObject::$name
The unique name of this object.

Inherited Variables

Inherited from DataTreeObject_Group

DataTreeObject_Group::$_auditLog
DataTreeObject_Group::$_groupOb

Inherited from DataTreeObject

DataTreeObject::$datatree
DataTreeObject::$order
Methods
Constructor SQLObject_Group (line 810)

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

SQLObject_Group SQLObject_Group (string $name)
  • string $name: The name of the group.
get (line 842)

Gets one of the attributes of the object, or null if it isn't defined.

  • return: The value of the attribute, or null.
mixed get (string $attribute)
  • string $attribute: The attribute to get.

Redefinition of:
DataTreeObject::get()
Gets one of the attributes of the object, or null if it isn't defined.
getId (line 820)

Gets the ID of this object.

  • return: The object's ID.
string getId ()

Redefinition of:
DataTreeObject_Group::getId()
Fetch the ID of this group
getName (line 830)

Gets the name of this object.

  • return: The object name.
string getName ()

Redefinition of:
DataTreeObject::getName()
Gets the name of this object.
save (line 863)

Save group

void save ()

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

Sets one of the attributes of the object.

void set (string $attribute, mixed $value)
  • string $attribute: The attribute to set.
  • mixed $value: The value for $attribute.

Redefinition of:
DataTreeObject::set()
Sets one of the attributes of the object.

Inherited Methods

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:21:42 +0000 by phpDocumentor 1.4.3