Extension

Extends \Joomla\CMS\Table\Table

Extension table

Parent class to all tables.

since

1.7.0

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null) 
inherited
since

1.7.0

Arguments

$properties

mixedEither and associative array or another object to set the initial properties of the object.

__toString

Magic method to convert the object to a string gracefully.

__toString() : string
inherited deprecated
since

1.7.0

deprecated

3.1.4 Classes should provide their own __toString() implementation.

Response

stringThe classname.

_getAssetName

Method to compute the default name of the asset.

_getAssetName() : string
inherited

The default name is in the form table_name.id where id is the value of the primary key of the table.

since

1.7.0

Response

string

_getAssetParentId

Method to get the parent asset under which to register this one.

_getAssetParentId(\Joomla\CMS\Table\Table $table = null, integer $id = null) : integer
inherited

By default, all assets are registered to the ROOT node with ID, which will default to 1 if none exists. An extended class can define a table and ID to lookup. If the asset does not exist it will be created.

since

1.7.0

Arguments

$table

\Joomla\CMS\Table\TableA Table object for the asset parent.

$id

integerId to look up

Response

integer

_getAssetTitle

Method to return the title to use for the asset table.

_getAssetTitle() : string
inherited

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.

since

1.7.0

Response

stringThe string to use as the title in the asset table.

_lock

Method to lock the database table for writing.

_lock() : boolean
inherited
since

1.7.0

throws

\RuntimeException

Response

booleanTrue on success.

_unlock

Method to unlock the database table for writing.

_unlock() : boolean
inherited
since

1.7.0

Response

booleanTrue on success.

addIncludePath

Add a filesystem path where Table should search for table class files.

addIncludePath(array|string $path = null) : array
inherited static deprecated
since

1.7.0

deprecated

5.0 Should not be used anymore as tables are loaded through the MvcFactory

Arguments

$path

array|stringA filesystem path or array of filesystem paths to add.

Response

arrayAn array of filesystem paths to find Table classes in.

appendPrimaryKeys

Method to append the primary keys for this table to a query.

appendPrimaryKeys(\Joomla\Database\DatabaseQuery $query, mixed $pk = null) : void
inherited
since

3.1.4

Arguments

$query

\Joomla\Database\DatabaseQueryA query object to append.

$pk

mixedOptional primary key parameter.

bind

Method to bind an associative array or object to the Table instance.This method only binds properties that are publicly accessible and optionally takes an array of properties to ignore when binding.

bind(array|object $src, array|string $ignore = array()) : boolean
inherited

This method only binds properties that are publicly accessible and optionally takes an array of properties to ignore when binding.

since

1.7.0

throws

\InvalidArgumentException

Arguments

$src

array|objectAn associative array or object to bind to the Table instance.

$ignore

array|stringAn optional array or space separated list of properties to ignore while binding.

Response

booleanTrue on success.

check

Method to perform sanity checks on the Table instance properties to ensure they are safe to store in the database.

check() : boolean
inherited

Child classes should override this method to make sure the data they are storing in the database is safe and as expected before storage.

since

1.7.0

Response

booleanTrue if the instance is sane and able to be stored in the database.

checkIn

Method to check a row in if the necessary properties/fields exist.

checkIn(mixed $pk = null) : boolean
inherited

Checking a row in will allow other users the ability to edit the row.

since

1.7.0

throws

\UnexpectedValueException

Arguments

$pk

mixedAn optional primary key value to check out. If not set the instance property value is used.

Response

booleanTrue on success.

checkOut

Method to check a row out if the necessary properties/fields exist.

checkOut(integer $userId, mixed $pk = null) : boolean
inherited

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.

since

1.7.0

throws

\UnexpectedValueException

Arguments

$userId

integerThe Id of the user checking out the row.

$pk

mixedAn optional primary key value to check out. If not set the instance property value is used.

Response

booleanTrue on success.

def

Sets a default value if not already assigned

def(string $property, mixed $default = null) : mixed
inherited
since

1.7.0

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixed

delete

Method to delete a row from the database table by primary key value.

delete(mixed $pk = null) : boolean
inherited
since

1.7.0

throws

\UnexpectedValueException

Arguments

$pk

mixedAn optional primary key value to delete. If not set the instance property value is used.

Response

booleanTrue on success.

find

Method to create and execute a SELECT WHERE query.

find(array $options = array()) : string
since

1.7.0

Arguments

$options

arrayArray of options

Response

stringThe database query result

get

Returns a property of the object or the default value if the property is not set.

get(string $property, mixed $default = null) : mixed
inherited
since

1.7.0

see \Joomla\CMS\Object\CMSObject::getProperties()

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixedThe value of the property.

getColumnAlias

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.

getColumnAlias(string $column) : string
inherited
since

