W3cubDocs

/CakePHP 3.8

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.

Cake\Routing\DispatcherFilter implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
Extended by Cake\Routing\Filter\ControllerFactoryFilter

Properties summary

  • $_priority protected
    integer
    Priority is set high to allow other filters to be called first.

Inherited Properties

Method Summary

  • _getController() protected
    Gets controller to use, either plugin or application controller.
  • Resolve the request parameters into a controller and attach the controller to the event object.

Method Detail

_getController()source protected

_getController( Cake\Http\ServerRequest $request , Cake\Http\Response $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

beforeDispatch()source 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.

Overrides

Cake\Routing\DispatcherFilter::beforeDispatch()

Methods inherited from Cake\Routing\DispatcherFilter

__construct()source public

__construct( array $config = [] )

Constructor.

Parameters

array $config optional []
Settings for the filter.

Throws

InvalidArgumentException
When 'when' conditions are not callable.

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

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

Implementation of

Cake\Event\EventListenerInterface::implementedEvents()

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

Methods used from Cake\Core\InstanceConfigTrait

_configDelete()source protected

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key
Key to delete.

Throws

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

_configRead()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key
Key to read.

Returns

mixed

_configWrite()source protected

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

Writes a config key.

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

config()source public deprecated

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

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']);

Deprecated

3.4.0 use setConfig()/getConfig() instead.

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.

configShallow()source 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->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 null
The value to set.

Returns


$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

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 null
The key to get or null for the whole config.
mixed $default optional null
The return value when the key does not exist.

Returns

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

setConfig()source public

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

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 null
The value to set.
boolean $merge optional true
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.

Properties detail

$_prioritysource

protected integer

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

50

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