Class JTableUsergroup

Description

Usergroup table class.

  • since: 11.1

Located in /libraries/joomla/database/table/usergroup.php (line 21)

JObject
   |
   --JTable
      |
      --JTableUsergroup
Method Summary
JTableUsergroup __construct (JDatabase &$db)
boolean check ()
mixed delete ([integer $oid = null])
boolean rebuild ([integer $parent_id = 0], [integer $left = 0])
boolean store ([boolean $updateNulls = false])
Variables
Methods
Constructor __construct (line 30)

Constructor

  • since: 11.1
  • access: public
JTableUsergroup __construct (JDatabase &$db)
  • JDatabase &$db: A database connector object

Redefinition of:
JTable::__construct()
Object constructor to set table and key fields. In most cases this will be overridden by child classes to explicitly set the table and key fields for a particular database table.
check (line 42)

Method to check the current record to save

  • return: True on success
  • since: 11.1
  • access: public
boolean check ()

Redefinition of:
JTable::check()
Method to perform sanity checks on the JTable instance properties to ensure they are safe to store in the database. Child classes should override this method to make sure the data they are storing in the database is safe and as expected before storage.
delete (line 148)

Delete this object and its dependencies

  • return: Boolean or Exception.
  • since: 11.1
  • access: public
mixed delete ([integer $oid = null])
  • integer $oid: The primary key of the user group to delete.

Redefinition of:
JTable::delete()
Method to delete a row from the database table by primary key value.
rebuild (line 81)

Method to recursively rebuild the nested set tree.

  • return: True on success
  • since: 11.1
  • access: public
boolean rebuild ([integer $parent_id = 0], [integer $left = 0])
  • integer $parent_id: The root of the tree to rebuild.
  • integer $left: The left id to start with in building the tree.
store (line 128)

Inserts a new row if id is zero or updates an existing row in the database table

  • return: True if successful, false otherwise and an internal error message is set
  • since: 11.1
  • access: public
boolean store ([boolean $updateNulls = false])
  • boolean $updateNulls: If false, null object variables are not updated

Redefinition of:
JTable::store()
Method to store a row in the database from the JTable instance properties.

Inherited Methods

Inherited From JTable

JTable::__construct()
JTable::addIncludePath()
JTable::bind()
JTable::canDelete()
JTable::check()
JTable::checkIn()
JTable::checkOut()
JTable::delete()
JTable::getDbo()
JTable::getFields()
JTable::getInstance()
JTable::getKeyName()
JTable::getNextOrder()
JTable::getRules()
JTable::getTableName()
JTable::hit()
JTable::isCheckedOut()
JTable::load()
JTable::move()
JTable::publish()
JTable::reorder()
JTable::reset()
JTable::save()
JTable::setDBO()
JTable::setRules()
JTable::store()
JTable::toXML()
JTable::_getAssetName()
JTable::_getAssetParentId()
JTable::_getAssetTitle()
JTable::_lock()
JTable::_unlock()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 14:00:30 -0500 by phpDocumentor 1.4.4