Class JMenuItem

Object representing a menu item

stdClass

JMenuItem

Package: Joomla\Libraries\Menu
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 3.7.0
Note: This class will no longer extend stdClass in Joomla 4
Located at cms/menu/item.php

Methods summary

`public`	# `__construct( array $data = array() )` Class constructor Class constructor Parameters `$data` `array` - $data The menu item data to load Since 3.7.0
`public mixed`	# `__get( string $name )` Method to get certain otherwise inaccessible properties from the form field object. Method to get certain otherwise inaccessible properties from the form field object. Deprecated 4.0 Access the item parameters through the `getParams()` method Parameters `$name` `string` - $name The property name for which to the the value. Returns `mixed` - The property value or null. Since 3.7.0
`public`	# `__set( string $name, mixed $value )` Method to set certain otherwise inaccessible properties of the form field object. Method to set certain otherwise inaccessible properties of the form field object. Deprecated 4.0 Set the item parameters through the `setParams()` method Parameters `$name` `string` - $name The property name for which to the the value. `$value` `mixed` - $value The value of the property. Since 3.7.0
`public boolean`	# `__isset( string $name )` Method check if a certain otherwise inaccessible properties of the form field object is set. Method check if a certain otherwise inaccessible properties of the form field object is set. Deprecated 4.0 Deprecated without replacement Parameters `$name` `string` - $name The property name to check. Returns `boolean` Since 3.7.1
`public Joomla\Registry\Registry`	# `getParams( )` Returns the menu item parameters Returns the menu item parameters Returns `Joomla\Registry\Registry` Since 3.7.0
`public`	# `setParams( Joomla\Registry\Registry\|string $params )` Sets the menu item parameters Sets the menu item parameters Parameters `$params` `Joomla\Registry\Registry\|string` - $params The data to be stored as the parameters Since 3.7.0
`public mixed`	# `get( string $property, mixed $default = null )` Returns a property of the object or the default value if the property is not set. Returns a property of the object or the default value if the property is not set. Deprecated 4.0 Parameters `$property` `string` - $property The name of the property. `$default` `mixed` - $default The default value. Returns `mixed` - The value of the property. Since 3.7.0
`public mixed`	# `set( string $property, mixed $value = null )` Modifies a property of the object, creating it if it does not already exist. Modifies a property of the object, creating it if it does not already exist. Deprecated 4.0 Parameters `$property` `string` - $property The name of the property. `$value` `mixed` - $value The value of the property to set. Returns `mixed` - Previous value of the property. Since 3.7.0

Magic methods summary

Properties summary

`public integer`	`$id`	# Primary key Primary key Since 3.7.0
`public integer`	`$menutype`	# The type of menu this item belongs to The type of menu this item belongs to Since 3.7.0
`public string`	`$title`	# The display title of the menu item The display title of the menu item Since 3.7.0
`public string`	`$alias`	# The SEF alias of the menu item The SEF alias of the menu item Since 3.7.0
`public string`	`$note`	# A note associated with the menu item 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 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 The actual link the menu item refers to Since 3.7.0
`public string`	`$type`	# The type of link The type of link Since 3.7.0
`public integer`	`$level`	# The relative level in the tree The relative level in the tree Since 3.7.0
`public string`	`$language`	# The assigned language for this item The assigned language for this item Since 3.7.0
`public string`	`$browserNav`	# The click behaviour of the link The click behaviour of the link Since 3.7.0
`public integer`	`$access`	# The access level required to view the menu item The access level required to view the menu item Since 3.7.0
`protected string\|Joomla\Registry\Registry`	`$params`	# The menu item parameters The menu item parameters Since 3.7.0 Note This field is protected to require reading this field to proxy through the getter to convert the params to a Registry instance
`public integer`	`$home`	# Indicates if this menu item is the home or default page Indicates if this menu item is the home or default page Since 3.7.0
`public string`	`$img`	# The image of the menu item The image of the menu item Since 3.7.0
`public integer`	`$template_style_id`	# The optional template style applied to this menu item The optional template style applied to this menu item Since 3.7.0
`public integer`	`$component_id`	# The extension ID of the component this menu item is for The extension ID of the component this menu item is for Since 3.7.0
`public integer`	`$parent_id`	# The parent menu item in the menu tree 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 The name of the component this menu item is for Since 3.7.0
`public array`	`$tree`	# The tree of parent menu items The tree of parent menu items Since 3.7.0
`public array`	`$query`	# An array of the query string values for this item An array of the query string values for this item Since 3.7.0

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JMenuItem

Methods summary

Parameters

Since

Deprecated

Parameters

Returns

Since

Deprecated

Parameters

Since

Deprecated

Parameters

Returns

Since

Returns

Since

Parameters

Since

Deprecated

Parameters

Returns

Since

Deprecated

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Note

Since

Since

Since

Since

Since

Since

Since

Since