Class DispatcherFactory

A factory for creating dispatchers with all the desired middleware connected.

Namespace: Cake\Routing

Properties summary

  • $_stack protected static
    \Cake\Routing\DispatcherFilter[]

    Stack of middleware to apply to dispatchers.

Method Summary

  • _createFilter() protected static

    Create an instance of a filter.

  • add() public static

    Add a new middleware object to the stack of middleware that will be executed.

  • clear() public static

    Clear the middleware stack.

  • create() public static

    Create a dispatcher that has all the configured middleware applied.

  • filters() public static

    Get the connected dispatcher filters.

Method Detail

_createFilter() protected static 

_createFilter(mixed $name, mixed $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\DispatcherFilter

Throws

Cake\Routing\Exception\MissingDispatcherFilterException
When filters cannot be found.

add() public static 

add(mixed $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 $options optional

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\DispatcherFilter

clear() public static 

clear()

Clear the middleware stack.

create() public static 

create()

Create a dispatcher that has all the configured middleware applied.

Returns

\Cake\Routing\Dispatcher

filters() public static 

filters()

Get the connected dispatcher filters.

Returns

\Cake\Routing\DispatcherFilter[]

Property Detail

$_stack protected static

Stack of middleware to apply to dispatchers.

Type

\Cake\Routing\DispatcherFilter[]

© 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.9/class-Cake.Routing.DispatcherFactory.html