Joomla! API

Constructor

__construct(\Joomla\Database\DatabaseDriver db) :

since	1.7.0

Arguments

db: DatabaseDriverDatabase driver object.

Response

mixed

Magic method to convert the object to a string gracefully.

__toString() :

inherited deprecated

since	1.7.0
deprecated	4.3 will be removed in 6.0 Classes should provide their own __toString() implementation.

Response

stringThe classname.

Method to compute the default name of the asset.

_getAssetName() :

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

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

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

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: TableA Table object for the asset parent.
id: intId to look up

Response

int

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

_getAssetTitle() :

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.

Method to lock the database table for writing.

_lock() :

inherited

since	1.7.0
throws	`RuntimeException`

Response

boolTrue on success.

Method to unlock the database table for writing.

_unlock() :

inherited

since	1.7.0

Response

boolTrue on success.

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

addIncludePath(array|string path = null) : mixed||string|int

inherited static deprecated

since	1.7.0
deprecated	4.3 will be removed in 6.0 Should not be used anymore as tables are loaded through the MvcFactory

Arguments

path: array<string|int, mixed>|stringA filesystem path or array of filesystem paths to add.

Response

array<string|int, mixed>An array of filesystem paths to find Table classes in.

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

appendPrimaryKeys(\Joomla\Database\DatabaseQuery query,  pk = null) :

inherited

since	3.1.4

Arguments

query: DatabaseQueryA query object to append.
pk: mixedOptional primary key parameter.

Response

void

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 = []) :

inherited

since	1.7.0
throws	`InvalidArgumentException`

Arguments

src: array<string|int, mixed>|objectAn associative array or object to bind to the Table instance.
ignore: array<string|int, mixed>|stringAn optional array or space separated list of properties to ignore while binding.

Response

boolTrue on success.

Overloaded check function

check() :

see	Table::check()
since	1.7.0

Response

boolTrue if the object is ok

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

checkIn( pk = null) :

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

boolTrue on success.

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

checkOut( userId,  pk = null) :

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: intThe 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

boolTrue on success.

Sets a default value if not already assigned

def( property,  default = null) :

inherited deprecated

since	1.7.0
deprecated	4.3.0 will be removed in 6.0 Defining dynamic properties should not be used anymore

Arguments

property: stringThe name of the property.
default: mixedThe default value.

Response

mixed

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

delete( pk = null) :

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

boolTrue on success.

Method to create and execute a SELECT WHERE query.

find(mixed||string|int options = []) :

since	1.7.0

Arguments

options: array<string|int, mixed>Array of options

Response

stringThe database query result

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

get( property,  default = null) :

inherited deprecated

since	1.7.0
see	CMSObject::getProperties()
deprecated	4.3.0 will be removed in 6.0 Create a proper getter function for the property

Arguments

property: stringThe name of the property.
default: mixedThe default value.

Response

mixedThe value of the property.

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( column) :

inherited

since	3.4

Arguments

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

Response

stringThe string that identify the special

Method to get the DatabaseDriver object.

getDbo() : \Joomla\Database\DatabaseDriver

inherited

since	1.7.0

Response

DatabaseDriverThe internal database driver object.

Get the most recent error message.

getError( i = null,  toString = true) :

inherited deprecated

since	1.7.0
deprecated	3.1.4 will be removed in 6.0 Will be removed without replacement Catch thrown Exceptions instead of getError

Arguments

i: intOption error index.
toString: boolIndicates if Exception objects should return their error message.

Response

stringError message

Return all errors, if any.

getErrors() : mixed||string|int

inherited deprecated

since	1.7.0
deprecated	3.1.4 will be removed in 6.0 Will be removed without replacement Catch thrown Exceptions instead of getErrors

Response

array<string|int, mixed>Array of error messages.

Get the columns from database table.

getFields( reload = false) :

inherited

since	1.7.0
throws	`UnexpectedValueException`

Arguments

reload: boolflag to reload cache

Response

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

Returns the identity (primary key) value of this record

getId() :

inherited

since	4.0.0

Response

mixed

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

getInstance( type,  prefix = 'JTable', mixed||string|int config = []) : \Joomla\CMS\Table\Table|bool

inherited static deprecated

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

since	1.7.0
deprecated	4.3 will be removed in 6.0 Use the MvcFactory instead Example: Factory::getApplication()->bootComponent('...')->getMVCFactory()->createTable($name, $prefix, $config);

Arguments

type: stringThe type (name) of the Table class to get an instance of.
prefix: stringAn optional prefix for the table class name.
config: array<string|int, mixed>An optional array of configuration values for the Table object.

Response

Table|boolA Table object if found or boolean false on failure.

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

getKeyName( multiple = false) :

inherited

since	1.7.0

Arguments

multiple: boolTrue 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.

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

getNextOrder( where = '') :

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

intThe next ordering value.

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

getPrimaryKey(mixed||string|int keys = []) : mixed||string|int

inherited

since	3.1.4

Arguments

keys: array<string|int, mixed>Optional primary key values to use.

Response

array<string|int, mixed>An array of primary key names and values.

Returns an associative array of object properties.

getProperties( public = true) : mixed||string|int

inherited deprecated

since	1.7.0
see	CMSObject::get()
deprecated	4.3.0 will be removed in 6.0 Create a proper getter function for the property

Arguments

public: boolIf true, returns only the public properties.

Response

array<string|int, mixed>

Method to get the rules for the record.

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

inherited

since	1.7.0

Response

Rulesobject

Method to get the database table name for the class.

getTableName() :

