Class RoutingFilter
A dispatcher filter that applies routing rules to the request.
This filter will call Router::parse() when the request has no controller parameter defined.
Property 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 setting.
Method Summary
-
__construct() public
Constructor.
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
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
Applies Routing and additionalParameters to the request to be dispatched. If Routes have not been loaded they will be loaded, and config/routes.php will be run.
-
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.
-
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. Dispatcher notifies 2 different events
Dispatcher.before
andDispatcher.after
. By default this class will attachpreDispatch
andpostDispatch
method 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
InvalidArgumentException
When 'when' conditions are not callable.
_configDelete() ¶ protected
_configDelete(string $key): void
Deletes a single config key.
Parameters
-
string
$key Key to delete.
Returns
void
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixed
Reads a config key.
Parameters
-
string|null
$key Key to read.
Returns
mixed
_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): void
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.
Returns
void
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
afterDispatch() ¶ public
afterDispatch(Cake\Event\Event $event): void
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
andresponse
keys in the data property.
Returns
void
beforeDispatch() ¶ public
beforeDispatch(Cake\Event\Event $event): Cake\Http\Response|null
Applies Routing and additionalParameters to the request to be dispatched. If Routes have not been loaded they will be loaded, and config/routes.php will be run.
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 containing the request, response and additional params
Returns
Cake\Http\Response|null
config() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixed
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
Throws
Cake\Core\Exception\Exception
When trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $this
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(string|null $key = null, mixed|null $default = null): mixed|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 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
getConfigOrFail() ¶ public
getConfigOrFail(string|null $key): mixed
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
Throws
InvalidArgumentException
handle() ¶ public
handle(Cake\Event\Event $event): mixed
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(): array
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): bool
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(string|array $key, mixed|null $value = null, bool $merge = true): $this
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
$_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 setting.
This filter is normally fired last just before the request is dispatched.
Type
int