W3cubDocs

/CakePHP 3.8

Trait EventDispatcherTrait

Implements Cake\Event\EventDispatcherInterface.

Direct Users

Indirect Users

Properties summary

Method Summary

  • Wrapper for creating and dispatching events.
  • eventManager() public deprecated
    Returns the Cake\Event\EventManager manager instance for this object.
  • Returns the Cake\Event\EventManager manager instance for this object.
  • Returns the Cake\Event\EventManager manager instance for this object.

Method Detail

dispatchEvent()source public

dispatchEvent( string $name , array|null $data = null , object|null $subject = null )

Wrapper for creating and dispatching events.

Returns a dispatched event.

Parameters

string $name
Name of the event.
array|null $data optional null

Any value you wish to be transported with this event to it can be read by listeners.

object|null $subject optional null

The object that this event applies to ($this by default).

Returns

Cake\Event\Event

eventManager()source public deprecated

eventManager( Cake\Event\EventManager $eventManager = null )

Returns the Cake\Event\EventManager manager instance for this object.

You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.

Deprecated

3.5.0 Use getEventManager()/setEventManager() instead.

Parameters

Cake\Event\EventManager $eventManager optional null
the eventManager to set

Returns

Cake\Event\EventManager

getEventManager()source public

getEventManager( )

Returns the Cake\Event\EventManager manager instance for this object.

You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.

Returns

Cake\Event\EventManager

setEventManager()source public

setEventManager( Cake\Event\EventManager $eventManager )

Returns the Cake\Event\EventManager manager instance for this object.

You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.

Parameters

Cake\Event\EventManager $eventManager
the eventManager to set

Returns


$this

Properties detail

$_eventClasssource

protected string

Default class name for new event objects.

Event::class

$_eventManagersource

protected Cake\Event\EventManagerInterface|Cake\Event\EventManager

Instance of the Cake\Event\EventManager this object is using to dispatch inner events.

© 2005–present 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.8/class-Cake.Event.EventDispatcherTrait.html