A base abstract asset. More...

Inheritance diagram for Assetic\Asset\BaseAsset:

Collaboration diagram for Assetic\Asset\BaseAsset:

Public Member Functions
	__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...

Public Member Functions inherited from Assetic\Asset\AssetInterface
	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...

Protected Member Functions
	doLoad ($content, FilterInterface $additionalFilter=null)
	Encapsulates asset loading logic. More...

Private Attributes
	$filters

	$sourceRoot

	$sourcePath

	$sourceDir

	$targetPath

	$content

	$loaded

	$vars

	$values

Detailed Description

A base abstract asset.

The methods load() and getLastModified() are left undefined, although a reusable doLoad() method is available to child classes.

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

Definition at line 25 of file BaseAsset.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

array	$filters	Filters for the asset
string	$sourceRoot	The root directory
string	$sourcePath	The asset path
array	$vars

Reimplemented in Assetic\Asset\HttpAsset.

Definition at line 45 of file BaseAsset.php.

    {
        $this->filters = new FilterCollection($filters);
        $this->sourceRoot = $sourceRoot;
        $this->sourcePath = $sourcePath;
        if ($sourcePath && $sourceRoot) {
            $this->sourceDir = dirname("$sourceRoot/$sourcePath");
        }
        $this->vars = $vars;
        $this->values = array();
        $this->loaded = false;
    }

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

Member Function Documentation

◆ __clone()

Assetic\Asset\BaseAsset::__clone ( )

Definition at line 58 of file BaseAsset.php.

    {
        $this->filters = clone $this->filters;
    }

References Assetic\Asset\BaseAsset\$filters.

◆ clearFilters()

Assetic\Asset\BaseAsset::clearFilters ( )

Clears all filters from the current asset.

Implements Assetic\Asset\AssetInterface.

Definition at line 73 of file BaseAsset.php.

    {
        $this->filters->clear();
    }

◆ doLoad()

Assetic\Asset\BaseAsset::doLoad	(		$content,
		FilterInterface	$additionalFilter = `null`
	)

protected

Encapsulates asset loading logic.

Parameters

string	$content	The asset content
FilterInterface	$additionalFilter	An additional filter

Definition at line 84 of file BaseAsset.php.

    {
        $filter = clone $this->filters;
        if ($additionalFilter) {
            $filter->ensure($additionalFilter);
        }
 
        $asset = clone $this;
        $asset->setContent($content);
 
        $filter->filterLoad($asset);
        $this->content = $asset->getContent();
 
        $this->loaded = true;
    }

References Assetic\Asset\BaseAsset\$content, and Assetic\Asset\BaseAsset\$filters.

Referenced by Assetic\Asset\FileAsset\load(), Assetic\Asset\HttpAsset\load(), and Assetic\Asset\StringAsset\load().

Here is the caller graph for this function:

◆ dump()

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

    {
        if (!$this->loaded) {
            $this->load();
        }
 
        $filter = clone $this->filters;
        if ($additionalFilter) {
            $filter->ensure($additionalFilter);
        }
 
        $asset = clone $this;
        $filter->filterDump($asset);
 
        return $asset->getContent();
    }

References Assetic\Asset\BaseAsset\$filters, and Assetic\Asset\AssetInterface\load().

Here is the call graph for this function:

◆ ensureFilter()

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

Ensures the current asset includes the supplied filter.

Parameters

FilterInterface $filter A filter

Implements Assetic\Asset\AssetInterface.

Definition at line 63 of file BaseAsset.php.

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

◆ getContent()

Assetic\Asset\BaseAsset::getContent ( )

Returns the loaded content of the current asset.

Returns: string The content

Implements Assetic\Asset\AssetInterface.

Definition at line 117 of file BaseAsset.php.

    {
        return $this->content;
    }

References Assetic\Asset\BaseAsset\$content.

◆ getFilters()

Assetic\Asset\BaseAsset::getFilters ( )

Returns an array of filters currently applied.

Returns: array An array of filters

Implements Assetic\Asset\AssetInterface.

Definition at line 68 of file BaseAsset.php.

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

◆ getSourceDirectory()

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

    {
        return $this->sourceDir;
    }

References Assetic\Asset\BaseAsset\$sourceDir.

◆ getSourcePath()

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

    {
        return $this->sourcePath;
    }

References Assetic\Asset\BaseAsset\$sourcePath.

◆ getSourceRoot()

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

    {
        return $this->sourceRoot;
    }

References Assetic\Asset\BaseAsset\$sourceRoot.

◆ getTargetPath()

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

    {
        return $this->targetPath;
    }

References Assetic\Asset\BaseAsset\$targetPath.

◆ getValues()

Assetic\Asset\BaseAsset::getValues ( )

Returns the current values for this asset.

Returns: array an array of strings

Implements Assetic\Asset\AssetInterface.

