AfterLoadEvent

Extends \Joomla\CMS\Event\Table\AbstractEvent

Event class for JTable's onAfterLoad event

You can create a new Event with something like this:

$event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments);

You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject.

This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.

since

4.0.0

Methods

__construct

Constructor. Overridden to go through the argument setters.

__construct(string $name, array $arguments = array()) 
inherited
since

4.0.0

Arguments

$name

stringThe event name.

$arguments

arrayThe event arguments.

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(string $eventName, array $arguments = array()) : static
inherited static

eventClass string The Event class name. If you do not provide it Joomla\CMS\Events\ will be used.

since

4.0.0

throws

\BadMethodCallExceptionIf you do not provide a subject argument

Arguments

$eventName

stringThe name of the event, e.g. onTableBeforeLoad

$arguments

arrayAdditional arguments to pass to the event

Response

static

getArgument

Get an event argument value. It will use a getter method if one exists. The getters have the signature:

getArgument(string $name, mixed $default = null) : mixed
inherited

get($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.

offsetSet

Set the value of an event argument.

offsetSet(string $name, mixed $value) : void
inherited
since

4.0.0

throws

\BadMethodCallException

Arguments

$name

stringThe argument name.

$value

mixedThe argument value.

offsetUnset

Remove an event argument.

offsetUnset(string $name) : void
inherited
since

4.0.0

throws

\BadMethodCallException

Arguments

$name

stringThe argument name.

setArgument

Add argument to event. It will use a setter method if one exists. The setters have the signature:

setArgument(string $name, mixed $value) : $this
inherited

set($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(boolean $value) : boolean
throws

\BadMethodCallExceptionif the argument is not of the expected type

Arguments

$value

booleanThe value to set

Response

boolean

setRow

Setter for the row argument

setRow(array|null $value) : array|null
throws

\BadMethodCallExceptionif the argument is not of the expected type

Arguments

$value

array|nullThe value to set

Response

array|null

setSubject

Setter for the subject argument

setSubject(\JTableInterface $value) : \JTableInterface
inherited
throws

\BadMethodCallExceptionif the argument is not of the expected type

Arguments

$value

\JTableInterfaceThe value to set

Response

\JTableInterface

Properties

constructed

A flag to see if the constructor has been already called.

inherited
since

4.0.0

Type(s)

boolean