Référence de la classe ListModel

Graphe d'héritage de ListModel:

Fonctions membres publiques
	__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
	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
	$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

Model class for handling lists of items.

Depuis

1.6

Documentation des constructeurs et destructeur

__construct()

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

Constructor

Paramètres

array	$config	An array of configuration options (name, state, dbo, table_path, ignore_request).
MVCFactoryInterface	$factory	The factory.

Depuis

1.6

Exceptions

Exception

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

Documentation des fonctions membres

_getListQuery()

_getListQuery ( )

protected

Method to cache the last query constructed.

This method ensures that the query is constructed only once for a given state of the model.

Renvoie

DatabaseQuery A DatabaseQuery object

Depuis

1.6

Références $query.

getActiveFilters()

getActiveFilters

(

)

Function to get the active filters

Renvoie

array Associative array in the format: array('filter_published' => 0)

Depuis

3.2

getEmptyStateQuery()

getEmptyStateQuery ( )

protected

Provide a query to be used to evaluate if this is an Empty State, can be overridden in the model to provide granular control.

Renvoie

DatabaseQuery

Depuis

4.0.0

Références $query.

getFilterForm()

getFilterForm	(		$data = array(),
			$loadData = true
	)

Get the filter form

Paramètres

array	$data	data
boolean	$loadData	load current data

Renvoie

Form|null The object or null if the form can't be found

Depuis

3.2

Références Joomla\CMS\MVC\Model\loadForm(), et null.

getIsEmptyState()

getIsEmptyState

(

)

Is this an empty state, I.e: no items of this type regardless of the searched for states.

Renvoie

boolean

Exceptions

Exception

Depuis

4.0.0

getItems()

getItems

(

)

Method to get an array of data items.

Renvoie

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

Depuis

1.6

Implémente ListModelInterface.

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

getListQuery()

getListQuery ( )

protected

Method to get a DatabaseQuery object for retrieving the data set from a database.

Renvoie

DatabaseQuery A DatabaseQuery object to retrieve the data set.

Depuis

1.6

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

getPagination()

getPagination

(

)

Method to get a object for the data set.

Renvoie

Pagination A Pagination object for the data set.

Depuis

1.6

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

getStart()

getStart

(

)

Method to get the starting number of items for the data set.

Renvoie

integer The starting number of items available in the data set.

Depuis

1.6

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

getStoreId()

getStoreId (   $id = '' )

protected

Method to get a store id based on the 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

An identifier string to generate the store id.

Renvoie

string A store id.

Depuis

1.6

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

getTotal()

getTotal

(

)

Method to get the total number of items for the data set.

Renvoie

integer The total number of items available in the data set.

Depuis

1.6

getUserStateFromRequest()

getUserStateFromRequest	(		$key,
			$request,
			$default = null,
			$type = 'none',
			$resetPage = true
	)

Gets the value of a user state variable and sets it in the session

This is the same as the method in Application except that this also can optionally force you back to the first page when a filter has changed

Paramètres

string	$key	The key of the user state variable.
string	$request	The name of the variable passed in a request.
string	$default	The default value for the variable if not found. Optional.
string	$type	Filter for the variable, for valid values see InputFilter::clean(). Optional.
boolean	$resetPage	If true, the limitstart in request is set to zero

Renvoie

mixed The request user state.

Depuis

1.6

Références $app, $default, $filters, $input, $key, $name, $type, Factory\getApplication(), et null.

loadFormData()

loadFormData ( )

protected

Method to get the data that should be injected in the form.

Renvoie

mixed The data for the form.

Depuis

3.2

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

populateState()

populateState (   $ordering = null,   $direction = null  )

protected

Method to auto-populate the model state.

This method should only be called once per instantiation and is designed to be called on the first call to the getState() method unless the model configuration flag to ignore the request is set.

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

Paramètres

string	$ordering	An optional ordering field.
string	$direction	An optional direction (asc|desc).

Renvoie

void

Depuis

1.6

Références $app, $direction, $field, $filters, $limit, $list, $name, $ordering, $this, $value, Factory\getApplication(), InputFilter\getInstance(), et Joomla\CMS\MVC\Model\setState().

refineSearchStringToRegex()

refineSearchStringToRegex (   $search,   $regexDelimiter = '/'  )

protected

Parse and transform the search string into a string fit for regex-ing arbitrary strings against

Paramètres

string	$search	The search string
string	$regexDelimiter	The regex delimiter to use for the quoting

Renvoie

string Search string escaped for regex

Depuis

3.4

Références $key.

Documentation des champs

$cache

$cache = array()

protected

$context

$context = null

protected

$filter_fields

$filter_fields = array()

protected

$filterBlacklist

$filterBlacklist = array()

protected

$filterForbiddenList

$filterForbiddenList = array()

protected

$filterFormName

$filterFormName = null

protected

$htmlFormName

$htmlFormName = 'adminForm'

protected

$lastQueryStoreId

$lastQueryStoreId = null

protected

$listBlacklist

$listBlacklist = array('select')

protected

$listForbiddenList

$listForbiddenList = array('select')

protected

$query

$query = array()

protected

---

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

• ListModel.php