ContentHistory
Extends TableContent History table.
| since |
3.2 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed properties = null) : mixed
| since |
1.7.0 |
|---|
Arguments
- properties
mixedEither and associative array or another object to set the initial properties of the object.
Response
mixed
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
| 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
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, int id = null) : int
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
intId to look up
Response
int
_getAssetTitle
Method to return the title to use for the asset table.
_getAssetTitle() : string
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() : bool
| since |
1.7.0 |
|---|---|
| throws |
|
Response
boolTrue on success.
_unlock
Method to unlock the database table for writing.
_unlock() : bool
| since |
1.7.0 |
|---|
Response
boolTrue on success.
addIncludePath
Add a filesystem path where Table should search for table class files.
addIncludePath(array|string path = null) : array
| 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
| 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()) : bool
| since |
1.7.0 |
|---|---|
| throws |
|
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
boolTrue on success.
check
Method to perform sanity checks on the Table instance properties to ensure they are safe to store in the database.
check() : bool
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
boolTrue 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) : bool
Checking a row in will allow other users the ability to edit the row.
| since |
1.7.0 |
|---|---|
| throws |
|
Arguments
- pk
mixedAn optional primary key value to check out. If not set the instance property value is used.
Response
boolTrue on success.
checkOut
Method to check a row out if the necessary properties/fields exist.
checkOut(int userId, mixed pk = null) : bool
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 |
|
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.
def
Sets a default value if not already assigned
def(string property, mixed default = null) : mixed
| 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) : bool
| since |
1.7.0 |
|---|---|
| throws |
|
Arguments
- pk
mixedAn optional primary key value to delete. If not set the instance property value is used.
Response
boolTrue on success.
deleteOldVersions
Utility method to remove the oldest versions of an item, saving only the most recent versions.
deleteOldVersions(int maxVersions) : bool
| since |
3.2 |
|---|
Arguments
- maxVersions
intThe maximum number of versions to save. All others will be deleted.
Response
booltrue on success, false on failure.
get
Returns a property of the object or the default value if the property is not set.
get(string property, mixed default = null) : mixed
| since |
1.7.0 |
|---|---|
| see | 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
| 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
| since |
1.7.0 |
|---|
Response
\Joomla\Database\DatabaseDriverThe internal database driver object.
getError
Get the most recent error message.
getError(int i = null, bool toString = true) : string
| since |
1.7.0 |
|---|---|
| deprecated |
3.1.4 JError has been deprecated |
Arguments
- i
intOption error index.- toString
boolIndicates if Exception objects should return their error message.
Response
stringError message
getErrors
Return all errors, if any.
getErrors() : array
| 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(bool reload = false) : mixed
| since |
1.7.0 |
|---|---|
| throws |
|
Arguments
- reload
boolflag to reload cache
Response
mixedAn array of the field names, or false if an error occurs.
getHashMatch
Utility method to get a matching row based on the hash value and id columns.
getHashMatch() : string
This lets us check to make sure we don't save duplicate versions.
| since |
3.2 |
|---|
Response
stringSHA1 hash on success. Empty string on failure.
getId
Returns the identity (primary key) value of this record
getId() : mixed
| 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|bool
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|boolA Table object if found or boolean false on failure.
getKeyName
Method to get the primary key field name for the table.
getKeyName(bool multiple = false) : mixed
| 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.
getNextOrder
Method to get the next ordering value for a group of rows defined by an SQL WHERE clause.
getNextOrder(string where = '') : int
This is useful for placing a new item last in a group of items in the table.
| since |
1.7.0 |
|---|---|
| throws |
|
Arguments
- where
stringWHERE clause to use for selecting the MAX(ordering) for the table.
Response
intThe next ordering value.
getPrimaryKey
Get the primary key values for this table using passed in values as a default.
getPrimaryKey(array keys = array()) : array
| 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(bool public = true) : array
| since |
1.7.0 |
|---|---|
| see | CMSObject::get() |
Arguments
- public
boolIf true, returns only the public properties.
Response
array
getRules
Method to get the rules for the record.
getRules() : \Joomla\CMS\Access\Rules
| since |
1.7.0 |
|---|
Response
\Joomla\CMS\Access\Rulesobject
getSha1
Utility method to get the hash after removing selected values. This lets us detect changes other than modified date (which will change on every save).
getSha1(mixed jsonData, \Joomla\CMS\Table\ContentType typeTable) : string
| since |
3.2 |
|---|
Arguments
- jsonData
mixedEither an object or a string with json-encoded data- typeTable
\Joomla\CMS\Table\ContentTypeTable object with data for this content type
Response
stringSHA1 hash on success. Empty string on failure.
getTableName
Method to get the database table name for the class.
getTableName() : string
| 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) : bool
| since |
3.9.11 |
|---|
Arguments
- key
stringkey to be checked
Response
bool
hasPrimaryKey
Validate that the primary key has been set.
hasPrimaryKey() : bool
| since |
3.1.4 |
|---|
Response
boolTrue 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) : bool
| since |
1.7.0 |
|---|---|
| throws |
|
Arguments
- pk
mixedAn optional primary key value to increment. If not set the instance property value is used.
Response
boolTrue on success.
isCheckedOut
Method to determine if a row is checked out and therefore uneditable by a user.
isCheckedOut(int with, int against = null) : bool
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.
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, bool reset = true) : bool
| since |
1.7.0 |
|---|---|
| throws |
|
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.
move
Method to move a row in the ordering sequence of a group of rows defined by an SQL WHERE clause.
move(int delta, string where = '') : bool
Negative numbers move the row up in the sequence and positive numbers move it down.
| since |
1.7.0 |
|---|---|
| throws |
|
Arguments
- delta
intThe 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
boolTrue on success.
publish
Method to set the publishing state for a row or list of rows in the database table.
publish(mixed pks = null, int state = 1, int userId) : bool
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.
reorder
Method to compact the ordering values of rows in a group of rows defined by an SQL WHERE clause.
reorder(string where = '') : mixed
| since |
1.7.0 |
|---|---|
| throws |
|
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
| 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 = '') : bool
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
boolTrue on success.
set
Modifies a property of the object, creating it if it does not already exist.
set(string property, mixed value = null) : mixed
| 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
| 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) : bool
| since |
1.7.0 |
|---|
Arguments
- db
\Joomla\Database\DatabaseDriverA DatabaseDriver object to be used by the table object.
Response
boolTrue on success.
setError
Add an error message.
setError(string error) : void
| 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) : bool
| since |
1.7.0 |
|---|---|
| see | CMSObject::set() |
Arguments
- properties
mixedEither an associative array or another object.
Response
bool
setRules
Method to set rules for the record.
setRules(mixed input) : void
| 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(bool updateNulls = false) : bool
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.
Properties
ignoreChanges
Array of object fields to unset from the data object before calculating SHA1 hash. This allows us to detect a meaningful change in the database row using the hash. This can be read from the #__content_types content_history_options column.
convertToInt
Array of object fields to convert to integers before calculating SHA1 hash. Some values are stored differently when an item is created than when the item is changed and saved. This works around that issue.
_includePaths
Include paths for searching for Table classes.
_db
DatabaseDriver object.
| since |
1.7.0 |
|---|
Type(s)
\Joomla\Database\DatabaseDriver
_columnAlias
Array with alias for "special" columns such as ordering, hits etc etc
_jsonEncode
An array of key names to be json encoded in the bind function
_supportNullValue
Indicates that columns fully support the NULL value in the database
typeAlias
The UCM type alias. Used for tags, content versioning etc. Leave blank to effectively disable these features.
_errors
An array of error messages or Exception objects.