diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Config] added ability to set info message and example to node definition

Browse Source
This commit is contained in:
Kevin Bond 2011-05-21 13:33:02 -05:00
parent fd12796673
commit 73ac77336b
15 changed files with 236 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/Symfony/Bundle/DoctrineBundle/DependencyInjection/DoctrineExtension.php
View File

@ -31,7 +31,7 @@ class DoctrineExtension extends AbstractDoctrineExtension
{
public function load(array $configs, ContainerBuilder $container)
{
$configuration = new Configuration($container->getParameter('kernel.debug'));
$configuration = $this->getConfiguration($configs, $container);
$config = $this->processConfiguration($configuration, $configs);
if (!empty($config['dbal'])) {
@ -412,4 +412,9 @@ class DoctrineExtension extends AbstractDoctrineExtension
{
return 'http://symfony.com/schema/dic/doctrine';
}
public function getConfiguration(array $config, ContainerBuilder $container)
{
return new Configuration($container->getParameter('kernel.debug'));
}
}

9
src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
View File

@ -13,6 +13,8 @@ namespace Symfony\Bundle\FrameworkBundle\DependencyInjection;
use Symfony\Component\Config\Loader\LoaderInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\DefinitionDecorator;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
@ -56,7 +58,7 @@ class FrameworkExtension extends Extension
$container->setAlias('debug.controller_resolver', 'controller_resolver');
}
$configuration = new Configuration($container->getParameter('kernel.debug'));
$configuration = $this->getConfiguration($configs, $container);
$config = $this->processConfiguration($configuration, $configs);
if (isset($config['charset'])) {
@ -146,6 +148,11 @@ class FrameworkExtension extends Extension
));
}
public function getConfiguration(array $config, ContainerBuilder $container)
{
return new Configuration($container->getParameter('kernel.debug'));
}
/**
* Loads Form configuration.
*

2
src/Symfony/Bundle/MonologBundle/DependencyInjection/MonologExtension.php
View File

@ -36,7 +36,7 @@ class MonologExtension extends Extension
*/
public function load(array $configs, ContainerBuilder $container)
{
$configuration = new Configuration();
$configuration = $this->getConfiguration($configs, $container);
$config = $this->processConfiguration($configuration, $configs);
if (isset($config['handlers'])) {

12
src/Symfony/Bundle/SecurityBundle/DependencyInjection/SecurityExtension.php
View File

@ -48,9 +48,9 @@ class SecurityExtension extends Extension
if (!array_filter($configs)) {
return;
}
// normalize and merge the actual configuration
$mainConfig = new MainConfiguration($this->factories, $this->userProviderFactories);
$mainConfig = $this->getConfiguration($configs, $container);
$config = $this->processConfiguration($mainConfig, $configs);
// load services
@ -569,5 +569,11 @@ class SecurityExtension extends Extension
{
return 'http://symfony.com/schema/dic/security';
}
public function getConfiguration(array $config, ContainerBuilder $container)
{
// first assemble the factories
return new MainConfiguration($this->factories, $this->userProviderFactories);
}
}

7
src/Symfony/Bundle/SwiftmailerBundle/DependencyInjection/SwiftmailerExtension.php
View File

@ -43,7 +43,7 @@ class SwiftmailerExtension extends Extension
$loader->load('swiftmailer.xml');
$container->setAlias('mailer', 'swiftmailer.mailer');
$configuration = new Configuration($container->getParameter('kernel.debug'));
$configuration = $this->getConfiguration($configs, $container);
$config = $this->processConfiguration($configuration, $configs);
if (null === $config['transport']) {
@ -145,4 +145,9 @@ class SwiftmailerExtension extends Extension
{
return 'http://symfony.com/schema/dic/swiftmailer';
}
public function getConfiguration(array $config, ContainerBuilder $container)
{
return new Configuration($container->getParameter('kernel.debug'));
}
}

2
src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php
View File

@ -36,7 +36,7 @@ class TwigExtension extends Extension
$loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
$loader->load('twig.xml');
$configuration = new Configuration();
$configuration = $this->getConfiguration($configs, $container);
$config = $this->processConfiguration($configuration, $configs);
$container->setParameter('twig.exception_listener.controller', $config['exception_controller']);

2
src/Symfony/Bundle/WebProfilerBundle/DependencyInjection/WebProfilerExtension.php
View File

@ -39,7 +39,7 @@ class WebProfilerExtension extends Extension
*/
public function load(array $configs, ContainerBuilder $container)
{
$configuration = new Configuration();
$configuration = $this->getConfiguration($configs, $container);
$config = $this->processConfiguration($configuration, $configs);
$loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));

10
src/Symfony/Component/Config/Definition/ArrayNode.php
View File

