[Config] Improve error messages & extensibility

Author: vicb

src/Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php

@@ -278,45 +278,21 @@ protected function getNodeBuilder()
  protected function createNode()
  {
  if (null === $this->prototype) {
- if (null !== $this->key) {
- throw new InvalidDefinitionException(
- sprintf('%s::useAttributeAsKey() is not applicable to concrete nodes.', __CLASS__)
- );
- }
-
- if (true === $this->atLeastOne) {
- throw new InvalidDefinitionException(
- sprintf('%s::requiresAtLeastOneElement() is not applicable to concrete nodes.', __CLASS__)
- );
- }
+ $node = new ArrayNode($this->name, $this->parent);
 
- if ($this->default) {
- throw new InvalidDefinitionException(
- sprintf('%s::defaultValue() is not applicable to concrete nodes.', __CLASS__)
- );
- }
+ $this->validateConcreteNode($node);
 
- $node = new ArrayNode($this->name, $this->parent);
  $node->setAddIfNotSet($this->addDefaults);
 
  foreach ($this->children as $child) {
  $child->parent = $node;
  $node->addChild($child->getNode());
  }
  } else {
- if ($this->addDefaults) {
- throw new InvalidDefinitionException(
- sprintf('%s::addDefaultsIfNotSet() is not applicable to prototype nodes.', __CLASS__)
- );
- }
-
- if ($this->default && false !== $this->addDefaultChildren) {
- throw new InvalidDefinitionException('A default value and default children might not be used together.');
-
- }
-
  $node = new PrototypedArrayNode($this->name, $this->parent);
 
+ $this->validatePrototypeNode($node);
+
  if (null !== $this->key) {
  $node->setKeyAttribute($this->key, $this->removeKeyItem);
  }
@@ -338,7 +314,6 @@ protected function createNode()
 
  $this->prototype->parent = $node;
  $node->setPrototype($this->prototype->getNode());
-
  }
 
  $node->setAllowNewKeys($this->allowNewKeys);
@@ -366,4 +341,57 @@ protected function createNode()
  return $node;
  }
 
+ /**
+ * Validate the confifuration of a concrete node.
+ *
+ * @param NodeInterface $node The related node
+ *
+ * @throws InvalidDefinitionException When an error is detected in the configuration
+ */
+ protected function validateConcreteNode(ArrayNode $node)
+ {
+ $path = $node->getPath();
+
+ if (null !== $this->key) {
+ throw new InvalidDefinitionException(
+ sprintf('->useAttributeAsKey() is not applicable to concrete nodes at path "%s"', $path)
+ );
+ }
+
+ if (true === $this->atLeastOne) {
+ throw new InvalidDefinitionException(
+ sprintf('->requiresAtLeastOneElement() is not applicable to concrete nodes at path "%s"', $path)
+ );
+ }
+
+ if ($this->default) {
+ throw new InvalidDefinitionException(
+ sprintf('->defaultValue() is not applicable to concrete nodes at path "%s"', $path)
+ );
+ }
+ }
+
+ /**
+ * Validate the configuration of a prototype node.
+ *
+ * @param NodeInterface $node The related node
+ *
+ * @throws InvalidDefinitionException When an error is detected in the configuration
+ */
+ protected function validatePrototypeNode(PrototypedArrayNode $node)
+ {
+ $path = $node->getPath();
+
+ if ($this->addDefaults) {
+ throw new InvalidDefinitionException(
+ sprintf('->addDefaultsIfNotSet() is not applicable to prototype nodes at path "%s"', $path)
+ );
+ }
+
+ if ($this->default && false !== $this->addDefaultChildren) {
+ throw new InvalidDefinitionException(
+ sprintf('A default value and default children might not be used together at path "%s"', $path)
+ );
+ }
+ }
 }