Outputs¶

use Ghispi\TreeTransform\Tree;

require __DIR__ . '/../vendor/autoload.php';

$rows = [
    ['id' => 1, 'title' => 'Clothing', 'lft' => 1, 'rgt' => 6],
    ['id' => 2, 'title' => 'Men',      'lft' => 2, 'rgt' => 3],
    ['id' => 3, 'title' => 'Women',    'lft' => 4, 'rgt' => 5],
];
$tree = Tree::fromNestedSet($rows)->map(fn(array $row) => ['id' => $row['id'], 'title' => $row['title']]);

echo "Default: every node gets a 'children' key\n";
echo json_encode($tree->toNestedArray()), "\n\n";

echo "omitEmptyChildren: true\n";
echo json_encode($tree->toNestedArray(omitEmptyChildren: true)), "\n\n";

echo "childrenField: '__children' (same shape as Gedmo buildTree())\n";
echo json_encode($tree->toNestedArray(childrenField: '__children')), "\n\n";

echo "nodeFactory: build any shape\n";
echo json_encode($tree->toNestedArray(nodeFactory: fn(array $node, array $children, int $depth) => [
    'text' => $node['title'],
    'level' => $depth,
    'nodes' => $children,
])), "\n";

use Ghispi\TreeTransform\Sink\TreeNode;
use Ghispi\TreeTransform\Tree;

require __DIR__ . '/../vendor/autoload.php';

final readonly class Page
{
    public function __construct(
        public string $title,
        public string $path,
    ) {}
}

$pages = [
    new Page('About', '/about'),
    new Page('Team', '/about/team'),
    new Page('Jobs', '/about/jobs'),
    new Page('Blog', '/blog'),
];

// Objects are never modified: each one is wrapped in a TreeNode with its children.
$roots = Tree::fromMaterializedPath($pages, new Ghispi\TreeTransform\Source\MaterializedPathFields(separator: '/'))
    ->toNestedArray();

foreach ($roots as $root) {
    assert($root instanceof TreeNode);
    echo $root->node->title, ' (', count($root), ' children, leaf: ', var_export($root->isLeaf(), true), ")\n";
    foreach ($root as $child) { // iterates the direct children
        assert($child instanceof TreeNode);
        echo '  ', $child->node->title, "\n";
    }
}

use Ghispi\TreeTransform\Tree;

require __DIR__ . '/../vendor/autoload.php';

$rows = require __DIR__ . '/support/shop.php';

$tree = Tree::fromNestedSet($rows)->maxDepth(2);

// Keys are depths and repeat, so loop with foreach. iterator_to_array() would keep only one node per depth.
foreach ($tree->iterate() as $depth => $category) {
    echo str_repeat('    ', $depth), $category['title'], "\n";
}

// A Tree is iterable itself: foreach ($tree as $depth => $node) does the same.
echo "\nNodes: ", $tree->count(), "\n";

use Ghispi\TreeTransform\Tree;

require __DIR__ . '/../vendor/autoload.php';

$rows = require __DIR__ . '/support/shop.php';

// A sitemap that does not descend into Electronics: send(true) instead of next() skips the current node's subtree.
// The source skips those rows without reading them further.
$nodes = Tree::fromNestedSet($rows)->iterate();
while ($nodes->valid()) {
    $depth = $nodes->key();
    $category = $nodes->current();
    echo str_repeat('    ', $depth), $category['title'], "\n";

    if ($category['title'] === 'Electronics') {
        $nodes->send(true);
    } else {
        $nodes->next();
    }
}

use Ghispi\TreeTransform\Tree;

require __DIR__ . '/../vendor/autoload.php';

$rows = require __DIR__ . '/support/shop.php';

$list = Tree::fromNestedSet($rows)
    ->maxDepth(1)
    ->map(fn(array $c) => $c['title'])
    ->toFlatList();

var_export($list);
echo "\n";

// Tree::fromFlatList() reads the same shape back.
echo implode(' / ', iterator_to_array(Tree::fromFlatList($list)->depthWindow(1)->iterate(), false)), "\n";

use Ghispi\TreeTransform\Source\AdjacencyListFields;
use Ghispi\TreeTransform\Strategy\Promote;
use Ghispi\TreeTransform\Tree;

require __DIR__ . '/../vendor/autoload.php';

$rows = require __DIR__ . '/support/shop.php';

// Only categories with products, moved up to the nearest kept ancestor: parents are rewritten.
$list = Tree::fromNestedSet($rows)
    ->filter(fn(array $c) => $c['products'] > 0, new Promote())
    ->map(fn(array $c) => ['id' => $c['id'], 'title' => $c['title']])
    ->toAdjacencyList(new AdjacencyListFields('id', 'parent_id'), rootParent: 0);

foreach ($list as $row) {
    printf("%-3d %-8s parent_id: %d\n", $row['id'], $row['title'], $row['parent_id']);
}

// Objects cannot get a parent field set; build the row with a factory instead.
$pairs = Tree::fromNestedSet($rows)
    ->maxDepth(1)
    ->toAdjacencyList(nodeFactory: fn(array $c, int|string|null $parentId, int $depth) => "{$c['id']}->" . ($parentId ?? 'null'));
echo "\n", implode(', ', $pairs), "\n";

use Ghispi\TreeTransform\Source\NestedSetFields;
use Ghispi\TreeTransform\Tree;

require __DIR__ . '/../vendor/autoload.php';

$rows = require __DIR__ . '/support/shop.php';

// Drop the Electronics branch and renumber: left/right/level are recomputed for the result.
$rows = Tree::fromNestedSet($rows)
    ->filter(fn(array $c) => $c['slug'] !== 'electronics')
    ->maxDepth(1)
    ->map(fn(array $c) => ['id' => $c['id'], 'title' => $c['title']])
    ->toNestedSet(new NestedSetFields(left: 'lft', right: 'rgt', level: 'lvl'), levelBase: 0);

foreach ($rows as $row) {
    printf("%-2d %-9s lft %2d  rgt %2d  lvl %d\n", $row['id'], $row['title'], $row['lft'], $row['rgt'], $row['lvl']);
}

// Several roots numbered from 1 each, with the id of each node's new root (Gedmo with a TreeRoot column).
$forest = Tree::fromNestedSet(require __DIR__ . '/support/shop.php')
    ->depthWindow(1, 1)
    ->map(fn(array $c) => ['id' => $c['id'], 'title' => $c['title']])
    ->toNestedSet(new NestedSetFields(root: 'root'));
echo "\n";
foreach ($forest as $row) {
    echo "{$row['title']}: {$row['lft']}..{$row['rgt']} root {$row['root']}\n";
}

$visibleCategories = Tree::fromNestedSet($rows)->filter($isVisible)->count();