Class ContenthistoryModelHistory

Description

Methods supporting a list of contenthistory records.

  • since: 3.2

Located in /administrator/components/com_contenthistory/models/history.php (line 19)

JObject
   |
   --JModelLegacy
      |
      --JModelList
         |
         --ContenthistoryModelHistory
Method Summary
 ContenthistoryModelHistory __construct ([array $config = array()])
 boolean canEdit (object $record)
 boolean delete (array &$pks)
 string getSha1Hash ()
 JTable getTable ([string $type = 'Contenthistory'], [string $prefix = 'JTable'], [array $config = array()])
 boolean keep (array &$pks)
 void populateState ([string $ordering = null], [string $direction = null])
Variables
Methods
Constructor __construct (line 29)

Constructor.

ContenthistoryModelHistory __construct ([array $config = array()])
  • array $config: An optional associative array of configuration settings.

Redefinition of:
JModelList::__construct()
Constructor.
canEdit (line 54)

Method to test whether a history record can be deleted. Note that we check whether we have edit permissions for the content item row.

  • return: True if allowed to delete the record. Defaults to the permission set in the component.
  • since: 3.2
  • access: protected
boolean canEdit (object $record)
  • object $record: A JTable object.
delete (line 87)

Method to delete one or more records from content history table.

  • return: True if successful, false if an error occurs.
  • since: 3.2
  • access: public
boolean delete (array &$pks)
  • array &$pks: An array of record primary keys.
getListQuery (line 259)

Build an SQL query to load the list data.

  • since: 3.2
  • access: protected
JDatabaseQuery getListQuery ()

Redefinition of:
JModelList::getListQuery()
Method to get a JDatabaseQuery object for retrieving the data set from a database.
getSha1Hash (line 296)

Get the sha1 hash value for the current item being edited.

  • return: sha1 hash of row data
  • since: 3.2
  • access: protected
string getSha1Hash ()
getTable (line 151)

Method to get a table object, load it if necessary.

  • return: A JTable object
  • since: 3.2
  • access: public
JTable getTable ([string $type = 'Contenthistory'], [string $prefix = 'JTable'], [array $config = array()])
  • string $type: The table name. Optional.
  • string $prefix: The class prefix. Optional.
  • array $config: Configuration array for model. Optional.

Redefinition of:
JModelLegacy::getTable()
Method to get a table object, load it if necessary.
keep (line 165)

Method to toggle on and off the keep forever value for one or more records from content history table.

  • return: True if successful, false if an error occurs.
  • since: 3.2
  • access: public
boolean keep (array &$pks)
  • array &$pks: An array of record primary keys.
populateState (line 232)

Method to auto-populate the model state.

Note. Calling getState in this method will result in recursion.

  • since: 3.2
  • access: protected
void populateState ([string $ordering = null], [string $direction = null])
  • string $ordering: An optional ordering field.
  • string $direction: An optional direction (asc|desc).

Redefinition of:
JModelList::populateState()
Method to auto-populate the model state.

Inherited Methods

Inherited From JModelList

 JModelList::__construct()
 JModelList::getActiveFilters()
 JModelList::getFilterForm()
 JModelList::getItems()
 JModelList::getListQuery()
 JModelList::getPagination()
 JModelList::getStart()
 JModelList::getStoreId()
 JModelList::getTotal()
 JModelList::getUserStateFromRequest()
 JModelList::loadForm()
 JModelList::loadFormData()
 JModelList::populateState()
 JModelList::preprocessForm()
 JModelList::_getListQuery()

Inherited From JModelLegacy

 JModelLegacy::__construct()
 JModelLegacy::addIncludePath()
 JModelLegacy::addTablePath()
 JModelLegacy::cleanCache()
 JModelLegacy::getDbo()
 JModelLegacy::getInstance()
 JModelLegacy::getName()
 JModelLegacy::getState()
 JModelLegacy::getTable()
 JModelLegacy::loadHistory()
 JModelLegacy::populateState()
 JModelLegacy::setDbo()
 JModelLegacy::setState()
 JModelLegacy::_createFileName()
 JModelLegacy::_createTable()
 JModelLegacy::_getList()
 JModelLegacy::_getListCount()

Inherited From JObject

 JObject::__construct()
 JObject::def()
 JObject::get()
 JObject::getError()
 JObject::getErrors()
 JObject::getProperties()
 JObject::set()
 JObject::setError()
 JObject::setProperties()
 JObject::__toString()

Documentation generated on Tue, 19 Nov 2013 15:04:43 +0100 by phpDocumentor 1.4.3