Represents an asset loaded from a file. More...

Inheritance diagram for Assetic\Asset\FileAsset:

Collaboration diagram for Assetic\Asset\FileAsset:

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

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

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

Public Member Functions inherited from Assetic\Asset\BaseAsset
	__construct ($filters=array(), $sourceRoot=null, $sourcePath=null, array $vars=array())
	Constructor. More...

	__clone ()

	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...

	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...

	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...

	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...

Private Attributes
	$source

Additional Inherited Members
Protected Member Functions inherited from Assetic\Asset\BaseAsset
	doLoad ($content, FilterInterface $additionalFilter=null)
	Encapsulates asset loading logic. More...

Detailed Description

Represents an asset loaded from a file.

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

Definition at line 22 of file FileAsset.php.

Constructor & Destructor Documentation

◆ __construct()

Assetic\Asset\FileAsset::__construct	(		$source,
			$filters = `array()`,
			$sourceRoot = `null`,
			$sourcePath = `null`,
		array	$vars = `array()`
	)

Constructor.

Parameters

string	$source	An absolute path
array	$filters	An array of filters
string	$sourceRoot	The source asset root directory
string	$sourcePath	The source asset path
array	$vars

Exceptions

InvalidArgumentException If the supplied root doesn't match the source when guessing the path

Definition at line 37 of file FileAsset.php.

    {
        if (null === $sourceRoot) {
            $sourceRoot = dirname($source);
            if (null === $sourcePath) {
                $sourcePath = basename($source);
            }
        } elseif (null === $sourcePath) {
            if (0 !== strpos($source, $sourceRoot)) {
                throw new \InvalidArgumentException(sprintf('The source "%s" is not in the root directory "%s"', $source, $sourceRoot));
            }
 
            $sourcePath = substr($source, strlen($sourceRoot) + 1);
        }
 
        $this->source = $source;
 
        parent::__construct($filters, $sourceRoot, $sourcePath, $vars);
    }

References Assetic\Asset\BaseAsset\$filters, Assetic\Asset\FileAsset\$source, Assetic\Asset\BaseAsset\$sourcePath, Assetic\Asset\BaseAsset\$sourceRoot, Assetic\Asset\BaseAsset\$vars, and sprintf.

Member Function Documentation

◆ getLastModified()

Assetic\Asset\FileAsset::getLastModified ( )

Returns the time the current asset was last modified.

Returns: integer|null A UNIX timestamp

Implements Assetic\Asset\AssetInterface.

Definition at line 68 of file FileAsset.php.

    {
        $source = VarUtils::resolve($this->source, $this->getVars(), $this->getValues());
 
        if (!is_file($source)) {
            throw new \RuntimeException(sprintf('The source file "%s" does not exist.', $source));
        }
 
        return filemtime($source);
    }

References Assetic\Asset\FileAsset\$source, Assetic\Asset\BaseAsset\getValues(), Assetic\Asset\BaseAsset\getVars(), Assetic\Util\VarUtils\resolve(), and sprintf.

Here is the call graph for this function:

◆ load()

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

    {
        $source = VarUtils::resolve($this->source, $this->getVars(), $this->getValues());
 
        if (!is_file($source)) {
            throw new \RuntimeException(sprintf('The source file "%s" does not exist.', $source));
        }
 
        $this->doLoad(file_get_contents($source), $additionalFilter);
    }

References Assetic\Asset\FileAsset\$source, Assetic\Asset\BaseAsset\doLoad(), Assetic\Asset\BaseAsset\getValues(), Assetic\Asset\BaseAsset\getVars(), Assetic\Util\VarUtils\resolve(), and sprintf.

Here is the call graph for this function:

Field Documentation

◆ $source

Assetic\Asset\FileAsset::$source

private

Definition at line 24 of file FileAsset.php.

Referenced by Assetic\Asset\FileAsset\__construct(), Assetic\Asset\FileAsset\getLastModified(), and Assetic\Asset\FileAsset\load().

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

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

Public Member Functions

Private Attributes

Additional Inherited Members