Class MenusModelItems

Description

Menu Item List Model for Menus.

  • since: 1.6

Located in /administrator/components/com_menus/models/items.php (line 19)

JObject
   |
   --JModelLegacy
      |
      --JModelList
         |
         --MenusModelItems
Method Summary
 MenusModelItems __construct ([array $config = array()])
 string getDefaultMenuType ()
 string getStoreId ([string $id = ''])
 void populateState ([ $ordering = null], [ $direction = null])
Variables
Methods
Constructor __construct (line 29)

Constructor.

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

Redefinition of:
JModelList::__construct()
Constructor.
getDefaultMenuType (line 162)

Finds the default menu type.

In the absence of better information, this is the first menu ordered by title.

  • return: The default menu type
  • since: 1.6
  • access: protected
string getDefaultMenuType ()
getListQuery (line 181)

Builds an SQL query to load the list data.

  • return: A query object.
  • access: protected
JDatabaseQuery getListQuery ()

Redefinition of:
JModelList::getListQuery()
Method to get a JDatabaseQuery object for retrieving the data set from a database.
getStoreId (line 140)

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.
  • since: 1.6
  • 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 72)

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

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