* To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
*/
class Configuration implements ConfigurationInterface {
- //Constructor required to derivate prefix from kernel.project_dir
- public function __construct($projectDir) {
- $this->projectDir = $projectDir;
- }
-
/**
* {@inheritdoc}
*/
public function getConfigTreeBuilder() {
//Get TreeBuilder object
- $treeBuilder = new TreeBuilder();
+ $treeBuilder = new TreeBuilder('rapsys_pack');
//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
+ /**
+ * 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' => [
- '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' => (string)ini_get('user_agent')?:'rapsys_pack/0.1.3',
'redirect' => 5
],
'output' => [
'js' => 'js/*.pack.js',
'img' => 'img/*.pack.jpg'
],
- 'filter' => [
+ 'filters' => [
'css' => [
- 'Rapsys\PackBundle\Twig\Filter\CPackFilter' => [$finder->find('cpack', '/usr/local/bin/cpack')]
+ 'class' => 'Rapsys\PackBundle\Twig\Filter\CPackFilter',
+ 'args' => [
+ $finder->find('cpack', '/usr/local/bin/cpack'),
+ 'minify'
+ ]
],
'js' => [
- 'Rapsys\PackBundle\Twig\Filter\JPackFilter' => [$finder->find('jpack', '/usr/local/bin/jpack')]
+ 'class' => 'Rapsys\PackBundle\Twig\Filter\JPackFilter',
+ 'args' => [
+ $finder->find('jpack', '/usr/local/bin/jpack'),
+ 'best'
+ ]
],
'img' => [
- 'Rapsys\PackBundle\Twig\Filter\IPackFilter' => []
+ 'class' => 'Rapsys\PackBundle\Twig\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
$treeBuilder
//Parameters
- ->root('parameters')
- ->isRequired()
+ ->getRootNode()
->addDefaultsIfNotSet()
->children()
- ->arrayNode('rapsys_pack')
- ->isRequired()
+ ->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()
- ->arrayNode('config')
- ->isRequired()
- ->addDefaultsIfNotSet()
- ->children()
- ->scalarNode('prefix')->isRequired()->defaultValue($defaults['config']['prefix'])->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()
+ ->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')
+ #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+ ->addDefaultChildrenIfNoneSet()
+ ->arrayPrototype()
+ ->children()
+ ->scalarNode('class')
+ ->isRequired()
+ ->cannotBeEmpty()
+ ->defaultValue($defaults['filters']['css']['class'])
+ ->end()
+ ->arrayNode('args')
+ /*->isRequired()*/
+ ->treatNullLike(array())
+ ->defaultValue($defaults['filters']['css']['args'])
+ ->scalarPrototype()->end()
+ ->end()
+ ->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()
+ ->arrayNode('js')
+ #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+ ->addDefaultChildrenIfNoneSet()
+ ->arrayPrototype()
+ ->children()
+ ->scalarNode('class')
+ ->isRequired()
+ ->cannotBeEmpty()
+ ->defaultValue($defaults['filters']['js']['class'])
+ ->end()
+ ->arrayNode('args')
+ ->treatNullLike(array())
+ ->defaultValue($defaults['filters']['js']['args'])
+ ->scalarPrototype()->end()
+ ->end()
+ ->end()
->end()
->end()
- ->arrayNode('filter')
- ->isRequired()
- ->addDefaultsIfNotSet()
- ->children()
- ->arrayNode('css')
- ->isRequired()
- ->treatNullLike(array())
- ->scalarPrototype()->end()
- ->defaultValue($defaults['filter']['css'])
- ->end()
- ->arrayNode('js')
- ->isRequired()
- ->treatNullLike(array())
- ->scalarPrototype()->end()
- ->defaultValue($defaults['filter']['js'])
- ->end()
- ->arrayNode('img')
- ->isRequired()
- ->treatNullLike(array())
- ->scalarPrototype()->end()
- ->defaultValue($defaults['filter']['img'])
+ ->arrayNode('img')
+ #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+ ->addDefaultChildrenIfNoneSet()
+ ->arrayPrototype()
+ ->children()
+ ->scalarNode('class')
+ ->isRequired()
+ ->cannotBeEmpty()
+ ->defaultValue($defaults['filters']['img']['class'])
+ ->end()
+ ->arrayNode('args')
+ ->treatNullLike(array())
+ ->defaultValue($defaults['filters']['img']['args'])
+ ->scalarPrototype()->end()
+ ->end()
->end()
->end()
->end()