vouga/tree

Library for managing adjacency list and nested set trees

Overview

This library contains some useful methods in managing adjacency lists and nested set trees., _(*1)

This library is still in beta. Most of the functionality works, but still needs improvement and benchmarking. You cannot modify your tree using this library. It's main usefulness at the moment is converting your trees from nested sets to adjacency lists and vice versa., _(*2)

Requirements

• PHP 5.3.0 or greater

Current Features

• Create POPO (plain old PHP objects) from your database trees (adjacency list or nested set)
• Convert your nested set to an adjacency list and vice-versa
• Tighten up a nested set that may be "loose".
• Easily add a level property to your nested set if you don't have one already.
• toArray and fromArray methods to easily add and retrieve your tree

To Do List

• An integrity checker to check the integrity of your tree. Mainly useful for nested sets (ex: left and right domains have gone bad).
• Add toNestedArray method which will return the tree as a nested array instead of a flat array.
• Add, move, delete node functionality. Need to experiment with this a bit to optimize speed.
• Add some unit testing

Basic Example

<?php

include 'vendor/autoload.php';

$sample = array(
    array(
        'id' => 1005,
        'left' => 7,
        'right' => 8
    ),
    array(
        'id' => 1001,
        'left' => 1,
        'right' => 12
    ),
    array(
        'id' => 1002,
        'left' => 2,
        'right' => 9
    ),
    array(
        'id' => 1003,
        'left' => 3,
        'right' => 4
    ),
    array(
        'id' => 1004,
        'left' => 5,
        'right' => 6
    ),
);

// Create a nested set from the sample data
$nested_set = Tree\NestedSet\NestedSet::fromArray($sample);

// The sample data contains some loose left and right domains, let's tighten it up
// NOTE: This method does not do the impossible. If your tree is corrupted, this method won't help.
$nested_set->tighten();

// You now have an adjacency list from your nested set
$adjacency_list = $nested_set->convert();

// You can do the same with your adjacency list and convert it to a nested set
$nested_set2 = $adjacency_list->convert();

// Let's see how our trees look back in array format
var_dump($adjacency_list->toArray());
var_dump($nested_set->toArray());

LICENSE

The MIT License (MIT), _(*3)

Copyright (c) 2013 Vouga Labs, _(*4)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:, _(*5)

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software., _(*6)

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE., _(*7)