inherited

since	1.7.0

Response

stringThe name of the database table being modeled.

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

hasField( key) :

inherited

since	3.9.11

Arguments

key: stringkey to be checked

Response

bool

Validate that the primary key has been set.

hasPrimaryKey() :

inherited

since	3.1.4

Response

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

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

hit( pk = null) :

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

boolTrue on success.

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

isCheckedOut( with,  against = null) :

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: intThe user ID to perform the match with, if an item is checked out by this user the function will return false.
against: intThe user ID to perform the match against when the function is used as a static function.

Response

boolTrue if checked out.

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

load( keys = null,  reset = true) :

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: boolTrue to reset the default values before loading the new row.

Response

boolTrue if successful. False if row not found.

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

move( delta, string|string[] where = '') :

inherited

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

since	1.7.0
throws	`UnexpectedValueException`

Arguments

delta: intThe direction and magnitude to move the row in the ordering sequence.
where: string|array<string|int, string>WHERE clause to use for limiting the selection of rows to compact the ordering values.

Response

boolTrue on success.

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

publish( pks = null,  state = 1,  userId) :

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: intThe publishing state. eg. [0 = unpublished, 1 = published]
userId: intThe user ID of the user performing the operation.

Response

boolTrue on success; false if $pks is empty.

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

reorder(string|string[] where = '') :

inherited

since	1.7.0
throws	`UnexpectedValueException`

Arguments

where: string|array<string|int, string>WHERE clause to use for limiting the selection of rows to compact the ordering values.

Response

mixedBoolean True on success.

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() :

inherited

since	1.7.0

Response

void

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

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

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<string|int, mixed>|objectAn associative array or object to bind to the Table instance.
orderingFilter: stringFilter for the order updating
ignore: array<string|int, mixed>|stringAn optional array or space separated list of properties to ignore while binding.

Response

boolTrue on success.

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

set( property,  value = null) :

inherited deprecated

since	1.7.0
deprecated	4.3.0 will be removed in 6.0 Create a proper setter function for the property

Arguments

property: stringThe name of the property.
value: mixedThe value of the property to set.

Response

mixedPrevious value of the property.

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

setColumnAlias( column,  columnAlias) :

inherited

since	3.4

Arguments

column: stringThe "special" column (ie ordering)
columnAlias: stringThe real column name (ie foo_ordering)

Response

void

Method to set the DatabaseDriver object.

setDbo(\Joomla\Database\DatabaseDriver db) :

inherited

since	1.7.0

Arguments

db: DatabaseDriverA DatabaseDriver object to be used by the table object.

Response

boolTrue on success.

Add an error message.

setError( error) :

inherited deprecated

since	1.7.0
deprecated	3.1.4 will be removed in 6.0 Will be removed without replacement Throw an Exception instead of using setError

Arguments

error: stringError message.

Response

void

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

setProperties( properties) :

inherited deprecated

since	1.7.0
see	CMSObject::set()
deprecated	4.3.0 will be removed in 6.0 Create a proper setter function for the property

Arguments

properties: mixedEither an associative array or another object.

Response

bool

Method to set rules for the record.

setRules( input) :

inherited

since	1.7.0

Arguments

input: mixedA Rules object, JSON string, or array.

Response

void

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

store( updateNulls = false) :

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: boolTrue to update fields even if they are null.

Response

boolTrue on success.

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<string|int, mixed>

Include paths for searching for Table classes.

inherited static

since	3.0.0

Type(s)

array<string|int, mixed>

Table fields cache

inherited static

since	3.10.4

Type(s)

array<string|int, mixed>

Name of the database table to model.

inherited

since	1.7.0

Type(s)

string

Name of the primary key field in the table.

inherited

since	1.7.0

Type(s)

string

Name of the primary key fields in the table.

inherited

since	3.0.1

Type(s)

array<string|int, mixed>

DatabaseDriver object.

inherited

since	1.7.0

Type(s)

DatabaseDriver

Should rows be tracked as ACL assets?

inherited

since	1.7.0

Type(s)

bool

The rules associated with this record.

inherited

since	1.7.0

Type(s)

Rules

Indicator that the tables have been locked.

inherited

since	1.7.0

Type(s)

bool

Indicates that the primary keys autoincrement.

inherited

since	3.1.4

Type(s)

bool

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

inherited

since	3.4.0

Type(s)

array<string|int, mixed>

Ensure the params in json encoded in the bind method

since	4.0.0

Type(s)

array<string|int, mixed>

Indicates that columns fully support the NULL value in the database

since	4.0.0

Type(s)

bool

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

Custom data can be used by extension developers

since	4.0.0

Type(s)

string

since	1.7.0
package	Joomla CMS

Extension

Methods

__construct

Arguments

Response

__toString

Response

_getAssetName

Response

_getAssetParentId

Arguments

Response

_getAssetTitle

Response

_lock

Response

_unlock

Response

addIncludePath

Arguments

Response

appendPrimaryKeys

Arguments

Response

bind

Arguments

Response

check

Response

checkIn

Arguments

Response

checkOut

Arguments

Response

def

Arguments

Response

delete

Arguments

Response

find

Arguments

Response

get

Arguments

Response

getColumnAlias

Arguments

Response

getDbo

Response

getError

Arguments

Response

getErrors

Response

getFields

Arguments

Response

getId

Response

getInstance

Arguments

Response

getKeyName

Arguments

Response

getNextOrder

Arguments

Response

getPrimaryKey

Arguments

Response

getProperties

Arguments

Response

getRules

Response

getTableName