vendor/symfony/symfony/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php line 51

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Config\Definition\Builder;
  14. use Symfony\Component\Config\Definition\Exception\TreeWithoutRootNodeException;
  15. use Symfony\Component\Config\Definition\NodeInterface;
  17. /**
  18.  * This is the entry class for building a config tree.
  19.  *
  20.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  21.  */
  22. class TreeBuilder implements NodeParentInterface
  23. {
  24.     protected $tree;
  25.     protected $root;
  27.     public function __construct(string $name = null, string $type = 'array', NodeBuilder $builder = null)
  28.     {
  29.         if (null === $name) {
  30.             @trigger_error('A tree builder without a root node is deprecated since Symfony 4.2 and will not be supported anymore in 5.0.', E_USER_DEPRECATED);
  31.         } else {
  32.             $builder = $builder ?: new NodeBuilder();
  33.             $this->root = $builder->node($name, $type)->setParent($this);
  34.         }
  35.     }
  37.     /**
  38.      * Creates the root node.
  39.      *
  40.      * @param string $name The name of the root node
  41.      * @param string $type The type of the root node
  42.      *
  43.      * @return ArrayNodeDefinition|NodeDefinition The root node (as an ArrayNodeDefinition when the type is 'array')
  44.      *
  45.      * @throws \RuntimeException When the node type is not supported
  46.      *
  47.      * @deprecated since Symfony 4.3, pass the root name to the constructor instead
  48.      */
  49.     public function root($name, $type = 'array', NodeBuilder $builder = null)
  50.     {
  51.         @trigger_error(sprintf('The "%s()" method called for the "%s" configuration is deprecated since Symfony 4.3, pass the root name to the constructor instead.', __METHOD__, $name), E_USER_DEPRECATED);
  53.         $builder = $builder ?: new NodeBuilder();
  55.         return $this->root = $builder->node($name, $type)->setParent($this);
  56.     }
  58.     /**
  59.      * @return NodeDefinition|ArrayNodeDefinition The root node (as an ArrayNodeDefinition when the type is 'array')
  60.      */
  61.     public function getRootNode(): NodeDefinition
  62.     {
  63.         if (null === $this->root) {
  64.             throw new \RuntimeException(sprintf('Calling "%s()" before creating the root node is not supported, migrate to the new constructor signature instead.', __METHOD__));
  65.         }
  67.         return $this->root;
  68.     }
  70.     /**
  71.      * Builds the tree.
  72.      *
  73.      * @return NodeInterface
  74.      *
  75.      * @throws \RuntimeException
  76.      */
  77.     public function buildTree()
  78.     {
  79.         $this->assertTreeHasRootNode();
  80.         if (null !== $this->tree) {
  81.             return $this->tree;
  82.         }
  84.         return $this->tree = $this->root->getNode(true);
  85.     }
  87.     public function setPathSeparator(string $separator)
  88.     {
  89.         $this->assertTreeHasRootNode();
  91.         // unset last built as changing path separator changes all nodes
  92.         $this->tree = null;
  94.         $this->root->setPathSeparator($separator);
  95.     }
  97.     /**
  98.      * @throws \RuntimeException if root node is not defined
  99.      */
  100.     private function assertTreeHasRootNode()
  101.     {
  102.         if (null === $this->root) {
  103.             throw new TreeWithoutRootNodeException('The configuration tree has no root node.');
  104.         }
  105.     }
  106. }