pbergman/tree-helper

A symfony console helper to print a tree

Tree builder helper

this is a small library for symfony console to print a tree in a fluent and flexible way., _(*1)

The output is similar as the linux tree command, an can be used to debug/output relational data., _(*2)

Usage:

$tree = new TreeHelper($output);

$tree
    ->newNode('first')
        ->addValue('fist value')
        ->addValue('second value')
        ->newNode('fist sub')
            ->addValue('fist sub value')
            ->addValue('second sub value')
            ->newNode('fist sub sub')
                ->addValue('fist sub sub value')
                ->addValue('second sub sub value')            
            ->end()
        ->end()
    ->newNode('second')
        ->addValue('second value')
        ->addValue('second second value')
    ->end();

$tree->printTree();    

or, _(*3)

$tree = new TreeHelper($output);
$tree->addArray([
    'first' => [
        0 => 'fist value',
        1 => 'second value',
        'fist sub' => [
            0 => 'fist sub value',
            1 => 'second sub value',
            'fist sub sub' => [
                'fist sub sub value',
                'second sub sub value',
            ],
        ],
    ],
    'second' => [
        'second value',
        'second second value',
    ]
]);

that will output:, _(*4)

.
│
└── first
    ├── fist value
    ├── second value
    ├── fist sub
    │   ├── fist sub value
    │   ├── second sub value
    │   └── fist sub sub
    │       ├── fist sub sub value
    │       └── second sub sub value
    └── second
        ├── second value
        └── second second value

for other example see the the tests., _(*5)

Methods

newNode($name)

Create an new node and bind it to the parent, _(*6)

addNode($node)

Append node to tree, _(*7)

end()

Will return the parent object (if set else null), _(*8)

getRoot()

Will return the root node, _(*9)

printTree($output)

Print the tree to output, _(*10)

findNode($name)

Search a node by title, _(*11)

toArray()

Returns a array representation of the data, _(*12)

getTitle()

Returns the title of the node, _(*13)

setTitle($title)

Sets the title of the node, _(*14)

addValue($value)

Add a value to the node, this can be a valid scalar or a object with method __toString, _(*15)

addArray($array)

Add a nested array to node, _(*16)

setValues($array)

Add a flat array to node, this be set as the values of the node, _(*17)

setParent($parent)

Set the parent of the node, will trow a RuntimeException is the the node all ready is linked to the given node, so we don`t get infinite loops., _(*18)

getNodes()

Get all the (child) nodes defined in the node, all the nodes are only saved in the root so to get all nodes you probably have to do this $t->getRoot()->getNodes(); else it will return the nodes where the parent is set as node where from you calling the method., _(*19)

setMaxDepth($depth)

Set the max depth of the node values, this can be done globally (on root) or on a specific node., _(*20)

getMaxDepth()

Return the max depth that is set, _(*21)

setFormats()

Set the form that is used for example:, _(*22)

$tree->setFormats([
    TreeHelper::LINE_PREFIX_EMPTY => '  ',
    TreeHelper::LINE_PREFIX => '│ ',
    TreeHelper::TEXT_PREFIX => '├ ',
    TreeHelper::TEXT_PREFIX_END => '└ ',
]);

no it will use a 2 space indent instead of 4, see tests, _(*23)

setFormat($id, $format)

Overwrite a specific format, _(*24)