Référence de la classe ItemsModel

Graphe d'héritage de ItemsModel:

Fonctions membres publiques
	__construct ($config=array(), MVCFactoryInterface $factory=null)
	getItems ()
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='a.lft', $direction='asc')
	getStoreId ($id='')
	getListQuery ()
	preprocessForm (Form $form, $data, $group='content')
	getMenu ($menuType, $check=false)
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

Menu Item List Model for Menus.

Depuis

1.6

Documentation des constructeurs et destructeur

__construct()

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

Constructor.

Paramètres

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

Voir également

Depuis

3.2

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

Documentation des fonctions membres

getItems()

getItems

(

)

Method to get an array of data items.

Renvoie

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

Depuis

3.0.1

Implémente ListModelInterface.

Références $client, $extension, $item, $items, $lang, Text\_(), Factory\getLanguage(), et JPATH_ADMINISTRATOR.

getListQuery()

getListQuery ( )

protected

Builds an SQL query to load the list data.

Renvoie

A query object.

Depuis

1.6

Références $clientId, $db, $groups, $language, $menuType, $menuTypes, $published, $query, $this, $type, $user, elseif, Joomla\Database\getDatabase(), Joomla\CMS\MVC\Model\getState(), Factory\getUser(), ParameterType\INTEGER, et Associations\isEnabled().

getMenu()

getMenu (   $menuType,   $check = false  )

protected

Get the client id for a menu

Paramètres

string	$menuType	The menutype identifier for the menu
boolean	$check	Flag whether to perform check against ACL as well as existence

Renvoie

integer

Depuis

3.7.0

Références $check, $db, $menuType, $query, Text\_(), Log\add(), elseif, Log\ERROR, Joomla\Database\getDatabase(), et Factory\getUser().

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

1.6

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

populateState()

populateState (   $ordering = 'a.lft',   $direction = 'asc'  )

protected

Method to auto-populate the model state.

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, $clientId, $direction, $language, $layout, $menuType, $ordering, $params, $published, elseif, Factory\getApplication(), Factory\getLanguage(), ComponentHelper\getParams(), JPATH_ADMINISTRATOR, Joomla\CMS\MVC\Model\populateState(), et Joomla\CMS\MVC\Model\setState().

preprocessForm()

preprocessForm ( Form  $form,   $data,   $group = 'content'  )

protected

Method to allow derived classes to preprocess the form.

Paramètres

Form	$form	A Form object.
mixed	$data	The data expected for the form.
string	$group	The name of the plugin group to import (defaults to "content").

Renvoie

void

Depuis

3.2

Exceptions

Références $clientId, $form, $name, elseif, Joomla\CMS\MVC\Model\getState(), et Form\setFieldAttribute().

---

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

• ItemsModel.php