On this page
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
- Cake\Controller\ErrorController
- Cake\View\AjaxView
- Cake\View\JsonView
- Cake\View\SerializedView
- Cake\View\XmlView
Properties summary
-
$_eventClassprotectedDefault class name for new event objects.string -
$_eventManagerprotectedInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
Method Summary
-
dispatchEvent() publicWrapper for creating and dispatching events.
- Returns the Cake\Event\EventManager manager instance for this object.
-
getEventManager() publicReturns the Cake\Event\EventManager manager instance for this object.
-
setEventManager() publicReturns 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
$dataoptional null -
Any value you wish to be transported with this event to it can be read by listeners.
-
object|null
$subjectoptional null -
The object that this event applies to ($this by default).
Returns
Cake\Event\EventeventManager()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$eventManageroptional null- the eventManager to set
Returns
Cake\Event\EventManagergetEventManager()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\EventManagersetEventManager()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
$_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.7/class-Cake.Event.EventDispatcherTrait.html