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.
Property Summary
-
$_eventClass protected
stringDefault class name for new event objects.
-
$_eventManager protected
Cake\Event\EventManagerInterface|Cake\Event\EventManagerInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
-
$factory protected
Cake\Http\ControllerFactoryController factory instance.
-
$filters protected
Cake\Event\EventListenerInterface[]Attached routing filters
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
-
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.
-
getFilters() public
Get the connected filters.
-
setEventManager() public
Returns the Cake\Event\EventManager manager instance for this object.
Method Detail
__construct() ¶ public
__construct(Cake\Http\ControllerFactory|null $factory = null, Cake\Event\EventManager|null $eventManager = null, Cake\Event\EventListenerInterface[] $filters = [])Constructor
Parameters
-
Cake\Http\ControllerFactory|null$factory optional A controller factory instance.
-
Cake\Event\EventManager|null$eventManager optional An event manager if you want to inject one.
-
Cake\Event\EventListenerInterface[]$filters optional The list of filters to include.
_invoke() ¶ protected
_invoke(Cake\Controller\Controller $controller): Cake\Http\ResponseInvoke a controller's action and wrapping methods.
Parameters
-
Cake\Controller\Controller$controller The controller to invoke.
Returns
Cake\Http\ResponseThrows
LogicExceptionIf the controller action returns a non-response value.
addFilter() ¶ public
addFilter(Cake\Event\EventListenerInterface $filter): voidAdd a filter to this dispatcher.
The added filter will be attached to the event manager used by this dispatcher.
Parameters
-
Cake\Event\EventListenerInterface$filter The filter to connect. Can be any EventListenerInterface. Typically an instance of \Cake\Routing\DispatcherFilter.
Returns
voiddispatch() ¶ public
dispatch(Cake\Http\ServerRequest $request, Cake\Http\Response $response): Cake\Http\ResponseDispatches a Request & Response
Parameters
-
Cake\Http\ServerRequest$request The request to dispatch.
-
Cake\Http\Response$response The response to dispatch.
Returns
Cake\Http\ResponseThrows
ReflectionExceptiondispatchEvent() ¶ public
dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventWrapper for creating and dispatching events.
Returns a dispatched event.
Parameters
-
string$name Name of the event.
-
array|null$data optional Any value you wish to be transported with this event to it can be read by listeners.
-
object|null$subject optional The object that this event applies to ($this by default).
Returns
Cake\Event\EventeventManager() ¶ public
eventManager(Cake\Event\EventManager|null $eventManager = null): Cake\Event\EventManagerReturns 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|null$eventManager optional the eventManager to set
Returns
Cake\Event\EventManagergetEventManager() ¶ public
getEventManager(): Cake\Event\EventManagerReturns 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() ¶ public
setEventManager(Cake\Event\EventManager $eventManager): $thisReturns 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
$thisProperty Detail
$_eventManager ¶ protected
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
Type
Cake\Event\EventManagerInterface|Cake\Event\EventManager