A collection of assets. More...

Inheritance diagram for Assetic\Asset\AssetCollection:

Collaboration diagram for Assetic\Asset\AssetCollection:

Public Member Functions
	__construct ($assets=array(), $filters=array(), $sourceRoot=null, array $vars=array())
	Constructor. More...

	__clone ()

	all ()
	Returns all child assets. More...

	add (AssetInterface $asset)
	Adds an asset to the current collection. More...

	removeLeaf (AssetInterface $needle, $graceful=false)
	Removes a leaf. More...

	replaceLeaf (AssetInterface $needle, AssetInterface $replacement, $graceful=false)
	Replaces an existing leaf with a new one. More...

	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 highest last-modified value of all assets in the current collection. More...

	getIterator ()
	Returns an iterator for looping recursively over unique leaves. 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...

Private Attributes
	$assets

	$filters

	$sourceRoot

	$targetPath

	$content

	$clones

	$vars

	$values

Detailed Description

A collection of assets.

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

Definition at line 24 of file AssetCollection.php.

Constructor & Destructor Documentation

◆ __construct()

Assetic\Asset\AssetCollection::__construct	(		$assets = `array()`,
			$filters = `array()`,
			$sourceRoot = `null`,
		array	$vars = `array()`
	)

Constructor.

Parameters

array	$assets	Assets for the current collection
array	$filters	Filters for the current collection
string	$sourceRoot	The root directory
array	$vars

Definition at line 43 of file AssetCollection.php.

References Assetic\Asset\AssetCollection\$assets, Assetic\Asset\AssetCollection\$filters, Assetic\Asset\AssetCollection\$sourceRoot, Assetic\Asset\AssetCollection\$vars, Assetic\Asset\AssetCollection\add(), and array.

     {
         $this->assets = array();
         foreach ($assets as $asset) {
             $this->add($asset);
         }
 
         $this->filters = new FilterCollection($filters);
         $this->sourceRoot = $sourceRoot;
         $this->clones = new \SplObjectStorage();
         $this->vars = $vars;
         $this->values = array();
     }

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

Assetic\Asset\AssetCollection::__clone ( )

Definition at line 57 of file AssetCollection.php.

References Assetic\Asset\AssetCollection\$filters.

     {
         $this->filters = clone $this->filters;
         $this->clones = new \SplObjectStorage();
     }

◆ add()

Assetic\Asset\AssetCollection::add ( AssetInterface $asset )

Adds an asset to the current collection.

Parameters

AssetInterface $asset An asset

Implements Assetic\Asset\AssetCollectionInterface.

Definition at line 68 of file AssetCollection.php.

Referenced by Assetic\Asset\AssetCollection\__construct(), and Assetic\Asset\GlobAsset\initialize().

     {
         $this->assets[] = $asset;
     }

Here is the caller graph for this function:

◆ all()

Assetic\Asset\AssetCollection::all ( )

Returns all child assets.

Returns: array An array of AssetInterface objects

Implements Assetic\Asset\AssetCollectionInterface.

Definition at line 63 of file AssetCollection.php.

References Assetic\Asset\AssetCollection\$assets.

     {
         return $this->assets;
     }

◆ clearFilters()

Assetic\Asset\AssetCollection::clearFilters ( )

Clears all filters from the current asset.

Implements Assetic\Asset\AssetInterface.

Definition at line 128 of file AssetCollection.php.

     {
         $this->filters->clear();
         $this->clones = new \SplObjectStorage();
     }

◆ dump()

Assetic\Asset\AssetCollection::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 146 of file AssetCollection.php.

References array.

     {
         // loop through leaves and dump each asset
         $parts = array();
         foreach ($this as $asset) {
             $parts[] = $asset->dump($additionalFilter);
         }
 
         return implode("\n", $parts);
     }

◆ ensureFilter()

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

Ensures the current asset includes the supplied filter.

Parameters

FilterInterface $filter A filter

Implements Assetic\Asset\AssetInterface.

Definition at line 118 of file AssetCollection.php.

     {
         $this->filters->ensure($filter);
     }

◆ getContent()

Assetic\Asset\AssetCollection::getContent ( )

Returns the loaded content of the current asset.

Returns: string The content

Implements Assetic\Asset\AssetInterface.

Definition at line 157 of file AssetCollection.php.

References Assetic\Asset\AssetCollection\$content.

     {
         return $this->content;
     }

◆ getFilters()

Assetic\Asset\AssetCollection::getFilters ( )

Returns an array of filters currently applied.

