FOFTable
Implements interfaces:
FrameworkOnFramework Table class. The Table is one part controller, one part model and one part data adapter. It's supposed to handle operations for single records.
Located in /libraries/fof/table/table.php (line 34)
JObject | --FOFTable
static FOFTable
&getAnInstance
([string $type = null], [string $prefix = 'JTable'], [array $config = array()])
static array
$tableCache
= array() (line 199)
A list of tables in the database
static array
$tableFieldCache
= array() (line 192)
A list of table fields, keyed per table
array
$config
= array() (line 55)
The configuration parameters array
FOFConfigProvider
$configProvider
= null (line 206)
An instance of FOFConfigProvider to provision configuration overrides
array
$default_behaviors
= array('tags', 'assets') (line 220)
List of default behaviors to apply to the table
array
$knownFields
= array() (line 185)
The known fields for this table
FOFTableDispatcherBehavior
$tableDispatcher
= null (line 213)
FOFTableDispatcherBehavior for dealing with extra behaviors
type
$_assetKey
= '' (line 157)
The asset key for items in this table. It's usually something in the com_example.viewname format. They asset name will be this key appended with the item's ID, e.g. com_example.viewname.123
boolean
$_autoChecks
= false (line 133)
If set to true, it enabled automatic checks on fields based on columns properties
array
$_columnAlias
= array() (line 126)
Array with alias for "special" columns such as ordering, hits etc etc
JDatabaseDriver
$_db
(line 76)
JDatabaseDriver object.
boolean
$_has_tags
= false (line 90)
Does the resource support joomla tags?
boolean
$_locked
= false (line 104)
Indicator that the tables have been locked.
JDatabaseQuery
$_queryJoin
= null (line 171)
Extended query including joins with other tables
JAccessRules
$_rules
(line 97)
The rules associated with this record.
array
$_skipChecks
= array() (line 140)
Array with fields that should be skipped by automatic checks
string
$_tableAlias
= false (line 119)
Table alias used in queries
boolean
$_tableExists
= true (line 148)
Does the table actually exist? We need that to avoid PHP notices on table-less views.
string
$_tablePrefix
= '' (line 178)
The prefix for the table class
string
$_tbl
= '' (line 62)
Name of the database table to model.
string
$_tbl_key
= '' (line 69)
Name of the primary key field in the table.
boolean
$_trackAssets
= false (line 83)
Should rows be tracked as ACL assets?
boolean
$_trigger_events
= false (line 112)
If this is set to true, it triggers automatically plugin events for table actions
Inherited Variables
Inherited from JObject
Add a filesystem path where FOFTable 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.
Force an instance inside class cache. Setting arguments to null nukes all or part of the cache
- string|null $key: TableClass to replace. Set it to null to nuke the entire cache
- FOFTable|null $instance: Instance to replace. Set it to null to nuke $key instances
Returns a static object instance of a particular table type
- string $type: The table name
- string $prefix: The prefix of the table class
- array $config: Optional configuration variables
Returns a static object instance of a particular table type
- string $type: The table name
- string $prefix: The prefix of the table class
- array $config: Optional configuration variables
Class Constructor.
- string $table: Name of the database table to model.
- string $key: Name of the primary key field in the table.
- JDatabaseDriver &$db: Database driver
- array $config: The configuration parameters array
- JObject::__construct()
- Class constructor, overridden in descendant classes.
Adds a behavior to the table
- string $name: The name of the behavior
- array $config: Optional Behavior configuration
Add a field to the known fields array
- string $field: The name of the field to add
- boolean $initialise: Should we initialise the variable to null?
Method to bind an associative array or object to the FOFTable 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 FOFTable instance.
- mixed $ignore: An optional array or space separated list of properties to ignore while binding.
Generic check for whether dependancies exist for this object in the db schema
- integer $oid: The primary key of the record to delete
- array $joins: Any joins to foreign table, used to determine if dependent records exist
Based on fields properties (nullable column), checks if the field is required or not
Check in (unlock) a record
- integer $oid: The primary key value of the record to unlock
Check out (lock) a record
- integer $userId: The locking user's ID
- integer $oid: The primary key value of the record to lock
Copy (duplicate) one or more records
- integer|array $cid: The primary key value (or values) or the record(s) to copy
Delete a record
- integer $oid: The primary key value of the item to delete
Loads the asset table related to this table.
This will help tests, too, since we can mock this function.
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.
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.
Method to get the parent asset under which to register this one.
By default, all assets are registered to the ROOT node with ID, which will default to 1 if none exists. The extended class can define a table and id to lookup. If the asset does not exist it will be created.
- FOFTable $table: A FOFTable object for the asset parent.
- integer $id: Id to look up
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.
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.
- string $column: Name of the "special" column (ie ordering, hits etc etc)
Get the header for exporting item list to CSV
- string $separator: CSV separator. Tip: use "\t" to get a TSV file instead.
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.
Get a JOIN query, used to join other tables
- boolean $asReference: Return an object reference instead of a copy
Get the columns from a database table.
- string $tableName: Table name. If null current table is used
Method to get the database table name for the class.
Register a hit on a record
- integer $oid: The primary key value of the record
- boolean $log: Should I log the hit?
Method to check if the record is treated as an ACL asset
Is a record locked?
- integer $with: The userid to preform the match with. If an item is checked out by this user the function will return false.
- integer $unused_against: Junk inherited from JTable; ignore
Is the field quoted?
- string $column: Column, passed by reference, so in later version of Joomla I can always quote them
- &$column
Method to load a row from the database by primary key and bind the fields to the FOFTable 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.
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.
Normalizes the fields, returning an associative array with all the fields.
Ie array('foobar as foo, bar') becomes array('foobar' => 'foo', 'bar' => 'bar')
- array $fields: Array with column fields
The event which runs after binding data to the class
- object|array &$src: The data to bind
The even which runs after copying a record
- integer $oid: The PK value of the record which was copied (not the new one)
The event which runs after deleting a record
- integer $oid: The PK value of the record which was deleted
The event which runs after hitting a record
- integer $oid: The PK value of the record which was hit
The event which runs after loading a record from the database
- boolean &$result: Did the load succeeded?
The event which runs after the object is reset to its default values.
The event which runs after storing (saving) data to the database
The event which runs before binding data to the table
NOTE TO 3RD PARTY DEVELOPERS:
When you override the following methods in your child classes, be sure to call parent::method *AFTER* your code, otherwise the plugin events do NOT get triggered
Example: protected function onAfterStore(){ // Your code here return parent::onAfterStore() && $your_result; }
Do not do it the other way around, e.g. return $your_result && parent::onAfterStore() Due to PHP short-circuit boolean evaluation the parent::onAfterStore() will not be called if $your_result is false.
- object|array &$from: The data to bind
The even which runs before copying a record
- integer $oid: The PK value of the record being copied
The event which runs before deleting a record
- integer $oid: The PK value of the record to delete
The event which runs before hitting a record
- integer $oid: The PK value of the record to hit
- boolean $log: Should we log the hit?
The event which runs before moving a record
- boolean $updateNulls: Should nulls be saved as nulls (true) or just skipped over (false)?
The event which runs before a record is (un)published
- integer|array &$cid: The PK IDs of the records being (un)published
-
integer
$publish:
- to publish, 0 to unpublish
The event which runs before reordering a table
- string $where: The WHERE clause of the SQL query to run on reordering (record filter)
The even which runs before the object is reset to its default values.
The event which runs before storing (saving) data to the database
- boolean $updateNulls: Should nulls be saved as nulls (true) or just skipped over (false)?
Publish or unpublish records
- integer|array $cid: The primary key value(s) of the item(s) to publish/unpublish
-
integer
$publish:
- to publish an item, 0 to unpublish
- integer $user_id: The user ID of the user (un)publishing the item.
Remove a field from the known fields array
- string $field: The name of the field to remove
Change the ordering of the records of the table
- string $where: The WHERE clause of the SQL used to fetch the order
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 FOFTable
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 FOFTable instance for the property specified.
- mixed $src: An associative array or object to bind to the FOFTable instance.
- string $orderingFilter: Filter for the order updating
- mixed $ignore: An optional array or space separated list of properties to ignore while binding.
This method sets the asset key for the items of this table. Obviously, it is only meant to be used when you have a table with an asset field.
- string $assetKey: The name of the asset key to use
Method to register a column alias for a "special" column.
- string $column: The "special" column (ie ordering)
- string $columnAlias: The real column name (ie foo_ordering)
Method to set the JDatabaseDriver object.
- JDatabaseDriver $db: A JDatabaseDriver object to be used by the table object.
Sets the has tags switch state
- bool $newState
Replace the input object of this table with the provided FOFInput object
- FOFInput $input: The new input object
Replace the entire known fields array
- array $fields: A simple array of known field names
- boolean $initialise: Should we initialise variables to null?
Sets the query with joins to other tables
- JDatabaseQuery $query: The JOIN query to use
Method to set rules for the record.
- mixed $input: A JAccessRules object, JSON string, or array.
Sets fields to be skipped from automatic checks.
- array/string $skip: Fields to be skipped by automatic checks
Set the class prefix
- string $prefix: The prefix
Sets the events trigger switch state
- boolean $newState: The new state of the switch (what else could it be?)
Method to store a row in the database from the FOFTable 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 FOFTable instance.
- boolean $updateNulls: True to update fields even if they are null.
Export the item as a CSV line
- string $separator: CSV separator. Tip: use "\t" to get a TSV file instead.
Inherited Methods
Inherited From JObject
JObject::__construct()
JObject::def()
Documentation generated on Tue, 19 Nov 2013 15:15:02 +0100 by phpDocumentor 1.4.3