JTable
Abstract Table class
Parent class to all tables.
Located in /libraries/joomla/table/table.php (line 25)
JObject (Subpackage Object)
JTable (Subpackage Table)
| Class | Description |
|---|---|
|
JTableModule
|
Module table |
|
JTableUser
|
Users table |
|
JTableExtension
|
Extension table Replaces plugins table |
|
JTableMenuType
|
Menu Types table |
|
JTableSession
|
Session table |
|
JTableLanguage
|
Languages table. |
|
JTableUsergroup
|
Usergroup table class. |
|
JTableUpdate
|
Update table Stores updates temporarily |
|
JTableNested
|
Table class supporting modified pre-order tree traversal behavior. |
|
JTableViewlevel
|
Viewlevels table class. |
static 
JDatabaseDriver
$_db
(line 57)
JDatabaseDriver object.
boolean
$_locked
= false (line 81)
Indicator that the tables have been locked.
JAccessRules
$_rules
(line 73)
The rules associated with this record.
string
$_tbl
= '' (line 41)
Name of the database table to model.
string
$_tbl_key
= '' (line 49)
Name of the primary key field in the table.
boolean
$_trackAssets
= false (line 65)
Should rows be tracked as ACL assets?
Inherited Variables
Inherited from JObject
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.
- string $table: Name of the table to model.
- string $key: Name of the primary key field in the table.
- JDatabaseDriver $db: JDatabaseDriver object.
- JObject::__construct()
- Class constructor, overridden in descendant classes.
- JTableModule::__construct() : Constructor.
- JTableUser::__construct() : Constructor
- JTableExtension::__construct() : Constructor
- JTableMenuType::__construct() : Constructor
- JTableSession::__construct() : Constructor
- JTableLanguage::__construct() : Constructor
- JTableUsergroup::__construct() : Constructor
- JTableUpdate::__construct() : Constructor
- JTableMenu::__construct() : Constructor
- JTableCategory::__construct() : Constructor
- JTableAsset::__construct() : Constructor
- JTableViewlevel::__construct() : Constructor
Add a filesystem path where JTable should search for table class files.
You may either pass a string or an array of paths.
- mixed $path: A filesystem path or array of filesystem paths to add.
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.
- mixed $src: An associative array or object to bind to the JTable instance.
- mixed $ignore: An optional array or space separated list of properties to ignore while binding.
- JTableModule::bind() : Overloaded bind function.
- JTableUser::bind() : Method to bind the user, user groups, and any other necessary data.
- JTableExtension::bind() : Overloaded bind function
- JTableUpdate::bind() : Overloaded bind function
- JTableMenu::bind() : Overloaded bind function
- JTableCategory::bind() : Overloaded bind function.
- JTableViewlevel::bind() : Method to bind the data.
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.
- JTableModule::check() : Overloaded check function.
- JTableUser::check() : Validation and filtering
- JTableExtension::check() : Overloaded check function
- JTableMenuType::check() : Overloaded check function
- JTableLanguage::check() : Overloaded check method to ensure data integrity
- JTableUsergroup::check() : Method to check the current record to save
- JTableUpdate::check() : Overloaded check function
- JTableNested::check() : Checks that the object is valid and able to be stored.
- JTableMenu::check() : Overloaded check function
- JTableCategory::check() : Override check function
- JTableAsset::check() : Assert that the nested set data is valid.
- JTableViewlevel::check() : Method to check the current record to save
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.
- mixed $pk: An optional primary key value to check out. If not set the instance property value is used.
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 'checked_out' and 'checked_out_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.
- integer $userId: The Id of the user checking out the row.
- mixed $pk: An optional primary key value to check out. If not set the instance property value is used.
Method to delete a row from the database table by primary key value.
- mixed $pk: An optional primary key value to delete. If not set the instance property value is used.
- JTableUser::delete() : Method to delete a user, user groups, and any other necessary data from the database.
- JTableMenuType::delete() : Method to delete a row from the database table by primary key value.
- JTableSession::delete() : Overloaded delete method
- JTableUsergroup::delete() : Delete this object and its dependencies
- JTableNested::delete() : Method to delete a node and, optionally, its child nodes from the table.
Static method to get an instance of a JTable class if it can be found in the table include paths. To add include paths for searching for JTable classes @see JTable::addIncludePath().
- string $type: The type (name) of the JTable class to get an instance of.
- string $prefix: An optional prefix for the table class name.
- array $config: An optional array of configuration values for the JTable object.
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.
- string $where: WHERE clause to use for selecting the MAX(ordering) for the table.
Method to increment the hits for a row if the necessary property/field exists.
- mixed $pk: An optional primary key value to increment. If not set the instance property value is used.
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 $with: The userid to preform the match with, if an item is checked out by this user the function will return false.
- integer $against: The userid to perform the match against when the function is used as a static function.
Method to load a row from the database by primary key and bind the fields to the JTable instance properties.
- mixed $keys: An optional primary key value to load the row by, or an array of fields to match. If not set the instance property value is used.
- boolean $reset: True to reset the default values before loading the new row.
- JTableUser::load() : 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.
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.
- integer $delta: The direction and magnitude to move the row in the ordering sequence.
- string $where: WHERE clause to use for limiting the selection of rows to compact the ordering values.
- JTableNested::move() : 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. The method respects checked out rows by other users and will attempt to checkin rows that it can after adjustments are made.
- mixed $pks: An optional array of primary key values to update. If not set the instance property value is used.
- integer $state: The publishing state. eg. [0 = unpublished, 1 = published]
- integer $userId: The user id of the user performing the operation.
- JTableExtension::publish() : 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.
- JTableNested::publish() : Method to set the publishing state for a node or list of nodes in the database
Method to compact the ordering values of rows in a group of rows defined by an SQL WHERE clause.
- string $where: WHERE clause to use for limiting the selection of rows to compact the ordering values.
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.
Method to provide a shortcut to binding, checking and storing a JTable
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 JTable instance for the property specified.
- mixed $src: An associative array or object to bind to the JTable instance.
- string $orderingFilter: Filter for the order updating
- mixed $ignore: An optional array or space separated list of properties to ignore while binding.
Method to set the JDatabaseDriver object.
- JDatabaseDriver $db: A JDatabaseDriver object to be used by the table object.
Method to set rules for the record.
- mixed $input: A JAccessRules object, JSON string, or array.
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 $updateNulls: True to update fields even if they are null.
- JTableUser::store() : Method to store a row in the database from the JTable instance properties.
- JTableMenuType::store() : Method to store a row in the database from the JTable instance properties.
- JTableLanguage::store() : Overrides JTable::store to check unique fields.
- JTableUsergroup::store() : Inserts a new row if id is zero or updates an existing row in the database table
- JTableNested::store() : Method to store a node in the database table.
- JTableMenu::store() : Overloaded store function
- JTableCategory::store() : Overridden JTable::store to set created/modified and user id.
Method to compute the default name of the asset.
The default name is in the form table_name.id where id is the value of the primary key of the table.
- JTableCategory::_getAssetName() : Method to compute the default name of the asset.
Method to get the parent asset under which to register this one.
By default, all assets are registered to the ROOT node with ID 1. The extended class can define a table and id to lookup. If the asset does not exist it will be created.
- JTable $table: A JTable object for the asset parent.
- integer $id: Id to look up
- JTableCategory::_getAssetParentId() : Get the parent asset id for the record
Method to return the title to use for the asset table. In
tracking the assets a title is kept for each asset so that there is some context available in a unified access manager. Usually this would just return $this->title or $this->name or whatever is being used for the primary name of the row. If this method is not overridden, the asset name is used.
- JTableCategory::_getAssetTitle() : Method to return the title to use for the asset table.
Inherited Methods
Inherited From JObject
JObject::__construct()
JObject::def()