Returns: array An array of filters

Implements Assetic\Asset\AssetInterface.

Definition at line 123 of file AssetCollection.php.

     {
         return $this->filters->all();
     }

◆ getIterator()

Assetic\Asset\AssetCollection::getIterator ( )

Returns an iterator for looping recursively over unique leaves.

Definition at line 215 of file AssetCollection.php.

     {
         return new \RecursiveIteratorIterator(new AssetCollectionFilterIterator(new AssetCollectionIterator($this, $this->clones)));
     }

◆ getLastModified()

Assetic\Asset\AssetCollection::getLastModified ( )

Returns the highest last-modified value of all assets in the current collection.

Returns: integer|null A UNIX timestamp

Implements Assetic\Asset\AssetInterface.

Definition at line 195 of file AssetCollection.php.

     {
         if (!count($this->assets)) {
             return;
         }
 
         $mtime = 0;
         foreach ($this as $asset) {
             $assetMtime = $asset->getLastModified();
             if ($assetMtime > $mtime) {
                 $mtime = $assetMtime;
             }
         }
 
         return $mtime;
     }

◆ getSourceDirectory()

Assetic\Asset\AssetCollection::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 176 of file AssetCollection.php.

177 {

178 }

◆ getSourcePath()

Assetic\Asset\AssetCollection::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 172 of file AssetCollection.php.

173 {

174 }

◆ getSourceRoot()

Assetic\Asset\AssetCollection::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 167 of file AssetCollection.php.

References Assetic\Asset\AssetCollection\$sourceRoot.

Referenced by Assetic\Asset\GlobAsset\initialize().

     {
         return $this->sourceRoot;
     }

Here is the caller graph for this function:

◆ getTargetPath()

Assetic\Asset\AssetCollection::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 180 of file AssetCollection.php.

References Assetic\Asset\AssetCollection\$targetPath.

     {
         return $this->targetPath;
     }

◆ getValues()

Assetic\Asset\AssetCollection::getValues ( )

Returns the current values for this asset.

Returns: array an array of strings

Implements Assetic\Asset\AssetInterface.

Definition at line 234 of file AssetCollection.php.

References Assetic\Asset\AssetCollection\$values.

Referenced by Assetic\Asset\GlobAsset\initialize().

     {
         return $this->values;
     }

Here is the caller graph for this function:

◆ getVars()

Assetic\Asset\AssetCollection::getVars ( )

Returns an array of variable names for this asset.

Returns: array

Implements Assetic\Asset\AssetInterface.

Definition at line 220 of file AssetCollection.php.

References Assetic\Asset\AssetCollection\$vars.

Referenced by Assetic\Asset\GlobAsset\initialize().

     {
         return $this->vars;
     }

Here is the caller graph for this function:

◆ load()

Assetic\Asset\AssetCollection::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 134 of file AssetCollection.php.

References array.

     {
         // loop through leaves and load each asset
         $parts = array();
         foreach ($this as $asset) {
             $asset->load($additionalFilter);
             $parts[] = $asset->getContent();
         }
 
         $this->content = implode("\n", $parts);
     }

◆ removeLeaf()

Assetic\Asset\AssetCollection::removeLeaf	(	AssetInterface	$leaf,
			$graceful = `false`
	)

Removes a leaf.

Parameters

AssetInterface	$leaf	The leaf to remove
Boolean	$graceful	Whether the failure should return false or throw an exception

Returns: Boolean Whether the asset has been found

Exceptions

Implements Assetic\Asset\AssetCollectionInterface.

Definition at line 73 of file AssetCollection.php.

References array, and Assetic\Asset\AssetCollectionInterface\removeLeaf().

     {
         foreach ($this->assets as $i => $asset) {
             $clone = isset($this->clones[$asset]) ? $this->clones[$asset] : null;
             if (in_array($needle, array($asset, $clone), true)) {
                 unset($this->clones[$asset], $this->assets[$i]);
 
                 return true;
             }
 
             if ($asset instanceof AssetCollectionInterface && $asset->removeLeaf($needle, true)) {
                 return true;
             }
         }
 
         if ($graceful) {
             return false;
         }
 
         throw new \InvalidArgumentException('Leaf not found.');
     }

Here is the call graph for this function:

◆ replaceLeaf()

Assetic\Asset\AssetCollection::replaceLeaf	(	AssetInterface	$needle,
		AssetInterface	$replacement,
			$graceful = `false`
	)

Replaces an existing leaf with a new one.

Parameters

