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

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

Constructor.

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

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

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

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

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

Method to adjust the ordering of a row.

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

Saves the manually set order of records.

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

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 13:56:17 -0500 by phpDocumentor 1.4.4