Back to Joomla project (class list)

Class SiteMenu - list of methods

Menu class

Extends

Package: Joomla\CMS\Menu
Copyright: (C) 2007 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Menu/SiteMenu.php
Project: Joomla

Method Summary

public
(mixed $options = array())

Class constructor
Parameters
  • array $options An array of configuration options.
Since
  • 1.5
Show source code of this method: __construct Source Code

public bool
()

Loads the entire menu table into memory.
Returns
  • bool True on success, false on failure
Since
  • 1.5
Show source code of this method: load Source Code

public \Joomla\CMS\Menu\MenuItem|\Joomla\CMS\Menu\MenuItem[]
(mixed $attributes, mixed $values, mixed $firstonly = false)

Gets menu items by attribute
Parameters
  • string $attributes The field name
  • string $values The value of the field
  • bool $firstonly If true, only returns the first item found
Returns
  • \Joomla\CMS\Menu\MenuItem|\Joomla\CMS\Menu\MenuItem[] An array of menu item objects or a single object if the $firstonly parameter is true
Since
  • 1.6
Show source code of this method: getItems Source Code

public \Joomla\CMS\Menu\MenuItem|null
(mixed $language = '*')

Get menu item by id
Parameters
  • string $language The language code.
Returns
  • \Joomla\CMS\Menu\MenuItem|null The item object or null when not found for given language
Since
  • 1.6
Show source code of this method: getDefault Source Code

Properties Summary

protected \Joomla\CMS\Application\CMSApplication
$app
Application object
Since
  • 3.5
protected \Joomla\Database\DatabaseDriver
$db
Database driver
Since
  • 3.5
protected \Joomla\CMS\Language\Language
$language
Language object
Since
  • 3.5

Tags Summary

Since
1.5