EditorButtonsSetupEvent
Extends AbstractImmutableEventEditor setup event
| since |
5.0.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor.
__construct( name, mixed||string|int arguments = []) :
| throws |
|
|---|---|
| since |
5.0.0 |
Arguments
- name
stringThe event name.- arguments
array<string|int, mixed>The event arguments.
Response
mixed
create
Creates a new CMS event object for a given event name and subject. The following arguments must be given: subject object The subject of the event. This is the core object you are going to manipulate.
create( eventName, mixed||string|int arguments = []) :
eventClass string The Event class name. If you do not provide it Joomla\CMS\Events<eventNameWithoutOnPrefix> will be used.
| since |
4.0.0 |
|---|---|
| throws |
|
Arguments
- eventName
stringThe name of the event, e.g. onTableBeforeLoad- arguments
array<string|int, mixed>Additional arguments to pass to the event
Response
static
getArgument
Get an event argument value.
getArgument( name, default = null) :
It will use a pre-processing method if one exists. The method has the signature:
onGet<ArgumentName>($value): mixed
where:
$value is the value currently stored in the $arguments array of the event It returns the value to return to the caller.
| since |
4.0.0 |
|---|
Arguments
- name
stringThe argument name.- default
mixedThe default value if not found.
Response
mixedThe argument value or the default value.
getAsset
Getter for the asset argument.
getAsset() :
| since |
5.0.0 |
|---|
Response
int
getAuthor
Getter for the author argument.
getAuthor() :
| since |
5.0.0 |
|---|
Response
int
getButtonsRegistry
Returns Buttons Registry instance.
getButtonsRegistry() : \Joomla\CMS\Editor\Button\ButtonsRegistryInterface
getDisabledButtons
Getter for the disabled buttons argument.
getDisabledButtons() : mixed||string|int
| since |
5.0.0 |
|---|
Response
array<string|int, mixed>
getEditorId
Getter for the Editor ID argument.
getEditorId() :
| since |
5.0.0 |
|---|
Response
string
getEditorType
Getter for the Editor Type argument.
getEditorType() :
| since |
5.0.0 |
|---|
Response
string
getEventClassByEventName
Get the concrete event class name for the given event name.
getEventClassByEventName( eventName) :
This method falls back to the generic Joomla\Event\Event class if the event name is unknown to this trait.
| since |
4.2.0 |
|---|
Arguments
- eventName
stringThe event name
Response
stringThe event class name
offsetSet
Set the value of an event argument.
offsetSet( name, value) :
| since |
4.0.0 |
|---|---|
| throws |
|
Arguments
- name
stringThe argument name.- value
mixedThe argument value.
Response
void
offsetUnset
Remove an event argument.
offsetUnset( name) :
| since |
4.0.0 |
|---|---|
| throws |
|
Arguments
- name
stringThe argument name.
Response
void
onSetAsset
Setter for the asset argument.
onSetAsset( value) :
| since |
5.0.0 |
|---|
Arguments
- value
intThe value to set
Response
int
onSetAuthor
Setter for the author argument.
onSetAuthor( value) :
| since |
5.0.0 |
|---|
Arguments
- value
intThe value to set
Response
int
onSetDisabledButtons
Setter for the disabled buttons argument.
onSetDisabledButtons(mixed||string|int value) : mixed||string|int
| since |
5.0.0 |
|---|
Arguments
- value
array<string|int, mixed>The value to set
Response
array<string|int, mixed>
onSetEditorId
Setter for the Editor ID argument.
onSetEditorId( value) :
| since |
5.0.0 |
|---|
Arguments
- value
stringThe value to set
Response
string
onSetEditorType
Setter for the Editor Type argument.
onSetEditorType( value) :
| since |
5.0.0 |
|---|
Arguments
- value
stringThe value to set
Response
string
onSetSubject
Setter for the subject argument.
onSetSubject(\Joomla\CMS\Editor\Button\ButtonsRegistryInterface value) : \Joomla\CMS\Editor\Button\ButtonsRegistryInterface
setArgument
Add argument to event.
setArgument( name, value) :
It will use a pre-processing method if one exists. The method has the signature:
onSet<ArgumentName>($value): mixed
where:
$value is the value being set by the user It returns the value to return to set in the $arguments array of the event.
| since |
4.0.0 |
|---|
Arguments
- name
stringArgument name.- value
mixedValue.
Response
$this
Properties
eventNameToConcreteClass
Maps event names to concrete Event classes.
This is only for events with invariable names. Events with variable names are handled with PHP logic in the getEventClassByEventName class.
| since |
4.2.0 |
|---|
Type(s)
array<string|int, mixed>