Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class MenuItem - list of methods

Object representing a menu item

Extends

NodeInterface

Direct known subclasses

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

Method Summary

public
__construct
(mixed $data = array())

Class constructor
Parameters
  • array $data The menu item data to load
Since
  • 3.7.0
Show source code of this method: __construct Source Code

public \Joomla\Registry\Registry
()

Returns the menu item parameters
Returns
  • \Joomla\Registry\Registry
Since
  • 3.7.0
Show source code of this method: getParams Source Code

public void
(mixed $params)

Sets the menu item parameters
Parameters
  • \Joomla\Registry\Registry|string $params The data to be stored as the parameters
Returns
  • void
Since
  • 3.7.0
Show source code of this method: setParams Source Code

Properties Summary

public int
$id
Primary key
Since
  • 3.7.0
public int
$menutype
The type of menu this item belongs to
Since
  • 3.7.0
public string
$title
The display title of the menu item
Since
  • 3.7.0
public string
$alias
The SEF alias of the menu item
Since
  • 3.7.0
public string
$note
A note associated with the menu item
Since
  • 3.7.0
public string
$route
The computed path of the menu item based on the alias field, this is populated from the `path` field in the `#__menu` table
Since
  • 3.7.0
public string
$link
The actual link the menu item refers to
Since
  • 3.7.0
public string
$type
The type of link
Since
  • 3.7.0
public int
$level
The relative level in the tree
Since
  • 3.7.0
public string
$language
The assigned language for this item
Since
  • 3.7.0
public int
$browserNav
The click behaviour of the link
Since
  • 3.7.0
public int
$access
The access level required to view the menu item
Since
  • 3.7.0
protected string|\Joomla\Registry\Registry
$params
The menu item parameters
Since
  • 3.7.0
-
  • string|\Joomla\Registry\Registry
public int
$home
Indicates if this menu item is the home or default page
Since
  • 3.7.0
public string
$img
The image of the menu item
Since
  • 3.7.0
public int
$template_style_id
The optional template style applied to this menu item
Since
  • 3.7.0
public int
$component_id
The extension ID of the component this menu item is for
Since
  • 3.7.0
public int
$parent_id
The parent menu item in the menu tree
Since
  • 3.7.0
public string
$component
The name of the component this menu item is for
Since
  • 3.7.0
public array
$tree
The tree of parent menu items
Since
  • 3.7.0
public array
$query
An array of the query string values for this item
Since
  • 3.7.0

Tags Summary

Since
3.7.0