minor #26335 [Config] Handle nullable node name + fix inheritdocs (ro0NL)

This PR was squashed before being merged into the 2.7 branch (closes #26335).

Discussion
----------

[Config] Handle nullable node name + fix inheritdocs

| Q             | A
| ------------- | ---
| Branch?       | 2.7
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no-ish
| Deprecations? | no
| Tests pass?   | yes    <!-- please add some, will be required by reviewers -->
| Fixed tickets | #...   <!-- #-prefixed issue number(s), if any -->
| License       | MIT
| Doc PR        | symfony/symfony-docs#... <!-- required for new features -->

Small split from #26297 that can be merged until master/4.1. Whereas the doc fixes only apply until 3.4, hence the split.

Small change regarding `getName/Path()` for not returning a `null` value anymore which violates `NodeInterface::getName/Path()`

Remainng issue left at

cd5f4105a4/src/Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php (L381-L383)

which i tend to leave untouched across all branches for now.

Commits
-------

5c3e6a9 [Config] Handle nullable node name + fix inheritdocs
This commit is contained in:
Nicolas Grekas 2018-03-19 21:05:12 +01:00
commit 7323372c2b
7 changed files with 52 additions and 68 deletions

View File

@ -150,9 +150,7 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
}
/**
* Sets the node Name.
*
* @param string $name The node's name
* {@inheritdoc}
*/
public function setName($name)
{
@ -160,9 +158,7 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
}
/**
* Checks if the node has a default value.
*
* @return bool
* {@inheritdoc}
*/
public function hasDefaultValue()
{
@ -170,11 +166,7 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
}
/**
* Retrieves the default value.
*
* @return array The default value
*
* @throws \RuntimeException if the node has no default value
* {@inheritdoc}
*/
public function getDefaultValue()
{

View File

@ -40,7 +40,7 @@ abstract class BaseNode implements NodeInterface
*/
public function __construct($name, NodeInterface $parent = null)
{
if (false !== strpos($name, '.')) {
if (false !== strpos($name = (string) $name, '.')) {
throw new \InvalidArgumentException('The name must not contain ".".');
}
@ -170,9 +170,7 @@ abstract class BaseNode implements NodeInterface
}
/**
* Checks if this node is required.
*
* @return bool
* {@inheritdoc}
*/
public function isRequired()
{
@ -180,9 +178,7 @@ abstract class BaseNode implements NodeInterface
}
/**
* Returns the name of this node.
*
* @return string The Node's name
* {@inheritdoc}
*/
public function getName()
{
@ -190,9 +186,7 @@ abstract class BaseNode implements NodeInterface
}
/**
* Retrieves the path of this node.
*
* @return string The Node's path
* {@inheritdoc}
*/
public function getPath()
{
@ -206,14 +200,7 @@ abstract class BaseNode implements NodeInterface
}
/**
* Merges two values together.
*
* @param mixed $leftSide
* @param mixed $rightSide
*
* @return mixed The merged value
*
* @throws ForbiddenOverwriteException
* {@inheritdoc}
*/
final public function merge($leftSide, $rightSide)
{
@ -233,11 +220,7 @@ abstract class BaseNode implements NodeInterface
}
/**
* Normalizes a value, applying all normalization closures.
*
* @param mixed $value Value to normalize
*
* @return mixed The normalized value
* {@inheritdoc}
*/
final public function normalize($value)
{
@ -285,14 +268,7 @@ abstract class BaseNode implements NodeInterface
}
/**
* Finalizes a value, applying all finalization closures.
*
* @param mixed $value The value to finalize
*
* @return mixed The finalized value
*
* @throws Exception
* @throws InvalidConfigurationException
* {@inheritdoc}
*/
final public function finalize($value)
{

View File

@ -47,7 +47,7 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
}
/**
* Sets a custom children builder.
* {@inheritdoc}
*/
public function setBuilder(NodeBuilder $builder)
{
@ -55,9 +55,7 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
}
/**
* Returns a builder to add children nodes.
*
* @return NodeBuilder
* {@inheritdoc}
*/
public function children()
{
@ -306,17 +304,7 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
}
/**
* Appends a node definition.
*
* $node = new ArrayNodeDefinition()
* ->children()
* ->scalarNode('foo')->end()
* ->scalarNode('baz')->end()
* ->end()
* ->append($this->getBarNodeDefinition())
* ;
*
* @return $this
* {@inheritdoc}
*/
public function append(NodeDefinition $node)
{

View File

@ -18,9 +18,32 @@ namespace Symfony\Component\Config\Definition\Builder;
*/
interface ParentNodeDefinitionInterface
{
/**
* Returns a builder to add children nodes.
*
* @return NodeBuilder
*/
public function children();
/**
* Appends a node definition.
*
* Usage:
*
* $node = $parentNode
* ->children()
* ->scalarNode('foo')->end()
* ->scalarNode('baz')->end()
* ->append($this->getBarNodeDefinition())
* ->end()
* ;
*
* @return $this
*/
public function append(NodeDefinition $node);
/**
* Sets a custom children builder.
*/
public function setBuilder(NodeBuilder $builder);
}

View File

@ -11,6 +11,10 @@
namespace Symfony\Component\Config\Definition;
use Symfony\Component\Config\Definition\Exception\ForbiddenOverwriteException;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\Config\Definition\Exception\InvalidTypeException;
/**
* Common Interface among all nodes.
*
@ -59,11 +63,13 @@ interface NodeInterface
public function getDefaultValue();
/**
* Normalizes the supplied value.
* Normalizes a value.
*
* @param mixed $value The value to normalize
*
* @return mixed The normalized value
*
* @throws InvalidTypeException if the value type is invalid
*/
public function normalize($value);
@ -73,7 +79,10 @@ interface NodeInterface
* @param mixed $leftSide
* @param mixed $rightSide
*
* @return mixed The merged values
* @return mixed The merged value
*
* @throws ForbiddenOverwriteException if the configuration path cannot be overwritten
* @throws InvalidTypeException if the value type is invalid
*/
public function merge($leftSide, $rightSide);
@ -83,6 +92,9 @@ interface NodeInterface
* @param mixed $value The value to finalize
*
* @return mixed The finalized value
*
* @throws InvalidTypeException if the value type is invalid
* @throws InvalidConfigurationException if the value is invalid configuration
*/
public function finalize($value);
}

View File

@ -102,9 +102,7 @@ class PrototypedArrayNode extends ArrayNode
}
/**
* Checks if the node has a default value.
*
* @return bool
* {@inheritdoc}
*/
public function hasDefaultValue()
{
@ -126,12 +124,10 @@ class PrototypedArrayNode extends ArrayNode
}
/**
* Retrieves the default value.
* {@inheritdoc}
*
* The default value could be either explicited or derived from the prototype
* default value.
*
* @return array The default value
*/
public function getDefaultValue()
{

View File

@ -27,9 +27,6 @@ class VariableNode extends BaseNode implements PrototypeNodeInterface
protected $defaultValue;
protected $allowEmptyValue = true;
/**
* {@inheritdoc}
*/
public function setDefaultValue($value)
{
$this->defaultValueSet = true;