Class FOFTable

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.

FOFUtilsObject

FOFTable implements JTableInterface

Direct known subclasses

FOFTableNested

Package: FrameworkOnFramework\table
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.0
Located at fof/table/table.php

Methods summary

`public static FOFTable`	# `getInstance( string $type, string $prefix = 'JTable', array $config = array() )` Returns a static object instance of a particular table type Returns a static object instance of a particular table type Parameters `$type` `string` - $type The table name `$prefix` `string` - $prefix The prefix of the table class `$config` `array` - $config Optional configuration variables Returns `FOFTable`
`public static FOFTable &`	# `getAnInstance( string $type = null, string $prefix = 'JTable', array $config = array() )` Returns a static object instance of a particular table type Returns a static object instance of a particular table type Parameters `$type` `string` - $type The table name `$prefix` `string` - $prefix The prefix of the table class `$config` `array` - $config Optional configuration variables Returns `FOFTable`
`public static boolean`	# `forceInstance( string\|null $key = null, FOFTable\|null $instance = null )` Force an instance inside class cache. Setting arguments to null nukes all or part of the cache Force an instance inside class cache. Setting arguments to null nukes all or part of the cache Parameters `$key` `string\|null` - $key TableClass to replace. Set it to null to nuke the entire cache `$instance` `FOFTable\|null` - $instance Instance to replace. Set it to null to nuke $key instances Returns `boolean` - Did I correctly switch the instance?
`public`	# `__construct( string $table, string $key, FOFDatabaseDriver & $db, array $config = array() )` Class Constructor. Class Constructor. Parameters `$table` `string` - $table Name of the database table to model. `$key` `string` - $key Name of the primary key field in the table. `$db` `FOFDatabaseDriver` - &$db Database driver `$config` `array` - $config The configuration parameters array Overrides `FOFUtilsObject::__construct`
`public`	# `setKnownFields( array $fields, boolean $initialise = false )` Replace the entire known fields array Replace the entire known fields array Parameters `$fields` `array` - $fields A simple array of known field names `$initialise` `boolean` - $initialise Should we initialise variables to null?
`public array`	# `getKnownFields( )` Get the known fields array Get the known fields array Returns `array`
`public boolean`	# `hasField( string $fieldName )` Does the specified field exist? Does the specified field exist? Parameters `$fieldName` `string` - $fieldName The field name to search (it's OK to use aliases) Returns `boolean`
`public`	# `addKnownField( string $field, boolean $initialise = false )` Add a field to the known fields array Add a field to the known fields array Parameters `$field` `string` - $field The name of the field to add `$initialise` `boolean` - $initialise Should we initialise the variable to null?
`public`	# `removeKnownField( string $field )` Remove a field from the known fields array Remove a field from the known fields array Parameters `$field` `string` - $field The name of the field to remove
`public boolean`	# `addBehavior( string $name, array $config = array() )` Adds a behavior to the table Adds a behavior to the table Parameters `$name` `string` - $name The name of the behavior `$config` `array` - $config Optional Behavior configuration Returns `boolean`
`public`	# `setTriggerEvents( boolean $newState = false )` Sets the events trigger switch state Sets the events trigger switch state Parameters `$newState` `boolean` - $newState The new state of the switch (what else could it be?)
`public boolean`	# `getTriggerEvents( )` Gets the events trigger switch state Gets the events trigger switch state Returns `boolean`
`public boolean`	# `hasTags( )` Gets the has tags switch state Gets the has tags switch state Returns `boolean`
`public`	# `setHasTags( boolean $newState = false )` Sets the has tags switch state Sets the has tags switch state Parameters `$newState` `boolean` - $newState
`public`	# `setTablePrefix( string $prefix )` Set the class prefix Set the class prefix Parameters `$prefix` `string` - $prefix The prefix
`public`	# `setSkipChecks( array/string $skip )` Sets fields to be skipped from automatic checks. Sets fields to be skipped from automatic checks. Parameters `$skip` `array/string` - $skip Fields to be skipped by automatic checks
`public boolean`	# `load( mixed $keys = null, boolean $reset = true )` Method to load a row from the database by primary key and bind the fields to the FOFTable instance properties. Method to load a row from the database by primary key and bind the fields to the FOFTable instance properties. Parameters `$keys` `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. `$reset` `boolean` - $reset True to reset the default values before loading the new row. Returns `boolean` - True if successful. False if row not found. Throws `RuntimeException` `UnexpectedValueException`
`public boolean`	# `check( )` Based on fields properties (nullable column), checks if the field is required or not Based on fields properties (nullable column), checks if the field is required or not Returns `boolean`
`public`	# `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. 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.
`public static`	# `getClone( )` Clones the current object, after resetting it Clones the current object, after resetting it Returns `static`
`public boolean`	# `canDelete( integer $oid = null, array $joins = null )` Generic check for whether dependencies exist for this object in the db schema Generic check for whether dependencies exist for this object in the db schema Parameters `$oid` `integer` - $oid The primary key of the record to delete `$joins` `array` - $joins Any joins to foreign table, used to determine if dependent records exist Returns `boolean` - True if the record can be deleted
`public boolean`	# `bind( mixed $src, mixed $ignore = array() )` 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. 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. Parameters `$src` `mixed` - $src An associative array or object to bind to the FOFTable instance. `$ignore` `mixed` - $ignore An optional array or space separated list of properties to ignore while binding. Returns `boolean` - True on success. Throws `InvalidArgumentException`
`public boolean`	# `store( boolean $updateNulls = false )` 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. 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. Parameters `$updateNulls` `boolean` - $updateNulls True to update fields even if they are null. Returns `boolean` - True on success.
`public mixed`	# `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. 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. Parameters `$delta` `integer` - $delta The direction and magnitude to move the row in the ordering sequence. `$where` `string` - $where WHERE clause to use for limiting the selection of rows to compact the ordering values. Returns `mixed` - Boolean True on success. Throws `UnexpectedValueException`
`public boolean`	# `reorder( string $where = '' )` Change the ordering of the records of the table Change the ordering of the records of the table Parameters `$where` `string` - $where The WHERE clause of the SQL used to fetch the order Returns `boolean` - True is successful Throws `UnexpectedValueException`
`public boolean`	# `checkout( integer $userId, integer $oid = null )` Check out (lock) a record Check out (lock) a record Parameters `$userId` `integer` - $userId The locking user's ID `$oid` `integer` - $oid The primary key value of the record to lock Returns `boolean` - True on success
`public boolean`	# `checkin( integer $oid = null )` Check in (unlock) a record Check in (unlock) a record Parameters `$oid` `integer` - $oid The primary key value of the record to unlock Returns `boolean` - True on success
`public boolean`	# `isCheckedOut( integer $with = 0, integer $unused_against = null )` Is a record locked? Is a record locked? Parameters `$with` `integer` - $with The userid to preform the match with. If an item is checked out by this user the function will return false. `$unused_against` `integer` - $unused_against Junk inherited from JTable; ignore Returns `boolean` - True if the record is locked by another user Throws `UnexpectedValueException`
`public boolean`	# `copy( integer\|array $cid = null )` Copy (duplicate) one or more records Copy (duplicate) one or more records Parameters `$cid` `integer\|array` - $cid The primary key value (or values) or the record(s) to copy Returns `boolean` - True on success
`public boolean`	# `publish( integer\|array $cid = null, integer $publish = 1, integer $user_id = 0 )` Publish or unpublish records Publish or unpublish records Parameters `$cid` `integer\|array` - $cid The primary key value(s) of the item(s) to publish/unpublish `$publish` `integer` - $publish 1 to publish an item, 0 to unpublish `$user_id` `integer` - $user_id The user ID of the user (un)publishing the item. Returns `boolean` - True on success, false on failure (e.g. record is locked)
`public boolean`	# `delete( integer $oid = null )` Delete a record Delete a record Parameters `$oid` `integer` - $oid The primary key value of the item to delete Returns `boolean` - True on success Throws `UnexpectedValueException`
`public boolean`	# `hit( integer $oid = null, boolean $log = false )` Register a hit on a record Register a hit on a record Parameters `$oid` `integer` - $oid The primary key value of the record `$log` `boolean` - $log Should I log the hit? Returns `boolean` - True on success
`public string`	# `toCSV( string $separator = ',' )` Export the item as a CSV line Export the item as a CSV line Parameters `$separator` `string` - $separator CSV separator. Tip: use "\t" to get a TSV file instead. Returns `string` - The CSV line
`public array`	# `getData( )` Exports the table in array format Exports the table in array format Returns `array`
`public string`	# `getCSVHeader( string $separator = ',' )` Get the header for exporting item list to CSV Get the header for exporting item list to CSV Parameters `$separator` `string` - $separator CSV separator. Tip: use "\t" to get a TSV file instead. Returns `string` - The CSV file's header
`public mixed`	# `getTableFields( string $tableName = null )` Get the columns from a database table. Get the columns from a database table. Parameters `$tableName` `string` - $tableName Table name. If null current table is used Returns `mixed` - An array of the field names, or false if an error occurs.
`public`	# `getTableAlias( )`
`public`	# `setTableAlias( mixed $string )`
`public 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. 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. Parameters `$column` `string` - $column Name of the "special" column (ie ordering, hits etc etc) Returns `string` - The string that identify the special
`public`	# `setColumnAlias( string $column, string $columnAlias )` Method to register a column alias for a "special" column. Method to register a column alias for a "special" column. Parameters `$column` `string` - $column The "special" column (ie ordering) `$columnAlias` `string` - $columnAlias The real column name (ie foo_ordering)
`public FOFDatabaseQuery`	# `getQueryJoin( boolean $asReference = false )` Get a JOIN query, used to join other tables Get a JOIN query, used to join other tables Parameters `$asReference` `boolean` - $asReference Return an object reference instead of a copy Returns `FOFDatabaseQuery` - Query used to join other tables
`public`	# `setQueryJoin( FOFDatabaseQuery $query )` Sets the query with joins to other tables Sets the query with joins to other tables Parameters `$query` `FOFDatabaseQuery` - $query The JOIN query to use
`protected array`	# `getQueryJoinFields( )` Extracts the fields from the join query Extracts the fields from the join query Returns `array` - Fields contained in the join query
`protected array`	# `normalizeSelectFields( array $fields )` Normalizes the fields, returning an associative array with all the fields. Ie array('foobar as foo, bar') becomes array('foobar' => 'foo', 'bar' => 'bar') Normalizes the fields, returning an associative array with all the fields. Ie array('foobar as foo, bar') becomes array('foobar' => 'foo', 'bar' => 'bar') Parameters `$fields` `array` - $fields Array with column fields Returns `array` - Normalized array
`protected boolean`	# `isQuoted( string $column )` Is the field quoted? Is the field quoted? Parameters `$column` `string` - $column Column field Returns `boolean` - Is the field quoted?
`protected boolean`	# `onBeforeBind( object\|array & $from )` The event which runs before binding data to the table 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 onBeforeBind(){ // Your code here return parent::onBeforeBind() && $your_result; } Do not do it the other way around, e.g. return $your_result && parent::onBeforeBind() Due to PHP short-circuit boolean evaluation the parent::onBeforeBind() will not be called if $your_result is false. Parameters `$from` `object\|array` - &$from The data to bind Returns `boolean` - True on success
`protected`	# `onAfterLoad( boolean & $result )` The event which runs after loading a record from the database The event which runs after loading a record from the database Parameters `$result` `boolean` - &$result Did the load succeeded?
`protected boolean`	# `onBeforeStore( boolean $updateNulls )` The event which runs before storing (saving) data to the database The event which runs before storing (saving) data to the database Parameters `$updateNulls` `boolean` - $updateNulls Should nulls be saved as nulls (true) or just skipped over (false)? Returns `boolean` - True to allow saving
`protected boolean`	# `onAfterBind( object\|array & $src )` The event which runs after binding data to the class The event which runs after binding data to the class Parameters `$src` `object\|array` - &$src The data to bind Returns `boolean` - True to allow binding without an error
`protected boolean`	# `onAfterStore( )` The event which runs after storing (saving) data to the database The event which runs after storing (saving) data to the database Returns `boolean` - True to allow saving without an error
`protected boolean`	# `onBeforeMove( boolean $updateNulls )` The event which runs before moving a record The event which runs before moving a record Parameters `$updateNulls` `boolean` - $updateNulls Should nulls be saved as nulls (true) or just skipped over (false)? Returns `boolean` - True to allow moving
`protected boolean`	# `onAfterMove( )` The event which runs after moving a record The event which runs after moving a record Returns `boolean` - True to allow moving without an error
`protected boolean`	# `onBeforeReorder( string $where = '' )` The event which runs before reordering a table The event which runs before reordering a table Parameters `$where` `string` - $where The WHERE clause of the SQL query to run on reordering (record filter) Returns `boolean` - True to allow reordering
`protected boolean`	# `onAfterReorder( )` The event which runs after reordering a table The event which runs after reordering a table Returns `boolean` - True to allow the reordering to complete without an error
`protected boolean`	# `onBeforeDelete( integer $oid )` The event which runs before deleting a record The event which runs before deleting a record Parameters `$oid` `integer` - $oid The PK value of the record to delete Returns `boolean` - True to allow the deletion
`protected boolean`	# `onAfterDelete( integer $oid )` The event which runs after deleting a record The event which runs after deleting a record Parameters `$oid` `integer` - $oid The PK value of the record which was deleted Returns `boolean` - True to allow the deletion without errors
`protected boolean`	# `onBeforeHit( integer $oid, boolean $log )` The event which runs before hitting a record The event which runs before hitting a record Parameters `$oid` `integer` - $oid The PK value of the record to hit `$log` `boolean` - $log Should we log the hit? Returns `boolean` - True to allow the hit
`protected boolean`	# `onAfterHit( integer $oid )` The event which runs after hitting a record The event which runs after hitting a record Parameters `$oid` `integer` - $oid The PK value of the record which was hit Returns `boolean` - True to allow the hitting without errors
`protected boolean`	# `onBeforeCopy( integer $oid )` The even which runs before copying a record The even which runs before copying a record Parameters `$oid` `integer` - $oid The PK value of the record being copied Returns `boolean` - True to allow the copy to take place
`protected boolean`	# `onAfterCopy( integer $oid )` The even which runs after copying a record The even which runs after copying a record Parameters `$oid` `integer` - $oid The PK value of the record which was copied (not the new one) Returns `boolean` - True to allow the copy without errors
`protected boolean`	# `onBeforePublish( integer\|array & $cid, integer $publish )` The event which runs before a record is (un)published The event which runs before a record is (un)published Parameters `$cid` `integer\|array` - &$cid The PK IDs of the records being (un)published `$publish` `integer` - $publish 1 to publish, 0 to unpublish Returns `boolean` - True to allow the (un)publish to proceed
`protected boolean`	# `onAfterReset( )` The event which runs after the object is reset to its default values. The event which runs after the object is reset to its default values. Returns `boolean` - True to allow the reset to complete without errors
`protected boolean`	# `onBeforeReset( )` The even which runs before the object is reset to its default values. The even which runs before the object is reset to its default values. Returns `boolean` - True to allow the reset to complete
`public`	# `setInput( FOFInput $input )` Replace the input object of this table with the provided FOFInput object Replace the input object of this table with the provided FOFInput object Parameters `$input` `FOFInput` - $input The new input object
`public mixed`	# `getFields( )` Get the columns from database table. Get the columns from database table. Deprecated 2.1 Returns `mixed` - An array of the field names, or false if an error occurs.
`public static array`	# `addIncludePath( mixed $path = null )` Add a filesystem path where FOFTable should search for table class files. You may either pass a string or an array of paths. Add a filesystem path where FOFTable should search for table class files. You may either pass a string or an array of paths. Parameters `$path` `mixed` - $path A filesystem path or array of filesystem paths to add. Returns `array` - An array of filesystem paths to find FOFTable classes in.
`protected boolean\|JTableAsset`	# `getAsset( )` Loads the asset table related to this table. This will help tests, too, since we can mock this function. Loads the asset table related to this table. This will help tests, too, since we can mock this function. Returns `boolean\|JTableAsset` - False on failure, otherwise JTableAsset
`public string`	# `getAssetName( )` 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. Returns `string` Throws `UnexpectedValueException`
`public string`	# `getAssetKey( )` 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. Returns `string` Throws `UnexpectedValueException`
`public string`	# `getAssetTitle( )` 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 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. Returns `string` - The string to use as the title in the asset table.
`public integer`	# `getAssetParentId( FOFTable $table = null, integer $id = null )` 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. 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. Parameters `$table` `FOFTable` - $table A FOFTable object for the asset parent. `$id` `integer` - $id Id to look up Returns `integer`
`public`	# `setAssetKey( string $assetKey )` 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. 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. Parameters `$assetKey` `string` - $assetKey The name of the asset key to use
`public string`	# `getTableName( )` Method to get the database table name for the class. Method to get the database table name for the class. Returns `string` - The name of the database table being modeled.
`public string`	# `getKeyName( )` Method to get the primary key field name for the table. Method to get the primary key field name for the table. Returns `string` - The name of the primary key for the table.
`public mixed`	# `getId( )` Returns the identity value of this record Returns the identity value of this record Returns `mixed`
`public FOFDatabaseDriver`	# `getDbo( )` Method to get the FOFDatabaseDriver object. Method to get the FOFDatabaseDriver object. Returns `FOFDatabaseDriver` - The internal database driver object.
`public boolean`	# `setDBO( FOFDatabaseDriver $db )` Method to set the FOFDatabaseDriver object. Method to set the FOFDatabaseDriver object. Parameters `$db` `FOFDatabaseDriver` - $db A FOFDatabaseDriver object to be used by the table object. Returns `boolean` - True on success.
`public`	# `setRules( mixed $input )` Method to set rules for the record. Method to set rules for the record. Parameters `$input` `mixed` - $input A JAccessRules object, JSON string, or array.
`public JAccessRules`	# `getRules( )` Method to get the rules for the record. Method to get the rules for the record. Returns `JAccessRules` - object
`public boolean`	# `isAssetsTracked( )` Method to check if the record is treated as an ACL asset Method to check if the record is treated as an ACL asset Returns `boolean` - [description]
`public`	# `setAssetsTracked( mixed $state )` Method to manually set this record as ACL asset or not. We have to do this since the automatic check is made in the constructor, but here we can't set any alias. So, even if you have an alias for `asset_id`, it wouldn't be reconized and assets won't be tracked. Method to manually set this record as ACL asset or not. We have to do this since the automatic check is made in the constructor, but here we can't set any alias. So, even if you have an alias for `asset_id`, it wouldn't be reconized and assets won't be tracked. Parameters `$state` `mixed` - $state
`public boolean`	# `save( mixed $src, string $orderingFilter = '', mixed $ignore = '' )` 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. 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. Parameters `$src` `mixed` - $src An associative array or object to bind to the FOFTable instance. `$orderingFilter` `string` - $orderingFilter Filter for the order updating `$ignore` `mixed` - $ignore An optional array or space separated list of properties to ignore while binding. Returns `boolean` - True on success.
`public mixed`	# `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. 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. Parameters `$where` `string` - $where WHERE clause to use for selecting the MAX(ordering) for the table. Returns `mixed` - Boolean false an failure or the next ordering value as an integer.
`protected boolean`	# `_lock( )` Method to lock the database table for writing. Method to lock the database table for writing. Returns `boolean` - True on success. Throws `RuntimeException`
`protected boolean`	# `_unlock( )` Method to unlock the database table for writing. Method to unlock the database table for writing. Returns `boolean` - True on success.
`public`	# `setConfig( array $config )`
`public string`	# `getContentType( )` Get the content type for ucm Get the content type for ucm Returns `string` - The content type alias
`public FOFTableRelations`	# `getRelations( )` Returns the table relations object of the current table, lazy-loading it if necessary Returns the table relations object of the current table, lazy-loading it if necessary Returns `FOFTableRelations`
`public FOFConfigProvider`	# `getConfigProvider( )` Gets a reference to the configuration parameters provider for this table Gets a reference to the configuration parameters provider for this table Returns `FOFConfigProvider`
`public string`	# `getConfigProviderKey( )` Returns the configuration parameters provider's key for this table Returns the configuration parameters provider's key for this table Returns `string`
`public null`	# `checkContentType( string $alias = null )` Check if a UCM content type exists for this resource, and create it if it does not Check if a UCM content type exists for this resource, and create it if it does not Parameters `$alias` `string` - $alias The content type alias (optional) Returns `null`
`protected string`	# `getUcmCoreAlias( string $alias, string $null = "null" )` Utility methods that fetches the column name for the field. If it does not exists, returns a "null" string Utility methods that fetches the column name for the field. If it does not exists, returns a "null" string Parameters `$alias` `string` - $alias The alias for the column `$null` `string` - $null What to return if no column exists Returns `string` - The column name

