Button
Implements ButtonInterface| package |
Joomla CMS |
|---|
Methods
__construct
Class constructor;
__construct( name, mixed||string|int props = [], mixed||string|int options = []) :
| since |
5.0.0 |
|---|
Arguments
- name
stringThe button name- props
array<string|int, mixed>The button properties.- options
array<string|int, mixed>The button options.
Response
mixed
__get
Magic method to access a property.
__get( name) : string|null
| since |
5.0.0 |
|---|---|
| deprecated |
7.0 This is a B/C proxy for deprecated read accesses |
Arguments
- name
stringThe name of the property.
Response
string|nullA value if the property name is valid, null otherwise.
__set
Magic method to access property.
__set( name, value) :
| since |
5.0.0 |
|---|---|
| deprecated |
7.0 This is a B/C proxy for deprecated write accesses |
Arguments
- name
stringThe name of the property.- value
mixedThe value of the property.
Response
void
get
Return Button property.
get( name, default = null) :
| since |
5.0.0 |
|---|
Arguments
- name
stringProperty name- default
stringDefault value
Response
mixed
getButtonName
Return Button name, CMD string.
getButtonName() :
| since |
5.0.0 |
|---|
Response
string
getOptions
Return Button options.
getOptions() : mixed||string|int
| since |
5.0.0 |
|---|
Response
array<string|int, mixed>
set
Set Button property.
set( name, value) : \Joomla\CMS\Editor\Button\ButtonInterface
setOptions
Set Button options.
setOptions(mixed||string|int options) : \Joomla\CMS\Editor\Button\ButtonInterface
Properties
name
Button name, CMD string.
| return | |
|---|---|
| since |
5.0.0 |
props
Button properties.
| return | |
|---|---|
| since |
5.0.0 |
options
Button options.
| return | |
|---|---|
| since |
5.0.0 |