]> Raphaël G. Git Repositories - packbundle/blobdiff - DependencyInjection/Configuration.php
Use bundle alias and version as user agent
[packbundle] / DependencyInjection / Configuration.php
index 5456a29d0ccf02b56b7450e356c9aaf9cc29561e..2e57ae864af747a11ac4e51e70377341532c86e4 100644 (file)
-<?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;
+use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\Process\ExecutableFinder;
 
+use Rapsys\PackBundle\RapsysPackBundle;
+
 /**
  * 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 {
-       //Constructor required to derivate prefix from kernel.project_dir
-       public function __construct($projectDir) {
-               $this->projectDir = $projectDir;
-       }
-
        /**
         * {@inheritdoc}
         */
-       public function getConfigTreeBuilder() {
+       public function getConfigTreeBuilder(): TreeBuilder {
                //Get TreeBuilder object
-               $treeBuilder = new TreeBuilder();
+               $treeBuilder = new TreeBuilder($alias = RapsysPackBundle::getAlias());
 
                //Get ExecutableFinder object
                $finder = new ExecutableFinder();
 
-               #TODO: see how we deal with asset url generation: see Rapsys/PackBundle/Twig/PackTokenParser.php +243
-               #framework:
-               #    assets:
-               #        packages:
-               #            rapsys_pack:
-               #                base_path: '/'
-               #                version: ~
-               #
-               ## Force cache disable to regenerate resources each time
-               ##twig:
-               ##    cache: ~
-
-               //TODO: see https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php for default value and description
-               //TODO: see http://symfony.com/doc/current/components/config/definition.html
-               //TODO: see https://github.com/symfony/assetic-bundle/blob/master/DependencyInjection/Configuration.php#L63
-               //TODO: use bin/console config:dump-reference to dump class infos
-
                //The bundle default values
                $defaults = [
                        'config' => [
-                               'prefix' => $this->projectDir,
                                'name' => 'asset_url',
                                'scheme' => 'https://',
                                'timeout' => (int)ini_get('default_socket_timeout'),
-                               'agent' => (string)ini_get('user_agent')?:'rapsys_pack/0.0.2',
+                               'agent' => $alias.'/'.($version = RapsysPackBundle::getVersion()),
                                'redirect' => 5
                        ],
+                       #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' => 'css/*.pack.css',
-                               'js' => 'js/*.pack.js',
-                               'img' => 'img/*.pack.jpg'
+                               'css' => '@RapsysPack/css/*.pack.css',
+                               'js' =>  '@RapsysPack/js/*.pack.js',
+                               'img' => '@RapsysPack/img/*.pack.jpg'
                        ],
                        'filters' => [
                                'css' => [
-                                       'class' => 'Rapsys\PackBundle\Twig\Filter\CPackFilter',
-                                       'args' => [
-                                               $finder->find('cpack', '/usr/local/bin/cpack'),
-                                               'minify'
+                                       0 => [
+                                               'class' => 'Rapsys\PackBundle\Filter\CPackFilter',
+                                               'args' => [
+                                                       $finder->find('cpack', '/usr/local/bin/cpack'),
+                                                       'minify'
+                                               ]
                                        ]
                                ],
                                'js' => [
-                                       'class' => 'Rapsys\PackBundle\Twig\Filter\JPackFilter',
-                                       'args' => [
-                                               $finder->find('jpack', '/usr/local/bin/jpack'),
-                                               'best'
+                                       0 => [
+                                               'class' => 'Rapsys\PackBundle\Filter\JPackFilter',
+                                               'args' => [
+                                                       $finder->find('jpack', '/usr/local/bin/jpack'),
+                                                       'best'
+                                               ]
                                        ]
                                ],
                                'img' => [
-                                       'class' => 'Rapsys\PackBundle\Twig\Filter\IPackFilter',
-                                       'args' => []
+                                       0 => [
+                                               'class' => 'Rapsys\PackBundle\Filter\IPackFilter',
+                                               'args' => []
+                                       ]
                                ],
-                       ]
+                       ],
+                       'path' => dirname(__DIR__).'/Resources/public',
                ];
 
-               //Here we define the parameters that are allowed to configure the bundle.
+               /**
+                * 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
-                       ->root('parameters')
+                       ->getRootNode()
                                ->addDefaultsIfNotSet()
                                ->children()
-                                       ->arrayNode('rapsys_pack')
+                                       ->arrayNode('config')
                                                ->addDefaultsIfNotSet()
                                                ->children()
-                                                       ->arrayNode('config')
-                                                               ->isRequired()
-                                                               ->addDefaultsIfNotSet()
-                                                               ->children()
-                                                                       ->scalarNode('prefix')->isRequired()->defaultValue($defaults['config']['prefix'])->end()
-                                                                       ->scalarNode('name')->isRequired()->defaultValue($defaults['config']['name'])->end()
-                                                                       ->scalarNode('scheme')->isRequired()->defaultValue($defaults['config']['scheme'])->end()
-                                                                       ->integerNode('timeout')->isRequired()->min(0)->defaultValue($defaults['config']['timeout'])->end()
-                                                                       ->scalarNode('agent')->isRequired()->defaultValue($defaults['config']['agent'])->end()
-                                                                       ->integerNode('redirect')->isRequired()->min(1)->defaultValue($defaults['config']['redirect'])->end()
-                                                               ->end()
-                                                       ->end()
-                                                       ->arrayNode('output')
-                                                               ->isRequired()
-                                                               ->addDefaultsIfNotSet()
-                                                               ->children()
-                                                                       ->scalarNode('css')->isRequired()->defaultValue($defaults['output']['css'])->end()
-                                                                       ->scalarNode('js')->isRequired()->defaultValue($defaults['output']['js'])->end()
-                                                                       ->scalarNode('img')->isRequired()->defaultValue($defaults['output']['img'])->end()
+                                                       ->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')
+                                                               /**
+                                                                * Undocumented
+                                                                *
+                                                                * @see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                                */
+                                                               ->addDefaultChildrenIfNoneSet()
+                                                               ->arrayPrototype()
+                                                                       ->children()
+                                                                               ->scalarNode('class')
+                                                                                       ->isRequired()
+                                                                                       ->cannotBeEmpty()
+                                                                                       ->defaultValue($defaults['filters']['css'][0]['class'])
+                                                                               ->end()
+                                                                               ->arrayNode('args')
+                                                                                       //->isRequired()
+                                                                                       ->treatNullLike([])
+                                                                                       ->defaultValue($defaults['filters']['css'][0]['args'])
+                                                                                       ->scalarPrototype()->end()
+                                                                               ->end()
+                                                                       ->end()
                                                                ->end()
                                                        ->end()
-                                                       ->arrayNode('filters')
-                                                               ->isRequired()
-                                                               ->addDefaultsIfNotSet()
-                                                               ->children()
-                                                                       ->arrayNode('css')
-                                                                               #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
-                                                                               ->addDefaultChildrenIfNoneSet()
-                                                                               ->arrayPrototype()
-                                                                                       ->children()
-                                                                                               ->scalarNode('class')
-                                                                                                       ->isRequired()
-                                                                                                       ->defaultValue($defaults['filters']['css']['class'])
-                                                                                               ->end()
-                                                                                               ->arrayNode('args')
-                                                                                                       ->isRequired()
-                                                                                                       ->treatNullLike(array())
-                                                                                                       ->defaultValue($defaults['filters']['css']['args'])
-                                                                                                       ->scalarPrototype()->end()
-                                                                                               ->end()
-                                                                                       ->end()
+                                                       ->arrayNode('js')
+                                                               /**
+                                                                * Undocumented
+                                                                *
+                                                                * @see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                                */
+                                                               ->addDefaultChildrenIfNoneSet()
+                                                               ->arrayPrototype()
+                                                                       ->children()
+                                                                               ->scalarNode('class')
+                                                                                       ->isRequired()
+                                                                                       ->cannotBeEmpty()
+                                                                                       ->defaultValue($defaults['filters']['js'][0]['class'])
                                                                                ->end()
-                                                                       ->end()
-                                                                       ->arrayNode('js')
-                                                                               #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
-                                                                               ->addDefaultChildrenIfNoneSet()
-                                                                               ->arrayPrototype()
-                                                                                       ->children()
-                                                                                               ->scalarNode('class')
-                                                                                                       ->isRequired()
-                                                                                                       ->defaultValue($defaults['filters']['js']['class'])
-                                                                                               ->end()
-                                                                                               ->arrayNode('args')
-                                                                                                       ->isRequired()
-                                                                                                       ->treatNullLike(array())
-                                                                                                       ->defaultValue($defaults['filters']['js']['args'])
-                                                                                                       ->scalarPrototype()->end()
-                                                                                               ->end()
-                                                                                       ->end()
+                                                                               ->arrayNode('args')
+                                                                                       ->treatNullLike([])
+                                                                                       ->defaultValue($defaults['filters']['js'][0]['args'])
+                                                                                       ->scalarPrototype()->end()
                                                                                ->end()
                                                                        ->end()
-                                                                       ->arrayNode('img')
-                                                                               #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
-                                                                               ->addDefaultChildrenIfNoneSet()
-                                                                               ->arrayPrototype()
-                                                                                       ->children()
-                                                                                               ->scalarNode('class')
-                                                                                                       ->isRequired()
-                                                                                                       ->defaultValue($defaults['filters']['img']['class'])
-                                                                                               ->end()
-                                                                                               ->arrayNode('args')
-                                                                                                       ->isRequired()
-                                                                                                       ->treatNullLike(array())
-                                                                                                       ->defaultValue($defaults['filters']['img']['args'])
-                                                                                                       ->scalarPrototype()->end()
-                                                                                               ->end()
-                                                                                       ->end()
+                                                               ->end()
+                                                       ->end()
+                                                       ->arrayNode('img')
+                                                               /**
+                                                                * Undocumented
+                                                                *
+                                                                * @see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                                */
+                                                               ->addDefaultChildrenIfNoneSet()
+                                                               ->arrayPrototype()
+                                                                       ->children()
+                                                                               ->scalarNode('class')
+                                                                                       ->isRequired()
+                                                                                       ->cannotBeEmpty()
+                                                                                       ->defaultValue($defaults['filters']['img'][0]['class'])
+                                                                               ->end()
+                                                                               ->arrayNode('args')
+                                                                                       ->treatNullLike([])
+                                                                                       ->defaultValue($defaults['filters']['img'][0]['args'])
+                                                                                       ->scalarPrototype()->end()
                                                                                ->end()
                                                                        ->end()
                                                                ->end()
                                                        ->end()
                                                ->end()
                                        ->end()
+                                       ->scalarNode('path')->cannotBeEmpty()->defaultValue($defaults['path'])->end()
                                ->end()
                        ->end();