Replace filters, output and token with parameters argument

[packbundle] / DependencyInjection / Configuration.php

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
index b0de9a4619dc02df54ec864dac52c95d089c9687..ebbdbfd8d11893f73c1f958f6dcfc45f9436c7b5 100644 (file)
--- a/DependencyInjection/Configuration.php
+++ b/DependencyInjection/Configuration.php
@@ -1,119 +1,104 @@
-<?php
+<?php declare(strict_types=1);
+
+/*
+ * This file is part of the Rapsys PackBundle package.
+ *
+ * (c) Raphaël Gertz <symfony@rapsys.eu>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */

 
 namespace Rapsys\PackBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 namespace Rapsys\PackBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;

+use Symfony\Component\DependencyInjection\Container;

 use Symfony\Component\Process\ExecutableFinder;
 
 use Symfony\Component\Process\ExecutableFinder;
 

+use Rapsys\PackBundle\RapsysPackBundle;
+

 /**
  * This is the class that validates and merges configuration from your app/config files.
  *
 /**
  * This is the class that validates and merges configuration from your app/config files.
  *

- * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
+ * @link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
+ *
+ * {@inheritdoc}

  */
 class Configuration implements ConfigurationInterface {
        /**
         * {@inheritdoc}
         */
  */
 class Configuration implements ConfigurationInterface {
        /**
         * {@inheritdoc}
         */

-       public function getConfigTreeBuilder() {
+       public function getConfigTreeBuilder(): TreeBuilder {

                //Get TreeBuilder object
                //Get TreeBuilder object

-               $treeBuilder = new TreeBuilder('rapsys_pack');
+               $treeBuilder = new TreeBuilder($alias = RapsysPackBundle::getAlias());

 
                //Get ExecutableFinder object
                $finder = new ExecutableFinder();
 
 
                //Get ExecutableFinder object
                $finder = new ExecutableFinder();
 

-               /**
-                * XXX: Note about the output schemes
-                *
-                * The output files are written based on the output.<ext> scheme with the * replaced by the hashed path of packed files
-                *
-                * The following service configuration make twig render the output file path with the right '/' basePath prefix:
-                * services:
-                *     assets.pack_package:
-                *         class: Rapsys\PackBundle\Asset\PathPackage
-                *         arguments: [ '/', '@assets.empty_version_strategy', '@assets.context' ]
-                *     rapsys_pack.twig.pack_extension:
-                *         class: Rapsys\PackBundle\Twig\PackExtension
-                *         arguments: [ '@file_locator', '@service_container', '@assets.pack_package' ]
-                *         tags: [ twig.extension ]
-                */
-

                //The bundle default values
                $defaults = [
                //The bundle default values
                $defaults = [

-                       'config' => [
-                               'name' => 'asset_url',
-                               'scheme' => 'https://',
-                               'timeout' => (int)ini_get('default_socket_timeout'),
-                               'agent' => (string)ini_get('user_agent')?:'rapsys_pack/0.1.8',
-                               'redirect' => 5
-                       ],
-                       'output' => [
-                               'css' => '@RapsysPack/css/*.pack.css',
-                               'js' =>  '@RapsysPack/js/*.pack.js',
-                               'img' => '@RapsysPack/img/*.pack.jpg'
-                       ],

                        'filters' => [
                                'css' => [
                                        0 => [
                        'filters' => [
                                'css' => [
                                        0 => [

-                                               'class' => 'Rapsys\PackBundle\Twig\Filter\CPackFilter',
+                                               'class' => 'Rapsys\PackBundle\Filter\CPackFilter',

                                                'args' => [
                                                        $finder->find('cpack', '/usr/local/bin/cpack'),
                                                        'minify'
                                                ]
                                        ]
                                ],
                                                'args' => [
                                                        $finder->find('cpack', '/usr/local/bin/cpack'),
                                                        'minify'
                                                ]
                                        ]
                                ],

+                               'img' => [
+                                       0 => [
+                                               'class' => 'Rapsys\PackBundle\Filter\IPackFilter',
+                                               'args' => []
+                                       ]
+                               ],

                                'js' => [
                                        0 => [
                                'js' => [
                                        0 => [

-                                               'class' => 'Rapsys\PackBundle\Twig\Filter\JPackFilter',
+                                               'class' => 'Rapsys\PackBundle\Filter\JPackFilter',

                                                'args' => [
                                                        $finder->find('jpack', '/usr/local/bin/jpack'),
                                                        'best'
                                                ]
                                        ]
                                                'args' => [
                                                        $finder->find('jpack', '/usr/local/bin/jpack'),
                                                        'best'
                                                ]
                                        ]

-                               ],
-                               'img' => [
-                                       0 => [
-                                               'class' => 'Rapsys\PackBundle\Twig\Filter\IPackFilter',
-                                               'args' => []
-                                       ]
-                               ],
-                       ]
+                               ]
+                       ],
+                       #TODO: migrate to public.path, public.url and router->generateUrl ?
+                       #XXX: that would means dropping the PathPackage stuff and use static route like rapsys_pack_facebook
+                       'output' => [
+                               'css' => '@RapsysPack/css/*.pack.css',
+                               'img' => '@RapsysPack/img/*.pack.jpg',
+                               'js' =>  '@RapsysPack/js/*.pack.js'
+                       ],
+                       'path' => dirname(__DIR__).'/Resources/public',
+                       'token' => 'asset_url'

                ];
 
                ];
 

-               //Here we define the parameters that are allowed to configure the bundle.
-               //XXX: see https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php for default value and description
-               //XXX: see http://symfony.com/doc/current/components/config/definition.html
-               //XXX: see https://github.com/symfony/assetic-bundle/blob/master/DependencyInjection/Configuration.php#L63
-               //XXX: see php bin/console config:dump-reference rapsys_pack to dump default config
-               //XXX: see php bin/console debug:config rapsys_pack to dump config
+               /**
+                * Defines parameters allowed to configure the bundle
+                *
+                * @link https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
+                * @link http://symfony.com/doc/current/components/config/definition.html
+                * @link https://github.com/symfony/assetic-bundle/blob/master/DependencyInjection/Configuration.php#L63
+                *
+                * @see php bin/console config:dump-reference rapsys_pack to dump default config
+                * @see php bin/console debug:config rapsys_pack to dump config
+                */

                $treeBuilder
                        //Parameters
                        ->getRootNode()
                                ->addDefaultsIfNotSet()
                                ->children()
                $treeBuilder
                        //Parameters
                        ->getRootNode()
                                ->addDefaultsIfNotSet()
                                ->children()

-                                       ->arrayNode('config')
-                                               ->addDefaultsIfNotSet()
-                                               ->children()
-                                                       ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['config']['name'])->end()
-                                                       ->scalarNode('scheme')->cannotBeEmpty()->defaultValue($defaults['config']['scheme'])->end()
-                                                       ->integerNode('timeout')->min(0)->max(300)->defaultValue($defaults['config']['timeout'])->end()
-                                                       ->scalarNode('agent')->cannotBeEmpty()->defaultValue($defaults['config']['agent'])->end()
-                                                       ->integerNode('redirect')->min(1)->max(30)->defaultValue($defaults['config']['redirect'])->end()
-                                               ->end()
-                                       ->end()
-                                       ->arrayNode('output')
-                                               ->addDefaultsIfNotSet()
-                                               ->children()
-                                                       ->scalarNode('css')->cannotBeEmpty()->defaultValue($defaults['output']['css'])->end()
-                                                       ->scalarNode('js')->cannotBeEmpty()->defaultValue($defaults['output']['js'])->end()
-                                                       ->scalarNode('img')->cannotBeEmpty()->defaultValue($defaults['output']['img'])->end()
-                                               ->end()
-                                       ->end()

                                        ->arrayNode('filters')
                                                ->addDefaultsIfNotSet()
                                                ->children()
                                                        ->arrayNode('css')
                                        ->arrayNode('filters')
                                                ->addDefaultsIfNotSet()
                                                ->children()
                                                        ->arrayNode('css')

-                                                               #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                               /**
+                                                                * Undocumented
+                                                                *
+                                                                * @see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                                */

                                                                ->addDefaultChildrenIfNoneSet()
                                                                ->arrayPrototype()
                                                                        ->children()
                                                                ->addDefaultChildrenIfNoneSet()
                                                                ->arrayPrototype()
                                                                        ->children()


@@ -123,45 +108,53 @@ class Configuration implements ConfigurationInterface {
                                                                                        ->defaultValue($defaults['filters']['css'][0]['class'])
                                                                                ->end()
                                                                                ->arrayNode('args')
                                                                                        ->defaultValue($defaults['filters']['css'][0]['class'])
                                                                                ->end()
                                                                                ->arrayNode('args')

-                                                                                       /*->isRequired()*/
-                                                                                       ->treatNullLike(array())
+                                                                                       //->isRequired()
+                                                                                       ->treatNullLike([])

                                                                                        ->defaultValue($defaults['filters']['css'][0]['args'])
                                                                                        ->scalarPrototype()->end()
                                                                                ->end()
                                                                        ->end()
                                                                ->end()
                                                        ->end()
                                                                                        ->defaultValue($defaults['filters']['css'][0]['args'])
                                                                                        ->scalarPrototype()->end()
                                                                                ->end()
                                                                        ->end()
                                                                ->end()
                                                        ->end()

-                                                       ->arrayNode('js')
-                                                               #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                       ->arrayNode('img')
+                                                               /**
+                                                                * Undocumented
+                                                                *
+                                                                * @see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                                */

                                                                ->addDefaultChildrenIfNoneSet()
                                                                ->arrayPrototype()
                                                                        ->children()
                                                                                ->scalarNode('class')
                                                                                        ->isRequired()
                                                                                        ->cannotBeEmpty()
                                                                ->addDefaultChildrenIfNoneSet()
                                                                ->arrayPrototype()
                                                                        ->children()
                                                                                ->scalarNode('class')
                                                                                        ->isRequired()
                                                                                        ->cannotBeEmpty()

-                                                                                       ->defaultValue($defaults['filters']['js'][0]['class'])
+                                                                                       ->defaultValue($defaults['filters']['img'][0]['class'])

                                                                                ->end()
                                                                                ->arrayNode('args')
                                                                                ->end()
                                                                                ->arrayNode('args')

-                                                                                       ->treatNullLike(array())
-                                                                                       ->defaultValue($defaults['filters']['js'][0]['args'])
+                                                                                       ->treatNullLike([])
+                                                                                       ->defaultValue($defaults['filters']['img'][0]['args'])

                                                                                        ->scalarPrototype()->end()
                                                                                ->end()
                                                                        ->end()
                                                                ->end()
                                                        ->end()
                                                                                        ->scalarPrototype()->end()
                                                                                ->end()
                                                                        ->end()
                                                                ->end()
                                                        ->end()

-                                                       ->arrayNode('img')
-                                                               #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                       ->arrayNode('js')
+                                                               /**
+                                                                * Undocumented
+                                                                *
+                                                                * @see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                                */

                                                                ->addDefaultChildrenIfNoneSet()
                                                                ->arrayPrototype()
                                                                        ->children()
                                                                                ->scalarNode('class')
                                                                                        ->isRequired()
                                                                                        ->cannotBeEmpty()
                                                                ->addDefaultChildrenIfNoneSet()
                                                                ->arrayPrototype()
                                                                        ->children()
                                                                                ->scalarNode('class')
                                                                                        ->isRequired()
                                                                                        ->cannotBeEmpty()

-                                                                                       ->defaultValue($defaults['filters']['img'][0]['class'])
+                                                                                       ->defaultValue($defaults['filters']['js'][0]['class'])

                                                                                ->end()
                                                                                ->arrayNode('args')
                                                                                ->end()
                                                                                ->arrayNode('args')

-                                                                                       ->treatNullLike(array())
-                                                                                       ->defaultValue($defaults['filters']['img'][0]['args'])
+                                                                                       ->treatNullLike([])
+                                                                                       ->defaultValue($defaults['filters']['js'][0]['args'])

                                                                                        ->scalarPrototype()->end()
                                                                                ->end()
                                                                        ->end()
                                                                                        ->scalarPrototype()->end()
                                                                                ->end()
                                                                        ->end()


@@ -169,6 +162,16 @@ class Configuration implements ConfigurationInterface {
                                                        ->end()
                                                ->end()
                                        ->end()
                                                        ->end()
                                                ->end()
                                        ->end()

+                                       ->arrayNode('output')
+                                               ->addDefaultsIfNotSet()
+                                               ->children()
+                                                       ->scalarNode('css')->cannotBeEmpty()->defaultValue($defaults['output']['css'])->end()
+                                                       ->scalarNode('img')->cannotBeEmpty()->defaultValue($defaults['output']['img'])->end()
+                                                       ->scalarNode('js')->cannotBeEmpty()->defaultValue($defaults['output']['js'])->end()
+                                               ->end()
+                                       ->end()
+                                       ->scalarNode('path')->cannotBeEmpty()->defaultValue($defaults['path'])->end()
+                                       ->scalarNode('token')->cannotBeEmpty()->defaultValue($defaults['token'])->end()

                                ->end()
                        ->end();
 
                                ->end()
                        ->end();