vendor/symfony/config/Definition/Builder/TreeBuilder.php line 30

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.      * @param NodeBuilder $builder A custom node builder instance
  43.      *
  44.      * @return ArrayNodeDefinition|NodeDefinition The root node (as an ArrayNodeDefinition when the type is 'array')
  45.      *
  46.      * @throws \RuntimeException When the node type is not supported
  47.      *
  48.      * @deprecated since Symfony 4.3, pass the root name to the constructor instead
  49.      */
  50.     public function root($name, $type = 'array', NodeBuilder $builder = null)
  51.     {
  52.         @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);
  54.         $builder = $builder ?: new NodeBuilder();
  56.         return $this->root = $builder->node($name, $type)->setParent($this);
  57.     }
  59.     /**
  60.      * @return NodeDefinition|ArrayNodeDefinition The root node (as an ArrayNodeDefinition when the type is 'array')
  61.      */
  62.     public function getRootNode(): NodeDefinition
  63.     {
  64.         if (null === $this->root) {
  65.             throw new \RuntimeException(sprintf('Calling %s() before creating the root node is not supported, migrate to the new constructor signature instead.', __METHOD__));
  66.         }
  68.         return $this->root;
  69.     }
  71.     /**
  72.      * Builds the tree.
  73.      *
  74.      * @return NodeInterface
  75.      *
  76.      * @throws \RuntimeException
  77.      */
  78.     public function buildTree()
  79.     {
  80.         $this->assertTreeHasRootNode();
  81.         if (null !== $this->tree) {
  82.             return $this->tree;
  83.         }
  85.         return $this->tree = $this->root->getNode(true);
  86.     }
  88.     public function setPathSeparator(string $separator)
  89.     {
  90.         $this->assertTreeHasRootNode();
  92.         // unset last built as changing path separator changes all nodes
  93.         $this->tree = null;
  95.         $this->root->setPathSeparator($separator);
  96.     }
  98.     /**
  99.      * @throws \RuntimeException if root node is not defined
  100.      */
  101.     private function assertTreeHasRootNode()
  102.     {
  103.         if (null === $this->root) {
  104.             throw new TreeWithoutRootNodeException('The configuration tree has no root node.');
  105.         }
  106.     }
  107. }