Référence de la classe UsersModelUsers

Graphe d'héritage de UsersModelUsers:

Fonctions membres publiques
	__construct ($config=array())
	getItems ()

Fonctions membres protégées
	populateState ($ordering='a.name', $direction='asc')
	getStoreId ($id='')
	getListQuery ()
	_getUserDisplayedGroups ($userId)

Attributs protégés
	$filterBlacklist = array('groups', 'excluded')

Fonctions membres privées
	buildDateRange ($range)

Description détaillée

Methods supporting a list of user records.

Depuis

1.6

Documentation des constructeurs et destructeur

__construct()

__construct

(

$config = array()

)

Constructor.

Paramètres

array

$config

An optional associative array of configuration settings.

Voir également

JController

Depuis

1.6

Références $config.

Documentation des fonctions membres

_getUserDisplayedGroups()

_getUserDisplayedGroups (   $userId )

protected

SQL server change

Paramètres

integer

$userId

User identifier

Renvoie

string Groups titles imploded :$

Références $db, $query, et $userId.

buildDateRange()

buildDateRange (   $range )

private

Construct the date range to filter on.

Paramètres

string

$range

The textual range to construct the filter for.

Renvoie

string The date range to filter on.

Depuis

3.6.0

Références $app, $offset, et $range.

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

Références $db, $groups, $item, $items, et $query.

getListQuery()

getListQuery ( )

protected

Build an SQL query to load the list data.

Renvoie

JDatabaseQuery

Depuis

1.6

Références $active, $db, $groups, $query, $range, $state, et elseif.

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.

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	$ordering	An optional ordering field.
string	$direction	An optional direction (asc|desc).

Renvoie

void

Depuis

1.6

Références $app, $direction, $groups, $layout, $ordering, $params, null, et ArrayHelper\toInteger().

Documentation des champs

$filterBlacklist

$filterBlacklist = array('groups', 'excluded')

protected

---

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

• administrator/components/com_users/models/users.php