JElementMenu
Extends \JElementRenders a menu element
The JElement is the base class for all JElement types
package |
Joomla.Platform |
---|---|
subpackage |
Parameter |
since |
11.1 |
deprecated |
Use JFormMenu instead |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
since |
11.1 |
---|
Arguments
- $properties
mixed
Either 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
string
The classname.
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
since |
11.1 |
---|
Arguments
- $property
string
The name of the property.- $default
mixed
The default value.
Response
mixed
fetchElement
Fetch an element
fetchElement(string $name, string $value, &$xmlElement, string $control_name) : void
deprecated |
12.1 |
---|---|
since |
11.1 |
Arguments
- $name
string
Name attribute of the element- $value
string
Value attribute of the element- $xmlElement
- $control_name
string
Control name of the element
fetchTooltip
Method to get a tool tip from an XML element
fetchTooltip(string $label, string $description, &$xmlElement, string $control_name = '', string $name = '') : string
deprecated |
12.1 |
---|---|
since |
11.1 |
Arguments
- $label
string
Label attribute for the element- $description
string
Description attribute for the element- $xmlElement
- $control_name
string
Control name- $name
string
Name attribut
Response
string
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
string
The name of the property.- $default
mixed
The default value.
Response
mixed
The value of the property.
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
integer
Option error index.- $toString
boolean
Indicates if JError objects should return their error message.
Response
string
Error message
getErrors
Return all errors, if any.
getErrors() : array
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Response
array
Array of error messages or JErrors.
getName
Get the element name
getName() : string
since |
11.1 |
---|---|
deprecated |
12.1 |
Response
string
type of the parameter
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
since |
11.1 |
---|---|
see | \JObject::get() |
Arguments
- $public
boolean
If true, returns only the public properties.
Response
array
render
Method to render an xml element
render( &$xmlElement, string $value, string $control_name = 'params') : array
deprecated |
12.1 |
---|---|
since |
11.1 |
Arguments
- $xmlElement
- $value
string
Value of the element- $control_name
string
Name of the control
Response
array
Attributes of an element
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
string
The name of the property.- $value
mixed
The value of the property to set.
Response
mixed
Previous value of the property.
setError
Add an error message.
setError(string $error) : void
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Arguments
- $error
string
Error message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
since |
11.1 |
---|---|
see | \JObject::set() |
Arguments
- $properties
mixed
Either an associative array or another object.
Response
boolean
toString
Converts the object to a string (the class name).
toString() : string
Properties
_name
Element name
This has to be set in the final renderer classes.
since |
11.1 |
---|
Type(s)
string
_parent
Reference to the object that instantiated the element
since |
11.1 |
---|
Type(s)
object
_errors
An array of error messages or Exception objects.