3.4

Arguments

$column

stringName of the "special" column (ie ordering, hits)

Response

stringThe string that identify the special

getDbo

Method to get the DatabaseDriver object.

getDbo() : \Joomla\Database\DatabaseDriver
inherited
since

1.7.0

Response

\Joomla\Database\DatabaseDriverThe internal database driver object.

getError

Get the most recent error message.

getError(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Arguments

$i

integerOption error index.

$toString

booleanIndicates if Exception objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : array
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Response

arrayArray of error messages.

getFields

Get the columns from database table.

getFields(boolean $reload = false) : mixed
inherited
since

1.7.0

throws

\UnexpectedValueException

Arguments

$reload

booleanflag to reload cache

Response

mixedAn array of the field names, or false if an error occurs.

getId

Returns the identity (primary key) value of this record

getId() : mixed
inherited
since

4.0.0

Response

mixed

getInstance

Static method to get an instance of a Table class if it can be found in the table include paths.

getInstance(string $type, string $prefix = 'JTable', array $config = array()) : \Joomla\CMS\Table\Table|boolean
inherited static deprecated

To add include paths for searching for Table classes see Table::addIncludePath().

since

1.7.0

deprecated

5.0 Use the MvcFactory instead

Arguments

$type

stringThe type (name) of the Table class to get an instance of.

$prefix

stringAn optional prefix for the table class name.

$config

arrayAn optional array of configuration values for the Table object.

Response

\Joomla\CMS\Table\Table|booleanA Table object if found or boolean false on failure.

getKeyName

Method to get the primary key field name for the table.

getKeyName(boolean $multiple = false) : mixed
inherited
since

1.7.0

Arguments

$multiple

booleanTrue to return all primary keys (as an array) or false to return just the first one (as a string).

Response

mixedArray of primary key field names or string containing the first primary key field.

getNextOrder

Method to get the next ordering value for a group of rows defined by an SQL WHERE clause.

getNextOrder(string $where = '') : integer
inherited

This is useful for placing a new item last in a group of items in the table.

since

1.7.0

throws

\UnexpectedValueException

Arguments

$where

stringWHERE clause to use for selecting the MAX(ordering) for the table.

Response

integerThe next ordering value.

getPrimaryKey

Get the primary key values for this table using passed in values as a default.

getPrimaryKey(array $keys = array()) : array
inherited
since

3.1.4

Arguments

$keys

arrayOptional primary key values to use.

Response

arrayAn array of primary key names and values.

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
since

1.7.0

see \Joomla\CMS\Object\CMSObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

getRules

Method to get the rules for the record.

getRules() : \Joomla\CMS\Access\Rules
inherited
since

1.7.0

Response

\Joomla\CMS\Access\Rulesobject

getTableName

Method to get the database table name for the class.

getTableName() : string
inherited
since

1.7.0

Response

stringThe name of the database table being modeled.

hasField

Check if the record has a property (applying a column alias if it exists)

hasField(string $key) : boolean
inherited
since

3.9.11

Arguments

$key

stringkey to be checked

Response

boolean

hasPrimaryKey

Validate that the primary key has been set.

hasPrimaryKey() : boolean
inherited
since

3.1.4

Response

booleanTrue if the primary key(s) have been set.

hit

Method to increment the hits for a row if the necessary property/field exists.

hit(mixed $pk = null) : boolean
inherited
since

1.7.0

throws

\UnexpectedValueException

Arguments

$pk

mixedAn optional primary key value to increment. If not set the instance property value is used.

Response

booleanTrue on success.

isCheckedOut

Method to determine if a row is checked out and therefore uneditable by a user.

isCheckedOut(integer $with, integer $against = null) : boolean
inherited

If the row is checked out by the same user, then it is considered not checked out -- as the user can still edit it.

since

1.7.0

Arguments

$with

integerThe user ID to preform the match with, if an item is checked out by this user the function will return false.

$against

integerThe user ID to perform the match against when the function is used as a static function.

Response

booleanTrue if checked out.

load

Method to load a row from the database by primary key and bind the fields to the Table instance properties.

load(mixed $keys = null, boolean $reset = true) : boolean
inherited
since

1.7.0

throws

\InvalidArgumentException

\RuntimeException

\UnexpectedValueException

Arguments

$keys

mixedAn 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

booleanTrue to reset the default values before loading the new row.

Response

booleanTrue if successful. False if row not found.

move

Method to move a row in the ordering sequence of a group of rows defined by an SQL WHERE clause.

move(integer $delta, string $where = '') : boolean
inherited

Negative numbers move the row up in the sequence and positive numbers move it down.

since

1.7.0

throws

\UnexpectedValueException

Arguments

$delta

integerThe direction and magnitude to move the row in the ordering sequence.

$where

stringWHERE clause to use for limiting the selection of rows to compact the ordering values.

Response

booleanTrue on success.

publish

Method to set the publishing state for a row or list of rows in the database table.

publish(mixed $pks = null, integer $state = 1, integer $userId) : boolean
inherited

The method respects checked out rows by other users and will attempt to checkin rows that it can after adjustments are made.

since

1.7.0

Arguments

$pks

mixedAn optional array of primary key values to update. If not set the instance property value is used.

$state

integerThe publishing state. eg. [0 = unpublished, 1 = published]

$userId

integerThe user ID of the user performing the operation.

Response

booleanTrue on success; false if $pks is empty.

reorder

Method to compact the ordering values of rows in a group of rows defined by an SQL WHERE clause.

reorder(string $where = '') : mixed
inherited
since

1.7.0

throws

\UnexpectedValueException

Arguments

$where

stringWHERE clause to use for limiting the selection of rows to compact the ordering values.

Response

mixedBoolean True on success.

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).

