Docs For Class JTableUser

Description

Users table

since: 11.1

Located in /libraries/joomla/table/user.php (line 19)

JObject
   |
   --JTable
      |
      --JTableUser

Variable Summary

array $groups

Method Summary

JTableUser __construct (JDatabaseDriver $db)

boolean bind (array $array, [mixed $ignore = ''])

boolean check ()

boolean delete ([integer $userId = null])

boolean load ([integer $userId = null], [boolean $reset = true])

boolean setLastVisit ([integer $timeStamp = null], [integer $userId = null])

boolean store ([boolean $updateNulls = false])

Variables

array $groups (line 27)

Associative array of group ids => group ids for the user

since: 11.1
access: public

Inherited Variables

Inherited from JTable

JTable::$_autoincrement
JTable::$_db
JTable::$_locked
JTable::$_observers
JTable::$_rules
JTable::$_tbl
JTable::$_tbl_key
JTable::$_tbl_keys
JTable::$_trackAssets

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 36)

Constructor

since: 11.1
access: public

JTableUser __construct (JDatabaseDriver $db)

JDatabaseDriver $db: Database driver 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.

bind (line 125)

Method to bind the user, user groups, and any other necessary data.

return: True on success, false on failure.
since: 11.1
access: public

boolean bind (array $array, [mixed $ignore = ''])

array $array: The data to bind.
mixed $ignore: An array or space separated list of fields to ignore.

Redefinition of:

JTable::bind(): Method to bind an associative array or object to the JTable instance.This method only binds properties that are publicly accessible and optionally takes an array of properties to ignore when binding.

check (line 166)

Validation and filtering

return: True if satisfactory
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 364)

Method to delete a user, user groups, and any other necessary data from the database.

return: True on success, false on failure.
since: 11.1
access: public

boolean delete ([integer $userId = null])

integer $userId: An optional user id.

Redefinition of:

JTable::delete(): Method to delete a row from the database table by primary key value.

load (line 57)

Method to load a user, user groups, and any other necessary data from the database so that it can be bound to the user object.

return: True on success, false on failure.
since: 11.1
access: public

boolean load ([integer $userId = null], [boolean $reset = true])

integer $userId: An optional user id.
boolean $reset: False if row not found or on error (internal error state set in that case).

Redefinition of:

JTable::load(): Method to load a row from the database by primary key and bind the fields to the JTable instance properties.

setLastVisit (line 423)

Updates last visit time of user

return: False if an error occurs
since: 11.1
access: public

boolean setLastVisit ([integer $timeStamp = null], [integer $userId = null])

integer $timeStamp: The timestamp, defaults to 'now'.
integer $userId: The user id (optional).

store (line 290)

Method to store a row in the database from the JTable instance properties.

If a primary key value is set the row with that primary key value will be updated with the instance property values. If no primary key value is set a new row will be inserted into the database with the properties from the JTable instance.

return: True on success.
link: http://docs.joomla.org/JTable/store
since: 11.1
access: public

boolean store ([boolean $updateNulls = false])

boolean $updateNulls: True to update fields even if they are null.

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::appendPrimaryKeys()
JTable::attachObserver()
JTable::bind()
JTable::check()
JTable::checkIn()
JTable::checkOut()
JTable::delete()
JTable::getDbo()
JTable::getFields()
JTable::getInstance()
JTable::getKeyName()
JTable::getNextOrder()
JTable::getObserverOfClass()
JTable::getPrimaryKey()
JTable::getRules()
JTable::getTableName()
JTable::hasPrimaryKey()
JTable::hit()
JTable::isCheckedOut()
JTable::load()
JTable::move()
JTable::publish()
JTable::reorder()
JTable::reset()
JTable::save()
JTable::setDBO()
JTable::setRules()
JTable::store()
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()