Class MenusModelMenus

Description

Menu List Model for Menus.

  • since: 1.6

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

JObject
   |
   --JModel
      |
      --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 32)

Constructor.

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

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

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

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

Gets the extension id of the core mod_menu module.

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

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

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

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