Class UsersModelLevels

Description

Methods supporting a list of user access level records.

  • since: 1.6

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

JObject
   |
   --JModelLegacy
      |
      --JModelList
         |
         --UsersModelLevels
Method Summary
 UsersModelLevels __construct ([array $config = array()])
 string getStoreId ([string $id = ''])
 void populateState ([ $ordering = null], [ $direction = null])
 boolean reorder (integer $pk, [integer $direction = 0])
 void saveorder (array $pks, integer $order)
Variables
Methods
Constructor __construct (line 28)

Constructor.

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

Redefinition of:
JModelList::__construct()
Constructor.
getListQuery (line 87)

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 74)

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 49)

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.
reorder (line 136)

Method to adjust the ordering of a row.

  • return: False on failure or error, true otherwise.
  • access: public
boolean reorder (integer $pk, [integer $direction = 0])
  • integer $pk: The ID of the primary key to move.
  • integer $direction: Increment, usually +1 or -1
saveorder (line 174)

Saves the manually set order of records.

  • access: public
void saveorder (array $pks, integer $order)
  • array $pks: An array of primary key ids.
  • integer $order: +/-1

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()

Documentation generated on Tue, 19 Nov 2013 15:07:01 +0100 by phpDocumentor 1.4.3