JMenu
Extends \JObjectJMenu class
This class allows for simple but smart objects with get and set methods and an internal error handler.
| package |
Joomla.Platform |
|---|---|
| subpackage |
Application |
| since |
11.1 |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
| since |
11.1 |
|---|
Arguments
- $properties
mixedEither and associative array or another object to set the initial properties of the object.
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
| since |
11.1 |
|---|---|
| deprecated |
12.3 Classes should provide their own __toString() implementation. |
Response
stringThe classname.
authorise
Method to check JMenu object authorization against an access control object and optionally an access extension object
authorise(integer $id) : boolean
| since |
11.1 |
|---|
Arguments
- $id
integerThe menu id
Response
booleanTrue if authorised
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixed
get
Returns a property of the object or the default value if the property is not set.
get(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|---|
| see | \JObject::getProperties() |
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixedThe value of the property.
getActive
Get menu item by id.
getActive() : object
| since |
11.1 |
|---|
Response
objectThe item object.
getDefault
Get the default item by language code.
getDefault(string $language = '*') : object
| since |
11.1 |
|---|
Arguments
- $language
stringThe language code, default value of * means all.
Response
objectThe item object
getError
Get the most recent error message.
getError(integer $i = null, boolean $toString = true) : string
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $i
integerOption error index.- $toString
booleanIndicates if JError objects should return their error message.
Response
stringError message
getErrors
Return all errors, if any.
getErrors() : array
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Response
arrayArray of error messages or JErrors.
getInstance
Returns a JMenu object
getInstance(string $client, array $options = array()) : \JMenu
| since |
11.1 |
|---|
Arguments
- $client
stringThe name of the client- $options
arrayAn associative array of options
Response
\JMenuA menu object.
getItem
Get menu item by id
getItem(integer $id) : mixed
| since |
11.1 |
|---|
Arguments
- $id
integerThe item id
Response
mixedThe item object, or null if not found
getItems
Gets menu items by attribute
getItems(mixed $attributes, mixed $values, boolean $firstonly = false) : array
| since |
11.1 |
|---|
Arguments
- $attributes
mixedThe field name(s).- $values
mixedThe value(s) of the field. If an array, need to match field names each attribute may have multiple values to lookup for.- $firstonly
booleanIf true, only returns the first item found
Response
array
getMenu
Getter for the menu array
getMenu() : array
| since |
11.1 |
|---|
Response
array
getParams
Gets the parameter object for a certain menu item
getParams(integer $id) : \JRegistry
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
| since |
11.1 |
|---|---|
| see | \JObject::get() |
Arguments
- $public
booleanIf true, returns only the public properties.
Response
array
load
Loads the menu items
load() : array
| since |
11.1 |
|---|
Response
array
set
Modifies a property of the object, creating it if it does not already exist.
set(string $property, mixed $value = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $value
mixedThe value of the property to set.
Response
mixedPrevious value of the property.
setActive
Set the default item by id
setActive(integer $id) : mixed
| since |
11.1 |
|---|
Arguments
- $id
integerThe item id
Response
mixedIf successful the active item, otherwise null
setDefault
Set the default item by id and language code.
setDefault(integer $id, string $language = '') : boolean
| since |
11.1 |
|---|
Arguments
- $id
integerThe menu item id.- $language
stringThe language cod (since 1.6).
Response
booleanTrue, if successful
setError
Add an error message.
setError(string $error) : void
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $error
stringError message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
| since |
11.1 |
|---|---|
| see | \JObject::set() |
Arguments
- $properties
mixedEither an associative array or another object.
Response
boolean
toString
Converts the object to a string (the class name).
toString() : string
Properties
_items
Array to hold the menu items
| since |
11.1 |
|---|
Type(s)
array
_default
Identifier of the default menu item
| since |
11.1 |
|---|
Type(s)
integer
_active
Identifier of the active menu item
| since |
11.1 |
|---|
Type(s)
integer
instances
JMenu instances container.
| since |
11.3 |
|---|
Type(s)
array
_errors
An array of error messages or Exception objects.