Class UsersModelUsers

Description

Methods supporting a list of user records.

  • since: 1.6

Located in /administrator/components/com_users/models/users.php (line 21)

JObject
   |
   --JModel
      |
      --JModelList
         |
         --UsersModelUsers
Method Summary
UsersModelUsers __construct ([array $config = array()])
mixed getItems ()
string getStoreId ([string $id = ''])
void populateState ([ $ordering = null], [ $direction = null])
void _getUserDisplayedGroups ( $user_id)
Variables
Methods
Constructor __construct (line 31)

Constructor.

UsersModelUsers __construct ([array $config = array()])
  • array $config: An optional associative array of configuration settings.

Redefinition of:
JModelList::__construct()
Constructor.
getItems (line 141)

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

  • return: An array of data items on success, false on failure.
  • since: 1.6
  • access: public
mixed getItems ()

Redefinition of:
JModelList::getItems()
Method to get an array of data items.
getListQuery (line 256)

Build an SQL query to load the list data.

  • since: 1.6
  • access: protected
JDatabaseQuery getListQuery ()

Redefinition of:
JModelList::getListQuery()
Method to get a JDatabaseQuery object for retrieving the data set from a database.
getStoreId (line 122)

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.

  • return: A store id.
  • since: 1.6
  • access: protected
string getStoreId ([string $id = ''])
  • string $id: A prefix for the store id.

Redefinition of:
JModelList::getStoreId()
Method to get a store id based on the model configuration state.
populateState (line 60)

Method to auto-populate the model state.

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

  • since: 1.6
  • access: protected
void populateState ([ $ordering = null], [ $direction = null])
  • $ordering
  • $direction

Redefinition of:
JModelList::populateState()
Method to auto-populate the model state.
_getUserDisplayedGroups (line 409)
void _getUserDisplayedGroups ( $user_id)
  • $user_id

Inherited Methods

Inherited From JModelList

JModelList::__construct()
JModelList::getItems()
JModelList::getListQuery()
JModelList::getPagination()
JModelList::getStart()
JModelList::getStoreId()
JModelList::getTotal()
JModelList::getUserStateFromRequest()
JModelList::populateState()
JModelList::_getListQuery()

Inherited From JModel

JModel::__construct()
JModel::addIncludePath()
JModel::addTablePath()
JModel::cleanCache()
JModel::getDbo()
JModel::getInstance()
JModel::getName()
JModel::getState()
JModel::getTable()
JModel::populateState()
JModel::setDbo()
JModel::setState()
JModel::_createFileName()
JModel::_createTable()
JModel::_getList()
JModel::_getListCount()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 14:00:31 -0500 by phpDocumentor 1.4.4