On this page
Class DispatcherFactory
A factory for creating dispatchers with all the desired middleware connected.
Properties summary
-
Stack of middleware to apply to dispatchers.
array
Method Summary
- Create an instance of a filter.
-
Add a new middleware object to the stack of middleware that will be executed.
- Clear the middleware stack.
- Create a dispatcher that has all the configured middleware applied.
- Get the connected dispatcher filters.
Method Detail
_createFilter()source protected static
_createFilter( string $name , array $options )
Create an instance of a filter.
Parameters
-
string
$name - The name of the filter to build.
-
array
$options - Constructor arguments/options for the filter.
Returns
Cake\Routing\DispatcherFilterThrows
Cake\Routing\Exception\MissingDispatcherFilterExceptionWhen filters cannot be found.
add()source public static
add( string|Cake\Routing\DispatcherFilter $filter , array $options [] )
Add a new middleware object to the stack of middleware that will be executed.
Instances of filters will be re-used across all sub-requests in a request.
Parameters
-
string|
Cake\Routing\DispatcherFilter$filter -
Either the classname of the filter or an instance to use.
-
array
$optionsoptional [] -
Constructor arguments/options for the filter if you are using a string name. If you are passing an instance, this argument will be ignored.
Returns
Cake\Routing\DispatcherFiltercreate()source public static
create( )
Create a dispatcher that has all the configured middleware applied.
Returns
Cake\Routing\DispatcherProperties detail
© 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/3.2/class-Cake.Routing.DispatcherFactory.html