Class ActionDispatcher
This class provides compatibility with dispatcher filters and interacting with the controller layers.
Long term this should just be the controller dispatcher, but for now it will do a bit more than that.
- Cake\Http\ActionDispatcher uses Cake\Event\EventDispatcherTrait
Properties summary
Inherited Properties
Method Summary
-
__construct() public
Constructor -
_invoke() protected
Invoke a controller's action and wrapping methods. -
addFilter() public deprecated
Add a filter to this dispatcher. -
dispatch() public
Dispatches a Request & Response -
getFilters() public
Get the connected filters.
Method Detail
__construct() public ¶
__construct( Cake\Http\ControllerFactory|null $factory = null , Cake\Event\EventManager|null $eventManager = null , array $filters = [] )
Constructor
Parameters
-
Cake\Http\ControllerFactory|null $factory optional null - A controller factory instance.
-
Cake\Event\EventManager|null $eventManager optional null - An event manager if you want to inject one.
- array $filters optional []
- The list of filters to include.
_invoke() protected ¶
_invoke( Cake\Controller\Controller $controller )
Invoke a controller's action and wrapping methods.
Parameters
-
Cake\Controller\Controller$controller - The controller to invoke.
Returns
Throws
If the controller action returns a non-response value.
addFilter() public deprecated ¶
addFilter( Cake\Event\EventListenerInterface $filter )
Add a filter to this dispatcher.
The added filter will be attached to the event manager used by this dispatcher.
Deprecated
Parameters
-
Cake\Event\EventListenerInterface$filter The filter to connect. Can be any EventListenerInterface. Typically an instance of \Cake\Routing\DispatcherFilter.
dispatch() public ¶
dispatch( Cake\Http\ServerRequest $request , Cake\Http\Response $response )
Dispatches a Request & Response
Parameters
-
Cake\Http\ServerRequest$request - The request to dispatch.
-
Cake\Http\Response$response - The response to dispatch.
Returns
Throws
Methods used from Cake\Event\EventDispatcherTrait
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