AfterLoadEvent
Extends AbstractEventEvent class for JTable's onAfterLoad event
| since |
4.0.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor.
__construct( name, mixed||string|int arguments = []) :
Mandatory arguments: subject JTableInterface The table we are operating on result boolean Did the table record load succeed? row null|array The values loaded from the database, null if it failed
| throws |
|
|---|
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.
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
onSetResult
Setter for the result argument
onSetResult( value) :
| throws |
|
|---|---|
| since |
4.4.0 |
Arguments
- value
boolThe value to set
Response
bool
onSetRow
Setter for the row argument
onSetRow(array|null value) : array|null
| throws |
|
|---|---|
| since |
4.4.0 |
Arguments
- value
array<string|int, mixed>|nullThe value to set
Response
array<string|int, mixed>|null
onSetSubject
Setter for the subject argument
onSetSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
| throws |
|
|---|---|
| since |
4.4.0 |
Arguments
- value
TableInterfaceThe value to set
Response
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
setResult
Setter for the result argument
setResult( value) :
| throws |
|
|---|---|
| deprecated |
4.4.0 will be removed in 6.0 Use counterpart with onSet prefix |
Arguments
- value
boolThe value to set
Response
bool
setRow
Setter for the row argument
setRow(array|null value) : array|null
| throws |
|
|---|---|
| deprecated |
4.4.0 will be removed in 6.0 Use counterpart with onSet prefix |
Arguments
- value
array<string|int, mixed>|nullThe value to set
Response
array<string|int, mixed>|null
setSubject
Setter for the subject argument
setSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
| throws |
|
|---|---|
| deprecated |
4.4.0 will be removed in 6.0 Use counterpart with onSet prefix |
Arguments
- value
TableInterfaceThe value to set
Response
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>
constructed
A flag to see if the constructor has been already called.
| since |
4.0.0 |
|---|
Type(s)
bool