Skip to content

[Config] Handle nullable node name + fix inheritdocs #26335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 3 additions & 11 deletions src/Symfony/Component/Config/Definition/ArrayNode.php
Original file line number Diff line number Diff line change
Expand Up @@ -150,31 +150,23 @@ public function setIgnoreExtraKeys($boolean)
}

/**
* Sets the node Name.
*
* @param string $name The node's name
* {@inheritdoc}
*/
public function setName($name)
{
$this->name = $name;
}

/**
* Checks if the node has a default value.
*
* @return bool
* {@inheritdoc}
*/
public function hasDefaultValue()
{
return $this->addIfNotSet;
}

/**
* Retrieves the default value.
*
* @return array The default value
*
* @throws \RuntimeException if the node has no default value
* {@inheritdoc}
*/
public function getDefaultValue()
{
Expand Down
38 changes: 7 additions & 31 deletions src/Symfony/Component/Config/Definition/BaseNode.php
Original file line number Diff line number Diff line change
Expand Up @@ -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, '.')) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$name must be a string, so casting here should be removed. Adding this is not a bug fix.

Copy link
Contributor Author

@ro0NL ro0NL Mar 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in 4.0 it's string|null already

public function __construct(?string $name, NodeInterface $parent = null, string $pathSeparator = self::DEFAULT_PATH_SEPARATOR)

hence #26297

practically using null is just an alias for empty string, but we use null by design (as of 2.7!):

public function prototype($type)
{
return $this->prototype = $this->getNodeBuilder()->node(null, $type)->setParent($this);
}

if we preserve null on the property side (thus no cast) we keep violating getName:

* @return string The Node's name
*/
public function getName()

hence the cast

throw new \InvalidArgumentException('The name must not contain ".".');
}

Expand Down Expand Up @@ -170,29 +170,23 @@ public function setFinalValidationClosures(array $closures)
}

/**
* Checks if this node is required.
*
* @return bool
* {@inheritdoc}
*/
public function isRequired()
{
return $this->required;
}

/**
* Returns the name of this node.
*
* @return string The Node's name
* {@inheritdoc}
*/
public function getName()
{
return $this->name;
}

/**
* Retrieves the path of this node.
*
* @return string The Node's path
* {@inheritdoc}
*/
public function getPath()
{
Expand All @@ -206,14 +200,7 @@ public function getPath()
}

/**
* Merges two values together.
*
* @param mixed $leftSide
* @param mixed $rightSide
*
* @return mixed The merged value
*
* @throws ForbiddenOverwriteException
* {@inheritdoc}
*/
final public function merge($leftSide, $rightSide)
{
Expand All @@ -233,11 +220,7 @@ final public function merge($leftSide, $rightSide)
}

/**
* Normalizes a value, applying all normalization closures.
*
* @param mixed $value Value to normalize
*
* @return mixed The normalized value
* {@inheritdoc}
*/
final public function normalize($value)
{
Expand Down Expand Up @@ -285,14 +268,7 @@ public function getParent()
}

/**
* 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)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,15 @@ public function __construct($name, NodeParentInterface $parent = null)
}

/**
* Sets a custom children builder.
* {@inheritdoc}
*/
public function setBuilder(NodeBuilder $builder)
{
$this->nodeBuilder = $builder;
}

/**
* Returns a builder to add children nodes.
*
* @return NodeBuilder
* {@inheritdoc}
*/
public function children()
{
Expand Down Expand Up @@ -306,17 +304,7 @@ public function normalizeKeys($bool)
}

/**
* 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)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,32 @@
*/
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);
}
16 changes: 14 additions & 2 deletions src/Symfony/Component/Config/Definition/NodeInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand Down Expand Up @@ -59,11 +63,13 @@ public function hasDefaultValue();
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);

Expand All @@ -73,7 +79,10 @@ public function normalize($value);
* @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);

Expand All @@ -83,6 +92,9 @@ public function merge($leftSide, $rightSide);
* @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);
}
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,7 @@ public function setDefaultValue($value)
}

/**
* Checks if the node has a default value.
*
* @return bool
* {@inheritdoc}
*/
public function hasDefaultValue()
{
Expand All @@ -126,12 +124,10 @@ public function setAddChildrenIfNoneSet($children = array('defaults'))
}

/**
* 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()
{
Expand Down
3 changes: 0 additions & 3 deletions src/Symfony/Component/Config/Definition/VariableNode.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,6 @@ class VariableNode extends BaseNode implements PrototypeNodeInterface
protected $defaultValue;
protected $allowEmptyValue = true;

/**
* {@inheritdoc}
*/
public function setDefaultValue($value)
{
$this->defaultValueSet = true;
Expand Down