Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[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 1 commit
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
Prev Previous commit
Next Next commit
fix BaseNode inheritdoc
  • Loading branch information
ro0NL committed Feb 27, 2018
commit bc1c94503a87df82c1e699bd6cdbc8a4c387122f
38 changes: 7 additions & 31 deletions 38 src/Symfony/Component/Config/Definition/BaseNode.php
Original file line number Diff line number Diff line change
Expand Up @@ -170,33 +170,27 @@ 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 null === $this->name ? '' : $this->name;
}

/**
* Retrieves the path of this node.
*
* @return string The Node's path
* {@inheritdoc}
*/
public function getPath()
{
$path = $this->name;
$path = null === $this->name ? '' : $this->name;

if (null !== $this->parent) {
$path = $this->parent->getPath().'.'.$path;
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
15 changes: 12 additions & 3 deletions 15 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\Exception;
use Symfony\Component\Config\Definition\Exception\ForbiddenOverwriteException;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;

/**
* Common Interface among all nodes.
*
Expand Down Expand Up @@ -59,9 +63,9 @@ public function hasDefaultValue();
public function getDefaultValue();

/**
* Normalizes the supplied value.
* Normalizes a value.
*
* @param mixed $value The value to normalize
* @param mixed $value Value to normalize
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe A value to normalize ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

in fact.. i think i should revert this one as the interface was already using different syntax:

https://github.com/symfony/symfony/pull/26335/files#diff-41913ce7a681852774440044e2c091bdR92

*
* @return mixed The normalized value
*/
Expand All @@ -73,7 +77,9 @@ public function normalize($value);
* @param mixed $leftSide
* @param mixed $rightSide
*
* @return mixed The merged values
* @return mixed The merged value
*
* @throws ForbiddenOverwriteException
*/
public function merge($leftSide, $rightSide);

Expand All @@ -83,6 +89,9 @@ public function merge($leftSide, $rightSide);
* @param mixed $value The value to finalize
*
* @return mixed The finalized value
*
* @throws Exception
Copy link
Member

Choose a reason for hiding this comment

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

All @throws should have a description explaining when the exception can be triggered... or be removed :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Now updated.

* @throws InvalidConfigurationException
*/
public function finalize($value);
}
Morty Proxy This is a proxified and sanitized view of the page, visit original site.