1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Config
  7. \
  8. Definition
  9. \
  10. Builder
  11. \
  12. TreeBuilder

TreeBuilder

class TreeBuilder implements NodeParentInterface

This is the entry class for building a config tree.

Properties

protected $tree
protected $root

Methods

__construct(string $name = null, string $type = 'array', NodeBuilder $builder = null)

No description

ArrayNodeDefinition|NodeDefinition
root(string $name, string $type = 'array', NodeBuilder $builder = null)

Creates the root node.

NodeDefinition
getRootNode()

No description

NodeInterface
buildTree()

Builds the tree.

setPathSeparator(string $separator)

No description

Details

__construct(string $name = null, string $type = 'array', NodeBuilder $builder = null)

Parameters

string $name
string $type
NodeBuilder $builder

ArrayNodeDefinition|NodeDefinition root(string $name, string $type = 'array', NodeBuilder $builder = null)

Creates the root node.

Parameters

string $name The name of the root node
string $type The type of the root node
NodeBuilder $builder A custom node builder instance

Return Value

ArrayNodeDefinition|NodeDefinition The root node (as an ArrayNodeDefinition when the type is 'array')

Exceptions

RuntimeException When the node type is not supported

NodeDefinition getRootNode()

Return Value

NodeDefinition

NodeInterface buildTree()

Builds the tree.

Return Value

NodeInterface

Exceptions

RuntimeException

setPathSeparator(string $separator)

Parameters

string $separator