[Asset] added the component

symfony · fabpot · Feb 10, 2015 · Dec 28, 2014 · Jan 19, 2015 · Jan 17, 2015
commit d33c41d43663f1f638ec083fa2b8c3bddec5ad1a
diff --git a/composer.json b/composer.json
@@ -22,6 +22,7 @@
         "psr/log": "~1.0"
     },
     "replace": {
+        "symfony/asset": "self.version",
         "symfony/browser-kit": "self.version",
         "symfony/class-loader": "self.version",
         "symfony/config": "self.version",

diff --git a/src/Symfony/Bridge/Twig/CHANGELOG.md b/src/Symfony/Bridge/Twig/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * added LogoutUrlExtension (provides `logout_url` and `logout_path`)
  * added an HttpFoundation extension (provides the `absolute_url` and the `relative_path` functions)
+ * added AssetExtension (provides the `asset_path` function)
 
 2.5.0
 -----

diff --git a/src/Symfony/Bridge/Twig/Extension/AssetExtension.php b/src/Symfony/Bridge/Twig/Extension/AssetExtension.php
@@ -0,0 +1,79 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Twig\Extension;
+
+use Symfony\Component\Asset\Packages;
+
+/**
+ * Twig extension for the Symfony Asset component.
+ *
+ * @author Fabien Potencier <fabien@symfony.com>
+ */
+class AssetExtension extends \Twig_Extension
+{
+        private $packages;
+
+    public function __construct(Packages $packages)
+    {
+        $this->packages = $packages;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFunctions()
+    {
+        return array(
+            new \Twig_SimpleFunction('asset_path', array($this, 'getAssetPath')),
+            new \Twig_SimpleFunction('asset_version', array($this, 'getAssetVersion')),
+        );
+    }
+
+    /**
+     * Returns the public path of an asset.
+     *
+     * If the package used to generate the path is an instance of
+     * UrlPackage, you will always get a URL and not a path.
+     *
+     * @param string $path        A public path
+     * @param string $packageName The name of the asset package to use
+     *
+     * @return string The public path of the asset
+     */
+    public function getAssetPath($path, $packageName = null)
+    {
+        return $this->packages->getUrl($path, $packageName);
+    }
+
+    /**
+     * Returns the version of an asset.
+     *
+     * @param string $path        A public path
+     * @param string $packageName The name of the asset package to use
+     *
+     * @return string The asset version
+     */
+    public function getAssetVersion($path, $packageName = null)
+    {
+        return $this->packages->getVersion($path, $packageName);
+    }
+
+    /**
+     * Returns the name of the extension.
+     *
+     * @return string The extension name
+     */
+    public function getName()
+    {
+        return 'asset';
+    }
+}
diff --git a/src/Symfony/Bridge/Twig/composer.json b/src/Symfony/Bridge/Twig/composer.json
@@ -37,6 +37,7 @@
     },
     "suggest": {
         "symfony/finder": "",
+        "symfony/asset": "For using the AssetExtension",
         "symfony/form": "For using the FormExtension",
         "symfony/http-kernel": "For using the HttpKernelExtension",
         "symfony/routing": "For using the RoutingExtension",

diff --git a/...Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/TemplatingAssetHelperPass.php b/...Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/TemplatingAssetHelperPass.php
@@ -16,6 +16,9 @@
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 
+/**
+ * @deprecated since 2.7, will be removed in 3.0
+ */
 class TemplatingAssetHelperPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container)

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -108,6 +108,7 @@ public function getConfigTreeBuilder()
         $this->addSessionSection($rootNode);
         $this->addRequestSection($rootNode);
         $this->addTemplatingSection($rootNode);
+        $this->addAssetsSection($rootNode);
         $this->addTranslatorSection($rootNode);
         $this->addValidationSection($rootNode);
         $this->addAnnotationsSection($rootNode);
@@ -347,8 +348,8 @@ private function addTemplatingSection(ArrayNodeDefinition $rootNode)
                     ->info('templating configuration')
                     ->canBeUnset()
                     ->children()
-                        ->scalarNode('assets_version')->defaultValue(null)->end()
-                        ->scalarNode('assets_version_format')->defaultValue('%%s?%%s')->end()
+                        ->scalarNode('assets_version')->defaultNull()->info('Deprecated since 2.7, will be removed in 3.0. Use the new assets entry instead.')->end()
+                        ->scalarNode('assets_version_format')->defaultValue('%%s?%%s')->info('Deprecated since 2.7, will be removed in 3.0. Use the new assets entry instead.')->end()
                         ->scalarNode('hinclude_default_template')->defaultNull()->end()
                         ->arrayNode('form')
                             ->addDefaultsIfNotSet()
@@ -370,6 +371,7 @@ private function addTemplatingSection(ArrayNodeDefinition $rootNode)
                     ->fixXmlConfig('assets_base_url')
                     ->children()
                         ->arrayNode('assets_base_urls')
+                            ->info('Deprecated since 2.7, will be removed in 3.0. Use the new assets entry instead.')
                             ->performNoDeepMerging()
                             ->addDefaultsIfNotSet()
                             ->beforeNormalization()
@@ -417,6 +419,7 @@ private function addTemplatingSection(ArrayNodeDefinition $rootNode)
                     ->fixXmlConfig('package')
                     ->children()
                         ->arrayNode('packages')
+                            ->info('Deprecated since 2.7, will be removed in 3.0. Use the new assets entry instead.')
                             ->useAttributeAsKey('name')
                             ->prototype('array')
                                 ->fixXmlConfig('base_url')
@@ -452,6 +455,54 @@ private function addTemplatingSection(ArrayNodeDefinition $rootNode)
         ;
     }
 