AssetInterface	$needle	The current asset to replace
AssetInterface	$replacement	The new asset
Boolean	$graceful	Whether the failure should return false or throw an exception

Returns: Boolean Whether the asset has been found

Exceptions

Implements Assetic\Asset\AssetCollectionInterface.

Definition at line 95 of file AssetCollection.php.

References array, and Assetic\Asset\AssetCollectionInterface\replaceLeaf().

     {
         foreach ($this->assets as $i => $asset) {
             $clone = isset($this->clones[$asset]) ? $this->clones[$asset] : null;
             if (in_array($needle, array($asset, $clone), true)) {
                 unset($this->clones[$asset]);
                 $this->assets[$i] = $replacement;
 
                 return true;
             }
 
             if ($asset instanceof AssetCollectionInterface && $asset->replaceLeaf($needle, $replacement, true)) {
                 return true;
             }
         }
 
         if ($graceful) {
             return false;
         }
 
         throw new \InvalidArgumentException('Leaf not found.');
     }

Here is the call graph for this function:

◆ setContent()

Assetic\Asset\AssetCollection::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 162 of file AssetCollection.php.

References Assetic\Asset\AssetCollection\$content.

     {
         $this->content = $content;
     }

◆ setTargetPath()

Assetic\Asset\AssetCollection::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 185 of file AssetCollection.php.

References Assetic\Asset\AssetCollection\$targetPath.

     {
         $this->targetPath = $targetPath;
     }

◆ setValues()

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

Sets the values for the asset's variables.

Parameters

array $values

Implements Assetic\Asset\AssetInterface.

Definition at line 225 of file AssetCollection.php.

References Assetic\Asset\AssetCollection\$values.

     {
         $this->values = $values;
 
         foreach ($this as $asset) {
             $asset->setValues(array_intersect_key($values, array_flip($asset->getVars())));
         }
     }

Field Documentation

◆ $assets

Assetic\Asset\AssetCollection::$assets

private

Definition at line 26 of file AssetCollection.php.

Referenced by Assetic\Asset\AssetCollection\__construct(), and Assetic\Asset\AssetCollection\all().

◆ $clones

Assetic\Asset\AssetCollection::$clones

private

Definition at line 31 of file AssetCollection.php.

◆ $content

Assetic\Asset\AssetCollection::$content

private

Definition at line 30 of file AssetCollection.php.

Referenced by Assetic\Asset\AssetCollection\getContent(), and Assetic\Asset\AssetCollection\setContent().

◆ $filters

Assetic\Asset\AssetCollection::$filters

private

Definition at line 27 of file AssetCollection.php.

Referenced by Assetic\Asset\AssetCollection\__clone(), Assetic\Asset\GlobAsset\__construct(), and Assetic\Asset\AssetCollection\__construct().

◆ $sourceRoot

Assetic\Asset\AssetCollection::$sourceRoot

private

Definition at line 28 of file AssetCollection.php.

Referenced by Assetic\Asset\AssetCollection\__construct(), and Assetic\Asset\AssetCollection\getSourceRoot().

◆ $targetPath

Assetic\Asset\AssetCollection::$targetPath

private

Definition at line 29 of file AssetCollection.php.

Referenced by Assetic\Asset\AssetCollection\getTargetPath(), and Assetic\Asset\AssetCollection\setTargetPath().

◆ $values

Assetic\Asset\AssetCollection::$values

private

Definition at line 33 of file AssetCollection.php.

Referenced by Assetic\Asset\AssetCollection\getValues(), and Assetic\Asset\AssetCollection\setValues().

◆ $vars

Assetic\Asset\AssetCollection::$vars

private

Definition at line 32 of file AssetCollection.php.

Referenced by Assetic\Asset\GlobAsset\__construct(), Assetic\Asset\AssetCollection\__construct(), and Assetic\Asset\AssetCollection\getVars().

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ add()

◆ all()

◆ clearFilters()

◆ dump()

◆ ensureFilter()

◆ getContent()

◆ getFilters()

◆ getIterator()

◆ getLastModified()

◆ getSourceDirectory()

◆ getSourcePath()

◆ getSourceRoot()

◆ getTargetPath()

◆ getValues()

◆ getVars()

◆ load()

◆ removeLeaf()

◆ replaceLeaf()

◆ setContent()

◆ setTargetPath()

◆ setValues()

Field Documentation

◆ $assets

◆ $clones

◆ $content

◆ $filters

◆ $sourceRoot

◆ $targetPath

◆ $values

◆ $vars