Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Fonctions membres publiques | Fonctions membres protégées | Attributs protégés | Fonctions membres privées
Référence de la classe UsersModel
+ Graphe d'héritage de UsersModel:

Fonctions membres publiques

 __construct ($config=array(), MVCFactoryInterface $factory=null)
 
 getItems ()
 
 getFilterForm ($data=[], $loadData=true)
 
- 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.name', $direction='asc')
 
 getStoreId ($id='')
 
 getListQuery ()
 
 getUserDisplayedGroups ($userId)
 
- 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

 $filterForbiddenList = array('groups', 'excluded')
 
- 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()
 

Fonctions membres privées

 buildDateRange ($range)
 

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

Methods supporting a list of user records.

Depuis
1.6

Documentation des constructeurs et destructeur

◆ __construct()

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

Override parent 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

◆ buildDateRange()

buildDateRange (   $range)
private

Construct the date range to filter on.

Paramètres
string$rangeThe textual range to construct the filter for.
Renvoie
array The date range to filter on.
Depuis
3.6.0
Exceptions

Références $app, Joomla\Database\Query\$offset, $range, et Factory\getApplication().

◆ getFilterForm()

getFilterForm (   $data = [],
  $loadData = true 
)

Get the filter form

Paramètres
array$datadata
boolean$loadDataload current data
Renvoie
Form|null The object or null if the form can't be found
Depuis
4.2.0

Références $data, $form, et PluginHelper\isEnabled().

◆ getItems()

getItems ( )

Gets the list of users and adds expensive joins to the result set.

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

Implémente ListModelInterface.

Références $db, $groups, $item, $items, $query, Joomla\Database\getDatabase(), et Joomla\CMS\MVC\Model\getState().

◆ getListQuery()

getListQuery ( )
protected

Build an SQL query to load the list data.

Renvoie
DatabaseQuery
Depuis
1.6

Références $active, $db, $groups, $query, $range, $state, $this, elseif, Joomla\Database\getDatabase(), Joomla\CMS\MVC\Model\getState(), ParameterType\INTEGER, et PluginHelper\isEnabled().

◆ 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$idA prefix for the store id.
Renvoie
string A store id.
Depuis
1.6

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

◆ getUserDisplayedGroups()

getUserDisplayedGroups (   $userId)
protected

SQL server change

Paramètres
integer$userIdUser identifier
Renvoie
string Groups titles imploded :$

Références $db, $query, $result, $userId, Joomla\Database\getDatabase(), et ParameterType\INTEGER.

◆ populateState()

populateState (   $ordering = 'a.name',
  $direction = 'asc' 
)
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
1.6
Exceptions

Références $app, $direction, $groups, $layout, $ordering, $params, Factory\getApplication(), ComponentHelper\getParams(), Joomla\CMS\MVC\Model\populateState(), Joomla\CMS\MVC\Model\setState(), et ArrayHelper\toInteger().

Documentation des champs

◆ $filterForbiddenList

$filterForbiddenList = array('groups', 'excluded')
protected
La documentation de cette classe a été générée à partir du fichier suivant :