Class Table - list of methods

Object constructor to set table and key fields. In most cases this will be overridden by child classes to explicitly set the table and key fields for a particular database table.

• string $table Name of the table to model.
• mixed $key Name of the primary key field in the table or array of field names that compose the primary key.
• \Joomla\Database\DatabaseDriver $db DatabaseDriver object.
• \Joomla\Event\DispatcherInterface $dispatcher Event dispatcher for this table

• 1.7.0

Get the columns from database table.

• bool $reload flag to reload cache

• mixed An array of the field names, or false if an error occurs.

• 1.7.0

• \UnexpectedValueException

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

• string $type The type (name) of the Table class to get an instance of.
• string $prefix An optional prefix for the table class name.
• array $config An optional array of configuration values for the Table object.

• \Joomla\CMS\Table\Table|bool A Table object if found or boolean false on failure.

• 1.7.0

• 5.0

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

• array|string $path A filesystem path or array of filesystem paths to add.

• array An array of filesystem paths to find Table classes in.

• 1.7.0

• 5.0

Method to compute the default name of the asset.

• string

• 1.7.0

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

• string The string to use as the title in the asset table.

• 1.7.0

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

• \Joomla\CMS\Table\Table $table A Table object for the asset parent.
• int $id Id to look up

• int

• 1.7.0

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

• \Joomla\Database\DatabaseQuery $query A query object to append.
• mixed $pk Optional primary key parameter.

• void

• 3.1.4

Method to get the database table name for the class.

• string The name of the database table being modeled.

• 1.7.0

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

• bool $multiple True to return all primary keys (as an array) or false to return just the first one (as a string).

• mixed Array of primary key field names or string containing the first primary key field.

• 1.7.0

Returns the identity (primary key) value of this record

• mixed

• 4.0.0

Method to get the DatabaseDriver object.

• \Joomla\Database\DatabaseDriver The internal database driver object.

• 1.7.0

Method to set the DatabaseDriver object.

• \Joomla\Database\DatabaseDriver $db A DatabaseDriver object to be used by the table object.

• bool True on success.

• 1.7.0

Method to set rules for the record.

• mixed $input A Rules object, JSON string, or array.

• void

• 1.7.0

Method to get the rules for the record.

• \Joomla\CMS\Access\Rules object

• 1.7.0

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

• void

• 1.7.0

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.

• array|object $src An associative array or object to bind to the Table instance.
• array|string $ignore An optional array or space separated list of properties to ignore while binding.

• bool True on success.

• 1.7.0

• \InvalidArgumentException

Method to load a row from the database by primary key and bind the fields to the Table 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.
• bool $reset True to reset the default values before loading the new row.

• bool True if successful. False if row not found.

• 1.7.0

• \InvalidArgumentException
• \RuntimeException
• \UnexpectedValueException

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

• bool True if the instance is sane and able to be stored in the database.

• 1.7.0

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

• bool $updateNulls True to update fields even if they are null.

• bool True on success.

• 1.7.0

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

• array|object $src An associative array or object to bind to the Table instance.
• string $orderingFilter Filter for the order updating
• array|string $ignore An optional array or space separated list of properties to ignore while binding.

• bool True on success.

• 1.7.0

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

• mixed $pk An optional primary key value to delete. If not set the instance property value is used.

• bool True on success.

• 1.7.0

• \UnexpectedValueException

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

• int $userId The Id of the user checking out the row.
• mixed $pk An optional primary key value to check out. If not set the instance property value is used.

• bool True on success.

• 1.7.0

• \UnexpectedValueException

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

• mixed $pk An optional primary key value to check out. If not set the instance property value is used.

• bool True on success.

• 1.7.0

• \UnexpectedValueException

Validate that the primary key has been set.

• bool True if the primary key(s) have been set.

• 3.1.4

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

• mixed $pk An optional primary key value to increment. If not set the instance property value is used.

• bool True on success.

• 1.7.0

• \UnexpectedValueException

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

• int $with The user ID to preform the match with, if an item is checked out by this user the function will return false.
• int $against The user ID to perform the match against when the function is used as a static function.

• bool True if checked out.

• 1.7.0

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

• string $where WHERE clause to use for selecting the MAX(ordering) for the table.

• int The next ordering value.

• 1.7.0

• \UnexpectedValueException

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

• array $keys Optional primary key values to use.

• array An array of primary key names and values.

• 3.1.4

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

• string $where WHERE clause to use for limiting the selection of rows to compact the ordering values.

• mixed Boolean True on success.

• 1.7.0

• \UnexpectedValueException

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

• int $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.

• bool True on success.

• 1.7.0

• \UnexpectedValueException

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

• mixed $pks An optional array of primary key values to update. If not set the instance property value is used.
• int $state The publishing state. eg. [0 = unpublished, 1 = published]
• int $userId The user ID of the user performing the operation.

• bool True on success; false if $pks is empty.

• 1.7.0

Method to lock the database table for writing.

• bool True on success.

• 1.7.0

• \RuntimeException

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)

• string The string that identify the special

• 3.4

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)

• void

• 3.4

Method to unlock the database table for writing.

• bool True on success.

• 1.7.0

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

• string $key key to be checked

• bool

• 3.9.11