Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smoren/tree-tools-php
PHP library for working with trees
https://github.com/smoren/tree-tools-php
php tree tree-builder tree-structure tree-walker
Last synced: about 1 month ago
JSON representation
PHP library for working with trees
- Host: GitHub
- URL: https://github.com/smoren/tree-tools-php
- Owner: Smoren
- License: mit
- Created: 2023-01-10T14:03:17.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T13:02:03.000Z (almost 2 years ago)
- Last Synced: 2024-09-21T21:24:04.741Z (4 months ago)
- Topics: php, tree, tree-builder, tree-structure, tree-walker
- Language: PHP
- Homepage:
- Size: 19.5 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP Tree Tools
[](https://scrutinizer-ci.com/g/Smoren/tree-tools-php/?branch=master)
[](https://coveralls.io/github/Smoren/tree-tools-php?branch=master)
[](https://opensource.org/licenses/MIT)
Library for working with trees.
## How to install to your project
```
composer require smoren/tree-tools
```
## Quick reference
#### Tree Walker
| Reducer | Description | Code Snippet |
|---------------------------------------------------|--------------------------------------------|------------------------------------------------------------------|
| [`traverseDepthFirst`](#Traverse-Depth-First) | Iterates a tree using depth-first search | `TreeWalker::traverseDepthFirst($data, $childrenContainerKey)` |
| [`traverseBreadthFirst`](#Traverse-Breadth-First) | Iterates a tree using breadth-first search | `TreeWalker::traverseBreadthFirst($data, $childrenContainerKey)` |
#### Tree Builder
| Reducer | Description | Code Snippet |
|-------------------|------------------------------------------|-----------------------------------------------------------------------------------------------------------|
| [`build`](#Build) | Builds a tree from given flat collection | `TreeBuilder::build($collection, $idField, $parentIdField, $childrenContainerField, $itemContainerField)` |
## Usage
### Tree Walker
#### Traverse Depth First
Iterates a tree like a flat collection using depth-first traversal.
```TreeWalker::traverseDepthFirst(iterable $data, ?string $childrenContainerKey = null): Generator```
If `$childrenContainerKey` is not null looks for children items using by this key only.
Otherwise, considers any subarray to contain children.
```php
use Smoren\TreeTools\TreeWalker;
$tree = [
[
'id' => 1,
'children' => [
['id' => 11],
[
'id' => 12,
'children' => [
['id' => 121],
['id' => 122],
],
],
],
],
[
'id' => 2,
'children' => [
['id' => 21],
],
],
['id' => 3],
];
$result = [];
foreach(TreeWalker::traverseDepthFirst($tree) as $item) {
$result[] = $item['id'];
}
var_dump($result);
// [1, 11, 12, 121, 122, 2, 21, 3]
```
#### Traverse Breadth First
Iterates a tree like a flat collection using depth-breadth traversal.
```TreeWalker::traverseBreadthFirst(iterable $data, ?string $childrenContainerKey = null): Generator```
If `$childrenContainerKey` is not null looks for children items using by this key only.
Otherwise, considers any subarray to contain children.
```php
use Smoren\TreeTools\TreeWalker;
$tree = [
[
'id' => 1,
'children' => [
['id' => 11],
[
'id' => 12,
'children' => [
['id' => 121],
['id' => 122],
],
],
],
],
[
'id' => 2,
'children' => [
['id' => 21],
],
],
['id' => 3],
];
$result = [];
foreach(TreeWalker::traverseBreadthFirst($tree) as $item) {
$result[] = $item['id'];
}
var_dump($result);
// [1, 2, 3, 11, 12, 21, 121, 122]
```
### Tree Builder
#### Build
Builds a tree from given flat collection of items with relations.
```
TreeBuilder::build(
iterable $collection,
string $idField = 'id',
string $parentIdField = 'parent_id',
string $childrenContainerField = 'children',
string $itemContainerField = 'item'
): array
```
```php
use Smoren\TreeTools\TreeBuilder;
$input = [
['id' => 1, 'name' => 'Item 1', 'parent_id' => null],
['id' => 2, 'name' => 'Item 1.1', 'parent_id' => 1],
['id' => 3, 'name' => 'Item 1.2', 'parent_id' => 1],
['id' => 4, 'name' => 'Item 1.1.1', 'parent_id' => 2],
['id' => 5, 'name' => 'Item 2', 'parent_id' => null],
['id' => 6, 'name' => 'Item 3', 'parent_id' => null],
['id' => 7, 'name' => 'Item 3.1', 'parent_id' => 6],
['id' => 8, 'name' => 'Item 3.2', 'parent_id' => 6],
];
$tree = TreeBuilder::build($input);
print_r($tree);
/*
[
[
'id' => 1,
'name' => 'Item 1',
'parent_id' => null,
'children' => [
[
'id' => 2,
'name' => 'Item 1.1',
'parent_id' => 1,
'children' => [
[
'id' => 4,
'name' => 'Item 1.1.1',
'parent_id' => 2,
'children' => [],
]
],
],
[
'id' => 3,
'name' => 'Item 1.2',
'parent_id' => 1,
'children' => [],
],
],
],
[
'id' => 5,
'name' => 'Item 2',
'parent_id' => null,
'children' => [],
],
[
'id' => 6,
'name' => 'Item 3',
'parent_id' => null,
'children' => [
[
'id' => 7,
'name' => 'Item 3.1',
'parent_id' => 6,
'children' => [],
],
[
'id' => 8,
'name' => 'Item 3.2',
'parent_id' => 6,
'children' => [],
],
]
],
]
*/
```
## Unit testing
```
composer install
composer test-init
composer test
```
## License
PHP Tree Tools is licensed under the MIT License.