$_priority
$_priority : integer
Default priority for all methods in this filter
Sets the runtime default locale for the request based on the Accept-Language header. The default will only be set if it matches the list of passed valid locales.
Subclasses of this class use a class naming convention having a Filter suffix.
By using the for option you can limit with request paths a filter is applied to.
Both the before and after event will have the same conditions applied to them. For
example, if you only wanted a filter applied to blog requests you could do:
$filter = new BlogFilter(['for' => '/blog']);When the above filter is connected to a dispatcher it will only fire
its beforeDispatch and afterDispatch methods on requests that start with /blog.
The for condition can also be a regular expression by using the preg: prefix:
$filter = new BlogFilter(['for' => 'preg:#^/blog/\d+$#']);In addition to simple path based matching you can use a closure to match on arbitrary request or response conditions. For example:
$cookieMonster = new CookieFilter([
'when' => function ($req, $res) {
// Custom code goes here.
}
]);If your when condition returns true the before/after methods will be called.
When using the for or when matchers, conditions will be re-checked on the before and after
callback as the conditions could change during the dispatch cycle.
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.
handle(\Cake\Event\Event $event) : mixed
Handler method that applies conditions and resolves the correct method to call.
| \Cake\Event\Event | $event | The event instance. |
matches(\Cake\Event\Event $event) : boolean
Check to see if the incoming request matches this filter's criteria.
| \Cake\Event\Event | $event | The event to match. |
beforeDispatch(\Cake\Event\Event $event) : void
Inspects the request for the Accept-Language header and sets the Locale for the current runtime if it matches the list of valid locales as passed in the configuration.
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\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.
| \Cake\Event\Event | $event | The event instance. |
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.
| \Cake\Event\Event | $event | container object having the |
setConfig(string|array $key, mixed|null $value = null, boolean $merge = true) : $this
Sets the config.
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']);| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
getConfig(string|null $key = null, mixed $default = null) : mixed
Returns the config.
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');| string|null | $key | The key to get or null for the whole config. |
| mixed | $default | The return value when the key does not exist. |
Config value being read.
config(string|array|null $key = null, mixed|null $value = null, boolean $merge = true) : mixed
Gets/Sets the config.
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']);| string|array|null | $key | The key to get/set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
Config value being read, or the object itself on write operations.
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']);| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
_configWrite(string|array $key, mixed $value, boolean|string $merge = false) : void
Writes a config key.
| string|array | $key | Key to write to. |
| mixed | $value | Value to write. |
| boolean|string | $merge | True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false. |
if attempting to clobber existing config
Loading…