Class PluginsModelPlugins

Description

Methods supporting a list of plugin records.

  • since: 1.6

Located in /administrator/components/com_plugins/models/plugins.php (line 19)

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

Constructor.

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

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

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

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

Method to auto-populate the model state.

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

  • since: 1.6
  • access: protected
void populateState ([string $ordering = null], [string $direction = null])
  • string $ordering: An optional ordering field.
  • string $direction: An optional direction (asc|desc).

Redefinition of:
JModelList::populateState()
Method to auto-populate the model state.
translate (line 176)

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

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:
JModelLegacy::_getList()
Gets an array of objects from the results of database query.

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:10:51 +0100 by phpDocumentor 1.4.3