[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_contenthistory/src/Model/ -> HistoryModel.php (summary)

(no description)

Copyright: (C) 2013 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 394 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

HistoryModel:: (10 methods):
  __construct()
  canEdit()
  canDelete()
  delete()
  getItems()
  getTable()
  keep()
  populateState()
  getListQuery()
  getSha1Hash()


Class: HistoryModel  - X-Ref

Methods supporting a list of contenthistory records.

__construct($config = array()   X-Ref
Constructor.

param: array                $config   An optional associative array of configuration settings.
param: MVCFactoryInterface  $factory  The factory.

canEdit($record)   X-Ref
Method to test whether a record is editable

param: ContentHistory  $record  A Table object.
return: boolean  True if allowed to edit the record. Defaults to the permission set in the component.

canDelete($record)   X-Ref
Method to test whether a history record can be deleted. Note that we check whether we have edit permissions
for the content item row.

param: ContentHistory  $record  A Table object.
return: boolean  True if allowed to delete the record. Defaults to the permission set in the component.

delete(&$pks)   X-Ref
Method to delete one or more records from content history table.

param: array  $pks  An array of record primary keys.
return: boolean  True if successful, false if an error occurs.

getItems()   X-Ref
Method to get an array of data items.

return: mixed  An array of data items on success, false on failure.

getTable($type = 'ContentHistory', $prefix = 'Joomla\\CMS\\Table\\', $config = array()   X-Ref
Method to get a table object, load it if necessary.

param: string  $type    The table name. Optional.
param: string  $prefix  The class prefix. Optional.
param: array   $config  Configuration array for model. Optional.
return: Table   A Table object

keep(&$pks)   X-Ref
Method to toggle on and off the keep forever value for one or more records from content history table.

param: array  $pks  An array of record primary keys.
return: boolean  True if successful, false if an error occurs.

populateState($ordering = 'h.save_date', $direction = 'DESC')   X-Ref
Method to auto-populate the model state.

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

param: string  $ordering   An optional ordering field.
param: string  $direction  An optional direction (asc|desc).
return: void

getListQuery()   X-Ref
Build an SQL query to load the list data.

return: \Joomla\Database\DatabaseQuery

getSha1Hash()   X-Ref
Get the sha1 hash value for the current item being edited.

return: string  sha1 hash of row data



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer