123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\Config\Definition\Builder;
- use Symfony\Component\Config\Definition\Exception\TreeWithoutRootNodeException;
- use Symfony\Component\Config\Definition\NodeInterface;
- /**
- * This is the entry class for building a config tree.
- *
- * @author Johannes M. Schmitt <schmittjoh@gmail.com>
- */
- class TreeBuilder implements NodeParentInterface
- {
- protected $tree;
- protected $root;
- public function __construct(string $name = null, string $type = 'array', NodeBuilder $builder = null)
- {
- if (null === $name) {
- @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);
- } else {
- $builder = $builder ?? new NodeBuilder();
- $this->root = $builder->node($name, $type)->setParent($this);
- }
- }
- /**
- * Creates the root node.
- *
- * @param string $name The name of the root node
- * @param string $type The type of the root node
- *
- * @return ArrayNodeDefinition|NodeDefinition The root node (as an ArrayNodeDefinition when the type is 'array')
- *
- * @throws \RuntimeException When the node type is not supported
- *
- * @deprecated since Symfony 4.3, pass the root name to the constructor instead
- */
- public function root($name, $type = 'array', NodeBuilder $builder = null)
- {
- @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);
- $builder = $builder ?? new NodeBuilder();
- return $this->root = $builder->node($name, $type)->setParent($this);
- }
- /**
- * @return NodeDefinition|ArrayNodeDefinition The root node (as an ArrayNodeDefinition when the type is 'array')
- */
- public function getRootNode(): NodeDefinition
- {
- if (null === $this->root) {
- throw new \RuntimeException(sprintf('Calling "%s()" before creating the root node is not supported, migrate to the new constructor signature instead.', __METHOD__));
- }
- return $this->root;
- }
- /**
- * Builds the tree.
- *
- * @return NodeInterface
- *
- * @throws \RuntimeException
- */
- public function buildTree()
- {
- $this->assertTreeHasRootNode();
- if (null !== $this->tree) {
- return $this->tree;
- }
- return $this->tree = $this->root->getNode(true);
- }
- public function setPathSeparator(string $separator)
- {
- $this->assertTreeHasRootNode();
- // unset last built as changing path separator changes all nodes
- $this->tree = null;
- $this->root->setPathSeparator($separator);
- }
- /**
- * @throws \RuntimeException if root node is not defined
- */
- private function assertTreeHasRootNode()
- {
- if (null === $this->root) {
- throw new TreeWithoutRootNodeException('The configuration tree has no root node.');
- }
- }
- }
|