The asset factory creates asset objects. More...

Collaboration diagram for Assetic\Factory\AssetFactory:

Public Member Functions
	__construct ($root, $debug=false)
	Constructor. More...

	setDebug ($debug)
	Sets debug mode for the current factory. More...

	isDebug ()
	Checks if the factory is in debug mode. More...

	setDefaultOutput ($output)
	Sets the default output string. More...

	addWorker (WorkerInterface $worker)
	Adds a factory worker. More...

	getAssetManager ()
	Returns the current asset manager. More...

	setAssetManager (AssetManager $am)
	Sets the asset manager to use when creating asset references. More...

	getFilterManager ()
	Returns the current filter manager. More...

	setFilterManager (FilterManager $fm)
	Sets the filter manager to use when adding filters. More...

	createAsset ($inputs=array(), $filters=array(), array $options=array())
	Creates a new asset. More...

	generateAssetName ($inputs, $filters, $options=array())

	getLastModified (AssetInterface $asset)

Protected Member Functions
	parseInput ($input, array $options=array())
	Parses an input string string into an asset. More...

	createAssetCollection (array $assets=array(), array $options=array())

	createAssetReference ($name)

	createHttpAsset ($sourceUrl, $vars)

	createGlobAsset ($glob, $root=null, $vars)

	createFileAsset ($source, $root=null, $path=null, $vars)

	getFilter ($name)

Private Member Functions
	applyWorkers (AssetCollectionInterface $asset)
	Filters an asset collection through the factory workers. More...

Static Private Member Functions
static	isAbsolutePath ($path)

static	findRootDir ($path, array $roots)
	Loops through the root directories and returns the first match. More...

Private Attributes
	$root

	$debug

	$output

	$workers

	$am

	$fm

Detailed Description

The asset factory creates asset objects.

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

Definition at line 31 of file AssetFactory.php.

Constructor & Destructor Documentation

◆ __construct()

Assetic\Factory\AssetFactory::__construct	(	$root,
		$debug = `false`
	)

Constructor.

Parameters

string	$root	The default root directory
Boolean	$debug	Filters prefixed with a "?" will be omitted in debug mode

Definition at line 46 of file AssetFactory.php.

References Assetic\Factory\AssetFactory\$debug, Assetic\Factory\AssetFactory\$root, and array.

     {
         $this->root      = rtrim($root, '/');
         $this->debug     = $debug;
         $this->output    = 'assetic/*';
         $this->workers   = array();
     }

Member Function Documentation

◆ addWorker()

Assetic\Factory\AssetFactory::addWorker ( WorkerInterface $worker )

Adds a factory worker.

Parameters

WorkerInterface $worker A worker

Definition at line 89 of file AssetFactory.php.

     {
         $this->workers[] = $worker;
     }

◆ applyWorkers()

Assetic\Factory\AssetFactory::applyWorkers ( AssetCollectionInterface $asset )

private

Filters an asset collection through the factory workers.

Each leaf asset will be processed first, followed by the asset collection itself.

Parameters

AssetCollectionInterface $asset An asset collection

Returns: AssetCollectionInterface

Definition at line 380 of file AssetFactory.php.

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

