Référence de la classe CacheModel

Graphe d'héritage de CacheModel:

Fonctions membres publiques
	__construct ($config=array())
	getData ()
	getCache ()
	getTotal ()
	getPagination ()
	clean ($group='')
	cleanlist ($array)
	purge ()
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
	populateState ($ordering='group', $direction='asc')
	getStoreId ($id='')
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)

Attributs protégés
	$_data = array()
	$_total = null
	$_pagination = null
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()

Membres hérités additionnels
Fonctions membres publiques statiques hérités de BaseModel
static	addIncludePath ($path='', $prefix='')
Attributs protégés statiques hérités de BaseModel
static	$paths

Description détaillée

Cache Model

Depuis

1.6

Documentation des constructeurs et destructeur

__construct()

__construct

(

$config = array()

)

Constructor.

Paramètres

array

$config

An optional associative array of configuration settings.

Depuis

3.5

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

Documentation des fonctions membres

clean()

clean

(

$group = ''

)

Clean out a cache group as named by param. If no param is passed clean all cache groups.

Paramètres

string

$group

Cache group name.

Renvoie

boolean True on success, false otherwise

Références Factory\getApplication().

cleanlist()

cleanlist

(

$array

)

Purge an array of cache groups.

Paramètres

array

$array

Array of cache group names.

Renvoie

array Array with errors, if they exist.

getCache()

getCache

(

)

Method to get cache instance.

Renvoie

CacheController

Références $app, $options, Factory\getApplication(), Cache\getInstance(), et JPATH_CACHE.

getData()

getData

(

)

Method to get cache data

Renvoie

array

Références $data, $key, $limit, $listDirn, $listOrder, $start, Text\_(), Joomla\CMS\MVC\Model\getState(), et ArrayHelper\sortObjects().

getPagination()

getPagination

(

)

Method to get a pagination object for the cache.

Renvoie

Pagination

Références Joomla\CMS\MVC\Model\getState().

getStoreId()

getStoreId (   $id = '' )

protected

Method to get a store id based on model configuration state.

This is necessary because the model is used by the component and different modules that might need different sets of data or different ordering requirements.

Paramètres

string

$id

A prefix for the store id.

Renvoie

string A store id.

Depuis

3.5

Références $id, et Joomla\CMS\MVC\Model\getState().

getTotal()

getTotal

(

)

Get the number of current Cache Groups.

Renvoie

integer

populateState()

populateState (   $ordering = 'group',   $direction = 'asc'  )

protected

Method to auto-populate the model state.

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

Paramètres

string	$ordering	Field for ordering.
string	$direction	Direction of ordering.

Renvoie

void

Depuis

1.6

Références $direction, $ordering, Joomla\CMS\MVC\Model\populateState(), et Joomla\CMS\MVC\Model\setState().

purge()

purge

(

)

Purge all cache items.

Renvoie

boolean True if successful; false otherwise.

Références Factory\getApplication(), et Factory\getCache().

Documentation des champs

$_data

$_data = array()

protected

$_pagination

$_pagination = null

protected

$_total

$_total = null

protected

---

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

• CacheModel.php