Trait EventDispatcherTrait
Implements Cake\Event\EventDispatcherInterface.
Direct Users
- Cake\Console\CommandRunner
- Cake\Controller\Component\AuthComponent
- Cake\ORM\Table
- Cake\Routing\Dispatcher
- Cake\View\Cell
- Cake\View\HelperRegistry
- Cake\View\View
- Cake\Controller\ComponentRegistry
- Cake\Controller\Controller
- Cake\Event\EventManagerTrait
- Cake\Form\Form
- Cake\Http\ActionDispatcher
- Cake\Http\BaseApplication
- Cake\Http\Server
- Cake\ORM\BehaviorRegistry
Indirect Users
Properties summary
-
$_eventClassprotectedstringDefault class name for new event objects. -
$_eventManagerprotectedInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
Method Summary
-
dispatchEvent() public
Wrapper for creating and dispatching events. -
eventManager() public deprecated
Returns the Cake\Event\EventManager manager instance for this object. -
getEventManager() public
Returns the Cake\Event\EventManager manager instance for this object. -
setEventManager() public
Returns the Cake\Event\EventManager manager instance for this object.
Method Detail
dispatchEvent() 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
eventManager() 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
Parameters
-
Cake\Event\EventManager$eventManager optional null - the eventManager to set
Returns
getEventManager() 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
setEventManager() 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
$_eventManager ¶
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.