Class ModulesModelModules

Description

Modules Component Module Model

  • since: 1.5

Located in /administrator/components/com_modules/models/modules.php (line 19)

JObject
   |
   --JModel
      |
      --JModelList
         |
         --ModulesModelModules
Method Summary
ModulesModelModules __construct ([array $config = array()])
string getStoreId ([string $id = ''])
void populateState ([ $ordering = null], [ $direction = null])
array translate (array &$items)
array _getList (string $query, [int $limitstart = 0], [int $limit = 0])
Variables
Methods
Constructor __construct (line 28)

Constructor.

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

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

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

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 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.
translate (line 173)

Translate a list of objects

  • return: The array of translated objects
  • access: protected
array translate (array &$items)
  • array &$items: The array of objects
_getList (line 132)

Returns an object list

  • access: protected
array _getList (string $query, [int $limitstart = 0], [int $limit = 0])
  • string $query: The query
  • int $limitstart: Offset
  • int $limit: The number of records

Redefinition of:
JModel::_getList()
Gets an array of objects from the results of database query.

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:57:37 -0500 by phpDocumentor 1.4.4