W3cubDocs

/CakePHP 3.4

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.

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

Properties summary

  • $_cacheTime protected
    string
    The amount of time to cache the asset.
  • $_priority protected
    integer

    Default priority for all methods in this filter This filter should run before the request gets parsed by router

Inherited Properties

Method Summary

Method Detail

__construct()source public

__construct( array $config [] )

Constructor.

Parameters

array $config optional []
Array of config.

Throws

InvalidArgumentException
When 'when' conditions are not callable.

Overrides

Cake\Routing\DispatcherFilter::__construct()

_deliverAsset()source protected

_deliverAsset( Cake\Http\ServerRequest $request , Cake\Network\Response $response , string $assetFile , string $ext )

Sends an asset file to the client

Parameters

Cake\Http\ServerRequest $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

Cake\Network\Response
The updated response.

_getAssetFile()source protected

_getAssetFile( string $url )

Builds asset file path based off url

Parameters

string $url
Asset URL

Returns

string
Absolute path for asset file

beforeDispatch()source public

beforeDispatch( Cake\Event\Event $event )

Checks if a requested asset exists and sends it to the browser

Parameters

Cake\Event\Event $event
Event containing the request and response object

Returns

Cake\Network\Response|null
If the client is requesting a recognized asset, null otherwise

Throws

Cake\Network\Exception\NotFoundException
When asset not found

Overrides

Cake\Routing\DispatcherFilter::beforeDispatch()

Methods inherited from Cake\Routing\DispatcherFilter

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

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->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 null
The value to set.

Returns


$this

getConfig()source public

getConfig( string|null $key 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');

Parameters

string|null $key optional null
The key to get or null for the whole config.

Returns

mixed
Config value being read.

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

$_cacheTimesource

protected string

The amount of time to cache the asset.

'+1 day'

$_prioritysource

protected integer

Default priority for all methods in this filter This filter should run before the request gets parsed by router

9

© 2005–2017 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.4/class-Cake.Routing.Filter.AssetFilter.html