From 60043a3c9621c0852f509484172e1d090770f60d Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Thu, 24 Feb 2011 17:16:57 +0100 Subject: [PATCH 1/8] [Config][ArrayNode] Tweak some phpDoc --- src/Symfony/Component/Config/Definition/ArrayNode.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Symfony/Component/Config/Definition/ArrayNode.php b/src/Symfony/Component/Config/Definition/ArrayNode.php index 485300233c506..189a9e28a0c75 100644 --- a/src/Symfony/Component/Config/Definition/ArrayNode.php +++ b/src/Symfony/Component/Config/Definition/ArrayNode.php @@ -81,7 +81,7 @@ public function setMinNumberOfElements($number) } /** - * The name of the attribute that should be used as key. + * The name of the attribute which value should be used as key. * * This is only relevant for XML configurations, and only in combination * with a prototype based node. @@ -92,12 +92,12 @@ public function setMinNumberOfElements($number) * * becomes * - * 'id' => array('foo' => 'bar') + * 'my_name' => array('foo' => 'bar') * * If $remove is false, the resulting array will still have the * "'id' => 'my_name'" item in it. * - * @param string $attribute The name of the attribute to use as a key + * @param string $attribute The name of the attribute which value is to be used as a key * @param Boolean $remove Whether or not to remove the key * @return void */ @@ -238,7 +238,7 @@ public function getDefaultValue() * Sets the node prototype. * * @param PrototypeNodeInterface $node - * @throws \RuntimeException if the node doesn't have concrete children + * @throws \RuntimeException if the node has concrete children */ public function setPrototype(PrototypeNodeInterface $node) { From 4d83b36170e2b2112cec199fa5c20287e26a5191 Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Thu, 24 Feb 2011 17:52:13 +0100 Subject: [PATCH 2/8] [Config][ArrayNode] Tweak normalizeValue() code & phpDoc --- .../Component/Config/Definition/ArrayNode.php | 52 +++++++------------ 1 file changed, 20 insertions(+), 32 deletions(-) diff --git a/src/Symfony/Component/Config/Definition/ArrayNode.php b/src/Symfony/Component/Config/Definition/ArrayNode.php index 189a9e28a0c75..28aea51b70531 100644 --- a/src/Symfony/Component/Config/Definition/ArrayNode.php +++ b/src/Symfony/Component/Config/Definition/ArrayNode.php @@ -356,10 +356,10 @@ protected function validateType($value) } /** - * Normalises the value. + * Normalizes the value. * - * @param mixed $value The value to normalise - * @return mixed The normalised value + * @param mixed $value The value to normalize + * @return mixed The normalized value */ protected function normalizeValue($value) { @@ -378,16 +378,13 @@ protected function normalizeValue($value) unset($value[$singular]); } - if (null !== $this->prototype) { - $normalized = array(); + $normalized = array(); + if (null !== $this->prototype) { foreach ($value as $k => $v) { if (null !== $this->keyAttribute && is_array($v)) { if (!isset($v[$this->keyAttribute]) && is_int($k)) { - throw new InvalidConfigurationException(sprintf( - 'You must set a "%s" attribute for path "%s".', - $this->keyAttribute, - $this->getPath() - )); + $msg = sprintf('The attribute "%s" must be set for path "%s".', $this->keyAttribute, $this->getPath()); + throw new InvalidConfigurationException($msg); } else if (isset($v[$this->keyAttribute])) { $k = $v[$this->keyAttribute]; @@ -398,11 +395,8 @@ protected function normalizeValue($value) } if (array_key_exists($k, $normalized)) { - throw new DuplicateKeyException(sprintf( - 'Duplicate key "%s" for path "%s".', - $k, - $this->getPath() - )); + $msg = sprintf('Duplicate key "%s" for path "%s".', $k, $this->getPath()); + throw new DuplicateKeyException($msg); } } @@ -413,25 +407,19 @@ protected function normalizeValue($value) $normalized[] = $this->prototype->normalize($v); } } - - return $normalized; - } - - $normalized = array(); - foreach ($this->children as $name => $child) { - if (!array_key_exists($name, $value)) { - continue; + } else { + foreach ($this->children as $name => $child) { + if (array_key_exists($name, $value)) { + $normalized[$name] = $child->normalize($value[$name]); + unset($value[$name]); + } } - $normalized[$name] = $child->normalize($value[$name]); - unset($value[$name]); - } - - // if extra fields are present, throw exception - if (count($value) && !$this->ignoreExtraKeys) { - $msg = sprintf('Unrecognized options "%s" under "%s"', implode(', ', array_keys($value)), $this->getPath()); - - throw new InvalidConfigurationException($msg); + // if extra fields are present, throw exception + if (count($value) && !$this->ignoreExtraKeys) { + $msg = sprintf('Unrecognized options "%s" under "%s"', implode(', ', array_keys($value)), $this->getPath()); + throw new InvalidConfigurationException($msg); + } } return $normalized; From e47f808376fc2e20401f15fb3ed45e4143c7d43e Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Mon, 28 Feb 2011 10:22:26 +0100 Subject: [PATCH 3/8] [Config] Tweak phpDoc --- .../Component/Config/Definition/ArrayNode.php | 6 ------ .../Component/Config/Definition/BaseNode.php | 14 ++++---------- .../Config/Definition/Builder/MergeBuilder.php | 4 ++-- .../Config/Definition/Builder/NodeBuilder.php | 10 +++++----- .../Config/Definition/Builder/TreeBuilder.php | 2 +- .../Component/Config/Definition/NodeInterface.php | 4 ++-- .../Component/Config/Definition/Processor.php | 2 +- .../Config/Definition/PrototypeNodeInterface.php | 1 - .../Component/Config/Definition/VariableNode.php | 3 +-- 9 files changed, 16 insertions(+), 30 deletions(-) diff --git a/src/Symfony/Component/Config/Definition/ArrayNode.php b/src/Symfony/Component/Config/Definition/ArrayNode.php index 28aea51b70531..22995779f4b88 100644 --- a/src/Symfony/Component/Config/Definition/ArrayNode.php +++ b/src/Symfony/Component/Config/Definition/ArrayNode.php @@ -61,7 +61,6 @@ public function __construct($name, NodeInterface $parent = null) * Sets the xml remappings that should be performed. * * @param array $remappings an array of the form array(array(string, string)) - * @return void */ public function setXmlRemappings(array $remappings) { @@ -73,7 +72,6 @@ public function setXmlRemappings(array $remappings) * contain. By default this is zero, meaning no elements. * * @param integer $number - * @return void */ public function setMinNumberOfElements($number) { @@ -99,7 +97,6 @@ public function setMinNumberOfElements($number) * * @param string $attribute The name of the attribute which value is to be used as a key * @param Boolean $remove Whether or not to remove the key - * @return void */ public function setKeyAttribute($attribute, $remove = true) { @@ -112,7 +109,6 @@ public function setKeyAttribute($attribute, $remove = true) * defined in any of the configuration files. * * @param Boolean $boolean - * @return void */ public function setAddIfNotSet($boolean) { @@ -124,7 +120,6 @@ public function setAddIfNotSet($boolean) * be unset. * * @param Boolean $allow - * @return void */ public function setAllowFalse($allow) { @@ -135,7 +130,6 @@ public function setAllowFalse($allow) * Sets whether new keys can be defined in subsequent configurations. * * @param Boolean $allow - * @return void */ public function setAllowNewKeys($allow) { diff --git a/src/Symfony/Component/Config/Definition/BaseNode.php b/src/Symfony/Component/Config/Definition/BaseNode.php index 43ff3f4df9c47..5578d361d1b3b 100644 --- a/src/Symfony/Component/Config/Definition/BaseNode.php +++ b/src/Symfony/Component/Config/Definition/BaseNode.php @@ -57,7 +57,6 @@ public function __construct($name, NodeInterface $parent = null) * * @param mixed $originalValue * @param mixed $equivalentValue - * @return void */ public function addEquivalentValue($originalValue, $equivalentValue) { @@ -67,8 +66,7 @@ public function addEquivalentValue($originalValue, $equivalentValue) /** * Set this node as required. * - * @param boolean $boolean Required node - * @return void + * @param Boolean $boolean Required node */ public function setRequired($boolean) { @@ -78,8 +76,7 @@ public function setRequired($boolean) /** * Sets if this node can be overridden. * - * @param boolean $allow - * @return void + * @param Boolean $allow */ public function setAllowOverwrite($allow) { @@ -90,7 +87,6 @@ public function setAllowOverwrite($allow) * Sets the closures used for normalization. * * @param array $closures An array of Closures used for normalization - * @return void */ public function setNormalizationClosures(array $closures) { @@ -101,7 +97,6 @@ public function setNormalizationClosures(array $closures) * Sets the closures used for final validation. * * @param array $closures An array of Closures used for final validation - * @return void */ public function setFinalValidationClosures(array $closures) { @@ -111,7 +106,7 @@ public function setFinalValidationClosures(array $closures) /** * Checks if this node is required. * - * @return boolean + * @return Boolean */ public function isRequired() { @@ -232,8 +227,7 @@ public final function finalize($value) * Validates the type of a Node. * * @param mixed $value The value to validate - * @return void - * @throws \InvalidTypeException when the value is invalid + * @throws InvalidTypeException when the value is invalid */ abstract protected function validateType($value); diff --git a/src/Symfony/Component/Config/Definition/Builder/MergeBuilder.php b/src/Symfony/Component/Config/Definition/Builder/MergeBuilder.php index e05d3c2e619cc..22e004be85fcc 100644 --- a/src/Symfony/Component/Config/Definition/Builder/MergeBuilder.php +++ b/src/Symfony/Component/Config/Definition/Builder/MergeBuilder.php @@ -37,7 +37,7 @@ public function __construct($parent) /** * Sets whether the node can be unset. * - * @param boolean $allow + * @param Boolean $allow * @return Symfony\Component\Config\Definition\Builder\MergeBuilder */ public function allowUnset($allow = true) @@ -50,7 +50,7 @@ public function allowUnset($allow = true) /** * Sets whether the node can be overwritten. * - * @param boolean $deny Whether the overwriting is forbidden or not + * @param Boolean $deny Whether the overwriting is forbidden or not * * @return Symfony\Component\Config\Definition\Builder\MergeBuilder */ diff --git a/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php b/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php index c7044dc9f3b52..bf80e5f233c99 100644 --- a/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php +++ b/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php @@ -149,7 +149,7 @@ public function scalarNode($name) } /** - * Creates a child boolean node. + * Creates a child Boolean node. * * @param string $name The name of the node * @@ -349,7 +349,7 @@ public function fixXmlConfig($singular, $plural = null) } /** - * Sets an attribute to use as key. + * Set the attribute which value is to be used as key. * * This is useful when you have an indexed array that should be an * associative array. You can select an item from within the array @@ -363,7 +363,7 @@ public function fixXmlConfig($singular, $plural = null) * becomes * * array( - * 'id' => array('foo' => 'bar'), + * 'my_name' => array('foo' => 'bar'), * ) * * If you'd like "'id' => 'my_name'" to still be present in the resulting @@ -399,7 +399,7 @@ protected function merge() /** * Sets whether the node can be overwritten. * - * @param boolean $deny Whether the overwriting is forbidden or not + * @param Boolean $deny Whether the overwriting is forbidden or not * * @return Symfony\Component\Config\Definition\Builder\NodeBuilder */ @@ -425,7 +425,7 @@ public function cannotBeEmpty() /** * Sets whether the node can be unset. * - * @param boolean $allow + * @param Boolean $allow * * @return Symfony\Component\Config\Definition\Builder\NodeBuilder */ diff --git a/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php b/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php index 060bb9af0c833..d7dbf6a93d5ea 100644 --- a/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php +++ b/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php @@ -80,7 +80,7 @@ protected function createConfigNode(NodeBuilder $node) } /** - * Creates a boolean node. + * Creates a Boolean node. * * @param NodeBuilder $node The builder of the node * diff --git a/src/Symfony/Component/Config/Definition/NodeInterface.php b/src/Symfony/Component/Config/Definition/NodeInterface.php index 4fddce01cb3f3..7a3402341c1da 100644 --- a/src/Symfony/Component/Config/Definition/NodeInterface.php +++ b/src/Symfony/Component/Config/Definition/NodeInterface.php @@ -38,14 +38,14 @@ function getPath(); /** * Returns true when the node is required. * - * @return boolean If the node is required + * @return Boolean If the node is required */ function isRequired(); /** * Returns true when the node has a default value. * - * @return boolean If the node has a default value + * @return Boolean If the node has a default value */ function hasDefaultValue(); diff --git a/src/Symfony/Component/Config/Definition/Processor.php b/src/Symfony/Component/Config/Definition/Processor.php index 2688b0a973fb8..729bd6fd45318 100644 --- a/src/Symfony/Component/Config/Definition/Processor.php +++ b/src/Symfony/Component/Config/Definition/Processor.php @@ -25,7 +25,7 @@ class Processor * * @param NodeInterface $configTree The node tree to process * @param array $configs An array of configuration items - * @return boolean + * @return Boolean */ public function process(NodeInterface $configTree, array $configs) { diff --git a/src/Symfony/Component/Config/Definition/PrototypeNodeInterface.php b/src/Symfony/Component/Config/Definition/PrototypeNodeInterface.php index dcf39e84a3f9b..81be01fce5372 100644 --- a/src/Symfony/Component/Config/Definition/PrototypeNodeInterface.php +++ b/src/Symfony/Component/Config/Definition/PrototypeNodeInterface.php @@ -22,7 +22,6 @@ interface PrototypeNodeInterface extends NodeInterface * Sets the name of the node. * * @param string $name The name of the node - * @return void */ function setName($name); } \ No newline at end of file diff --git a/src/Symfony/Component/Config/Definition/VariableNode.php b/src/Symfony/Component/Config/Definition/VariableNode.php index 327143b984738..056018130dd95 100644 --- a/src/Symfony/Component/Config/Definition/VariableNode.php +++ b/src/Symfony/Component/Config/Definition/VariableNode.php @@ -55,8 +55,7 @@ public function getDefaultValue() /** * Sets if this node is allowed to have an empty value. * - * @param boolean $boolean True if this entity will accept empty values. - * @return void + * @param Boolean $boolean True if this entity will accept empty values. */ public function setAllowEmptyValue($boolean) { From 687c4dfeb1d4eb5d86eb1e374863cffa2276079e Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Mon, 28 Feb 2011 10:38:44 +0100 Subject: [PATCH 4/8] [Config][BooleanNode] Tweak the code --- src/Symfony/Component/Config/Definition/BooleanNode.php | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/Symfony/Component/Config/Definition/BooleanNode.php b/src/Symfony/Component/Config/Definition/BooleanNode.php index faf93ba8e8221..94134b956b78a 100644 --- a/src/Symfony/Component/Config/Definition/BooleanNode.php +++ b/src/Symfony/Component/Config/Definition/BooleanNode.php @@ -20,8 +20,6 @@ class BooleanNode extends ScalarNode */ protected function validateType($value) { - parent::validateType($value); - if (!is_bool($value)) { throw new InvalidTypeException(sprintf( 'Invalid type for path "%s". Expected boolean, but got %s.', From 6c9e48fd8f9ac935b5b4bd3de7f2b9b174e5a686 Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Mon, 28 Feb 2011 10:47:57 +0100 Subject: [PATCH 5/8] [Config][VariableNode] Tweak the code --- src/Symfony/Component/Config/Definition/VariableNode.php | 1 - 1 file changed, 1 deletion(-) diff --git a/src/Symfony/Component/Config/Definition/VariableNode.php b/src/Symfony/Component/Config/Definition/VariableNode.php index 056018130dd95..8d24f25d70f75 100644 --- a/src/Symfony/Component/Config/Definition/VariableNode.php +++ b/src/Symfony/Component/Config/Definition/VariableNode.php @@ -75,7 +75,6 @@ public function setName($name) */ protected function validateType($value) { - return true; } /** From b5fadcd22c31388cd9a7a19bb9a4335b3251cf1b Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Mon, 28 Feb 2011 11:04:33 +0100 Subject: [PATCH 6/8] [Config][TreeBuilder] Tweak the code --- .../Component/Config/Definition/Builder/TreeBuilder.php | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php b/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php index d7dbf6a93d5ea..1a4a2035116bb 100644 --- a/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php +++ b/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php @@ -11,10 +11,7 @@ namespace Symfony\Component\Config\Definition\Builder; -use Symfony\Component\Config\Definition\BaseNode; - use Symfony\Component\Config\Definition\BooleanNode; - use Symfony\Component\Config\Definition\ArrayNode; use Symfony\Component\Config\Definition\ScalarNode; use Symfony\Component\Config\Definition\VariableNode; From 6d37218db19d39debc14c6ba612e4ad004a31baf Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Mon, 28 Feb 2011 11:36:13 +0100 Subject: [PATCH 7/8] [Config] Tweak type hints & phpDoc for the builders --- .../Config/Definition/Builder/ExprBuilder.php | 28 ++++----- .../Definition/Builder/MergeBuilder.php | 10 +-- .../Config/Definition/Builder/NodeBuilder.php | 62 +++++++++---------- .../Builder/NormalizationBuilder.php | 8 +-- .../Config/Definition/Builder/TreeBuilder.php | 2 +- .../Definition/Builder/ValidationBuilder.php | 6 +- 6 files changed, 58 insertions(+), 58 deletions(-) diff --git a/src/Symfony/Component/Config/Definition/Builder/ExprBuilder.php b/src/Symfony/Component/Config/Definition/Builder/ExprBuilder.php index c391000bc01c5..9688bd7ea21ca 100644 --- a/src/Symfony/Component/Config/Definition/Builder/ExprBuilder.php +++ b/src/Symfony/Component/Config/Definition/Builder/ExprBuilder.php @@ -26,9 +26,9 @@ class ExprBuilder /** * Constructor * - * @param Symfony\Component\Config\Definition\Builder\NodeBuilder $parent The parent node + * @param NodeBuilder $parent The parent node */ - public function __construct($parent) + public function __construct(NodeBuilder $parent) { $this->parent = $parent; } @@ -36,7 +36,7 @@ public function __construct($parent) /** * Mark the expression as being always used. * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder + * @return ExprBuilder */ public function always() { @@ -51,7 +51,7 @@ public function always() * The default one tests if the value is true. * * @param \Closure $closure - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder + * @return ExprBuilder */ public function ifTrue(\Closure $closure = null) { @@ -67,7 +67,7 @@ public function ifTrue(\Closure $closure = null) /** * Tests if the value is a string. * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder + * @return ExprBuilder */ public function ifString() { @@ -79,7 +79,7 @@ public function ifString() /** * Tests if the value is null. * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder + * @return ExprBuilder */ public function ifNull() { @@ -91,7 +91,7 @@ public function ifNull() /** * Tests if the value is an array. * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder + * @return ExprBuilder */ public function ifArray() { @@ -105,7 +105,7 @@ public function ifArray() * * @param array $array * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder + * @return ExprBuilder */ public function ifInArray(array $array) { @@ -119,7 +119,7 @@ public function ifInArray(array $array) * * @param array $array * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder + * @return ExprBuilder */ public function ifNotInArray(array $array) { @@ -133,7 +133,7 @@ public function ifNotInArray(array $array) * * @param \Closure $closure * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder + * @return ExprBuilder */ public function then(\Closure $closure) { @@ -145,7 +145,7 @@ public function then(\Closure $closure) /** * Sets a closure returning an empty array. * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder + * @return ExprBuilder */ public function thenEmptyArray() { @@ -161,7 +161,7 @@ public function thenEmptyArray() * * @param string $message * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder + * @return ExprBuilder */ public function thenInvalid($message) { @@ -173,7 +173,7 @@ public function thenInvalid($message) /** * Sets a closure unsetting this key of the array at validation time. * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder + * @return ExprBuilder */ public function thenUnset() { @@ -185,7 +185,7 @@ public function thenUnset() /** * Returns the parent node * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function end() { diff --git a/src/Symfony/Component/Config/Definition/Builder/MergeBuilder.php b/src/Symfony/Component/Config/Definition/Builder/MergeBuilder.php index 22e004be85fcc..ec46cc540738f 100644 --- a/src/Symfony/Component/Config/Definition/Builder/MergeBuilder.php +++ b/src/Symfony/Component/Config/Definition/Builder/MergeBuilder.php @@ -25,9 +25,9 @@ class MergeBuilder /** * Constructor * - * @param Symfony\Component\Config\Definition\Builder\NodeBuilder $parent The parent node + * @param NodeBuilder $parent The parent node */ - public function __construct($parent) + public function __construct(NodeBuilder $parent) { $this->parent = $parent; $this->allowFalse = false; @@ -38,7 +38,7 @@ public function __construct($parent) * Sets whether the node can be unset. * * @param Boolean $allow - * @return Symfony\Component\Config\Definition\Builder\MergeBuilder + * @return MergeBuilder */ public function allowUnset($allow = true) { @@ -52,7 +52,7 @@ public function allowUnset($allow = true) * * @param Boolean $deny Whether the overwriting is forbidden or not * - * @return Symfony\Component\Config\Definition\Builder\MergeBuilder + * @return MergeBuilder */ public function denyOverwrite($deny = true) { @@ -64,7 +64,7 @@ public function denyOverwrite($deny = true) /** * Returns the parent node. * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function end() { diff --git a/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php b/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php index bf80e5f233c99..aa3b17fddd935 100644 --- a/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php +++ b/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php @@ -50,7 +50,7 @@ class NodeBuilder * * @param string $name the name of the node * @param string $type The type of the node - * @param NodeBuilder $parent + * @param mixed $parent Either a NodeBuilder or a TreeBuilder instance */ public function __construct($name, $type, $parent = null) { @@ -92,7 +92,7 @@ public function __construct($name, $type, $parent = null) * @param string $name The name of the node * @param string $type The type of the node * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder The builder of the child node + * @return NodeBuilder The builder of the child node */ public function node($name, $type) { @@ -129,7 +129,7 @@ public function builder(NodeBuilder $node) * * @param string $name The name of the node * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder The builder of the child node + * @return NodeBuilder The builder of the child node */ public function arrayNode($name) { @@ -141,7 +141,7 @@ public function arrayNode($name) * * @param string $name the name of the node * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder The builder of the child node + * @return NodeBuilder The builder of the child node */ public function scalarNode($name) { @@ -153,7 +153,7 @@ public function scalarNode($name) * * @param string $name The name of the node * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder The builder of the child node + * @return NodeBuilder The builder of the child node */ public function booleanNode($name) { @@ -165,7 +165,7 @@ public function booleanNode($name) * * @param string $name The name of the node * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder The builder of the child node + * @return NodeBuilder The builder of the child node */ public function variableNode($name) { @@ -177,7 +177,7 @@ public function variableNode($name) * * @param mixed $value The default value * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function defaultValue($value) { @@ -190,7 +190,7 @@ public function defaultValue($value) /** * Sets the node as required. * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function isRequired() { @@ -202,7 +202,7 @@ public function isRequired() /** * Requires the node to have at least one element. * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function requiresAtLeastOneElement() { @@ -216,7 +216,7 @@ public function requiresAtLeastOneElement() * * @param mixed $value * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function treatNullLike($value) { @@ -230,7 +230,7 @@ public function treatNullLike($value) * * @param mixed $value * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function treatTrueLike($value) { @@ -244,7 +244,7 @@ public function treatTrueLike($value) * * @param mixed $value * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function treatFalseLike($value) { @@ -256,7 +256,7 @@ public function treatFalseLike($value) /** * Sets null as the default value. * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function defaultNull() { @@ -266,7 +266,7 @@ public function defaultNull() /** * Sets true as the default value. * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function defaultTrue() { @@ -276,7 +276,7 @@ public function defaultTrue() /** * Sets false as the default value. * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function defaultFalse() { @@ -286,7 +286,7 @@ public function defaultFalse() /** * Adds the default value if the node is not set in the configuration. * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function addDefaultsIfNotSet() { @@ -300,7 +300,7 @@ public function addDefaultsIfNotSet() * * If used all keys have to be defined in the same configuration file. * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function disallowNewKeysInSubsequentConfigs() { @@ -312,7 +312,7 @@ public function disallowNewKeysInSubsequentConfigs() /** * Gets the builder for normalization rules. * - * @return Symfony\Component\Config\Definition\Builder\NormalizationBuilder + * @return NormalizationBuilder */ protected function normalization() { @@ -326,7 +326,7 @@ protected function normalization() /** * Sets an expression to run before the normalization. * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder + * @return ExprBuilder */ public function beforeNormalization() { @@ -339,7 +339,7 @@ public function beforeNormalization() * @param string $singular The key to remap * @param string $plural The plural of the key for irregular plurals * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function fixXmlConfig($singular, $plural = null) { @@ -372,7 +372,7 @@ public function fixXmlConfig($singular, $plural = null) * @param string $name The name of the key * @param Boolean $removeKeyItem Whether or not the key item should be removed. * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function useAttributeAsKey($name, $removeKeyItem = true) { @@ -385,7 +385,7 @@ public function useAttributeAsKey($name, $removeKeyItem = true) /** * Gets the builder for merging rules. * - * @return Symfony\Component\Config\Definition\Builder\MergeBuilder + * @return MergeBuilder */ protected function merge() { @@ -401,7 +401,7 @@ protected function merge() * * @param Boolean $deny Whether the overwriting is forbidden or not * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function cannotBeOverwritten($deny = true) { @@ -413,7 +413,7 @@ public function cannotBeOverwritten($deny = true) /** * Denies the node value being empty. * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function cannotBeEmpty() { @@ -427,7 +427,7 @@ public function cannotBeEmpty() * * @param Boolean $allow * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function canBeUnset($allow = true) { @@ -441,7 +441,7 @@ public function canBeUnset($allow = true) * * @param string $type the type of node * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function prototype($type) { @@ -451,7 +451,7 @@ public function prototype($type) /** * Disables the deep merging of the node. * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function performNoDeepMerging() { @@ -463,7 +463,7 @@ public function performNoDeepMerging() /** * Gets the builder for validation rules. * - * @return Symfony\Component\Config\Definition\Builder\ValidationBuilder + * @return ValidationBuilder */ protected function validation() { @@ -481,7 +481,7 @@ protected function validation() * modify it. * An exception should be thrown when the node is not valid. * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder + * @return ExprBuilder */ public function validate() { @@ -491,7 +491,7 @@ public function validate() /** * Returns the parent node. * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function end() { @@ -506,7 +506,7 @@ public function end() * in special cases where you want to send an entire configuration * array through a special tree that processes only part of the array. * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function ignoreExtraKeys() { diff --git a/src/Symfony/Component/Config/Definition/Builder/NormalizationBuilder.php b/src/Symfony/Component/Config/Definition/Builder/NormalizationBuilder.php index 9408cae516425..eb88119590cd9 100644 --- a/src/Symfony/Component/Config/Definition/Builder/NormalizationBuilder.php +++ b/src/Symfony/Component/Config/Definition/Builder/NormalizationBuilder.php @@ -25,9 +25,9 @@ class NormalizationBuilder /** * Constructor * - * @param Symfony\Component\Config\Definition\Builder\NodeBuilder $parent + * @param NodeBuilder $parent */ - public function __construct($parent) + public function __construct(NodeBuilder $parent) { $this->parent = $parent; @@ -44,7 +44,7 @@ public function __construct($parent) * @param string $key The key to remap * @param string $plural The plural of the key in case of irregular plural * - * @return Symfony\Component\Config\Definition\Builder\NormalizationBuilder + * @return NormalizationBuilder */ public function remap($key, $plural = null) { @@ -62,7 +62,7 @@ public function remap($key, $plural = null) * * @param \Closure $closure * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder|Symfony\Component\Config\Definition\Builder\NormalizationBuilder + * @return ExprBuilder|NormalizationBuilder */ public function before(\Closure $closure = null) { diff --git a/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php b/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php index 1a4a2035116bb..94a8b1630fd13 100644 --- a/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php +++ b/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php @@ -32,7 +32,7 @@ class TreeBuilder * @param string $name The name of the node * @param string $type The type of the node * - * @return Symfony\Component\Config\Definition\Builder\NodeBuilder + * @return NodeBuilder */ public function root($name, $type) { diff --git a/src/Symfony/Component/Config/Definition/Builder/ValidationBuilder.php b/src/Symfony/Component/Config/Definition/Builder/ValidationBuilder.php index ff2944d4f8454..1ec5921bed5f9 100644 --- a/src/Symfony/Component/Config/Definition/Builder/ValidationBuilder.php +++ b/src/Symfony/Component/Config/Definition/Builder/ValidationBuilder.php @@ -24,9 +24,9 @@ class ValidationBuilder /** * Constructor * - * @param Symfony\Component\Config\Definition\Builder\NodeBuilder $parent + * @param NodeBuilder $parent */ - public function __construct($parent) + public function __construct(NodeBuilder $parent) { $this->parent = $parent; @@ -38,7 +38,7 @@ public function __construct($parent) * * @param \Closure $closure * - * @return Symfony\Component\Config\Definition\Builder\ExprBuilder|Symfony\Component\Config\Definition\Builder\ValidationBuilder + * @return ExprBuilder|ValidationBuilder */ public function rule(\Closure $closure = null) { From d281409ed5ea7217cbcaccdffcb422eccad86ee8 Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Mon, 28 Feb 2011 11:46:18 +0100 Subject: [PATCH 8/8] [Config] Define a common interface for NodeBuilder and TreeBuilder --- .../Definition/Builder/BuilderInterface.php | 22 +++++++++++++++++++ .../Config/Definition/Builder/NodeBuilder.php | 10 ++++----- .../Config/Definition/Builder/TreeBuilder.php | 2 +- 3 files changed, 28 insertions(+), 6 deletions(-) create mode 100644 src/Symfony/Component/Config/Definition/Builder/BuilderInterface.php diff --git a/src/Symfony/Component/Config/Definition/Builder/BuilderInterface.php b/src/Symfony/Component/Config/Definition/Builder/BuilderInterface.php new file mode 100644 index 0000000000000..30db3d7061531 --- /dev/null +++ b/src/Symfony/Component/Config/Definition/Builder/BuilderInterface.php @@ -0,0 +1,22 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Component\Config\Definition\Builder; + +/** + * Defines a common interface for node & tree builders + * + * @author Victor Berchet + */ +interface BuilderInterface +{ +} + \ No newline at end of file diff --git a/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php b/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php index aa3b17fddd935..7d9512a2d3a22 100644 --- a/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php +++ b/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php @@ -16,7 +16,7 @@ * * @author Johannes M. Schmitt */ -class NodeBuilder +class NodeBuilder implements BuilderInterface { /************ * READ-ONLY @@ -48,11 +48,11 @@ class NodeBuilder /** * Constructor * - * @param string $name the name of the node - * @param string $type The type of the node - * @param mixed $parent Either a NodeBuilder or a TreeBuilder instance + * @param string $name The name of the node + * @param string $type The type of the node + * @param BuilderInterface $parent A builder instance */ - public function __construct($name, $type, $parent = null) + public function __construct($name, $type, BuilderInterface $parent = null) { $this->name = $name; $this->type = $type; diff --git a/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php b/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php index 94a8b1630fd13..cf3ed43d6fa36 100644 --- a/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php +++ b/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php @@ -21,7 +21,7 @@ * * @author Johannes M. Schmitt */ -class TreeBuilder +class TreeBuilder implements BuilderInterface { protected $root; protected $tree;