ErrorEvent

Extends AbstractEvent

Event class for representing the application's `onError` event

since

4.0.0

package

Joomla CMS

Methods

__construct

Constructor. Overridden to go through the argument setters.

__construct( name, mixed||string|int arguments = []) : 
inherited
since

4.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 = []) : 
inherited static

eventClass string The Event class name. If you do not provide it Joomla\CMS\Events<eventNameWithoutOnPrefix> 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

array<string|int, mixed>Additional arguments to pass to the event

Response

static

getApplication

Get the event's application object

getApplication() : \Joomla\Application\AbstractApplication
since

4.0.0

Response

AbstractApplication

getArgument

Get an event argument value.

getArgument( name,  default = null) : 
inherited

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.

getError

Get the event's error object

getError() : \Throwable
since

4.0.0

Response

Throwable

getEventClassByEventName

Get the concrete event class name for the given event name.

getEventClassByEventName( eventName) : 
inherited static

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

setArgument

Add argument to event.

setArgument( name,  value) : 
inherited

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

setError

Set the event's error object

setError(\Throwable error) : 
since

4.0.0

Arguments

error

ThrowableThe new error to process

Response

void

Properties

eventNameToConcreteClass

Maps event names to concrete Event classes.

inherited static

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>