Documentation

GenericEvent extends Event
in package
implements ArrayAccess, IteratorAggregate

Event encapsulation class.

Encapsulates events thus decoupling the observer from the subject they encapsulate.

Tags
author

Drak drak@zikula.org

Interfaces, Classes and Traits

ArrayAccess
IteratorAggregate

Table of Contents

$arguments  : mixed
$subject  : mixed
$propagationStopped  : mixed
__construct()  : mixed
Encapsulate an event with $subject and $args.
getArgument()  : mixed
Get argument by key.
getArguments()  : array<string|int, mixed>
Getter for all arguments.
getIterator()  : ArrayIterator
IteratorAggregate for iterating over the object like an array.
getSubject()  : mixed
Getter for subject property.
hasArgument()  : bool
Has argument.
isPropagationStopped()  : bool
Is propagation stopped?
offsetExists()  : bool
ArrayAccess has argument.
offsetGet()  : mixed
ArrayAccess for argument getter.
offsetSet()  : mixed
ArrayAccess for argument setter.
offsetUnset()  : mixed
ArrayAccess for unset argument.
setArgument()  : $this
Add argument to event.
setArguments()  : $this
Set args property.
stopPropagation()  : void
Stops the propagation of the event to further event listeners.

Properties

$propagationStopped

private mixed $propagationStopped = false

Methods

__construct()

Encapsulate an event with $subject and $args.

public __construct([mixed $subject = null ][, array<string|int, mixed> $arguments = [] ]) : mixed
Parameters
$subject : mixed = null

The subject of the event, usually an object or a callable

$arguments : array<string|int, mixed> = []

Arguments to store in the event

Return values
mixed —

getArgument()

Get argument by key.

public getArgument(string $key) : mixed
Parameters
$key : string
Tags
throws
InvalidArgumentException

if key is not found

Return values
mixed —

Contents of array key

getArguments()

Getter for all arguments.

public getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getIterator()

IteratorAggregate for iterating over the object like an array.

public getIterator() : ArrayIterator
Return values
ArrayIterator —

getSubject()

Getter for subject property.

public getSubject() : mixed
Return values
mixed —

The observer subject

hasArgument()

Has argument.

public hasArgument(string $key) : bool
Parameters
$key : string
Return values
bool —

isPropagationStopped()

Is propagation stopped?

public isPropagationStopped() : bool
Return values
bool —

True if the Event is complete and no further listeners should be called. False to continue calling listeners.

offsetExists()

ArrayAccess has argument.

public offsetExists(string $key) : bool
Parameters
$key : string

Array key

Return values
bool —

offsetGet()

ArrayAccess for argument getter.

public offsetGet(string $key) : mixed
Parameters
$key : string

Array key

Tags
throws
InvalidArgumentException

if key does not exist in $this->args

Return values
mixed —

offsetSet()

ArrayAccess for argument setter.

public offsetSet(string $key, mixed $value) : mixed
Parameters
$key : string

Array key to set

$value : mixed

Value

Return values
mixed —

offsetUnset()

ArrayAccess for unset argument.

public offsetUnset(string $key) : mixed
Parameters
$key : string

Array key

Return values
mixed —

setArgument()

Add argument to event.

public setArgument(string $key, mixed $value) : $this
Parameters
$key : string
$value : mixed

Value

Return values
$this —

setArguments()

Set args property.

public setArguments([array<string|int, mixed> $args = [] ]) : $this
Parameters
$args : array<string|int, mixed> = []
Return values
$this —

stopPropagation()

Stops the propagation of the event to further event listeners.

public stopPropagation() : void

If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().

Return values
void —

Search results