Merge remote branch 'vicb/config_base'

* vicb/config_base: [Config] Add a note about the ConfigurationInterface interface in UPDATE.md [MonologBundle] Make The Configuration class implements the ConfigurationInterface [Config] Introduction of an ConfigurationInterface

Author: fabpot

UPDATE.md

@@ -6,6 +6,14 @@ one. It only discusses changes that need to be done when using the "public"
 API of the framework. If you "hack" the core, you should probably follow the
 timeline closely anyway.
 
+PR10 to PR11
+------------
+
+* Extension configuration classes should now implement the
+`Symfony\Component\Config\Definition\ConfigurationInterface` interface. Note that
+the BC is kept but implementing this interface in your extensions will allow for
+further developments.
+
 PR9 to PR10
 -----------
 

src/Symfony/Bundle/AsseticBundle/DependencyInjection/AsseticExtension.php

@@ -99,11 +99,9 @@ public function load(array $configs, ContainerBuilder $container)
  */
  static protected function processConfigs(array $configs, $debug, array $bundles)
  {
- $configuration = new Configuration();
- $tree = $configuration->getConfigTree($debug, $bundles);
-
  $processor = new Processor();
- return $processor->process($tree, $configs);
+ $configuration = new Configuration($debug, $bundles);
+ return $processor->processConfiguration($configuration, $configs);
  }
 
  /**

src/Symfony/Bundle/AsseticBundle/DependencyInjection/Configuration.php

@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\AsseticBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 /**
  * This class contains the configuration information for the bundle
@@ -22,24 +23,36 @@
  * @author Christophe Coevoet <stof@notk.org>
  * @author Kris Wallsmith <kris@symfony.com>
  */
-class Configuration
+class Configuration implements ConfigurationInterface
 {
+ private $bundles;
+ private $debug;
+
  /**
- * Generates the configuration tree.
+ * Constructor
  *
  * @param Boolean $debug Wether to use the debug mode
  * @param array $bundles An array of bundle names
- * 
- * @return \Symfony\Component\Config\Definition\ArrayNode The config tree
  */
- public function getConfigTree($debug, array $bundles)
+ public function __construct($debug, array $bundles)
+ {
+ $this->debug = (Boolean) $debug;
+ $this->bundles = $bundles;
+ }
+
+ /**
+ * Generates the configuration tree builder.
+ *
+ * @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder
+ */
+ public function getConfigTreeBuilder()
  {
- $tree = new TreeBuilder();
+ $builder = new TreeBuilder();
 
- $tree->root('assetic')
+ $builder->root('assetic')
  ->children()
- ->booleanNode('debug')->defaultValue($debug)->end()
- ->booleanNode('use_controller')->defaultValue($debug)->end()
+ ->booleanNode('debug')->defaultValue($this->debug)->end()
+ ->booleanNode('use_controller')->defaultValue($this->debug)->end()
  ->scalarNode('read_from')->defaultValue('%kernel.root_dir%/../web')->end()
  ->scalarNode('write_to')->defaultValue('%assetic.read_from%')->end()
  ->scalarNode('java')->defaultValue('/usr/bin/java')->end()
@@ -51,7 +64,7 @@ public function getConfigTree($debug, array $bundles)
  ->fixXmlConfig('bundle')
  ->children()
  ->arrayNode('bundles')
- ->defaultValue($bundles)
+ ->defaultValue($this->bundles)
  ->requiresAtLeastOneElement()
  ->beforeNormalization()
  ->ifTrue(function($v) { return !is_array($v); })
@@ -84,6 +97,6 @@ public function getConfigTree($debug, array $bundles)
  ->end()
  ;
 
- return $tree->buildTree();
+ return $builder;
  }
 }

src/Symfony/Bundle/DoctrineBundle/DependencyInjection/Configuration.php

@@ -13,6 +13,7 @@
 
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 /**
  * This class contains the configuration information for the bundle
@@ -22,28 +23,34 @@
  *
  * @author Christophe Coevoet <stof@notk.org>
  */
