Joomla! Platform 12.1

Download

Demo

Class JTableUser

Description
Description | Variables (details) | Methods (details)

Users table

  • since: 11.1

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

Class JObject   (Subpackage Object)

Abstract class JTable
   
   Class JTableUser   (Subpackage Table)
Variable Summary
Description | Variables (details) | Methods (details)
Variable array $groups
Method Summary
Description | Variables (details) | Methods (details)
Constructor JTableUser __construct (JDatabaseDriver $db)
Method boolean bind (array $array, [mixed $ignore = ''])
Method boolean check ()
Method boolean delete ([integer $userId = null])
Method boolean load ([integer $userId = null], [boolean $reset = true])
Method boolean setLastVisit ([integer $timeStamp = null], [integer $userId = null])
Method boolean store ([boolean $updateNulls = false])
Variables
Description | Variables (details) | Methods (details)
array $groups (line 27)

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

  • since: 11.1
  • access: public

Inherited Variables

Inherited from JTable

Variable JTable::$_db
 Variable JTable::$_locked
 Variable JTable::$_rules
 Variable JTable::$_tbl
 Variable JTable::$_tbl_key
 Variable JTable::$_trackAssets

Inherited from JObject

Variable JObject::$_errors
Methods
Description | Variables (details) Methods (details)
Constructor __construct (line 36)

Constructor

  • since: 11.1
  • access: public
JTableUser __construct (JDatabaseDriver $db)
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 122)

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 163)

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 339)

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 395)

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 274)

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.

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::bind()
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::_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()
Support Joomla!
/html>