W3cubDocs

/CakePHP 3.8

Class DispatcherFactory

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

Namespace: Cake\Routing
Deprecated:

3.6.0 This class is part of the deprecated dispatcher system. Use Http\Server instead.


Location: Routing/DispatcherFactory.php

Properties summary

Method Summary

  • _createFilter() protected static deprecated
    Create an instance of a filter.
  • add() public static deprecated

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

  • clear() public static deprecated
    Clear the middleware stack.
  • create() public static deprecated
    Create a dispatcher that has all the configured middleware applied.
  • filters() public static deprecated
    Get the connected dispatcher filters.

Method Detail

_createFilter()source protected static deprecated

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

Throws

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

add()source public static deprecated

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 $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()source public static deprecated

clear( )

Clear the middleware stack.

create()source public static deprecated

create( )

Create a dispatcher that has all the configured middleware applied.

Returns

Cake\Routing\Dispatcher

filters()source public static deprecated

filters( )

Get the connected dispatcher filters.

Returns

Cake\Routing\DispatcherFilter[]

Properties detail

$_stacksource

protected static Cake\Routing\DispatcherFilter[]

Stack of middleware to apply to dispatchers.

[]

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