Caches an asset to avoid the cost of loading and dumping. More...

Inheritance diagram for Assetic\Asset\AssetCache:

Collaboration diagram for Assetic\Asset\AssetCache:

Public Member Functions
	__construct (AssetInterface $asset, CacheInterface $cache)

	ensureFilter (FilterInterface $filter)
	Ensures the current asset includes the supplied filter. More...

	getFilters ()
	Returns an array of filters currently applied. More...

	clearFilters ()
	Clears all filters from the current asset. More...

	load (FilterInterface $additionalFilter=null)
	Loads the asset into memory and applies load filters. More...

	dump (FilterInterface $additionalFilter=null)
	Applies dump filters and returns the asset as a string. More...

	getContent ()
	Returns the loaded content of the current asset. More...

	setContent ($content)
	Sets the content of the current asset. More...

	getSourceRoot ()
	Returns an absolute path or URL to the source asset's root directory. More...

	getSourcePath ()
	Returns the relative path for the source asset. More...

	getSourceDirectory ()
	Returns the asset's source directory. More...

	getTargetPath ()
	Returns the URL for the current asset. More...

	setTargetPath ($targetPath)
	Sets the URL for the current asset. More...

	getLastModified ()
	Returns the time the current asset was last modified. More...

	getVars ()
	Returns an array of variable names for this asset. More...

	setValues (array $values)
	Sets the values for the asset's variables. More...

	getValues ()
	Returns the current values for this asset. More...

Static Private Member Functions
static	getCacheKey (AssetInterface $asset, FilterInterface $additionalFilter=null, $salt='')
	Returns a cache key for the current asset. More...

Private Attributes
	$asset

	$cache

Detailed Description

Caches an asset to avoid the cost of loading and dumping.

Author: Kris Wallsmith kris..nosp@m.wall.nosp@m.smith.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Definition at line 23 of file AssetCache.php.

Constructor & Destructor Documentation

◆ __construct()

Assetic\Asset\AssetCache::__construct	(	AssetInterface	$asset,
		CacheInterface	$cache
	)

Definition at line 28 of file AssetCache.php.

References Assetic\Asset\AssetCache\$asset, and Assetic\Asset\AssetCache\$cache.

     {
         $this->asset = $asset;
         $this->cache = $cache;
     }

Member Function Documentation

◆ clearFilters()

Assetic\Asset\AssetCache::clearFilters ( )

Clears all filters from the current asset.

Implements Assetic\Asset\AssetInterface.

Definition at line 44 of file AssetCache.php.

     {
         $this->asset->clearFilters();
     }

◆ dump()

Assetic\Asset\AssetCache::dump ( FilterInterface $additionalFilter = null )

Applies dump filters and returns the asset as a string.

You may provide an additional filter to apply during dump.

Dumping an asset should not change its state.

If the current asset has not been loaded yet, it should be automatically loaded at this time.

Parameters

FilterInterface $additionalFilter An additional filter

Returns: string The filtered content of the current asset

Implements Assetic\Asset\AssetInterface.

Definition at line 62 of file AssetCache.php.

     {
         $cacheKey = self::getCacheKey($this->asset, $additionalFilter, 'dump');
         if ($this->cache->has($cacheKey)) {
             return $this->cache->get($cacheKey);
         }
 
         $content = $this->asset->dump($additionalFilter);
         $this->cache->set($cacheKey, $content);
 
         return $content;
     }

◆ ensureFilter()

Assetic\Asset\AssetCache::ensureFilter ( FilterInterface $filter )

Ensures the current asset includes the supplied filter.

Parameters

FilterInterface $filter A filter

Implements Assetic\Asset\AssetInterface.

Definition at line 34 of file AssetCache.php.

     {
         $this->asset->ensureFilter($filter);
     }

◆ getCacheKey()

static Assetic\Asset\AssetCache::getCacheKey	(	AssetInterface	$asset,
		FilterInterface	$additionalFilter = `null`,
			$salt = `''`
	)

staticprivate

Returns a cache key for the current asset.

The key is composed of everything but an asset's content:

source root
source path
target url
last modified
filters

Parameters

AssetInterface	$asset	The asset
FilterInterface	$additionalFilter	Any additional filter being applied
string	$salt	Salt for the key

Returns: string A key for identifying the current asset

Definition at line 147 of file AssetCache.php.

References Assetic\Asset\AssetCache\$asset, Assetic\Asset\AssetInterface\getFilters(), Assetic\Asset\AssetInterface\getLastModified(), Assetic\Asset\AssetInterface\getSourcePath(), Assetic\Asset\AssetInterface\getSourceRoot(), Assetic\Asset\AssetInterface\getTargetPath(), and Assetic\Asset\AssetInterface\getValues().

     {
         if ($additionalFilter) {
             $asset = clone $asset;
             $asset->ensureFilter($additionalFilter);
         }
 
         $cacheKey  = $asset->getSourceRoot();
         $cacheKey .= $asset->getSourcePath();
         $cacheKey .= $asset->getTargetPath();
         $cacheKey .= $asset->getLastModified();
 
         foreach ($asset->getFilters() as $filter) {
             if ($filter instanceof HashableInterface) {
                 $cacheKey .= $filter->hash();
             } else {
                 $cacheKey .= serialize($filter);
             }
         }
 
         if ($values = $asset->getValues()) {
             asort($values);
             $cacheKey .= serialize($values);
         }
 
         return md5($cacheKey.$salt);
     }

Here is the call graph for this function:

◆ getContent()

Assetic\Asset\AssetCache::getContent ( )

Returns the loaded content of the current asset.

Returns: string The content

Implements Assetic\Asset\AssetInterface.

