Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe HistoryModel
+ Graphe d'héritage de HistoryModel:

Fonctions membres publiques

 __construct ($config=array(), MVCFactoryInterface $factory=null)
 
 delete (&$pks)
 
 getItems ()
 
 getTable ($type='ContentHistory', $prefix='Joomla\\CMS\\Table\\', $config=array())
 
 keep (&$pks)
 
- Fonctions membres publiques hérités de ListModel
 __construct ($config=array(), MVCFactoryInterface $factory=null)
 
 getIsEmptyState ()
 
 getActiveFilters ()
 
 getItems ()
 
 getPagination ()
 
 getTotal ()
 
 getStart ()
 
 getFilterForm ($data=array(), $loadData=true)
 
 getUserStateFromRequest ($key, $request, $default=null, $type='none', $resetPage=true)
 
- Fonctions membres publiques hérités de BaseDatabaseModel
 __construct ($config=array(), MVCFactoryInterface $factory=null)
 
 getTable ($name='', $prefix='', $options=array())
 
 isCheckedOut ($item)
 
 getDbo ()
 
 setDbo (DatabaseInterface $db=null)
 
 __get ($name)
 
- Fonctions membres publiques hérités de BaseModel
 __construct ($config=array())
 
 getName ()
 
- Fonctions membres publiques hérités de CMSObject
 __construct ($properties=null)
 
 __toString ()
 
 def ($property, $default=null)
 
 get ($property, $default=null)
 
 getProperties ($public=true)
 
 getError ($i=null, $toString=true)
 
 getErrors ()
 
 set ($property, $value=null)
 
 setProperties ($properties)
 
 setError ($error)
 
- Fonctions membres publiques hérités de StatefulModelInterface
 getState ($property=null, $default=null)
 
 setState ($property, $value=null)
 
- Fonctions membres publiques hérités de DispatcherAwareInterface
 setDispatcher (DispatcherInterface $dispatcher)
 
- Fonctions membres publiques hérités de CurrentUserInterface
 setCurrentUser (User $currentUser)
 
- Fonctions membres publiques hérités de CacheControllerFactoryAwareInterface
 setCacheControllerFactory (CacheControllerFactoryInterface $factory)
 
- Fonctions membres publiques hérités de DatabaseAwareInterface
 setDatabase (DatabaseInterface $db)
 
- Fonctions membres publiques hérités de FormFactoryAwareInterface
 setFormFactory (FormFactoryInterface $factory)
 

Fonctions membres protégées

 canDelete ($record)
 
 populateState ($ordering='h.save_date', $direction='DESC')
 
 getListQuery ()
 
 getSha1Hash ()
 
- Fonctions membres protégées hérités de ListModel
 getEmptyStateQuery ()
 
 _getListQuery ()
 
 getListQuery ()
 
 getStoreId ($id='')
 
 loadFormData ()
 
 populateState ($ordering=null, $direction=null)
 
 refineSearchStringToRegex ($search, $regexDelimiter='/')
 
- Fonctions membres protégées hérités de BaseDatabaseModel
 _getList ($query, $limitstart=0, $limit=0)
 
 _getListCount ($query)
 
 _createTable ($name, $prefix='Table', $config=array())
 
 bootComponent ($component)
 
 dispatchEvent (EventInterface $event)
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de BaseModel
static addIncludePath ($path='', $prefix='')
 
- Attributs protégés hérités de ListModel
 $cache = array()
 
 $context = null
 
 $filter_fields = array()
 
 $query = array()
 
 $lastQueryStoreId = null
 
 $filterFormName = null
 
 $htmlFormName = 'adminForm'
 
 $filterBlacklist = array()
 
 $filterForbiddenList = array()
 
 $listBlacklist = array('select')
 
 $listForbiddenList = array('select')
 
- Attributs protégés hérités de BaseDatabaseModel
 $option = null
 
 $event_clean_cache = null
 
- Attributs protégés hérités de BaseModel
 $name
 
- Attributs protégés hérités de CMSObject
 $_errors = array()
 
- Attributs protégés statiques hérités de BaseModel
static $paths
 

Description détaillée

Methods supporting a list of contenthistory records.

Depuis
3.2

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = array(),
MVCFactoryInterface  $factory = null 
)

Constructor.

Paramètres
array$configAn optional associative array of configuration settings.
MVCFactoryInterface$factoryThe factory.
Voir également
Depuis
3.2

Références $config, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

◆ canDelete()

canDelete (   $record)
protected

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ètres
ContentHistory$recordA Table object.
Renvoie
boolean True if allowed to delete the record. Defaults to the permission set in the component.
Depuis
3.6

◆ delete()

delete ( $pks)

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

Paramètres
array$pksAn array of record primary keys.
Renvoie
boolean True if successful, false if an error occurs.
Depuis
3.2

Références $i, Text\_(), Log\add(), Factory\getApplication(), et Log\WARNING.

◆ getItems()

getItems ( )

Method to get an array of data items.

Renvoie
mixed An array of data items on success, false on failure.
Depuis
3.4.5
Exceptions
NotAllowedThrown if not authorised to edit an item

Implémente ListModelInterface.

Références $items, $user, Text\_(), et Factory\getUser().

◆ getListQuery()

getListQuery ( )
protected

Build an SQL query to load the list data.

Renvoie
Depuis
3.2

Références $db, $itemId, $query, Joomla\Database\getDatabase(), Joomla\CMS\MVC\Model\getState(), et ParameterType\STRING.

◆ getSha1Hash()

getSha1Hash ( )
protected

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

Renvoie
string sha1 hash of row data
Depuis
3.2

Références $helper, $result, Table\addIncludePath(), Factory\getApplication(), et JPATH_ADMINISTRATOR.

◆ getTable()

getTable (   $type = 'ContentHistory',
  $prefix = 'Joomla\\CMS\\Table\\',
  $config = array() 
)

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

Paramètres
string$typeThe table name. Optional.
string$prefixThe class prefix. Optional.
array$configConfiguration array for model. Optional.
Renvoie
Table A Table object
Depuis
3.2

Références $config, $prefix, $type, et Table\getInstance().

◆ keep()

keep ( $pks)

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

Paramètres
array$pksAn array of record primary keys.
Renvoie
boolean True if successful, false if an error occurs.
Depuis
3.2

Références $i, Text\_(), Log\add(), Factory\getApplication(), et Log\WARNING.

◆ populateState()

populateState (   $ordering = 'h.save_date',
  $direction = 'DESC' 
)
protected

Method to auto-populate the model state.

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

Paramètres
string$orderingAn optional ordering field.
string$directionAn optional direction (asc|desc).
Renvoie
void
Depuis
3.2

Références $direction, $input, $itemId, $ordering, $params, Factory\getApplication(), ComponentHelper\getParams(), Joomla\CMS\MVC\Model\populateState(), et Joomla\CMS\MVC\Model\setState().


La documentation de cette classe a été générée à partir du fichier suivant :