JTable
Abstract Table class
Parent classes to all tables.
Located in /joomla/database/table.php (line 30)
JObject (Subpackage Base) JTable (Subpackage Table)
Class | Description |
---|---|
JTableContent | Content table |
JTableSection | Section table |
JTableUser | Users table |
JTableMenu | Menu table |
JTableSession | Session table |
JTableComponent | Component table |
JTableMenuTypes | Menu Types table |
JTableCategory | Category table |
JTableModule | Module table |
JTablePlugin | Plugin table |
JTableARO | |
JTableAroGroup |
Object constructor to set table and key field
Can be overloaded/supplemented by the child class
- string $table: name of the table in the db schema relating to child class
- string $key: name of the primary key field in the table
- object $db: JDatabase object
- &$db
- JObject::__construct()
- Class constructor, overridden in descendant classes.
- JTableContent::__construct()
- JTableSection::__construct()
- JTableUser::__construct()
- JTableMenu::__construct() : Constructor
- JTableSession::__construct() : Constructor
- JTableComponent::__construct()
- JTableMenuTypes::__construct() : Constructor
- JTableCategory::__construct()
- JTableModule::__construct() : Contructore
- JTablePlugin::__construct()
- JTableARO::__construct()
- JTableAroGroup::__construct()
Add a directory where JTable should search for table types. You may either pass a string or an array of directories.
- string $path: A path to search.
Binds a named array/hash to this object
Can be overloaded/supplemented by the child class
- $from $from: mixed An associative array or object
- $ignore $ignore: mixed An array or space separated list of fields not to bind
- JTableSection::bind() : Overloaded bind function
- JTableUser::bind() : Overloaded bind function
- JTableMenu::bind() : Overloaded bind function
- JTableComponent::bind() : Overloaded bind function
- JTableModule::bind() : Overloaded bind function
- JTablePlugin::bind() : Overloaded bind function
Generic check for whether dependancies exist for this object in the db schema
can be overloaded/supplemented by the child class
- string $msg: Error message returned
- array 2: Optional array to compiles standard joins: format [label=>'Label',name=>'table name',idfield=>'field',joinfield=>'field']
- int $joins: Optional key index
- $oid
Generic check method
Can be overloaded/supplemented by the child class
- JTableContent::check() : Validation and filtering
- JTableSection::check()
- JTableUser::check() : Validation and filtering
- JTableComponent::check() : Validate and filter fields
- JTableMenuTypes::check()
- JTableCategory::check()
- JTableModule::check() : Overloaded check function
Checks in a row
- mixed $oid: The primary key value for the row
Checks out a row
- integer $who: The id of the user
- mixed $oid: The primary key value for the row
Default delete method
can be overloaded/supplemented by the child class
- $oid
Returns a reference to the a Table object, always creating it
- type $type: The table type to instantiate
- string $prefix: A prefix for the table class name
Returns the ordering value to place a new item last in its group
- string $where: query WHERE clause for selecting MAX(ordering).
Check if an item is checked out
This function can be used as a static function too, when you do so you need to also provide the a value for the $against parameter.
- 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.
Loads a row from the database and binds the fields to the object properties
- mixed $oid: Optional primary key. If not specifed, the value of current key is used
Generic Publish/Unpublish function
- array $cid: An array of id numbers
- integer $publish: 0 if unpublishing, 1 if publishing
- integer $user_id: The id of the user performnig the operation
Compacts the ordering sequence of the selected records
- string $where: Additional where query to limit ordering to a particular subset of records
Generic save function
- array $source: Source array for binding to class vars
- string $order_filter: Filter for the order updating
Set the internal database object
- object $db: A JDatabase based object
- &$db
Sets the internal error message
- string $value: The error message
Sets the internal error number
- int $value: Set the error number with this value
Inserts a new row if id is zero or updates an existing row in the database table
Can be overloaded/supplemented by the child class
- boolean $updateNulls: If false, null object variables are not updated
Export item list to xml
- boolean $mapKeysToText: Map foreign keys to text values
- JTableContent::toXML() : Converts record to XML
Inherited Methods
Inherited From JObject
JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()
Documentation generated on Mon, 05 Mar 2007 21:27:40 +0000 by phpDocumentor 1.3.1