Event

Extends \Joomla\Event\AbstractEvent

Default Event class.

since

1.0

Methods

__construct

Constructor.

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

1.0

Arguments

$name

stringThe event name.

$arguments

arrayThe event arguments.

addArgument

Add an event argument, only if it is not existing.

addArgument(string $name, mixed $value) : \Joomla\Event\Event
since

1.0

Arguments

$name

stringThe argument name.

$value

mixedThe argument value.

Response

\Joomla\Event\EventThis method is chainable.

clearArguments

Clear all event arguments.

clearArguments() : array
since

1.0

Response

arrayThe old arguments.

count

Count the number of arguments.

count() : integer
inherited
since

1.0

Response

integerThe number of arguments.

getArgument

Get an event argument value.

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

1.0

Arguments

$name

stringThe argument name.

$default

mixedThe default value if not found.

Response

mixedThe argument value or the default value.

getArguments

Get all event arguments.

getArguments() : array
inherited
since

1.0

Response

arrayAn associative array of argument names as keys and their values as values.

getName

Get the event name.

getName() : string
inherited
since

1.0

Response

stringThe event name.

hasArgument

Tell if the given event argument exists.

hasArgument(string $name) : boolean
inherited
since

1.0

Arguments

$name

stringThe argument name.

Response

booleanTrue if it exists, false otherwise.

isStopped

Tell if the event propagation is stopped.

isStopped() : boolean
inherited
since

1.0

Response

booleanTrue if stopped, false otherwise.

offsetExists

Tell if the given event argument exists.

offsetExists(string $name) : boolean
inherited
since

1.0

Arguments

$name

stringThe argument name.

Response

booleanTrue if it exists, false otherwise.

offsetGet

Get an event argument value.

offsetGet(string $name) : mixed
inherited
since

1.0

Arguments

$name

stringThe argument name.

Response

mixedThe argument value or null if not existing.

offsetSet

Set the value of an event argument.

offsetSet(string $name, mixed $value) : void
throws

\InvalidArgumentExceptionIf the argument name is null.

since

1.0

Arguments

$name

stringThe argument name.

$value

mixedThe argument value.

offsetUnset

Remove an event argument.

offsetUnset(string $name) : void
since

1.0

Arguments

$name

stringThe argument name.

removeArgument

Remove an event argument.

removeArgument(string $name) : mixed
since

1.0

Arguments

$name

stringThe argument name.

Response

mixedThe old argument value or null if it is not existing.

serialize

Serialize the event.

serialize() : string
inherited
since

1.0

Response

stringThe serialized event.

setArgument

Set the value of an event argument.

setArgument(string $name, mixed $value) : \Joomla\Event\Event

If the argument already exists, it will be overridden.

since

1.0

Arguments

$name

stringThe argument name.

$value

mixedThe argument value.

Response

\Joomla\Event\EventThis method is chainable.

stop

Stop the event propagation.

stop() : void
since

1.0

unserialize

Unserialize the event.

unserialize(string $serialized) : void
inherited
since

1.0

Arguments

$serialized

stringThe serialized event.

Properties

name

The event name.

inherited
since

1.0

Type(s)

string

arguments

The event arguments.

inherited
since

1.0

Type(s)

array

stopped

A flag to see if the event propagation is stopped.

inherited
since

1.0

Type(s)

boolean