CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.10 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.10
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
      • Exception
      • Filter
      • Middleware
      • Route
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

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.

Property 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(string $name, array $options): Cake\Routing\DispatcherFilter

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(string|Cake\Routing\DispatcherFilter $filter, array $options = []): Cake\Routing\DispatcherFilter

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(): void

Clear the middleware stack.

Returns
void

create() ¶ public static

create(): Cake\Routing\Dispatcher

Create a dispatcher that has all the configured middleware applied.

Returns
Cake\Routing\Dispatcher

filters() ¶ public static

filters(): Cake\Routing\DispatcherFilter[]

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[]
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs