Référence de la classe ModulesModel

Graphe d'héritage de ModulesModel:

Fonctions membres publiques
	__construct ($config=array())
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.position', $direction='asc')
	getStoreId ($id='')
	_getList ($query, $limitstart=0, $limit=0)
	translate (&$items)
	getListQuery ()
	getEmptyStateQuery ()
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

Modules Component Module Model

Depuis

1.5

Documentation des constructeurs et destructeur

__construct()

__construct

(

$config = array()

)

Constructor.

Paramètres

array

$config

An optional associative array of configuration settings.

Voir également

Depuis

1.6

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

Documentation des fonctions membres

_getList()

_getList (   $query,   $limitstart = 0,   $limit = 0  )

protected

Returns an object list

Paramètres

DatabaseQuery	$query	The query
int	$limitstart	Offset
int	$limit	The number of records

Renvoie

array

Références $db, $limit, $listDirn, $listOrder, $query, $result, $total, elseif, Joomla\Database\getDatabase(), Joomla\CMS\MVC\Model\getState(), null, Joomla\CMS\MVC\Model\setState(), et ArrayHelper\sortObjects().

getEmptyStateQuery()

getEmptyStateQuery ( )

protected

Manipulate the query to be used to evaluate if this is an Empty State to provide specific conditions for this extension.

Renvoie

DatabaseQuery

Depuis

4.0.0

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

getListQuery()

getListQuery ( )

protected

Build an SQL query to load the list data.

Renvoie

DatabaseQuery

Références $clientId, $db, $groups, $language, $module, $position, $query, $state, $user, elseif, Joomla\Database\getDatabase(), Factory\getLanguage(), Joomla\CMS\MVC\Model\getState(), Factory\getUser(), ParameterType\INTEGER, ParameterType\STRING, et StringHelper\strtolower().

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.

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

populateState()

populateState (   $ordering = 'a.position',   $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, $layout, $ordering, $params, Factory\getApplication(), ComponentHelper\getParams(), Joomla\CMS\MVC\Model\populateState(), et Joomla\CMS\MVC\Model\setState().

translate()

translate ( &  $items )

protected

Translate a list of objects

Paramètres

array

&$items

The array of objects

Renvoie

array The array of translated objects

Références $extension, $item, $items, $lang, Text\_(), elseif, Factory\getLanguage(), Joomla\CMS\MVC\Model\getState(), JPATH_ADMINISTRATOR, et JPATH_SITE.

---

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

• administrator/components/com_modules/src/Model/ModulesModel.php