Methods inherited from FOFUtilsObject

__toString(), def(), get(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

Properties summary

`protected static array`	`$instances`	# Cache array for instances Cache array for instances
`protected static array`	`$_includePaths`	# Include paths for searching for FOFTable classes. Include paths for searching for FOFTable classes.
`protected array`	`$config`	# The configuration parameters array The configuration parameters array
`protected string`	`$_tbl`	# Name of the database table to model. Name of the database table to model.
`protected string`	`$_tbl_key`	# Name of the primary key field in the table. Name of the primary key field in the table.
`protected FOFDatabaseDriver`	`$_db`	# FOFDatabaseDriver object. FOFDatabaseDriver object.
`protected boolean`	`$_trackAssets`	# Should rows be tracked as ACL assets? Should rows be tracked as ACL assets?
`protected boolean`	`$_has_tags`	# Does the resource support joomla tags? Does the resource support joomla tags?
`protected JAccessRules`	`$_rules`	# The rules associated with this record. The rules associated with this record.
`protected boolean`	`$_locked`	# Indicator that the tables have been locked. Indicator that the tables have been locked.
`protected boolean`	`$_trigger_events`	# If this is set to true, it triggers automatically plugin events for table actions If this is set to true, it triggers automatically plugin events for table actions
`protected string`	`$_tableAlias`	# Table alias used in queries Table alias used in queries
`protected array`	`$_columnAlias`	# Array with alias for "special" columns such as ordering, hits etc etc Array with alias for "special" columns such as ordering, hits etc etc
`protected boolean`	`$_autoChecks`	# If set to true, it enabled automatic checks on fields based on columns properties If set to true, it enabled automatic checks on fields based on columns properties
`protected array`	`$_skipChecks`	# Array with fields that should be skipped by automatic checks Array with fields that should be skipped by automatic checks
`protected boolean`	`$_tableExists`	# Does the table actually exist? We need that to avoid PHP notices on table-less views. Does the table actually exist? We need that to avoid PHP notices on table-less views.
`protected string`	`$_assetKey`	# 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 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
`protected FOFInput`	`$input`	# The input data The input data
`protected FOFDatabaseQuery`	`$_queryJoin`	# Extended query including joins with other tables Extended query including joins with other tables
`protected string`	`$_tablePrefix`	# The prefix for the table class The prefix for the table class
`protected array`	`$knownFields`	# The known fields for this table The known fields for this table
`protected static array`	`$tableFieldCache`	# A list of table fields, keyed per table A list of table fields, keyed per table
`protected static array`	`$tableCache`	# A list of tables in the database A list of tables in the database
`protected FOFConfigProvider`	`$configProvider`	# An instance of FOFConfigProvider to provision configuration overrides An instance of FOFConfigProvider to provision configuration overrides
`protected FOFTableDispatcherBehavior`	`$tableDispatcher`	# FOFTableDispatcherBehavior for dealing with extra behaviors FOFTableDispatcherBehavior for dealing with extra behaviors
`protected array`	`$default_behaviors`	# List of default behaviors to apply to the table List of default behaviors to apply to the table
`protected FOFTableRelations`	`$_relations`	# The relations object of the table. It's lazy-loaded by getRelations(). The relations object of the table. It's lazy-loaded by getRelations().
`protected string`	`$_configProviderKey`	# The configuration provider's key for this table, e.g. foobar.tables.bar for the #__foobar_bars table. This is set automatically by the constructor The configuration provider's key for this table, e.g. foobar.tables.bar for the #__foobar_bars table. This is set automatically by the constructor
`protected string`	`$contentType`	# The content type of the table. Required if using tags or content history behaviour The content type of the table. Required if using tags or content history behaviour

Properties inherited from FOFUtilsObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFTable

Direct known subclasses

Methods summary

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters