Class AssetDispatcher
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.
- DispatcherFilter implements CakeEventListener
- AssetDispatcher
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Located at Cake/Routing/Filter/AssetDispatcher.php
Method Detail
_deliverAssetsource protected
_deliverAsset( CakeResponse $response , string $assetFile , string $ext )
Sends an asset file to the client
Parameters
-
CakeResponse
$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
_filterAssetsource protected
_filterAsset( CakeEvent $event )
Checks if the client is requesting a filtered asset and runs the corresponding filter if any is configured
Parameters
-
CakeEvent
$event
- containing the request and response object
Returns
CakeResponse
if the client is requesting a recognized asset, null otherwise
_getAssetFilesource protected
_getAssetFile( string $url )
Builds asset file path based off url
Parameters
- string
$url
- URL
Returns
string
Absolute path for asset file
beforeDispatchsource public
beforeDispatch( CakeEvent $event )
Checks if a requested asset exists and sends it to the browser
Parameters
-
CakeEvent
$event
- containing the request and response object
Returns
mixed
The resulting response.
Throws
NotFoundException
When asset not found
Overrides
DispatcherFilter::beforeDispatch()
Methods inherited from DispatcherFilter
__constructsource public
__construct( array $settings array() )
Constructor.
Parameters
- array
$settings
optional array() - Configuration settings for the filter.
afterDispatchsource public
afterDispatch( CakeEvent $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
-
CakeEvent
$event
- container object having the
request
andresponse
keys in the data property.
Returns
mixed
boolean to stop the event dispatching or null to continue
implementedEventssource 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
array
Implementation of
CakeEventListener::implementedEvents()
Properties summary
Properties inherited from DispatcherFilter
© 2005–2016 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.
http://api.cakephp.org/2.7/class-AssetDispatcher.html