@ -49,6 +49,16 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
$this->allowNewKeys = true;
$this->performDeepMerging = true;
}
/**
* Retrieves the children of this node.
*
* @return array The children
*/
public function getChildren()
{
return $this->children;
}
/**
* Sets the xml remappings that should be performed.

42
src/Symfony/Component/Config/Definition/BaseNode.php
View File

@ -29,6 +29,8 @@ abstract class BaseNode implements NodeInterface
protected $allowOverwrite;
protected $required;
protected $equivalentValues;
protected $info;
protected $example;
/**
* Constructor.
@ -51,6 +53,46 @@ abstract class BaseNode implements NodeInterface
$this->required = false;
$this->equivalentValues = array();
}
/**
* Sets info message
*
* @param string $info The info text
*/
public function setInfo($info)
{
$this->info = $info;
}
/**
* Returns info message
*
* @return string The info text
*/
public function getInfo()
{
return $this->info;
}
/**
* Sets the example configuration for this node.
*
* @param array $example
*/
public function setExample($example)
{
$this->example = $example;
}
/**
* Retrieves the example configuration for this node.
*
* @return mixed The example
*/
public function getExample()
{
return $this->example;
}
/**
* Adds an equivalent value.

37
src/Symfony/Component/Config/Definition/Builder/NodeDefinition.php
View File

@ -32,6 +32,8 @@ abstract class NodeDefinition implements NodeParentInterface
protected $trueEquivalent;
protected $falseEquivalent;
protected $parent;
protected $info;
protected $example;
/**
* Constructor
@ -60,6 +62,34 @@ abstract class NodeDefinition implements NodeParentInterface
return $this;
}
/**
* Sets info message
*
* @param string $info The info text
*
* @return NodeDefinition
*/
public function setInfo($info)
{
$this->info = $info;
return $this;
}
/**
* Sets example configuration
*
* @param example $example
*
* @return NodeDefinition
*/
public function setExample($example)
{
$this->example = $example;
return $this;
}
/**
* Returns the parent node.
@ -91,8 +121,13 @@ abstract class NodeDefinition implements NodeParentInterface
if (null !== $this->validation) {
$this->validation->rules = ExprBuilder::buildExpressions($this->validation->rules);
}
$node = $this->createNode();
$node->setInfo($this->info);
$node->setExample($this->example);
return $this->createNode();
return $node;
}
/**

20
src/Symfony/Component/Config/Definition/PrototypedArrayNode.php
View File

@ -78,6 +78,16 @@ class PrototypedArrayNode extends ArrayNode
$this->removeKeyAttribute = $remove;
}
/**
* Retrieves the name of the attribute which value should be used as key.
*
* @return string The name of the attribute
*/
public function getKeyAttribute()
{
return $this->keyAttribute;
}
/**
* Sets the default value of this node.
*
@ -122,6 +132,16 @@ class PrototypedArrayNode extends ArrayNode
{
$this->prototype = $node;
}
/**
* Retrieves the prototype
*
* @return PrototypeNodeInterface The prototype
*/
public function getPrototype()
{
return $this->prototype;
}
/**
* Disable adding concrete children for prototyped nodes.

32
src/Symfony/Component/DependencyInjection/Extension/ConfigurationExtensionInterface.php Normal file
View File

@ -0,0 +1,32 @@
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\DependencyInjection\Extension;
use Symfony\Component\DependencyInjection\ContainerBuilder;
/**
* ConfigurationExtensionInterface is the interface implemented by container extension classes.
*
* @author Kevin Bond <kevinbond@gmail.com>
*/
interface ConfigurationExtensionInterface
{
/**
* Returns extension configuration
*
* @param array $config $config An array of configuration values
* @param ContainerBuilder $container A ContainerBuilder instance
*
* @return ConfigurationInterface|null The configuration or null
*/
function getConfiguration(array $config, ContainerBuilder $container);
}

25
src/Symfony/Component/HttpKernel/DependencyInjection/Extension.php
View File

@ -5,6 +5,9 @@ namespace Symfony\Component\HttpKernel\DependencyInjection;
use Symfony\Component\Config\Definition\Processor;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
use Symfony\Component\DependencyInjection\Extension\ConfigurationExtensionInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Container;
/*
@ -21,7 +24,7 @@ use Symfony\Component\DependencyInjection\Container;
*
* @author Fabien Potencier <fabien@symfony.com>
*/
abstract class Extension implements ExtensionInterface
abstract class Extension implements ExtensionInterface, ConfigurationExtensionInterface
{
private $classes = array();
@ -100,4 +103,24 @@ abstract class Extension implements ExtensionInterface
return $processor->processConfiguration($configuration, $configs);
}
/**
* {@inheritDoc}
*/
public function getConfiguration(array $config, ContainerBuilder $container)
{
$reflected = new \ReflectionClass($this);
$namespace = $reflected->getNamespaceName();
$class = $namespace . '\\Configuration';
if (class_exists($class)) {
if (!method_exists($class, '__construct')) {
$configuration = new $class();
return $configuration;
}
}
return null;
}
}

35
tests/Symfony/Tests/Component/Config/Definition/Builder/TreeBuilderTest.php
View File

@ -89,4 +89,39 @@ class TreeBuilderTest extends \PHPUnit_Framework_TestCase
->end()
->end();
}
public function testDefinitionInfoGetsTransferedToNode()
{
$builder = new TreeBuilder();
$builder->root('test')->setInfo('root info')
->children()
->node('child', 'variable')->setInfo('child info')->defaultValue('default')
->end()
->end();
$tree = $builder->buildTree();
$children = $tree->getChildren();
$this->assertEquals('root info', $tree->getInfo());
$this->assertEquals('child info', $children['child']->getInfo());
}
public function testDefinitionExampleGetsTransferedToNode()
{
$builder = new TreeBuilder();
$builder->root('test')
->setExample(array('key' => 'value'))
->children()
->node('child', 'variable')->setInfo('child info')->defaultValue('default')->setExample('example')
->end()
->end();
$tree = $builder->buildTree();
$children = $tree->getChildren();
$this->assertTrue(is_array($tree->getExample()));
$this->assertEquals('example', $children['child']->getExample());
}
}

5
tests/Symfony/Tests/Component/DependencyInjection/Fixtures/includes/ProjectExtension.php
View File

@ -33,4 +33,9 @@ class ProjectExtension implements ExtensionInterface
{
return 'project';
}
public function getConfiguration(array $config, ContainerBuilder $container)
{
return null;
}
}