-class Configuration
+class Configuration implements ConfigurationInterface
 {
- private $kernelDebug;
+ private $debug;
 
  /**
- * Generates the configuration tree.
+ * Constructor
  *
- * @param Boolean $kernelDebug
+ * @param Boolean $debug Wether to use the debug mode
+ */
+ public function __construct($debug)
+ {
+ $this->debug = (Boolean) $debug;
+ }
+ 
+ /**
+ * Generates the configuration tree builder.
  *
- * @return \Symfony\Component\Config\Definition\ArrayNode The config tree
+ * @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder
  */
- public function getConfigTree($kernelDebug)
+ public function getConfigTreeBuilder()
  {
- $this->kernelDebug = (bool) $kernelDebug;
-
  $treeBuilder = new TreeBuilder();
  $rootNode = $treeBuilder->root('doctrine');
 
  $this->addDbalSection($rootNode);
  $this->addOrmSection($rootNode);
 
- return $treeBuilder->buildTree();
+ return $treeBuilder;
  }
 
  private function addDbalSection(ArrayNodeDefinition $node)
@@ -98,7 +105,7 @@ private function getDbalConnectionsNode()
  ->scalarNode('unix_socket')->end()
  ->scalarNode('platform_service')->end()
  ->scalarNode('charset')->end()
- ->booleanNode('logging')->defaultValue($this->kernelDebug)->end()
+ ->booleanNode('logging')->defaultValue($this->debug)->end()
  ->end()
  ->fixXmlConfig('driver_class', 'driverClass')
  ->children()

src/Symfony/Bundle/DoctrineBundle/DependencyInjection/DoctrineExtension.php

@@ -31,9 +31,9 @@ class DoctrineExtension extends AbstractDoctrineExtension
 {
  public function load(array $configs, ContainerBuilder $container)
  {
- $configuration = new Configuration();
  $processor = new Processor();
- $config = $processor->process($configuration->getConfigTree($container->getParameter('kernel.debug')), $configs);
+ $configuration = new Configuration($container->getParameter('kernel.debug'));
+ $config = $processor->processConfiguration($configuration, $configs);
 
  if (!empty($config['dbal'])) {
  $this->dbalLoad($config['dbal'], $container);

src/Symfony/Bundle/DoctrineMigrationsBundle/DependencyInjection/Configuration.php

@@ -3,20 +3,21 @@
 namespace Symfony\Bundle\DoctrineMigrationsBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 /**
  * DoctrineMigrationsExtension configuration structure.
  *
  * @author Lukas Kahwe Smith <smith@pooteeweet.org>
  */
-class Configuration
+class Configuration implements ConfigurationInterface
 {
  /**
- * Generates the configuration tree.
+ * Generates the configuration tree builder.
  *
- * @return \Symfony\Component\Config\Definition\ArrayNode The config tree
+ * @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder
  */
- public function getConfigTree()
+ public function getConfigTreeBuilder()
  {
  $treeBuilder = new TreeBuilder();
  $rootNode = $treeBuilder->root('doctrine_migrations', 'array');
@@ -30,6 +31,6 @@ public function getConfigTree()
  ->end()
  ;
 
- return $treeBuilder->buildTree();
+ return $treeBuilder;
  }
 }

src/Symfony/Bundle/DoctrineMigrationsBundle/DependencyInjection/DoctrineMigrationsExtension.php

@@ -11,9 +11,9 @@
 
 namespace Symfony\Bundle\DoctrineMigrationsBundle\DependencyInjection;
 
-use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\Config\Definition\Processor;
 
 /**
  * DoctrineMigrationsExtension.
@@ -33,7 +33,7 @@ public function load(array $configs, ContainerBuilder $container)
  $processor = new Processor();
  $configuration = new Configuration();
 
- $config = $processor->process($configuration->getConfigTree(), $configs);
+ $config = $processor->processConfiguration($configuration, $configs);
 
  foreach ($config as $key => $value) {
  $container->setParameter($this->getAlias().'.'.$key, $value);

src/Symfony/Bundle/DoctrineMongoDBBundle/DependencyInjection/Configuration.php

@@ -4,13 +4,14 @@
 
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 /**
  * FrameworkExtension configuration structure.
  *
  * @author Ryan Weaver <ryan@thatsquality.com>
  */
-class Configuration
+class Configuration implements ConfigurationInterface
 {
  private $debug;
 
@@ -25,11 +26,11 @@ public function __construct($debug)
  }
 
  /**
- * Generates the configuration tree.
+ * Generates the configuration tree builder.
  *
- * @return \Symfony\Component\Config\Definition\ArrayNode The config tree
+ * @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder
  */
- public function getConfigTree()
+ public function getConfigTreeBuilder()
  {
  $treeBuilder = new TreeBuilder();
  $rootNode = $treeBuilder->root('doctrine_mongo_db');
@@ -49,7 +50,7 @@ public function getConfigTree()
  ->end()
  ;
 
- return $treeBuilder->buildTree();
+ return $treeBuilder;
  }
 
  /**

src/Symfony/Bundle/DoctrineMongoDBBundle/DependencyInjection/DoctrineMongoDBExtension.php

@@ -17,8 +17,8 @@
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\Config\FileLocator;
-use Symfony\Bundle\DoctrineAbstractBundle\DependencyInjection\AbstractDoctrineExtension;
 use Symfony\Component\Config\Definition\Processor;
+use Symfony\Bundle\DoctrineAbstractBundle\DependencyInjection\AbstractDoctrineExtension;
 
 /**
  * Doctrine MongoDB ODM extension.
@@ -40,7 +40,7 @@ public function load(array $configs, ContainerBuilder $container)
 
  $processor = new Processor();
  $configuration = new Configuration($container->getParameter('kernel.debug'));
- $config = $processor->process($configuration->getConfigTree(), $configs);
+ $config = $processor->processConfiguration($configuration, $configs);
 
  // can't currently default this correctly in Configuration
  if (!isset($config['metadata_cache_driver'])) {

src/Symfony/Bundle/DoctrineMongoDBBundle/Tests/DependencyInjection/ConfigurationTest.php

@@ -14,7 +14,6 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Bundle\DoctrineMongoDBBundle\DependencyInjection\Configuration;
 use Symfony\Component\Yaml\Yaml;
-
 use Symfony\Component\Config\Definition\Processor;
 
 class ConfigurationTest extends \PHPUnit_Framework_TestCase
@@ -23,7 +22,7 @@ public function testDefaults()
  {
  $processor = new Processor();
  $configuration = new Configuration(false);
- $options = $processor->process($configuration->getConfigTree(), array());
+ $options = $processor->processConfiguration($configuration, array());
 
  $defaults = array(
  'auto_generate_hydrator_classes' => false,
@@ -56,7 +55,7 @@ public function testFullConfiguration($config)
  {
  $processor = new Processor();
  $configuration = new Configuration(false);
- $options = $processor->process($configuration->getConfigTree(), array($config));
+ $options = $processor->processConfiguration($configuration, array($config));
 
  $expected = array(
  'proxy_namespace' => 'Test_Proxies',
@@ -141,7 +140,7 @@ public function testMergeOptions(array $configs, array $correctValues)
  {
  $processor = new Processor();
  $configuration = new Configuration(false);
- $options = $processor->process($configuration->getConfigTree(), $configs);
+ $options = $processor->processConfiguration($configuration, $configs);
 
  foreach ($correctValues as $key => $correctVal)
  {
@@ -230,7 +229,7 @@ public function testNormalizeOptions(array $config, $targetKey, array $normalize
  {
  $processor = new Processor();
  $configuration = new Configuration(false);
- $options = $processor->process($configuration->getConfigTree(), array($config));
+ $options = $processor->processConfiguration($configuration, array($config));
  $this->assertSame($normalized, $options[$targetKey]);
  }