MenuitemField
Extends \JFormFieldGroupedListSupports an HTML grouped select list of menu item grouped by menu
Provides a grouped list select field.
| since |
1.6 |
|---|
Methods
__get
Method to get certain otherwise inaccessible properties from the form field object.
__get(string $name) : mixed
| since |
3.2 |
|---|
Arguments
- $name
stringThe property name for which to get the value.
Response
mixedThe property value or null.
__set
Method to set certain otherwise inaccessible properties of the form field object.
__set(string $name, mixed $value) : void
| since |
3.2 |
|---|
Arguments
- $name
stringThe property name for which to set the value.- $value
mixedThe value of the property.
getGroups
Method to get the field option groups.
getGroups() : array
| since |
1.7.0 |
|---|---|
| throws |
|
Response
arrayThe field option objects as a nested array in groups.
getInput
Method to get the field input markup fora grouped list.
getInput() : string
Multiselect is enabled by using the multiple attribute.
| since |
1.7.0 |
|---|
Response
stringThe field input markup.
setup
Method to attach a JForm object to the field.
setup(\SimpleXMLElement $element, mixed $value, string $group = null) : boolean
| see | \Joomla\CMS\Form\Field\FormField::setup() |
|---|---|
| since |
3.2 |
Arguments
- $element
\SimpleXMLElementThe SimpleXMLElement object representing the<field>tag for the form field object.- $value
mixedThe form field value to validate.- $group
stringThe field name group control value. This acts as an array container for the field. For example if the field has name="foo" and the group value is set to "bar" then the full field name would end up being "bar[foo]".
Response
booleanTrue on success.
Properties
type
The form field type.
| since |
1.7.0 |
|---|
Type(s)
string
clientId
The client id.
| since |
3.2 |
|---|
Type(s)
string
language
The language.
| since |
3.2 |
|---|
Type(s)
array
published
The published status.
| since |
3.2 |
|---|
Type(s)
array
disable
The disabled status.
| since |
3.2 |
|---|
Type(s)
array