GenericEvent
extends Event
in package
implements
ArrayAccess, IteratorAggregate
Class GenericEvent
use \OCP\EventDispatcher\Event
convenience re-implementation of \Symfony\Component\GenericEvent against \OCP\EventDispatcher\Event
Tags
Table of Contents
Interfaces
- ArrayAccess
- IteratorAggregate
Properties
- $arguments : mixed
- $subject : mixed
- $propagationStopped : bool
Methods
- __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() : Traversable
- Retrieve an external iterator
- getSubject() : mixed
- Getter for subject property.
- hasArgument() : bool
- Has argument.
- isPropagationStopped() : bool
- {@inheritDoc}
- offsetExists() : bool
- Whether a offset exists
- offsetGet() : mixed
- Offset to retrieve
- offsetSet() : void
- Offset to set
- offsetUnset() : void
- Offset to unset
- setArgument() : GenericEvent
- Add argument to event.
- setArguments() : GenericEvent
- Set args property.
- stopPropagation() : void
- Stops the propagation of the event to further event listeners
Properties
$arguments
protected
mixed
$arguments
$subject
protected
mixed
$subject
$propagationStopped
private
bool
$propagationStopped
= false
Tags
Methods
__construct()
Encapsulate an event with $subject and $args.
public
__construct([mixed $subject = null ][, array<string|int, mixed> $arguments = [] ]) : mixed
Parameters
- $subject : mixed = null
- $arguments : array<string|int, mixed> = []
Tags
getArgument()
Get argument by key.
public
getArgument(string $key) : mixed
Parameters
- $key : string
Tags
getArguments()
Getter for all arguments.
public
getArguments() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getIterator()
Retrieve an external iterator
public
getIterator() : Traversable
Tags
Return values
TraversablegetSubject()
Getter for subject property.
public
getSubject() : mixed
Tags
hasArgument()
Has argument.
public
hasArgument(mixed $key) : bool
Parameters
- $key : mixed
Tags
Return values
boolisPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Return values
booloffsetExists()
Whether a offset exists
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Tags
Return values
booloffsetGet()
Offset to retrieve
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
Tags
Attributes
- #[ReturnTypeWillChange]
offsetSet()
Offset to set
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
Tags
offsetUnset()
Offset to unset
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
Tags
setArgument()
Add argument to event.
public
setArgument(mixed $key, mixed $value) : GenericEvent
Parameters
- $key : mixed
- $value : mixed
Tags
Return values
GenericEventsetArguments()
Set args property.
public
setArguments([array<string|int, mixed> $args = [] ]) : GenericEvent
Parameters
- $args : array<string|int, mixed> = []
Tags
Return values
GenericEventstopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void