Class MenusModelMenus

Description

Menu List Model for Menus.

  • since: 1.6

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

JObject
   |
   --JModelLegacy
      |
      --JModelList
         |
         --MenusModelMenus
Method Summary
 MenusModelMenus __construct ([array $config = array()])
 mixed getItems ()
 string getListQuery ()
 integer getModMenuId ()
 array &getModules ()
 void populateState ([string $ordering = null], [string $direction = null])
Variables
Methods
Constructor __construct (line 29)

Constructor.

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

Redefinition of:
JModelList::__construct()
Constructor.
getItems (line 50)

Overrides the getItems method to attach additional metrics to the list.

  • return: An array of data items on success, false on failure.
  • since: 1.6.1
  • access: public
mixed getItems ()

Redefinition of:
JModelList::getItems()
Method to get an array of data items.
getListQuery (line 156)

Method to build an SQL query to load the list data.

  • return: An SQL query
  • since: 1.6
  • access: protected
string getListQuery ()

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

Gets the extension id of the core mod_menu module.

  • since: 2.5
  • access: public
integer getModMenuId ()
getModules (line 228)

Gets a list of all mod_mainmenu modules and collates them by menutype

  • access: public
array &getModules ()
populateState (line 193)

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.

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