+    private function addAssetsSection(ArrayNodeDefinition $rootNode)
+    {
+        $rootNode
+            ->children()
+                ->arrayNode('assets')
+                    ->info('assets configuration')
+                    ->canBeUnset()
+                    ->fixXmlConfig('base_url')
+                    ->children()
+                        ->scalarNode('version')->defaultNull()->end()
+                        ->scalarNode('version_format')->defaultValue('%%s?%%s')->end()
+                        ->scalarNode('base_path')->defaultValue('')->end()
+                        ->arrayNode('base_urls')
+                            ->requiresAtLeastOneElement()
+                            ->beforeNormalization()
+                                ->ifTrue(function ($v) { return !is_array($v); })
+                                ->then(function ($v) { return array($v); })
+                            ->end()
+                            ->prototype('scalar')->end()
+                        ->end()
+                    ->end()
+                    ->fixXmlConfig('package')
+                    ->children()
+                        ->arrayNode('packages')
+                            ->useAttributeAsKey('name')
+                            ->prototype('array')
+                                ->fixXmlConfig('base_url')
+                                ->children()
+                                    ->scalarNode('version')->defaultNull()->end()
+                                    ->scalarNode('version_format')->defaultNull()->end()
+                                    ->scalarNode('base_path')->defaultValue('')->end()
+                                    ->arrayNode('base_urls')
+                                        ->requiresAtLeastOneElement()
+                                        ->beforeNormalization()
+                                            ->ifTrue(function ($v) { return !is_array($v); })
+                                            ->then(function ($v) { return array($v); })
+                                        ->end()
+                                        ->prototype('scalar')->end()
+                                    ->end()
+                                ->end()
+                            ->end()
+                        ->end()
+                    ->end()
+                ->end()
+            ->end()
+        ;
+    }
+
     private function addTranslatorSection(ArrayNodeDefinition $rootNode)
     {
         $rootNode

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -101,6 +101,10 @@ public function load(array $configs, ContainerBuilder $container)
 
         $this->registerSecurityCsrfConfiguration($config['csrf_protection'], $container, $loader);
 
+        if (isset($config['assets'])) {
+            $this->registerAssetsConfiguration($config['assets'], $container, $loader);
+        }
+
         if (isset($config['templating'])) {
             $this->registerTemplatingConfiguration($config['templating'], $config['ide'], $container, $loader);
         }
@@ -632,6 +636,86 @@ private function createTemplatingPackageDefinition(ContainerBuilder $container,
         return $package;
     }
 
+    /**
+     * Loads the assets configuration.
+     *
+     * @param array            $config    A assets configuration array
+     * @param ContainerBuilder $container A ContainerBuilder instance
+     * @param XmlFileLoader    $loader    An XmlFileLoader instance
+     */
+    private function registerAssetsConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader)
+    {
+        $loader->load('assets.xml');
+
+        $defaultVersion = $this->createVersion($container, $config['version'], $config['version_format']);
+
+        $defaultPackage = $this->createPackageDefinition($config['base_path'], $config['base_urls'], $defaultVersion);
+        $container->setDefinition('assets._default_package', $defaultPackage);
+
+        $namedPackages = array();
+        foreach ($config['packages'] as $name => $package) {
+            if (null === $package['version']) {
+                $version = $defaultVersion;
+            } else {
+                $format = $package['version_format'] ?: $config['version_format'];
+
+                $version = $this->createVersion($container, $package['version'], $format, $name);
+            }
+
+            $container->setDefinition('assets._package_'.$name, $this->createPackageDefinition($package['base_path'], $package['base_urls'], $version));
+            $namedPackages[$name] = new Reference('assets._package_'.$name);
+        }
+
+        $container->getDefinition('assets.packages')
+            ->replaceArgument(0, new Reference('assets._default_package'))
+            ->replaceArgument(1, $namedPackages)
+        ;
+    }
+
+    /**
+     * Returns a definition for an asset package.
+     */
+    private function createPackageDefinition($basePath, array $baseUrls, Reference $version)
+    {
+        if ($basePath && $baseUrls) {
+            throw new \LogicException('An asset package cannot have base URLs and base paths.');
+        }
+
+        if (!$baseUrls) {
+            $package = new DefinitionDecorator('assets.path_package');
+
+            return $package
+                ->setPublic(false)
+                ->replaceArgument(0, $basePath)
+                ->replaceArgument(1, $version)
+            ;
+        }
+
+        $package = new DefinitionDecorator('assets.url_package');
+
+        return $package
+            ->setPublic(false)
+            ->replaceArgument(0, $baseUrls)
+            ->replaceArgument(1, $version)
+        ;
+    }
+
+    private function createVersion(ContainerBuilder $container, $version, $format, $name = null)
+    {
+        if (!$version) {
+            return new Reference('assets.empty_version_strategy');
+        }
+
+        $def = new DefinitionDecorator('assets.static_version_strategy');
+        $def
+            ->replaceArgument(0, $version)
+            ->replaceArgument(1, $format)
+        ;
+        $container->setDefinition('assets._version_'.$name, $def);
+
+        return new Reference('assets._version_'.$name);
+    }
+
     /**
      * Loads the translator configuration.
      *

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/assets.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/assets.xml
@@ -0,0 +1,42 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+
+        <service id="assets.packages" class="Symfony\Component\Asset\Packages">
+            <argument /> <!-- default package -->
+            <argument type="collection" /> <!-- named packages -->
+        </service>
+
+        <service id="assets.context" class="Symfony\Component\Asset\Context\RequestStackContext">
+            <argument type="service" id="request_stack" />
+        </service>
+
+        <service id="assets.path_package" class="Symfony\Component\Asset\PathPackage" abstract="true">
+            <argument /> <!-- base path -->
+            <argument type="service" /> <!-- version strategy -->
+            <call method="setContext">
+                <argument type="service" id="assets.context" />
+            </call>
+        </service>
+
+        <service id="assets.url_package" class="Symfony\Component\Asset\UrlPackage" abstract="true">
+            <argument /> <!-- base URLs -->
+            <argument type="service" /> <!-- version strategy -->
+            <call method="setContext">
+                <argument type="service" id="assets.context" />
+            </call>
+        </service>
+
+        <service id="assets.static_version_strategy" class="Symfony\Component\Asset\VersionStrategy\StaticVersionStrategy" abstract="true">
+            <argument /> <!-- version -->
+            <argument /> <!-- format -->
+        </service>
+
+        <service id="assets.empty_version_strategy" class="Symfony\Component\Asset\VersionStrategy\EmptyVersionStrategy" public="false" />
+
+    </services>
+</container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Templating/Asset/PackageFactory.php b/src/Symfony/Bundle/FrameworkBundle/Templating/Asset/PackageFactory.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Templating\Asset;
 
+trigger_error('The Symfony\Bundle\FrameworkBundle\Templating\Asset\PackageFactory is deprecated since version 2.7 and will be removed in 3.0. Use the Asset component instead.', E_USER_DEPRECATED);
+
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Templating\Asset\PackageInterface;
@@ -19,6 +21,8 @@
  * Creates packages based on whether the current request is secure.
  *
  * @author Kris Wallsmith <kris@symfony.com>
+ *
+ * @deprecated since 2.7, will be removed in 3.0. Use the Asset component instead.
  */
 class PackageFactory
 {

diff --git a/src/Symfony/Bundle/FrameworkBundle/Templating/Asset/PathPackage.php b/src/Symfony/Bundle/FrameworkBundle/Templating/Asset/PathPackage.php
@@ -14,10 +14,14 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Templating\Asset\PathPackage as BasePathPackage;
 
+trigger_error('The Symfony\Bundle\FrameworkBundle\Templating\Asset\PathPackage is deprecated since version 2.7 and will be removed in 3.0. Use the Asset component instead.', E_USER_DEPRECATED);
+
 /**
  * The path packages adds a version and a base path to asset URLs.
  *
  * @author Kris Wallsmith <kris@symfony.com>
+ *
+ * @deprecated since 2.7, will be removed in 3.0. Use the Asset component instead.
  */
 class PathPackage extends BasePathPackage
 {

diff --git a/src/Symfony/Bundle/FrameworkBundle/composer.json b/src/Symfony/Bundle/FrameworkBundle/composer.json
@@ -32,6 +32,7 @@
         "doctrine/annotations": "~1.0"
     },
     "require-dev": {
+        "symfony/asset": "~2.7|~3.0.0",
         "symfony/browser-kit": "~2.4|~3.0.0",
         "symfony/console": "~2.6|~3.0.0",
         "symfony/css-selector": "~2.0,>=2.0.5|~3.0.0",

diff --git a/src/Symfony/Bundle/TwigBundle/CHANGELOG.md b/src/Symfony/Bundle/TwigBundle/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+2.7.0
+-----
+
+ * added support for the new Asset component (from Twig bridge)
+ * deprecated the assets extension (use the one from the Twig bridge instead)
+
 2.6.0
 -----
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,7 @@ CHANGELOG @@
      * added LogoutUrlExtension (provides `logout_url` and `logout_path`)
      * added an HttpFoundation extension (provides the `absolute_url` and the `relative_path` functions)
+     * added AssetExtension (provides the `asset_path` function)
 .5.0
     -----
@@ Expand Down @@