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.             $this->root($name, $type, $builder);
  33.         }
  34.     }
  36.     /**
  37.      * Creates the root node.
  38.      *
  39.      * @param string      $name    The name of the root node
  40.      * @param string      $type    The type of the root node
  41.      * @param NodeBuilder $builder A custom node builder instance
  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.     public function root($name, $type = 'array', NodeBuilder $builder = null)
  48.     {
  49.         $builder = $builder ?: new NodeBuilder();
  51.         return $this->root = $builder->node($name, $type)->setParent($this);
  52.     }
  54.     /**
  55.      * @return NodeDefinition|ArrayNodeDefinition The root node (as an ArrayNodeDefinition when the type is 'array')
  56.      */
  57.     public function getRootNode(): NodeDefinition
  58.     {
  59.         if (null === $this->root) {
  60.             throw new \RuntimeException(sprintf('Calling %s() before creating the root node is not supported, migrate to the new constructor signature instead.', __METHOD__));
  61.         }
  63.         return $this->root;
  64.     }
  66.     /**
  67.      * Builds the tree.
  68.      *
  69.      * @return NodeInterface
  70.      *
  71.      * @throws \RuntimeException
  72.      */
  73.     public function buildTree()
  74.     {
  75.         $this->assertTreeHasRootNode();
  76.         if (null !== $this->tree) {
  77.             return $this->tree;
  78.         }
  80.         return $this->tree = $this->root->getNode(true);
  81.     }
  83.     public function setPathSeparator(string $separator)
  84.     {
  85.         $this->assertTreeHasRootNode();
  87.         // unset last built as changing path separator changes all nodes
  88.         $this->tree = null;
  90.         $this->root->setPathSeparator($separator);
  91.     }
  93.     /**
  94.      * @throws \RuntimeException if root node is not defined
  95.      */
  96.     private function assertTreeHasRootNode()
  97.     {
  98.         if (null === $this->root) {
  99.             throw new TreeWithoutRootNodeException('The configuration tree has no root node.');
  100.         }
  101.     }
  102. }