This abstract class represents a filter to be applied to a dispatcher cycle. It acts as as event listener with the ability to alter the request or response as needed before it is handled by a controller or after the response body has already been built.
__construct( array $settings array() )
Constructor.
$settings
optional array() afterDispatch( CakeEvent $event )
Method called after the controller served a request and generated a response. It is possible to alter the response object at this point as it is not sent to the client yet.
If false is returned, the event will be stopped and no more listeners will be notified. Alternatively you can call $event->stopPropagation()
to achieve the same result.
CakeEvent
$event
request
and response
keys in the data property.mixed
beforeDispatch( CakeEvent $event )
Method called before the controller is instantiated and called to serve a request. If used with default priority, it will be called after the Router has parsed the URL and set the routing params into the request object.
If a CakeResponse object instance is returned, it will be served at the end of the event cycle, not calling any controller as a result. This will also have the effect of not calling the after event in the dispatcher.
If false is returned, the event will be stopped and no more listeners will be notified. Alternatively you can call $event->stopPropagation()
to achieve the same result.
CakeEvent
$event
request
, response
and additionalParams
keys in the data property.CakeResponse|boolean
implementedEvents( )
Returns the list of events this filter listens to. Dispatcher notifies 2 different events Dispatcher.before
and Dispatcher.after
. By default this class will attach preDispatch
and postDispatch
method respectively.
Override this method at will to only listen to the events you are interested in.
array
CakeEventListener::implementedEvents()
© 2005–2016 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.
http://api.cakephp.org/2.7/class-DispatcherFilter.html