moved asset_container into asset.php
This commit is contained in:
Taylor Otwell
parent
83ace2de68
commit
d8eba6389c
262
system/asset.php
262
system/asset.php
|
|
@ -1,5 +1,7 @@
|
||||||
<?php namespace System;
|
<?php namespace System;
|
||||||
|
|
||||||
|
use System\HTML;
|
||||||
|
|
||||||
class Asset {
|
class Asset {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -33,4 +35,264 @@ public static function __callStatic($method, $parameters)
|
||||||
return call_user_func_array(array(static::container(), $method), $parameters);
|
return call_user_func_array(array(static::container(), $method), $parameters);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
class Asset_Container {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The asset container name.
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
public $name;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* All of the registered assets.
|
||||||
|
*
|
||||||
|
* @var array
|
||||||
|
*/
|
||||||
|
public $assets = array();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new asset container instance.
|
||||||
|
*
|
||||||
|
* @param string $name
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function __construct($name)
|
||||||
|
{
|
||||||
|
$this->name = $name;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add an asset to the container.
|
||||||
|
*
|
||||||
|
* @param string $name
|
||||||
|
* @param string $source
|
||||||
|
* @param array $dependencies
|
||||||
|
* @param array $attributes
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function add($name, $source, $dependencies = array(), $attributes = array())
|
||||||
|
{
|
||||||
|
return call_user_func(array($this, (\System\File::extension($source) == 'css') ? 'style' : 'script'), $name, $source, $dependencies, $attributes);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add CSS to the registered assets.
|
||||||
|
*
|
||||||
|
* @param string $name
|
||||||
|
* @param string $source
|
||||||
|
* @param array $dependencies
|
||||||
|
* @param array $attributes
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function style($name, $source, $dependencies = array(), $attributes = array())
|
||||||
|
{
|
||||||
|
if ( ! array_key_exists('media', $attributes))
|
||||||
|
{
|
||||||
|
$attributes['media'] = 'all';
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->register('style', $name, $source, $dependencies, $attributes);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add JavaScript to the registered assets.
|
||||||
|
*
|
||||||
|
* @param string $name
|
||||||
|
* @param string $source
|
||||||
|
* @param array $dependencies
|
||||||
|
* @param array $attributes
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function script($name, $source, $dependencies = array(), $attributes = array())
|
||||||
|
{
|
||||||
|
$this->register('script', $name, $source, $dependencies, $attributes);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add an asset to the registered assets.
|
||||||
|
*
|
||||||
|
* @param string $type
|
||||||
|
* @param string $name
|
||||||
|
* @param string $source
|
||||||
|
* @param array $dependencies
|
||||||
|
* @param array $attributes
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
private function register($type, $name, $source, $dependencies, $attributes)
|
||||||
|
{
|
||||||
|
$dependencies = (array) $dependencies;
|
||||||
|
|
||||||
|
$this->assets[$type][$name] = compact('source', 'dependencies', 'attributes');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all of the registered CSS assets.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function styles()
|
||||||
|
{
|
||||||
|
return $this->get_group('style');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all of the registered JavaScript assets.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function scripts()
|
||||||
|
{
|
||||||
|
return $this->get_group('script');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all of the registered assets for a given group.
|
||||||
|
*
|
||||||
|
* @param string $group
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
private function get_group($group)
|
||||||
|
{
|
||||||
|
if ( ! isset($this->assets[$group]) or count($this->assets[$group]) == 0) return '';
|
||||||
|
|
||||||
|
$assets = '';
|
||||||
|
|
||||||
|
foreach ($this->arrange($this->assets[$group]) as $name => $data)
|
||||||
|
{
|
||||||
|
$assets .= $this->get_asset($group, $name);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $assets;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a registered CSS asset.
|
||||||
|
*
|
||||||
|
* @param string $name
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function get_style($name)
|
||||||
|
{
|
||||||
|
return $this->get_asset('style', $name);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a registered JavaScript asset.
|
||||||
|
*
|
||||||
|
* @param string $name
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function get_script($name)
|
||||||
|
{
|
||||||
|
return $this->get_asset('script', $name);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a registered asset.
|
||||||
|
*
|
||||||
|
* @param string $group
|
||||||
|
* @param string $name
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
private function get_asset($group, $name)
|
||||||
|
{
|
||||||
|
if ( ! isset($this->assets[$group][$name]))
|
||||||
|
{
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
$asset = $this->assets[$group][$name];
|
||||||
|
|
||||||
|
return HTML::$group($asset['source'], $asset['attributes']);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sort and retrieve assets based on their dependencies
|
||||||
|
*
|
||||||
|
* @param array $assets
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
private function arrange($assets)
|
||||||
|
{
|
||||||
|
list($original, $sorted) = array($assets, array());
|
||||||
|
|
||||||
|
while (count($assets) > 0)
|
||||||
|
{
|
||||||
|
foreach ($assets as $asset => $value)
|
||||||
|
{
|
||||||
|
$this->evaluate_asset($asset, $value, $original, $sorted, $assets);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $sorted;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Evaluate an asset and its dependencies.
|
||||||
|
*
|
||||||
|
* @param string $asset
|
||||||
|
* @param string $value
|
||||||
|
* @param array $original
|
||||||
|
* @param array $sorted
|
||||||
|
* @param array $assets
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
private function evaluate_asset($asset, $value, $original, &$sorted, &$assets)
|
||||||
|
{
|
||||||
|
// If the asset has no more dependencies, we can add it to the sorted list
|
||||||
|
// and remove it from the array of assets. Otherwise, we will not verify
|
||||||
|
// the asset's dependencies and determine if they have already been sorted.
|
||||||
|
if (count($assets[$asset]['dependencies']) == 0)
|
||||||
|
{
|
||||||
|
$sorted[$asset] = $value;
|
||||||
|
unset($assets[$asset]);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
foreach ($assets[$asset]['dependencies'] as $key => $dependency)
|
||||||
|
{
|
||||||
|
if ( ! $this->dependency_is_valid($asset, $dependency, $original, $assets))
|
||||||
|
{
|
||||||
|
unset($assets[$asset]['dependencies'][$key]);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the dependency has not yet been added to the sorted list, we can not
|
||||||
|
// remove it from this asset's array of dependencies. We'll try again on
|
||||||
|
// the next trip through the loop.
|
||||||
|
if ( ! isset($sorted[$dependency])) continue;
|
||||||
|
|
||||||
|
unset($assets[$asset]['dependencies'][$key]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check that a dependency is valid.
|
||||||
|
*
|
||||||
|
* @param string $asset
|
||||||
|
* @param string $dependency
|
||||||
|
* @param array $original
|
||||||
|
* @param array $assets
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
private function dependency_is_valid($asset, $dependency, $original, $assets)
|
||||||
|
{
|
||||||
|
if ( ! isset($original[$dependency]))
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
elseif ($dependency === $asset)
|
||||||
|
{
|
||||||
|
throw new \Exception("Asset [$asset] is dependent on itself.");
|
||||||
|
}
|
||||||
|
elseif (isset($assets[$dependency]) and in_array($asset, $assets[$dependency]['dependencies']))
|
||||||
|
{
|
||||||
|
throw new \Exception("Assets [$asset] and [$dependency] have a circular dependency.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
@ -1,263 +0,0 @@
|
||||||
<?php namespace System;
|
|
||||||
|
|
||||||
use System\HTML;
|
|
||||||
|
|
||||||
class Asset_Container {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The asset container name.
|
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
|
||||||
public $name;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* All of the registered assets.
|
|
||||||
*
|
|
||||||
* @var array
|
|
||||||
*/
|
|
||||||
public $assets = array();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a new asset container instance.
|
|
||||||
*
|
|
||||||
* @param string $name
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function __construct($name)
|
|
||||||
{
|
|
||||||
$this->name = $name;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add an asset to the container.
|
|
||||||
*
|
|
||||||
* @param string $name
|
|
||||||
* @param string $source
|
|
||||||
* @param array $dependencies
|
|
||||||
* @param array $attributes
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function add($name, $source, $dependencies = array(), $attributes = array())
|
|
||||||
{
|
|
||||||
return call_user_func(array($this, (\System\File::extension($source) == 'css') ? 'style' : 'script'), $name, $source, $dependencies, $attributes);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add CSS to the registered assets.
|
|
||||||
*
|
|
||||||
* @param string $name
|
|
||||||
* @param string $source
|
|
||||||
* @param array $dependencies
|
|
||||||
* @param array $attributes
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function style($name, $source, $dependencies = array(), $attributes = array())
|
|
||||||
{
|
|
||||||
if ( ! array_key_exists('media', $attributes))
|
|
||||||
{
|
|
||||||
$attributes['media'] = 'all';
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->register('style', $name, $source, $dependencies, $attributes);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add JavaScript to the registered assets.
|
|
||||||
*
|
|
||||||
* @param string $name
|
|
||||||
* @param string $source
|
|
||||||
* @param array $dependencies
|
|
||||||
* @param array $attributes
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function script($name, $source, $dependencies = array(), $attributes = array())
|
|
||||||
{
|
|
||||||
$this->register('script', $name, $source, $dependencies, $attributes);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add an asset to the registered assets.
|
|
||||||
*
|
|
||||||
* @param string $type
|
|
||||||
* @param string $name
|
|
||||||
* @param string $source
|
|
||||||
* @param array $dependencies
|
|
||||||
* @param array $attributes
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
private function register($type, $name, $source, $dependencies, $attributes)
|
|
||||||
{
|
|
||||||
$dependencies = (array) $dependencies;
|
|
||||||
|
|
||||||
$this->assets[$type][$name] = compact('source', 'dependencies', 'attributes');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get all of the registered CSS assets.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function styles()
|
|
||||||
{
|
|
||||||
return $this->get_group('style');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get all of the registered JavaScript assets.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function scripts()
|
|
||||||
{
|
|
||||||
return $this->get_group('script');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get all of the registered assets for a given group.
|
|
||||||
*
|
|
||||||
* @param string $group
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
private function get_group($group)
|
|
||||||
{
|
|
||||||
if ( ! isset($this->assets[$group]) or count($this->assets[$group]) == 0) return '';
|
|
||||||
|
|
||||||
$assets = '';
|
|
||||||
|
|
||||||
foreach ($this->arrange($this->assets[$group]) as $name => $data)
|
|
||||||
{
|
|
||||||
$assets .= $this->get_asset($group, $name);
|
|
||||||
}
|
|
||||||
|
|
||||||
return $assets;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get a registered CSS asset.
|
|
||||||
*
|
|
||||||
* @param string $name
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function get_style($name)
|
|
||||||
{
|
|
||||||
return $this->get_asset('style', $name);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get a registered JavaScript asset.
|
|
||||||
*
|
|
||||||
* @param string $name
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function get_script($name)
|
|
||||||
{
|
|
||||||
return $this->get_asset('script', $name);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get a registered asset.
|
|
||||||
*
|
|
||||||
* @param string $group
|
|
||||||
* @param string $name
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
private function get_asset($group, $name)
|
|
||||||
{
|
|
||||||
if ( ! isset($this->assets[$group][$name]))
|
|
||||||
{
|
|
||||||
return '';
|
|
||||||
}
|
|
||||||
|
|
||||||
$asset = $this->assets[$group][$name];
|
|
||||||
|
|
||||||
return HTML::$group($asset['source'], $asset['attributes']);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Sort and retrieve assets based on their dependencies
|
|
||||||
*
|
|
||||||
* @param array $assets
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
private function arrange($assets)
|
|
||||||
{
|
|
||||||
list($original, $sorted) = array($assets, array());
|
|
||||||
|
|
||||||
while (count($assets) > 0)
|
|
||||||
{
|
|
||||||
foreach ($assets as $asset => $value)
|
|
||||||
{
|
|
||||||
$this->evaluate_asset($asset, $value, $original, $sorted, $assets);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return $sorted;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Evaluate an asset and its dependencies.
|
|
||||||
*
|
|
||||||
* @param string $asset
|
|
||||||
* @param string $value
|
|
||||||
* @param array $original
|
|
||||||
* @param array $sorted
|
|
||||||
* @param array $assets
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
private function evaluate_asset($asset, $value, $original, &$sorted, &$assets)
|
|
||||||
{
|
|
||||||
// If the asset has no more dependencies, we can add it to the sorted list
|
|
||||||
// and remove it from the array of assets. Otherwise, we will not verify
|
|
||||||
// the asset's dependencies and determine if they have already been sorted.
|
|
||||||
if (count($assets[$asset]['dependencies']) == 0)
|
|
||||||
{
|
|
||||||
$sorted[$asset] = $value;
|
|
||||||
unset($assets[$asset]);
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
foreach ($assets[$asset]['dependencies'] as $key => $dependency)
|
|
||||||
{
|
|
||||||
if ( ! $this->dependency_is_valid($asset, $dependency, $original, $assets))
|
|
||||||
{
|
|
||||||
unset($assets[$asset]['dependencies'][$key]);
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the dependency has not yet been added to the sorted list, we can not
|
|
||||||
// remove it from this asset's array of dependencies. We'll try again on
|
|
||||||
// the next trip through the loop.
|
|
||||||
if ( ! isset($sorted[$dependency])) continue;
|
|
||||||
|
|
||||||
unset($assets[$asset]['dependencies'][$key]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check that a dependency is valid.
|
|
||||||
*
|
|
||||||
* @param string $asset
|
|
||||||
* @param string $dependency
|
|
||||||
* @param array $original
|
|
||||||
* @param array $assets
|
|
||||||
* @return bool
|
|
||||||
*/
|
|
||||||
private function dependency_is_valid($asset, $dependency, $original, $assets)
|
|
||||||
{
|
|
||||||
if ( ! isset($original[$dependency]))
|
|
||||||
{
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
elseif ($dependency === $asset)
|
|
||||||
{
|
|
||||||
throw new \Exception("Asset [$asset] is dependent on itself.");
|
|
||||||
}
|
|
||||||
elseif (isset($assets[$dependency]) and in_array($asset, $assets[$dependency]['dependencies']))
|
|
||||||
{
|
|
||||||
throw new \Exception("Assets [$asset] and [$dependency] have a circular dependency.");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
Loading…
Reference in New Issue