User
class User extends Table
Users table
Properties
| array | $groups | Associative array of group ids => group ids for the user |
Methods
Implement \JObservableInterface: Adds an observer to this instance.
Gets the instance of the observer of class $observerClass
Static method to get an instance of a Table class if it can be found in the table include paths.
Add a filesystem path where Table should search for table class files.
Method to append the primary keys for this table to a query.
Method to get the primary key field name for the table.
Method to reset class properties to the defaults set in the class definition. It will ignore the primary key as well as any private class properties (except $_errors).
Method to bind the user, user groups, and any other necessary data.
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.
Validation and filtering
Method to store a row in the database from the Table instance properties.
Method to provide a shortcut to binding, checking and storing a Table instance to the database table.
Method to delete a user, user groups, and any other necessary data from the database.
Method to check a row out if the necessary properties/fields exist.
Method to check a row in if the necessary properties/fields exist.
Method to increment the hits for a row if the necessary property/field exists.
Method to determine if a row is checked out and therefore uneditable by a user.
Method to get the next ordering value for a group of rows defined by an SQL WHERE clause.
Get the primary key values for this table using passed in values as a default.
Method to compact the ordering values of rows in a group of rows defined by an SQL WHERE clause.
Method to move a row in the ordering sequence of a group of rows defined by an SQL WHERE clause.
Method to set the publishing state for a row or list of rows in the database table.
Method to return the real name of a "special" column such as ordering, hits, published etc etc. In this way you are free to follow your db naming convention and use the built in \Joomla functions.
Method to register a column alias for a "special" column.
Updates last visit time of user
Details
void
attachObserver(
JObserverInterface $observer)
Implement \JObservableInterface: Adds an observer to this instance.
This method will be called fron the constructor of classes implementing \JObserverInterface which is instanciated by the constructor of $this with \JObserverMapper::attachAllObservers($this)
JTableObserver|null
getObserverOfClass(
string $observerClass)
Gets the instance of the observer of class $observerClass
static
Table|boolean
getInstance(
string $type,
string $prefix = 'JTable',
array $config = array())
Static method to get an instance of a Table class if it can be found in the table include paths.
To add include paths for searching for Table classes see Table::addIncludePath().
static
array
addIncludePath(
array|string $path = null)
Add a filesystem path where Table should search for table class files.
void
appendPrimaryKeys(
JDatabaseQuery $query,
mixed $pk = null)
Method to append the primary keys for this table to a query.
mixed
getKeyName(
boolean $multiple = false)
Method to get the primary key field name for the table.
void
reset()
Method to reset class properties to the defaults set in the class definition. It will ignore the primary key as well as any private class properties (except $_errors).
boolean
bind(
array $array,
array|string $ignore = '')
Method to bind the user, user groups, and any other necessary data.
boolean
load(
integer $userId = null,
boolean $reset = true)
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.
boolean
store(
boolean $updateNulls = false)
Method to store a row in the database from the Table 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 Table instance.
boolean
save(
array|object $src,
string $orderingFilter = '',
array|string $ignore = '')
Method to provide a shortcut to binding, checking and storing a Table instance to the database table.
The method will check a row in once the data has been stored and if an ordering filter is present will attempt to reorder the table rows based on the filter. The ordering filter is an instance property name. The rows that will be reordered are those whose value matches the Table instance for the property specified.
boolean
delete(
integer $userId = null)
Method to delete a user, user groups, and any other necessary data from the database.
boolean
checkOut(
integer $userId,
mixed $pk = null)
Method to check a row out if the necessary properties/fields exist.
To prevent race conditions while editing rows in a database, a row can be checked out if the fields 'checkedout' and 'checkedout_time' are available. While a row is checked out, any attempt to store the row by a user other than the one who checked the row out should be held until the row is checked in again.
boolean
checkIn(
mixed $pk = null)
Method to check a row in if the necessary properties/fields exist.
Checking a row in will allow other users the ability to edit the row.
boolean
hit(
mixed $pk = null)
Method to increment the hits for a row if the necessary property/field exists.
boolean
isCheckedOut(
integer $with,
integer $against = null)
Method to determine if a row is checked out and therefore uneditable by a user.
If the row is checked out by the same user, then it is considered not checked out -- as the user can still edit it.
integer
getNextOrder(
string $where = '')
Method to get the next ordering value for a group of rows defined by an SQL WHERE clause.
This is useful for placing a new item last in a group of items in the table.
array
getPrimaryKey(
array $keys = array())
Get the primary key values for this table using passed in values as a default.
mixed
reorder(
string $where = '')
Method to compact the ordering values of rows in a group of rows defined by an SQL WHERE clause.
boolean
move(
integer $delta,
string $where = '')
Method to move a row in the ordering sequence of a group of rows defined by an SQL WHERE clause.
Negative numbers move the row up in the sequence and positive numbers move it down.
boolean
publish(
mixed $pks = null,
integer $state = 1,
integer $userId)
Method to set the publishing state for a row or list of rows in the database table.
The method respects checked out rows by other users and will attempt to checkin rows that it can after adjustments are made.
string
getColumnAlias(
string $column)
Method to return the real name of a "special" column such as ordering, hits, published etc etc. In this way you are free to follow your db naming convention and use the built in \Joomla functions.