reset() : void
inherited

It will ignore the primary key as well as any private class properties.

since

1.7.0

save

Method to provide a shortcut to binding, checking and storing a Table instance to the database table.

save(array|object $src, string $orderingFilter = '', array|string $ignore = '') : boolean
inherited

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.

since

1.7.0

Arguments

$src

array|objectAn associative array or object to bind to the Table instance.

$orderingFilter

stringFilter for the order updating

$ignore

array|stringAn optional array or space separated list of properties to ignore while binding.

Response

booleanTrue on success.

set

Modifies a property of the object, creating it if it does not already exist.

set(string $property, mixed $value = null) : mixed
inherited
since

1.7.0

Arguments

$property

stringThe name of the property.

$value

mixedThe value of the property to set.

Response

mixedPrevious value of the property.

setColumnAlias

Method to register a column alias for a "special" column.

setColumnAlias(string $column, string $columnAlias) : void
inherited
since

3.4

Arguments

$column

stringThe "special" column (ie ordering)

$columnAlias

stringThe real column name (ie foo_ordering)

setDbo

Method to set the DatabaseDriver object.

setDbo(\Joomla\Database\DatabaseDriver $db) : boolean
inherited
since

1.7.0

Arguments

$db

\Joomla\Database\DatabaseDriverA DatabaseDriver object to be used by the table object.

Response

booleanTrue on success.

setError

Add an error message.

setError(string $error) : void
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Arguments

$error

stringError message.

setProperties

Set the object properties based on a named array/hash.

setProperties(mixed $properties) : boolean
inherited
since

1.7.0

see \Joomla\CMS\Object\CMSObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

setRules

Method to set rules for the record.

setRules(mixed $input) : void
inherited
since

1.7.0

Arguments

$input

mixedA Rules object, JSON string, or array.

store

Method to store a row in the database from the Table instance properties.

store(boolean $updateNulls = false) : boolean
inherited

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.

since

1.7.0

Arguments

$updateNulls

booleanTrue to update fields even if they are null.

Response

booleanTrue on success.

Properties

_supportNullValue

Indicates that columns fully support the NULL value in the database

inherited
since

3.10.0

Type(s)

boolean

_jsonEncode

An array of key names to be json encoded in the bind function

inherited
since

3.3

Type(s)

array

custom_data

Custom data can be used by extension developers

since

4.0.0

Type(s)

string

_includePaths

Include paths for searching for Table classes.

inherited static
since

3.0.0

Type(s)

array

_tbl

Name of the database table to model.

inherited
since

1.7.0

Type(s)

string

_tbl_key

Name of the primary key field in the table.

inherited
since

1.7.0

Type(s)

string

_tbl_keys

Name of the primary key fields in the table.

inherited
since

3.0.1

Type(s)

array

_db

DatabaseDriver object.

inherited
since

1.7.0

Type(s)

\Joomla\Database\DatabaseDriver

_trackAssets

Should rows be tracked as ACL assets?

inherited
since

1.7.0

Type(s)

boolean

_rules

The rules associated with this record.

inherited
since

1.7.0

Type(s)

\Joomla\CMS\Access\Rules

_locked

Indicator that the tables have been locked.

inherited
since

1.7.0

Type(s)

boolean

_autoincrement

Indicates that the primary keys autoincrement.

inherited
since

3.1.4

Type(s)

boolean

_columnAlias

Array with alias for "special" columns such as ordering, hits etc etc

inherited
since

3.4.0

Type(s)

array

typeAlias

The UCM type alias. Used for tags, content versioning etc. Leave blank to effectively disable these features.

inherited
since

4.0.0

Type(s)

string

_errors

An array of error messages or Exception objects.

inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Type(s)

array