\Cake\EventEventList

The Event List

Summary

Methods
Properties
Constants
flush()
add()
offsetExists()
offsetGet()
offsetSet()
offsetUnset()
count()
hasEvent()
No public properties found
No constants found
No protected methods found
$_events
N/A
No private methods found
No private properties found
N/A

Properties

$_events

$_events : array<mixed,\Cake\Event\Event>

Events list

Type

array<mixed,\Cake\Event\Event>

Methods

flush()

flush() : void

Empties the list of dispatched events.

add()

add(\Cake\Event\Event  $event) : void

Adds an event to the list when event listing is enabled.

Parameters

\Cake\Event\Event $event

An event to the list of dispatched events.

offsetExists()

offsetExists(mixed  $offset) : boolean

Whether a offset exists

Parameters

mixed $offset

An offset to check for.

Returns

boolean —

True on success or false on failure.

offsetGet()

offsetGet(mixed  $offset) : mixed

Offset to retrieve

Parameters

mixed $offset

The offset to retrieve.

Returns

mixed —

Can return all value types.

offsetSet()

offsetSet(mixed  $offset, mixed  $value) : void

Offset to set

Parameters

mixed $offset

The offset to assign the value to.

mixed $value

The value to set.

offsetUnset()

offsetUnset(mixed  $offset) : void

Offset to unset

Parameters

mixed $offset

The offset to unset.

count()

count() : integer

Count elements of an object

Returns

integer —

The custom count as an integer.

hasEvent()

hasEvent(string  $name) : boolean

Checks if an event is in the list.

Parameters

string $name

Event name.

Returns

boolean