Class ControllerFactoryFilter

A dispatcher filter that builds the controller to dispatch in the request.

This filter resolves the request parameters into a controller instance and attaches it to the event object.

Namespace: Cake\Routing\Filter

Properties summary

  • $_config protected
    array

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array

    Default config

  • $_priority protected
    int

    Priority is set high to allow other filters to be called first.

Method Summary

  • __construct() public

    Constructor.

  • _configDelete() protected

    Deletes a single config key.

  • _configRead() protected

    Reads a config key.

  • _configWrite() protected

    Writes a config key.

  • _getController() protected

    Gets controller to use, either plugin or application controller.

  • afterDispatch() public

    Method called after the controller served a request and generated a response.

  • beforeDispatch() public

    Resolve the request parameters into a controller and attach the controller to the event object.

  • config() public

    Gets/Sets the config.

  • configShallow() public

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

  • getConfig() public

    Returns the config.

  • getConfigOrFail() public

    Returns the config for this specific key.

  • handle() public

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

  • implementedEvents() public

    Returns the list of events this filter listens to.

  • matches() public

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

  • setConfig() public

    Sets the config.

Method Detail

__construct() public 

__construct(mixed $config)

Constructor.

Parameters

array $config optional

Settings for the filter.

Throws

InvalidArgumentException
When 'when' conditions are not callable.

_configDelete() protected 

_configDelete(mixed $key)

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

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

_configRead() protected 

_configRead(mixed $key)

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite() protected 

_configWrite(mixed $key, mixed $value, mixed $merge)

Writes a config key.

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

bool|string $merge optional

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

_getController() protected 

_getController(mixed $request, mixed $response)

Gets controller to use, either plugin or application controller.

Parameters

\Cake\Http\ServerRequest $request

Request object

\Cake\Http\Response $response

Response for the controller.

Returns

\Cake\Controller\Controller

Throws

ReflectionException

afterDispatch() 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.

beforeDispatch() public 

beforeDispatch(\Cake\Event\Event $event)

Resolve the request parameters into a controller and attach the controller to the event object.

Parameters

\Cake\Event\Event $event

The event instance.

config() public 

config(mixed $key, mixed $value, mixed $merge)

Gets/Sets the config.

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

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

mixed|null $value optional

The value to set.

bool $merge optional

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.

configShallow() public 

configShallow(mixed $key, mixed $value)

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->configShallow('key', $value);

Setting a nested value:

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

Updating multiple config settings at the same time:

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

Parameters

string|array $key

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

mixed|null $value optional

The value to set.

Returns

$this

getConfig() public 

getConfig(mixed $key, mixed $default)

Returns the config.

Usage

Reading the whole config:

$this->getConfig();

Reading a specific value:

$this->getConfig('key');

Reading a nested value:

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

Reading with default value:

$this->getConfig('some-key', 'default-value');

Parameters

string|null $key optional

The key to get or null for the whole config.

mixed|null $default optional

The return value when the key does not exist.

Returns

mixed|null

Configuration data at the named key or null if the key does not exist.

getConfigOrFail() public 

getConfigOrFail(mixed $key)

Returns the config for this specific key.

The config value for this key must exist, it can never be null.

Parameters

string|null $key

The key to get.

Returns

mixed

Configuration data at the named key

Throws

InvalidArgumentException

handle() 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

implementedEvents() 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

matches() 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

bool

setConfig() public 

setConfig(mixed $key, mixed $value, mixed $merge)

Sets the config.

Usage

Setting a specific value:

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

Setting a nested value:

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

Updating multiple config settings at the same time:

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

Parameters

string|array $key

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

mixed|null $value optional

The value to set.

bool $merge optional

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

Returns

$this

Throws

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

Property Detail

$_config protected

Runtime config

Type

array

$_configInitialized protected

Whether the config property has already been configured with defaults

Type

bool

$_defaultConfig protected

Default config

These are merged with user-provided config when the class is used. The when and for options allow you to define conditions that are checked before your filter is called.

Type

array

$_priority protected

Priority is set high to allow other filters to be called first.

Type

int

© 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.Filter.ControllerFactoryFilter.html