Class EventList
The Event List
- Cake\Event\EventList implements ArrayAccess, Countable
Properties summary
-
$_events
protected
Method Summary
- add() publicAdds an event to the list when event listing is enabled.
- count() publicCount elements of an object
- flush() publicEmpties the list of dispatched events.
- hasEvent() publicChecks if an event is in the list.
- offsetExists() publicWhether a offset exists
- offsetGet() publicOffset to retrieve
- offsetSet() publicOffset to set
- offsetUnset() publicOffset to unset
Method Detail
add()source public
add( Cake\Event\Event $event )
Adds an event to the list when event listing is enabled.
Parameters
-
Cake\Event\Event
$event
- An event to the list of dispatched events.
count()source public
count( )
Count elements of an object
Returns
integerThe custom count as an integer.
Link
https://secure.php.net/manual/en/countable.count.phpImplementation of
Countable::count()
hasEvent()source public
hasEvent( string $name )
Checks if an event is in the list.
Parameters
- string
$name
- Event name.
Returns
booleanoffsetExists()source public
offsetExists( mixed $offset )
Whether a offset exists
Parameters
- mixed
$offset
- An offset to check for.
Returns
booleanTrue on success or false on failure.
Link
https://secure.php.net/manual/en/arrayaccess.offsetexists.phpImplementation of
ArrayAccess::offsetExists()
offsetGet()source public
offsetGet( mixed $offset )
Offset to retrieve
Parameters
- mixed
$offset
- The offset to retrieve.
Returns
mixedCan return all value types.
Link
https://secure.php.net/manual/en/arrayaccess.offsetget.phpImplementation of
ArrayAccess::offsetGet()
offsetSet()source public
offsetSet( mixed $offset , mixed $value )
Offset to set
Parameters
- mixed
$offset
- The offset to assign the value to.
- mixed
$value
- The value to set.
Link
https://secure.php.net/manual/en/arrayaccess.offsetset.phpImplementation of
ArrayAccess::offsetSet()
offsetUnset()source public
offsetUnset( mixed $offset )
Offset to unset
Parameters
- mixed
$offset
- The offset to unset.
Link
https://secure.php.net/manual/en/arrayaccess.offsetunset.phpImplementation of
ArrayAccess::offsetUnset()
Properties detail
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Event.EventList.html