Definition at line 177 of file BaseAsset.php.

    {
        return $this->values;
    }

References Assetic\Asset\BaseAsset\$values.

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

Here is the caller graph for this function:

◆ getVars()

Assetic\Asset\BaseAsset::getVars ( )

Returns an array of variable names for this asset.

Returns: array

Implements Assetic\Asset\AssetInterface.

Definition at line 160 of file BaseAsset.php.

    {
        return $this->vars;
    }

References Assetic\Asset\BaseAsset\$vars.

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

Here is the caller graph for this function:

◆ setContent()

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

    {
        $this->content = $content;
    }

References Assetic\Asset\BaseAsset\$content.

◆ setTargetPath()

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

    {
        if ($this->vars) {
            foreach ($this->vars as $var) {
                if (false === strpos($targetPath, $var)) {
                    throw new \RuntimeException(sprintf('The asset target path "%s" must contain the variable "{%s}".', $targetPath, $var));
                }
            }
        }
 
        $this->targetPath = $targetPath;
    }

References Assetic\Asset\BaseAsset\$targetPath, and sprintf.

◆ setValues()

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

Sets the values for the asset's variables.

Parameters

array $values

Implements Assetic\Asset\AssetInterface.

Definition at line 165 of file BaseAsset.php.

    {
        foreach ($values as $var => $v) {
            if (!in_array($var, $this->vars, true)) {
                throw new \InvalidArgumentException(sprintf('The asset with source path "%s" has no variable named "%s".', $this->sourcePath, $var));
            }
        }
 
        $this->values = $values;
        $this->loaded = false;
    }

References Assetic\Asset\BaseAsset\$values, and sprintf.

Field Documentation

◆ $content

Assetic\Asset\BaseAsset::$content

private

Definition at line 32 of file BaseAsset.php.

Referenced by Assetic\Asset\StringAsset\__construct(), Assetic\Asset\BaseAsset\doLoad(), Assetic\Asset\BaseAsset\getContent(), Assetic\Asset\HttpAsset\load(), and Assetic\Asset\BaseAsset\setContent().

◆ $filters

Assetic\Asset\BaseAsset::$filters

private

Definition at line 27 of file BaseAsset.php.

Referenced by Assetic\Asset\BaseAsset\__clone(), Assetic\Asset\StringAsset\__construct(), Assetic\Asset\BaseAsset\__construct(), Assetic\Asset\FileAsset\__construct(), Assetic\Asset\HttpAsset\__construct(), Assetic\Asset\BaseAsset\doLoad(), and Assetic\Asset\BaseAsset\dump().

◆ $loaded

Assetic\Asset\BaseAsset::$loaded

private

Definition at line 33 of file BaseAsset.php.

◆ $sourceDir

Assetic\Asset\BaseAsset::$sourceDir

private

Definition at line 30 of file BaseAsset.php.

Referenced by Assetic\Asset\BaseAsset\getSourceDirectory().

◆ $sourcePath

Assetic\Asset\BaseAsset::$sourcePath

private

Definition at line 29 of file BaseAsset.php.

Referenced by Assetic\Asset\StringAsset\__construct(), Assetic\Asset\BaseAsset\__construct(), Assetic\Asset\FileAsset\__construct(), and Assetic\Asset\BaseAsset\getSourcePath().

◆ $sourceRoot

Assetic\Asset\BaseAsset::$sourceRoot

private

Definition at line 28 of file BaseAsset.php.

Referenced by Assetic\Asset\StringAsset\__construct(), Assetic\Asset\BaseAsset\__construct(), Assetic\Asset\FileAsset\__construct(), and Assetic\Asset\BaseAsset\getSourceRoot().

◆ $targetPath

Assetic\Asset\BaseAsset::$targetPath

private

Definition at line 31 of file BaseAsset.php.

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

◆ $values

Assetic\Asset\BaseAsset::$values

private

Definition at line 35 of file BaseAsset.php.

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

◆ $vars

Assetic\Asset\BaseAsset::$vars

private

Definition at line 34 of file BaseAsset.php.

Referenced by Assetic\Asset\BaseAsset\__construct(), Assetic\Asset\FileAsset\__construct(), Assetic\Asset\HttpAsset\__construct(), and Assetic\Asset\BaseAsset\getVars().

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

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

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ clearFilters()

◆ doLoad()

◆ dump()

◆ ensureFilter()

◆ getContent()

◆ getFilters()

◆ getSourceDirectory()

◆ getSourcePath()

◆ getSourceRoot()

◆ getTargetPath()

◆ getValues()

◆ getVars()

◆ setContent()

◆ setTargetPath()

◆ setValues()

Field Documentation

◆ $content

◆ $filters

◆ $loaded

◆ $sourceDir

◆ $sourcePath

◆ $sourceRoot

◆ $targetPath

◆ $values

◆ $vars