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.
Property Summary
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault config
-
$_priority protected
intPriority 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. It is possible to alter the response object at this point as it is not sent to the client yet.
-
beforeDispatch() public
Resolve the request parameters into a controller and attach the controller to the event object.
-
config() public deprecated
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.
-
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. Dispatcher notifies 2 different events
Dispatcher.beforeandDispatcher.after. By default this class will attachpreDispatchandpostDispatchmethod respectively. -
matches() public
Check to see if the incoming request matches this filter's criteria.
-
setConfig() public
Sets the config.
Method Detail
__construct() ¶ public
__construct(array $config = [])Constructor.
Parameters
-
array$config optional Settings for the filter.
Throws
InvalidArgumentExceptionWhen 'when' conditions are not callable.
_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrites 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.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_getController() ¶ protected
_getController(Cake\Http\ServerRequest $request, Cake\Http\Response $response): Cake\Controller\ControllerGets 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\ControllerThrows
ReflectionExceptionafterDispatch() ¶ public
afterDispatch(Cake\Event\Event $event): voidMethod 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
requestandresponsekeys in the data property.
Returns
voidbeforeDispatch() ¶ public
beforeDispatch(Cake\Event\Event $event): voidResolve the request parameters into a controller and attach the controller to the event object.
If a Cake\Http\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 The event instance.
Returns
voidconfig() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedGets/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
mixedConfig value being read, or the object itself on write operations.
Throws
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge 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
$thisgetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixedReturns 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$default optional The return value when the key does not exist.
Returns
mixedConfig value being read.
handle() ¶ public
handle(Cake\Event\Event $event): mixedHandler method that applies conditions and resolves the correct method to call.
Parameters
-
Cake\Event\Event$event The event instance.
Returns
mixedimplementedEvents() ¶ public
implementedEvents(): arrayReturns 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
arraymatches() ¶ public
matches(Cake\Event\Event $event): boolCheck to see if the incoming request matches this filter's criteria.
Parameters
-
Cake\Event\Event$event The event to match.
Returns
boolsetConfig() ¶ public
setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $thisSets 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
$thisThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
Property Detail
$_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