Definition at line 75 of file AssetCache.php.

     {
         return $this->asset->getContent();
     }

◆ getFilters()

Assetic\Asset\AssetCache::getFilters ( )

Returns an array of filters currently applied.

Returns: array An array of filters

Implements Assetic\Asset\AssetInterface.

Definition at line 39 of file AssetCache.php.

     {
         return $this->asset->getFilters();
     }

◆ getLastModified()

Assetic\Asset\AssetCache::getLastModified ( )

Returns the time the current asset was last modified.

Returns: integer|null A UNIX timestamp

Implements Assetic\Asset\AssetInterface.

Definition at line 110 of file AssetCache.php.

     {
         return $this->asset->getLastModified();
     }

◆ getSourceDirectory()

Assetic\Asset\AssetCache::getSourceDirectory ( )

Returns the asset's source directory.

The source directory is the directory the asset was located in and can be used to resolve references relative to an asset.

Returns: string|null The asset's source directory

Implements Assetic\Asset\AssetInterface.

Definition at line 95 of file AssetCache.php.

     {
         return $this->asset->getSourceDirectory();
     }

◆ getSourcePath()

Assetic\Asset\AssetCache::getSourcePath ( )

Returns the relative path for the source asset.

This value can be combined with the asset's source root (if both are non-null) to get something compatible with file_get_contents().

For example:

'js/main.js'
'main.js'
null

Returns: string|null The source asset path

Implements Assetic\Asset\AssetInterface.

Definition at line 90 of file AssetCache.php.

     {
         return $this->asset->getSourcePath();
     }

◆ getSourceRoot()

Assetic\Asset\AssetCache::getSourceRoot ( )

Returns an absolute path or URL to the source asset's root directory.

This value should be an absolute path to a directory in the filesystem, an absolute URL with no path, or null.

For example:

'/path/to/web'
'http://example.com'
null

Returns: string|null The asset's root

Implements Assetic\Asset\AssetInterface.

Definition at line 85 of file AssetCache.php.

     {
         return $this->asset->getSourceRoot();
     }

◆ getTargetPath()

Assetic\Asset\AssetCache::getTargetPath ( )

Returns the URL for the current asset.

Returns: string|null A web URL where the asset will be dumped

Implements Assetic\Asset\AssetInterface.

Definition at line 100 of file AssetCache.php.

     {
         return $this->asset->getTargetPath();
     }

◆ getValues()

Assetic\Asset\AssetCache::getValues ( )

Returns the current values for this asset.

Returns: array an array of strings

Implements Assetic\Asset\AssetInterface.

Definition at line 125 of file AssetCache.php.

     {
         return $this->asset->getValues();
     }

◆ getVars()

Assetic\Asset\AssetCache::getVars ( )

Returns an array of variable names for this asset.

Returns: array

Implements Assetic\Asset\AssetInterface.

Definition at line 115 of file AssetCache.php.

     {
         return $this->asset->getVars();
     }

◆ load()

Assetic\Asset\AssetCache::load ( FilterInterface $additionalFilter = null )

Loads the asset into memory and applies load filters.

You may provide an additional filter to apply during load.

Parameters

FilterInterface $additionalFilter An additional filter

Implements Assetic\Asset\AssetInterface.

Definition at line 49 of file AssetCache.php.

     {
         $cacheKey = self::getCacheKey($this->asset, $additionalFilter, 'load');
         if ($this->cache->has($cacheKey)) {
             $this->asset->setContent($this->cache->get($cacheKey));
 
             return;
         }
 
         $this->asset->load($additionalFilter);
         $this->cache->set($cacheKey, $this->asset->getContent());
     }

◆ setContent()

Assetic\Asset\AssetCache::setContent ( $content )

Sets the content of the current asset.

Filters can use this method to change the content of the asset.

Parameters

string $content The asset content

Implements Assetic\Asset\AssetInterface.

Definition at line 80 of file AssetCache.php.

     {
         $this->asset->setContent($content);
     }

◆ setTargetPath()

Assetic\Asset\AssetCache::setTargetPath ( $targetPath )

Sets the URL for the current asset.

Parameters

string $targetPath A web URL where the asset will be dumped

Implements Assetic\Asset\AssetInterface.

Definition at line 105 of file AssetCache.php.

     {
         $this->asset->setTargetPath($targetPath);
     }

◆ setValues()

Assetic\Asset\AssetCache::setValues ( array $values )

Sets the values for the asset's variables.

Parameters

array $values

Implements Assetic\Asset\AssetInterface.

Definition at line 120 of file AssetCache.php.

     {
         $this->asset->setValues($values);
     }

Field Documentation

◆ $asset

Assetic\Asset\AssetCache::$asset

private

Definition at line 25 of file AssetCache.php.

Referenced by Assetic\Asset\AssetCache\__construct(), and Assetic\Asset\AssetCache\getCacheKey().

◆ $cache

Assetic\Asset\AssetCache::$cache

private

Definition at line 26 of file AssetCache.php.

Referenced by Assetic\Asset\AssetCache\__construct().

The documentation for this class was generated from the following file:

libs/composer/vendor/kriswallsmith/assetic/src/Assetic/Asset/AssetCache.php

Public Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clearFilters()

◆ dump()

◆ ensureFilter()

◆ getCacheKey()

◆ getContent()

◆ getFilters()

◆ getLastModified()

◆ getSourceDirectory()

◆ getSourcePath()

◆ getSourceRoot()

◆ getTargetPath()

◆ getValues()

◆ getVars()

◆ load()

◆ setContent()

◆ setTargetPath()

◆ setValues()

Field Documentation

◆ $asset

◆ $cache