Methods supporting a list of user group records.

• since: 1.6

Located in /administrator/components/com_users/models/groups.php (line 19)

JObject
   |
   --JModelLegacy
      |
      --JModelList
         |
         --UsersModelGroups

Inherited Variables

Inherited from JModelList

JModelList::$cache
JModelList::$context
JModelList::$filterFormName
JModelList::$filter_fields
JModelList::$htmlFormName
JModelList::$query

Inherited from JModelLegacy

JModelLegacy::$event_clean_cache
JModelLegacy::$name
JModelLegacy::$option
JModelLegacy::$state
JModelLegacy::$_db
JModelLegacy::$__state_set

Inherited from JObject

JObject::$_errors

Constructor __construct (line 28)

Constructor.

• see: JController
• since: 1.6
• access: public

UsersModelGroups __construct ([array $config = array()])

• array $config: An optional associative array of configuration settings.

---

Redefinition of:

JModelList::__construct()

Constructor.

getItems (line 91)

Gets the list of groups 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 161)

Build an SQL query to load the list data.

• access: protected

JDatabaseQuery getListQuery ()

---

Redefinition of:

JModelList::getListQuery()

Method to get a JDatabaseQuery object for retrieving the data set from a database.

getStoreId (line 76)

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.
• 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 51)

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.

Inherited Methods

Inherited From JModelList

JModelList::__construct()
JModelList::getActiveFilters()
JModelList::getFilterForm()
JModelList::getItems()
JModelList::getListQuery()
JModelList::getPagination()
JModelList::getStart()
JModelList::getStoreId()
JModelList::getTotal()
JModelList::getUserStateFromRequest()
JModelList::loadForm()
JModelList::loadFormData()
JModelList::populateState()
JModelList::preprocessForm()
JModelList::_getListQuery()

Inherited From JModelLegacy

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

Inherited From JObject

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