Class AssetFilter
Filters a request and tests whether it is a file in the webroot folder or not and serves the file to the client if appropriate.
Property Summary
-
$_cacheTime protected
stringThe amount of time to cache the asset.
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault config
-
$_priority protected
intDefault priority for all methods in this filter This filter should run before the request gets parsed by router
Method Summary
-
__construct() public
Constructor.
-
_configDelete() protected
Delete a single config key
-
_configRead() protected
Read a config variable
-
_configWrite() protected
Write a config variable
-
_deliverAsset() protected
Sends an asset file to the client
-
_getAssetFile() protected
Builds asset file path based off url
-
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
Checks if a requested asset exists and sends it to the browser
-
config() public
Usage
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
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.
Method Detail
__construct() ¶ public
__construct(array $config = [])Constructor.
Parameters
-
array$config optional Array of config.
_configDelete() ¶ protected
_configDelete(string $key): voidDelete 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): mixedRead a config variable
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrite a config variable
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
_deliverAsset() ¶ protected
_deliverAsset(Cake\Network\Request $request, Cake\Network\Response $response, string $assetFile, string $ext): voidSends an asset file to the client
Parameters
-
Cake\Network\Request$request The request object to use.
-
Cake\Network\Response$response The response object to use.
-
string$assetFile Path to the asset file in the file system
-
string$ext The extension of the file to determine its mime type
Returns
void_getAssetFile() ¶ protected
_getAssetFile(string $url): stringBuilds asset file path based off url
Parameters
-
string$url Asset URL
Returns
stringafterDispatch() ¶ 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): Cake\Network\ResponseChecks if a requested asset exists and sends it to the browser
If a Cake\Network\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 and response object
Returns
Cake\Network\ResponseThrows
Cake\Network\Exception\NotFoundExceptionWhen asset not found
config() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedUsage
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
mixedThrows
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->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$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thishandle() ¶ 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
boolProperty 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
Default priority for all methods in this filter This filter should run before the request gets parsed by router
Type
int