baopham/tree-parser

Parse tree structure

tree-parser

![Software License][ico-license] , _(*1)

Parse this:, _(*2)

   Root
     |- Level 1.1
       |- Level 2.1
     |- Level 1.2
       |- Level 2.2
         |- Level 3
           |- Level 4

to this:, _(*3)

foreach ($root->children as $child) {
    print $child->name;

    print $child->order;

    print $child->level;

    print_r($child->children);

    print_r($child->children[0]->children);

    print $child->children[0]->parent === $child;
}

Table of Content

• Install
• Usage
  • Advanced
• Change log
• Testing
• Contributing
• Credits
• License

Install

Via Composer, _(*4)

``` bash $ composer require baopham/tree-parser, <sub>(*5)</sub>

## Usage

``` php
// A tree with 2 spaces for indentation
$tree = <<<TREE
  Root
    |- Level 1 - Order 1
      |- Level 2 - Order 2
        |- Level 3 - Order 3
        |- Level 3 - Order 4
      |- Level 2 - Order 5
    |- Level 1 - Order 6
      |- Level 2 - Order 7
        |- Level 3 - Order 8
          |- Level 4 - Order 9
TREE;

$parser = new BaoPham\TreeParser($tree);

$parser->setIndentation(2); // number of spaces for an indentation, 2 is the default.

$root = $parser->parse();

foreach ($root->children as $child) {
    print $child->name;

    print $child->order;

    print $child->level;

    print_r($child->children);

    print_r($child->children[0]->children);

    print $child->children[0]->parent === $child;
}

Advanced

$tree = <<<TREE
  Root
    |- Level 1 - Order 1
      |- Level 2 - Order 2
        |- Level 3 - Order 3
        |- Level 3 - Order 4
      |- Level 2 - Order 5
    |- Level 1 - Order 6
      |- Level 2 - Order 7
        |- Level 3 - Order 8
          |- Level 4 - Order 9
TREE;

$parser = new BaoPham\TreeParser($tree);

$parser->parse();

$structure = $parser->getStructure();

// Get nodes at level 3
$level3Nodes = $structure[3];
// Get node at level 3, order 4
$node = $structure[3][4];

// Get last leaf
$orderedNodes = $parser->getOrderedNodes();
$lastLeaf = $orderedNodes[count($orderedNodes) - 1];

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*6)</sub>

Testing

bash $ composer test, <sub>(*7)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*8)</sub>

Credits

• Bao Pham

License

The MIT License (MIT). Please see License File for more information., <sub>(*9)</sub>