Joomla! API

Download
Launch

ContentHistory

Extends AbstractObserver

Table class supporting modified pre-order tree traversal behavior.

since

3.2
package

Joomla CMS

Methods

__construct

Constructor: Associates to $table $this observer

__construct(\Joomla\CMS\Table\TableInterface table) : mixed
inherited
since

3.1.2

Arguments

table

\Joomla\CMS\Table\TableInterfaceTable to be observed

Response

mixed

createObserver

Creates the associated observer instance and attaches it to the $observableObject Creates the associated content history helper class instance $typeAlias can be of the form "{variableName}.type", automatically replacing {variableName} with table-instance variables variableName

createObserver(\JObservableInterface observableObject, array params = array()) : \Joomla\CMS\Table\Observer\ContentHistory
static
since

3.2

Arguments

observableObject

\JObservableInterfaceThe subject object to be observed

params

array( 'typeAlias' => $typeAlias )

Response

\Joomla\CMS\Table\Observer\ContentHistory

onAfterDelete

Post-processor for $table->delete($pk)

onAfterDelete(mixed pk) : void
inherited
since

3.1.2

Arguments

pk

mixedThe deleted primary key value.

onAfterLoad

Post-processor for $table->load($keys, $reset)

onAfterLoad(bool &result, array row) : void
inherited
since

3.1.2

Arguments

result

boolThe result of the load

row

arrayThe loaded (and already binded to $this->table) row of the database table

onAfterStore

Post-processor for $table->store($updateNulls)

onAfterStore(bool &result) : void
inherited
since

3.1.2

Arguments

result

boolThe result of the store

onBeforeDelete

Pre-processor for $table->delete($pk)

onBeforeDelete(mixed pk) : void
inherited
since

3.1.2
throws

\UnexpectedValueException

Arguments

pk

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

onBeforeLoad

Pre-processor for $table->load($keys, $reset)

onBeforeLoad(mixed keys, bool reset) : void
inherited
since

3.1.2

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.

onBeforeStore

Pre-processor for $table->store($updateNulls)

onBeforeStore(bool updateNulls, string tableKey) : void
inherited
since

3.1.2

Arguments

updateNulls

boolThe result of the load

tableKey

stringThe key of the table

parseTypeAlias

Internal method Parses a TypeAlias of the form "{variableName}.type", replacing {variableName} with table-instance variables variableName Storing result into $this->contenthistoryHelper->typeAlias

parseTypeAlias() : void
since

3.2

Properties

contenthistoryHelper

Helper object for storing and deleting version history information associated with this table observer

since

3.2

Type(s)

\JHelperContenthistory

typeAliasPattern

The pattern for this table's TypeAlias

since

3.2

Type(s)

string

_myTableForPregreplaceOnly

Not public, so marking private and deprecated, but needed internally in parseTypeAlias for PHP < 5.4.0 as it's not passing context $this to closure function.

static deprecated
since

3.2
deprecated

Never use this
private

Type(s)

\Joomla\CMS\Table\Observer\ContentHistory

table

The observed table

inherited
since

3.1.2

Type(s)

\Joomla\CMS\Table\Table
  • \ Joomla
  • \ CMS
  • \ Table
  • \ Observer
  • \ ContentHistory