dbeurive/tree

This package contains a list of PHP utilities used to manipulate trees

1.0.4 2016-07-07 09:20 UTC

MIT

• Denis BEURIVE

• tree

README

This package implements various tree utilities.

Installation

From the command line:

composer require dbeurive/tree

From your composer.json file:

{
    "require": {
        "dbeurive/tree": "1.0.*"
    }
}

API documentation

The detailed documentation of the API can be extracted from the code by using PhpDocumentor. The file phpdoc.xml contains the required configuration for PhpDocumentor. To generate the API documentation, just move into the root directory of this package and run PhpDocumentor from this location.

Note:

Since all the PHP code is documented using PhpDoc annotations, you should be able to exploit the auto completion feature from your favourite IDE. If you are using Eclipse, NetBeans or PhPStorm, you probably won’t need to consult the generated API documentation.

Since the API is quite simple and intuitive, the present document presents examples of code. These examples are located under the directory examples.

Examples

All examples are based on the tree which structure is represented by the figure below.

treeObject.php: this example shows how to create a tree using the tree builder. It creates an instance of class \dbeurive\Tree\Tree.

treeArray.php: this example illustrates the procedure to create a tree (an object of class \dbeurive\Tree\Tree) from an array of imbricated arrays.

treeObjectTraverse.php: this example shows how to traverse a tree that is an object of class \dbeurive\Tree\Tree.

treeArrayTravserse.php: this example shows how to traverse a tree represented by an array of imbricated arrays.

search.php: this example shows how to search for a node's data within the entire tree.

treeObjectToArray.php: this example shows how to convert a tree defined as an object of class \dbeurive\Tree\Tree into the "array representation" (an array of imbricated arrays).

treeToDot.php: this example shows how to produce a "GRAPHVIZ" representation of a tree.

treeObjectTraverseSerialize.php: this example shows how to use objects (instead of scalars) as nodes' data. We create a tree that contains objects. Then we traverse the tree and we serialise all nodes. Please note that the tree is represented by an object of class \dbeurive\Tree\Tree.

treeArrayTravserseSerialize.php: this example shows how to use objects (instead of scalars) as nodes' data. We create a tree that contains objects. Then we traverse the tree and we serialise all nodes. Please note that the tree is represented by an array of imbricated arrays.

treeIndex.php: this example shows how to create an index that references all nodes within the tree. Indexes are generated from the nodes' data. Please note that, in this example, we assume that all nodes have a unique data value.

treeIndexMulti.php: this example shows how to create an index that references all nodes within the tree. Indexes are generated from the nodes' data. Please note that, in this example, we assume that multiple nodes may have the same data value.

treeSelect.php: this example shows how to select nodes based on their data's values.

treeSearch.php: this example shows how search for nodes with given values.

nodes.php: this example illustrates various operations on nodes.