]> Raphaël G. Git Repositories - packbundle/blobdiff - DependencyInjection/Configuration.php
Update doc
[packbundle] / DependencyInjection / Configuration.php
index b0de9a4619dc02df54ec864dac52c95d089c9687..7217e98d3d5f7dc340f9f3d57c1bc56d4780da98 100644 (file)
@@ -1,4 +1,13 @@
-<?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;
 
@@ -6,45 +15,33 @@ use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 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 {
        /**
         * {@inheritdoc}
         */
-       public function getConfigTreeBuilder() {
+       public function getConfigTreeBuilder(): TreeBuilder {
                //Get TreeBuilder object
-               $treeBuilder = new TreeBuilder('rapsys_pack');
+               $treeBuilder = new TreeBuilder(RapsysPackBundle::getAlias());
 
                //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 = [
                        'config' => [
                                'name' => 'asset_url',
                                'scheme' => 'https://',
                                'timeout' => (int)ini_get('default_socket_timeout'),
-                               'agent' => (string)ini_get('user_agent')?:'rapsys_pack/0.1.8',
+                               'agent' => (string)ini_get('user_agent')?:'rapsys_pack/0.2.0',
                                'redirect' => 5
                        ],
                        'output' => [
@@ -55,7 +52,7 @@ class Configuration implements ConfigurationInterface {
                        'filters' => [
                                'css' => [
                                        0 => [
-                                               'class' => 'Rapsys\PackBundle\Twig\Filter\CPackFilter',
+                                               'class' => 'Rapsys\PackBundle\Filter\CPackFilter',
                                                'args' => [
                                                        $finder->find('cpack', '/usr/local/bin/cpack'),
                                                        'minify'
@@ -64,7 +61,7 @@ class Configuration implements ConfigurationInterface {
                                ],
                                'js' => [
                                        0 => [
-                                               'class' => 'Rapsys\PackBundle\Twig\Filter\JPackFilter',
+                                               'class' => 'Rapsys\PackBundle\Filter\JPackFilter',
                                                'args' => [
                                                        $finder->find('jpack', '/usr/local/bin/jpack'),
                                                        'best'
@@ -73,19 +70,23 @@ class Configuration implements ConfigurationInterface {
                                ],
                                'img' => [
                                        0 => [
-                                               'class' => 'Rapsys\PackBundle\Twig\Filter\IPackFilter',
+                                               'class' => 'Rapsys\PackBundle\Filter\IPackFilter',
                                                'args' => []
                                        ]
                                ],
                        ]
                ];
 
-               //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()
@@ -113,7 +114,11 @@ class Configuration implements ConfigurationInterface {
                                                ->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()
@@ -123,8 +128,8 @@ class Configuration implements ConfigurationInterface {
                                                                                        ->defaultValue($defaults['filters']['css'][0]['class'])
                                                                                ->end()
                                                                                ->arrayNode('args')
-                                                                                       /*->isRequired()*/
-                                                                                       ->treatNullLike(array())
+                                                                                       //->isRequired()
+                                                                                       ->treatNullLike([])
                                                                                        ->defaultValue($defaults['filters']['css'][0]['args'])
                                                                                        ->scalarPrototype()->end()
                                                                                ->end()
@@ -132,7 +137,11 @@ class Configuration implements ConfigurationInterface {
                                                                ->end()
                                                        ->end()
                                                        ->arrayNode('js')
-                                                               #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                               /**
+                                                                * Undocumented
+                                                                *
+                                                                * @see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                                */
                                                                ->addDefaultChildrenIfNoneSet()
                                                                ->arrayPrototype()
                                                                        ->children()
@@ -142,7 +151,7 @@ class Configuration implements ConfigurationInterface {
                                                                                        ->defaultValue($defaults['filters']['js'][0]['class'])
                                                                                ->end()
                                                                                ->arrayNode('args')
-                                                                                       ->treatNullLike(array())
+                                                                                       ->treatNullLike([])
                                                                                        ->defaultValue($defaults['filters']['js'][0]['args'])
                                                                                        ->scalarPrototype()->end()
                                                                                ->end()
@@ -150,7 +159,11 @@ class Configuration implements ConfigurationInterface {
                                                                ->end()
                                                        ->end()
                                                        ->arrayNode('img')
-                                                               #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                               /**
+                                                                * Undocumented
+                                                                *
+                                                                * @see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                                */
                                                                ->addDefaultChildrenIfNoneSet()
                                                                ->arrayPrototype()
                                                                        ->children()
@@ -160,7 +173,7 @@ class Configuration implements ConfigurationInterface {
                                                                                        ->defaultValue($defaults['filters']['img'][0]['class'])
                                                                                ->end()
                                                                                ->arrayNode('args')
-                                                                                       ->treatNullLike(array())
+                                                                                       ->treatNullLike([])
                                                                                        ->defaultValue($defaults['filters']['img'][0]['args'])
                                                                                        ->scalarPrototype()->end()
                                                                                ->end()