Class DispatcherFilter

$filter = new BlogFilter(['for' => '/blog']);

$filter = new BlogFilter(['for' => 'preg:#^/blog/\d+$#']);

$cookieMonster = new CookieFilter([
  'when' => function ($req, $res) {
    // Custom code goes here.
  }
]);

__constructsource public

__construct( array $config [] )

Constructor.

Parameters

array $config optional []

Settings for the filter.

Throws

InvalidArgumentException
When 'when' conditions are not callable.

afterDispatchsource public

afterDispatch( Cake\Event\Event $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.

Parameters

Cake\Event\Event $event

container object having the request and response keys in the data property.

beforeDispatchsource public

beforeDispatch( Cake\Event\Event $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 Cake\Network\Response 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.

Parameters

Cake\Event\Event $event

container object having the request, response and additionalParams keys in the data property.

handlesource public

handle( Cake\Event\Event $event )

Handler method that applies conditions and resolves the correct method to call.

Parameters

Cake\Event\Event $event

The event instance.

Returns

mixed
mixed

implementedEventssource public

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.

Returns

array
array

Implementation of

Cake\Event\EventListenerInterface::implementedEvents()

matchessource public

matches( Cake\Event\Event $event )

Check to see if the incoming request matches this filter's criteria.

Parameters

Cake\Event\Event $event

The event to match.

Returns

boolean
bool

_configDeletesource protected

_configDelete( string $key )

Delete a single config key

Parameters

string $key

Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configReadsource protected

_configRead( string|null $key )

Read a config variable

Parameters

string|null $key

Key to read.

Returns

mixed
mixed

_configWritesource protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Write a config variable

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

boolean|string $merge optional false

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

configsource public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

Reading a nested value:

$this->config('some.nested.key');

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);

Parameters

string|array|null $key optional null

The key to get/set, or a complete array of configs.

mixed|null $value optional null

The value to set.

boolean $merge optional true

Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed
Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallowsource public

configShallow( string|array $key , mixed|null $value null )

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional null

The value to set.

Returns

mixed
$this The object itself.

[
    'when' => null,
    'for' => null,
    'priority' => null,
]

10

[]

false