Referenced by Assetic\Factory\AssetFactory\createAsset().

     {
         foreach ($asset as $leaf) {
             foreach ($this->workers as $worker) {
                 $retval = $worker->process($leaf, $this);
 
                 if ($retval instanceof AssetInterface && $leaf !== $retval) {
                     $asset->replaceLeaf($leaf, $retval);
                 }
             }
         }
 
         foreach ($this->workers as $worker) {
             $retval = $worker->process($asset, $this);
 
             if ($retval instanceof AssetInterface) {
                 $asset = $retval;
             }
         }
 
         return $asset instanceof AssetCollectionInterface ? $asset : $this->createAssetCollection(array($asset));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createAsset()

Assetic\Factory\AssetFactory::createAsset	(		$inputs = `array()`,
			$filters = `array()`,
		array	$options = `array()`
	)

Creates a new asset.

Prefixing a filter name with a question mark will cause it to be omitted when the factory is in debug mode.

Available options:

output: An output string
name: An asset name for interpolation in output patterns
debug: Forces debug mode on or off for this asset
root: An array or string of more root directories

Parameters

array \| string	$inputs	An array of input strings
array \| string	$filters	An array of filter names
array	$options	An array of options

Returns: AssetCollection An asset collection

Definition at line 153 of file AssetFactory.php.

References Assetic\Factory\AssetFactory\$debug, $options, Assetic\Factory\AssetFactory\$output, Assetic\Factory\AssetFactory\$root, Assetic\Factory\AssetFactory\applyWorkers(), array, Assetic\Factory\AssetFactory\createAssetCollection(), Assetic\Factory\AssetFactory\generateAssetName(), Assetic\Factory\AssetFactory\getFilter(), and Assetic\Factory\AssetFactory\parseInput().

Referenced by Assetic\Filter\Sass\BaseSassFilter\addLoadPath(), Assetic\Filter\ScssphpFilter\getChildren(), Assetic\Filter\LessphpFilter\getChildren(), and Assetic\Filter\LessFilter\getChildren().

     {
         if (!is_array($inputs)) {
             $inputs = array($inputs);
         }
 
         if (!is_array($filters)) {
             $filters = array($filters);
         }
 
         if (!isset($options['output'])) {
             $options['output'] = $this->output;
         }
 
         if (!isset($options['vars'])) {
             $options['vars'] = array();
         }
 
         if (!isset($options['debug'])) {
             $options['debug'] = $this->debug;
         }
 
         if (!isset($options['root'])) {
             $options['root'] = array($this->root);
         } else {
             if (!is_array($options['root'])) {
                 $options['root'] = array($options['root']);
             }
 
             $options['root'][] = $this->root;
         }
 
         if (!isset($options['name'])) {
             $options['name'] = $this->generateAssetName($inputs, $filters, $options);
         }
 
         $asset = $this->createAssetCollection(array(), $options);
         $extensions = array();
 
         // inner assets
         foreach ($inputs as $input) {
             if (is_array($input)) {
                 // nested formula
                 $asset->add(call_user_func_array(array($this, 'createAsset'), $input));
             } else {
                 $asset->add($this->parseInput($input, $options));
                 $extensions[pathinfo($input, PATHINFO_EXTENSION)] = true;
             }
         }
 
         // filters
         foreach ($filters as $filter) {
             if ('?' != $filter[0]) {
                 $asset->ensureFilter($this->getFilter($filter));
             } elseif (!$options['debug']) {
                 $asset->ensureFilter($this->getFilter(substr($filter, 1)));
             }
         }
 
         // append variables
         if (!empty($options['vars'])) {
             $toAdd = array();
             foreach ($options['vars'] as $var) {
                 if (false !== strpos($options['output'], '{'.$var.'}')) {
                     continue;
                 }
 
                 $toAdd[] = '{'.$var.'}';
             }
 
             if ($toAdd) {
                 $options['output'] = str_replace('*', '*.'.implode('.', $toAdd), $options['output']);
             }
         }
 
         // append consensus extension if missing
         if (1 == count($extensions) && !pathinfo($options['output'], PATHINFO_EXTENSION) && $extension = key($extensions)) {
             $options['output'] .= '.'.$extension;
         }
 
         // output --> target url
         $asset->setTargetPath(str_replace('*', $options['name'], $options['output']));
 
         // apply workers and return
         return $this->applyWorkers($asset);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createAssetCollection()

Assetic\Factory\AssetFactory::createAssetCollection	(	array	$assets = `array()`,
		array	$options = `array()`
	)

protected

Definition at line 332 of file AssetFactory.php.

References $options, and array.

Referenced by Assetic\Factory\AssetFactory\applyWorkers(), and Assetic\Factory\AssetFactory\createAsset().

     {
         return new AssetCollection($assets, array(), null, isset($options['vars']) ? $options['vars'] : array());
     }

Here is the caller graph for this function:

◆ createAssetReference()

Assetic\Factory\AssetFactory::createAssetReference ( $name )

protected

Definition at line 337 of file AssetFactory.php.

Referenced by Assetic\Factory\AssetFactory\parseInput().

     {
         if (!$this->am) {
             throw new \LogicException('There is no asset manager.');
         }
 
         return new AssetReference($this->am, $name);
     }

Here is the caller graph for this function:

◆ createFileAsset()

Assetic\Factory\AssetFactory::createFileAsset	(	$source,
		$root = `null`,
		$path = `null`,
		$vars
	)

protected

Definition at line 356 of file AssetFactory.php.

References $path, Assetic\Factory\AssetFactory\$root, and array.

Referenced by Assetic\Factory\AssetFactory\parseInput().

     {
         return new FileAsset($source, array(), $root, $path, $vars);
     }

Here is the caller graph for this function:

◆ createGlobAsset()

Assetic\Factory\AssetFactory::createGlobAsset	(	$glob,
		$root = `null`,
		$vars
	)

protected

Definition at line 351 of file AssetFactory.php.

References Assetic\Factory\AssetFactory\$root, and array.

Referenced by Assetic\Factory\AssetFactory\parseInput().

     {
         return new GlobAsset($glob, array(), $root, $vars);
     }

Here is the caller graph for this function:

◆ createHttpAsset()

Assetic\Factory\AssetFactory::createHttpAsset	(	$sourceUrl,
		$vars
	)

protected

Definition at line 346 of file AssetFactory.php.

References array.

Referenced by Assetic\Factory\AssetFactory\parseInput().

     {
         return new HttpAsset($sourceUrl, array(), false, $vars);
     }

Here is the caller graph for this function:

◆ findRootDir()

static Assetic\Factory\AssetFactory::findRootDir	(		$path,
		array	$roots
	)

staticprivate

Loops through the root directories and returns the first match.

Parameters

string	$path	An absolute path
array	$roots	An array of root directories

Returns: string|null The matching root directory, if found

Definition at line 416 of file AssetFactory.php.

References $path, and Assetic\Factory\AssetFactory\$root.

     {
         foreach ($roots as $root) {
             if (0 === strpos($path, $root)) {
                 return $root;
             }
         }
     }

◆ generateAssetName()

Assetic\Factory\AssetFactory::generateAssetName	(	$inputs,
		$filters,
		$options = `array()`
	)

Definition at line 240 of file AssetFactory.php.

References $options, and array.

Referenced by Assetic\Factory\AssetFactory\createAsset().

     {
         foreach (array_diff(array_keys($options), array('output', 'debug', 'root')) as $key) {
             unset($options[$key]);
         }
 
         ksort($options);
 
         return substr(sha1(serialize($inputs).serialize($filters).serialize($options)), 0, 7);
     }

Here is the caller graph for this function:

◆ getAssetManager()

Assetic\Factory\AssetFactory::getAssetManager ( )

Returns the current asset manager.

Returns: AssetManager|null The asset manager

Definition at line 99 of file AssetFactory.php.

References Assetic\Factory\AssetFactory\$am.

     {
         return $this->am;
     }

◆ getFilter()

Assetic\Factory\AssetFactory::getFilter ( $name )

protected

Definition at line 361 of file AssetFactory.php.

Referenced by Assetic\Factory\AssetFactory\createAsset().

     {
         if (!$this->fm) {
             throw new \LogicException('There is no filter manager.');
         }
 
         return $this->fm->get($name);
     }

Here is the caller graph for this function:

◆ getFilterManager()

Assetic\Factory\AssetFactory::getFilterManager ( )

Returns the current filter manager.

Returns: FilterManager|null The filter manager

Definition at line 119 of file AssetFactory.php.

References Assetic\Factory\AssetFactory\$fm.

     {
         return $this->fm;
     }

◆ getLastModified()

Assetic\Factory\AssetFactory::getLastModified ( AssetInterface $asset )

Definition at line 251 of file AssetFactory.php.

References array.

Referenced by Assetic\Factory\Worker\CacheBustingWorker\getHash().

     {
         $mtime = 0;
         foreach ($asset instanceof AssetCollectionInterface ? $asset : array($asset) as $leaf) {
             $mtime = max($mtime, $leaf->getLastModified());
 
             if (!$filters = $leaf->getFilters()) {
                 continue;
             }
 
             $prevFilters = array();
             foreach ($filters as $filter) {
                 $prevFilters[] = $filter;
 
                 if (!$filter instanceof DependencyExtractorInterface) {
                     continue;
                 }
 
                 // extract children from leaf after running all preceeding filters
                 $clone = clone $leaf;
                 $clone->clearFilters();
                 foreach (array_slice($prevFilters, 0, -1) as $prevFilter) {
                     $clone->ensureFilter($prevFilter);
                 }
                 $clone->load();
 
                 foreach ($filter->getChildren($this, $clone->getContent(), $clone->getSourceDirectory()) as $child) {
                     $mtime = max($mtime, $this->getLastModified($child));
                 }
             }
         }
 
         return $mtime;
     }

Here is the caller graph for this function:

◆ isAbsolutePath()

static Assetic\Factory\AssetFactory::isAbsolutePath ( $path )

staticprivate

Definition at line 403 of file AssetFactory.php.

References $path.

     {
         return '/' == $path[0] || '\\' == $path[0] || (3 < strlen($path) && ctype_alpha($path[0]) && $path[1] == ':' && ('\\' == $path[2] || '/' == $path[2]));
     }

◆ isDebug()

Assetic\Factory\AssetFactory::isDebug ( )

Checks if the factory is in debug mode.

Returns: Boolean Debug mode

Definition at line 69 of file AssetFactory.php.

References Assetic\Factory\AssetFactory\$debug.

     {
         return $this->debug;
     }

◆ parseInput()

Assetic\Factory\AssetFactory::parseInput	(		$input,
		array	$options = `array()`
	)

protected

Parses an input string string into an asset.

The input string can be one of the following:

A reference: If the string starts with an "at" sign it will be interpreted as a reference to an asset in the asset manager
An absolute URL: If the string contains "://" or starts with "//" it will be interpreted as an HTTP asset
A glob: If the string contains a "*" it will be interpreted as a glob
A path: Otherwise the string is interpreted as a filesystem path

Both globs and paths will be absolutized using the current root directory.

Parameters

string	$input	An input string
array	$options	An array of options

Returns: AssetInterface An asset

Definition at line 303 of file AssetFactory.php.

References $options, $path, Assetic\Factory\AssetFactory\$root, Assetic\Factory\AssetFactory\createAssetReference(), Assetic\Factory\AssetFactory\createFileAsset(), Assetic\Factory\AssetFactory\createGlobAsset(), and Assetic\Factory\AssetFactory\createHttpAsset().

Referenced by Assetic\Factory\AssetFactory\createAsset().

     {
         if ('@' == $input[0]) {
             return $this->createAssetReference(substr($input, 1));
         }
 
         if (false !== strpos($input, '://') || 0 === strpos($input, '//')) {
             return $this->createHttpAsset($input, $options['vars']);
         }
 
         if (self::isAbsolutePath($input)) {
             if ($root = self::findRootDir($input, $options['root'])) {
                 $path = ltrim(substr($input, strlen($root)), '/');
             } else {
                 $path = null;
             }
         } else {
             $root  = $this->root;
             $path  = $input;
             $input = $this->root.'/'.$path;
         }
 
         if (false !== strpos($input, '*')) {
             return $this->createGlobAsset($input, $root, $options['vars']);
         }
 
         return $this->createFileAsset($input, $root, $path, $options['vars']);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAssetManager()

Assetic\Factory\AssetFactory::setAssetManager ( AssetManager $am )

Sets the asset manager to use when creating asset references.

Parameters

AssetManager $am The asset manager

Definition at line 109 of file AssetFactory.php.

References Assetic\Factory\AssetFactory\$am.

     {
         $this->am = $am;
     }

◆ setDebug()

Assetic\Factory\AssetFactory::setDebug ( $debug )

Sets debug mode for the current factory.

Parameters

Boolean $debug Debug mode

Definition at line 59 of file AssetFactory.php.

References Assetic\Factory\AssetFactory\$debug.

     {
         $this->debug = $debug;
     }

◆ setDefaultOutput()

Assetic\Factory\AssetFactory::setDefaultOutput ( $output )

Sets the default output string.

Parameters

string $output The default output string

Definition at line 79 of file AssetFactory.php.

References Assetic\Factory\AssetFactory\$output.

     {
         $this->output = $output;
     }

◆ setFilterManager()

Assetic\Factory\AssetFactory::setFilterManager ( FilterManager $fm )

Sets the filter manager to use when adding filters.

Parameters

FilterManager $fm The filter manager

Definition at line 129 of file AssetFactory.php.

References Assetic\Factory\AssetFactory\$fm.

     {
         $this->fm = $fm;
     }

Field Documentation

◆ $am

Assetic\Factory\AssetFactory::$am

private

Definition at line 37 of file AssetFactory.php.

Referenced by Assetic\Factory\AssetFactory\getAssetManager(), and Assetic\Factory\AssetFactory\setAssetManager().

◆ $debug

Assetic\Factory\AssetFactory::$debug

private

Definition at line 34 of file AssetFactory.php.

Referenced by Assetic\Factory\AssetFactory\__construct(), Assetic\Factory\AssetFactory\createAsset(), Assetic\Factory\AssetFactory\isDebug(), and Assetic\Factory\AssetFactory\setDebug().

◆ $fm

Assetic\Factory\AssetFactory::$fm

private

Definition at line 38 of file AssetFactory.php.

Referenced by Assetic\Factory\AssetFactory\getFilterManager(), and Assetic\Factory\AssetFactory\setFilterManager().

◆ $output

Assetic\Factory\AssetFactory::$output

private

Definition at line 35 of file AssetFactory.php.

Referenced by Assetic\Factory\AssetFactory\createAsset(), and Assetic\Factory\AssetFactory\setDefaultOutput().

◆ $root

Assetic\Factory\AssetFactory::$root

private

Definition at line 33 of file AssetFactory.php.

Referenced by Assetic\Factory\AssetFactory\__construct(), Assetic\Factory\AssetFactory\createAsset(), Assetic\Factory\AssetFactory\createFileAsset(), Assetic\Factory\AssetFactory\createGlobAsset(), Assetic\Factory\AssetFactory\findRootDir(), and Assetic\Factory\AssetFactory\parseInput().

◆ $workers

Assetic\Factory\AssetFactory::$workers

private

Definition at line 36 of file AssetFactory.php.

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

libs/composer/vendor/kriswallsmith/assetic/src/Assetic/Factory/AssetFactory.php

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addWorker()

◆ applyWorkers()

◆ createAsset()

◆ createAssetCollection()

◆ createAssetReference()

◆ createFileAsset()

◆ createGlobAsset()

◆ createHttpAsset()

◆ findRootDir()

◆ generateAssetName()

◆ getAssetManager()

◆ getFilter()

◆ getFilterManager()

◆ getLastModified()

◆ isAbsolutePath()

◆ isDebug()

◆ parseInput()

◆ setAssetManager()

◆ setDebug()

◆ setDefaultOutput()

◆ setFilterManager()

Field Documentation

◆ $am

◆ $debug

◆ $fm

◆ $output

◆ $root

◆ $workers