10000 Deprecated not passing the root node name to config tree builders by javiereguiluz · Pull Request #10388 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Deprecated not passing the root node name to config tree builders #10388

New issue 8000

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

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 25, 2018
Merged

Deprecated not passing the root node name to config tree builders #10388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions bundles/configuration.rst
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
Expand Up @@ -175,10 +175,9 @@ The ``Configuration`` class to handle the sample configuration looks like::
{
public function getConfigTreeBuilder()
{
$treeBuilder = new TreeBuilder();
$rootNode = $treeBuilder->root('acme_social');
$treeBuilder = new TreeBuilder('acme_social');

$rootNode
$treeBuilder->getRootNode()
->children()
->arrayNode('twitter')
->children()
Expand All @@ -193,6 +192,9 @@ The ``Configuration`` class to handle the sample configuration looks like::
}
}

.. versionadded:: 4.2
Not passing the root node name to ``TreeBuilder`` was deprecated in Symfony 4.2.

.. seealso::

The ``Configuration`` class can be much more complicated than shown here,
Expand Down
22 changes: 11 additions & 11 deletions components/config/definition.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,18 @@ implements the :class:`Symfony\\Component\\Config\\Definition\\ConfigurationInte
{
public function getConfigTreeBuilder()
{
$treeBuilder = new TreeBuilder();
$rootNode = $treeBuilder->root('database');
$treeBuilder = new TreeBuilder('database');

// ... add node definitions to the root of the tree
// $treeBuilder->getRootNode()->...

return $treeBuilder;
}
}

.. versionadded:: 4.2
Not passing the root node name to ``TreeBuilder`` was deprecated in Symfony 4.2.

Adding Node Definitions to the Tree
-----------------------------------

Expand Down Expand Up @@ -534,10 +537,9 @@ tree with ``append()``::

public function getConfigTreeBuilder()
{
$treeBuilder = new TreeBuilder();
$rootNode = $treeBuilder->root('database');
$treeBuilder = new TreeBuilder('database');

$rootNode
$treeBuilder->getRootNode()
->children()
->arrayNode('connection')
->children()
Expand All @@ -564,10 +566,9 @@ tree with ``append()``::

public function addParametersNode()
{
$treeBuilder = new TreeBuilder();
$node = $treeBuilder->root('parameters');
$treeBuilder = new TreeBuilder('parameters');

$node
$treeBuilder->getRootNode()
->isRequired()
->requiresAtLeastOneElement()
->useAttributeAsKey('name')
Expand Down Expand Up @@ -795,10 +796,9 @@ Configuring the Node Path Separator

Consider the following config builder example::

$treeBuilder = new TreeBuilder();
$rootNode = $treeBuilder->root('database');
$treeBuilder = new TreeBuilder('database');

$rootNode
$treeBuilder->getRootNode()
->children()
->arrayNode('connection')
->children()
Expand Down
8 changes: 5 additions & 3 deletions configuration/using_parameters_in_dic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,9 @@ be injected with this parameter via the extension as follows::

public function getConfigTreeBuilder()
{
$treeBuilder = new TreeBuilder();
$rootNode = $treeBuilder->root('my_bundle');
$treeBuilder = new TreeBuilder('my_bundle');

$rootNode
$treeBuilder->getRootNode()
->children()
// ...
->booleanNode('logging')->defaultValue($this->debug)->end()
Expand All @@ -124,6 +123,9 @@ be injected with this parameter via the extension as follows::
}
}

.. versionadded:: 4.2
Not passing the root node name to ``TreeBuilder`` was deprecated in Symfony 4.2.

And set it in the constructor of ``Configuration`` via the ``Extension`` class::

namespace App\DependencyInjection;
Expand Down
0