README

这是一个用于在关系型数据库中处理树形结构的 Laravel 4-5 包。

Laravel 5.5, 5.6 从 v4.3 版本开始支持
Laravel 5.2, 5.3, 5.4 从 v4 版本开始支持
Laravel 5.1 在 v3 版本中支持
Laravel 4 在 v2 版本中支持

尽管这个项目完全免费使用，但我非常感谢任何支持！

通过 PayPal 捐赠

内容

理论
文档
要求
安装

什么是嵌套集合？

嵌套集合或嵌套集合模型是一种在关系型表中有效存储层次化数据的方式。来自维基百科

嵌套集合模型是对节点按树遍历顺序编号，每个节点访问两次，按访问顺序分配编号，并且在两次访问时。这为每个节点留下两个数字，这两个数字作为两个属性存储。查询变得便宜：可以通过比较这些数字来测试层次结构成员资格。更新需要重新编号，因此成本较高。

应用

当树很少更新时，NSM（嵌套集合模型）表现出良好的性能。它经过调整以快速获取相关节点。它非常适合构建多级菜单或商店类别。

文档

假设我们有一个模型 Category；一个 $node 变量是这个模型的实例，也是我们正在操作的节点。它可以是一个新的模型或来自数据库的模型。

关系

节点有以下关系，这些关系完全有效并且可以预加载

节点属于 parent
节点有多个 children
节点有多个 ancestors
节点有多个 descendants

插入节点

移动和插入节点包括多个数据库查询，因此强烈建议使用事务。

重要！从 v4.2.0 版本开始，事务不会自动启动

另一个重要的注意事项是，结构操作将推迟到你在模型上调用 save 的时候（一些方法隐式调用 save 并返回操作的结果布尔值）。

如果模型成功保存，并不意味着节点已移动。如果你的应用程序依赖于节点是否实际改变了位置，请使用 hasMoved 方法

if ($node->save()) {
    $moved = $node->hasMoved();
}

创建节点

当你简单创建一个节点时，它将被追加到树的末尾

Category::create($attributes); // Saved as root

$node = new Category($attributes);
$node->save(); // Saved as root

在这种情况下，该节点被认为是根，这意味着它没有父节点。

将现有节点转换为根节点

// #1 Implicit save
$node->saveAsRoot();

// #2 Explicit save
$node->makeRoot()->save();

节点将被追加到树的末尾。

追加和预置到指定的父节点

如果你想使节点成为其他节点的子节点，你可以将其设置为最后一个或第一个子节点。

在以下示例中，$parent 是某个现有的节点。

有几种方法可以追加节点

// #1 Using deferred insert
$node->appendToNode($parent)->save();

// #2 Using parent node
$parent->appendNode($node);

// #3 Using parent's children relationship
$parent->children()->create($attributes);

// #5 Using node's parent relationship
$node->parent()->associate($parent)->save();

// #6 Using the parent attribute
$node->parent_id = $parent->id;
$node->save();

// #7 Using static method
Category::create($attributes, $parent);

只有几种方法可以预置

// #1
$node->prependToNode($parent)->save();

// #2
$parent->prependNode($node);

在指定节点之前或之后插入

你可以使用以下方法将 $node 设置为 $neighbor 节点的邻居

$neighbor 必须存在，目标节点可以是新的。如果目标节点存在，它将被移动到新位置，如果需要，父节点将更改。

# Explicit save
$node->afterNode($neighbor)->save();
$node->beforeNode($neighbor)->save();

# Implicit save
$node->insertAfterNode($neighbor);
$node->insertBeforeNode($neighbor);

从数组构建树

当在节点上使用静态方法 create 时，它会检查属性中是否包含 children 键。如果包含，则会递归地创建更多节点。

$node = Category::create([
    'name' => 'Foo',

    'children' => [
        [
            'name' => 'Bar',

            'children' => [
                [ 'name' => 'Baz' ],
            ],
        ],
    ],
]);

$node->children 现在包含已创建的子节点列表。

从数组重建树

你可以轻松地重建树。这在大量更改树结构时很有用。

Category::rebuildTree($data, $delete);

$data 是节点数组

$data = [
    [ 'id' => 1, 'name' => 'foo', 'children' => [ ... ] ],
    [ 'name' => 'bar' ],
];

对于名为 foo 的节点，指定了id，这意味着现有的节点将被填充并保存。如果节点不存在，将抛出 ModelNotFoundException。此外，此节点还指定了 children，它也是一个节点数组；它们将以相同的方式处理并保存为 foo 节点的子节点。

节点 bar 没有指定主键，因此它将被创建。

$delete 显示是否删除在 $data 中不存在但已存在的节点。默认情况下，不会删除节点。

重建子树

从4.2.8版本开始，你可以重建子树

Category::rebuildSubtree($root, $data);

这会将树重建限制在 $root 节点的后代。

检索节点

在某些情况下，我们将使用一个 $id 变量，它是目标节点的id。

祖先和后代

祖先形成到节点的父链。对于显示当前分类的面包屑很有用。

后代是子树中的所有节点，即节点的子节点、子节点的子节点等。

祖先和后代都可以进行延迟加载。

// Accessing ancestors
$node->ancestors;

// Accessing descendants
$node->descendants;

可以使用自定义查询加载祖先和后代

$result = Category::ancestorsOf($id);
$result = Category::ancestorsAndSelf($id);
$result = Category::descendantsOf($id);
$result = Category::descendantsAndSelf($id);

在大多数情况下，你需要按级别对祖先进行排序

$result = Category::defaultOrder()->ancestorsOf($id);

可以延迟加载祖先集合

$categories = Category::with('ancestors')->paginate(30);

// in view for breadcrumbs:
@foreach($categories as $i => $category)
    <small>{{ $category->ancestors->count() ? implode(' > ', $category->ancestors->pluck('name')->toArray()) : 'Top Level' }}</small><br>
    {{ $category->name }}
@endforeach

兄弟节点

兄弟节点具有相同父节点的节点。

$result = $node->getSiblings();

$result = $node->siblings()->get();

获取仅下一个兄弟节点

// Get a sibling that is immediately after the node
$result = $node->getNextSibling();

// Get all siblings that are after the node
$result = $node->getNextSiblings();

// Get all siblings using a query
$result = $node->nextSiblings()->get();

获取上一个兄弟节点

// Get a sibling that is immediately before the node
$result = $node->getPrevSibling();

// Get all siblings that are before the node
$result = $node->getPrevSiblings();

// Get all siblings using a query
$result = $node->prevSiblings()->get();

从其他表获取相关模型

想象一下，每个分类 has many 商品。即建立了 HasMany 关系。如何获取 $category 及其所有后代的全部商品？很简单！

// Get ids of descendants
$categories = $category->descendants()->pluck('id');

// Include the id of category itself
$categories[] = $category->getKey();

// Get goods
$goods = Goods::whereIn('category_id', $categories)->get();

包括节点深度

如果你需要知道节点处于哪个级别

$result = Category::withDepth()->find($id);

$depth = $result->depth;

根节点将处于级别0。根节点的子节点将具有级别1，依此类推。

要获取指定级别的节点，可以应用 having 约束

$result = Category::withDepth()->having('depth', '=', 1)->get();

重要！ 在数据库严格模式下，这不会起作用

默认排序

所有节点在内部被严格组织。默认情况下，不应用排序，因此节点可能以随机顺序出现，这不会影响树的显示。你可以按字母或其他索引对节点进行排序。

但在某些情况下，层次顺序是必要的。对于检索祖先和用于排序菜单项很有用。

要应用树排序，使用 defaultOrder 方法

$result = Category::defaultOrder()->get();

你可以以相反的顺序获取节点

$result = Category::reversed()->get();

要移动节点在父节点内部的上或下以影响默认顺序

$bool = $node->down();
$bool = $node->up();

// Shift node by 3 siblings
$bool = $node->down(3);

操作的结果是布尔值，表示节点是否已改变其位置。

约束

可以应用于查询构建器的各种约束

whereIsRoot() 获取仅根节点；
hasParent() 获取非根节点；
whereIsLeaf() 获取仅叶子节点；
hasChildren() 获取非叶子节点；
whereIsAfter($id) 获取每个具有指定id的节点（不仅仅是兄弟节点）之后的所有节点；
whereIsBefore($id) 获取每个在指定id节点之前的所有节点。

后代约束

$result = Category::whereDescendantOf($node)->get();
$result = Category::whereNotDescendantOf($node)->get();
$result = Category::orWhereDescendantOf($node)->get();
$result = Category::orWhereNotDescendantOf($node)->get();
$result = Category::whereDescendantAndSelf($id)->get();

// Include target node into result set
$result = Category::whereDescendantOrSelf($node)->get();

祖先约束

$result = Category::whereAncestorOf($node)->get();
$result = Category::whereAncestorOrSelf($id)->get();

$node 可以是模型的primay key或模型实例。

构建树

在获取一组节点后，你可以将其转换为树。例如

$tree = Category::get()->toTree();

这将填充集合中每个节点上的 parent 和 children 关系，您可以使用递归算法渲染树

$nodes = Category::get()->toTree();

$traverse = function ($categories, $prefix = '-') use (&$traverse) {
    foreach ($categories as $category) {
        echo PHP_EOL.$prefix.' '.$category->name;

        $traverse($category->children, $prefix.'-');
    }
};

$traverse($nodes);

这将输出类似以下的内容

- Root
-- Child 1
--- Sub child 1
-- Child 2
- Another root

构建扁平树

此外，您还可以构建一个扁平树：一个节点列表，其中子节点直接跟在父节点之后。当您获取带有自定义顺序（例如按字母顺序）的节点，且不想使用递归遍历节点时，这很有用。

$nodes = Category::get()->toFlatTree();

上一个例子将输出

Root
Child 1
Sub child 1
Child 2
Another root

获取子树

有时您不需要加载整个树，只需要特定节点的子树。以下示例显示了这种情况

$root = Category::descendantsAndSelf($rootId)->toTree()->first();

在单个查询中，我们获取子树的根节点及其所有可通过 children 关系访问的后代。

如果您不需要 $root 节点本身，请执行以下操作

$tree = Category::descendantsOf($rootId)->toTree($rootId);

删除节点

$node->delete();

重要！该节点具有的所有后代也将被删除！

重要！节点必须作为模型删除，不要尝试使用如下查询删除它们

Category::where('id', '=', $id)->delete();

这将破坏树！

SoftDeletes 特性受支持，也适用于模型级别。

辅助方法

检查节点是否是其他节点的后代

$bool = $node->isDescendantOf($parent);

检查节点是否是根节点

$bool = $node->isRoot();

其他检查

$node->isChildOf($other);
$node->isAncestorOf($other);
$node->isSiblingOf($other);
$node->isLeaf()

检查一致性

您可以检查树是否损坏（即存在一些结构错误）

$bool = Category::isBroken();

可以获取错误统计信息

$data = Category::countErrors();

它将返回一个具有以下键的数组

oddness -- 错误的 lft 和 rgt 值的节点数
duplicates -- 具有相同 lft 或 rgt 值的节点数
wrong_parent -- 具有无效 parent_id 值的节点数，该值不对应于 lft 和 rgt 值
missing_parent -- 具有指向不存在的节点的 parent_id 的节点数

修复树

从 v3.1 版本开始，现在可以修复树。使用 parent_id 列的继承信息，为每个节点设置正确的新 _lft 和 _rgt 值。

Node::fixTree();

范围

想象您有一个 Menu 模型和 MenuItems。在这些模型之间设置了多对一的关系。`MenuItem` 有一个 menu_id 属性用于连接模型。`MenuItem` 包含嵌套集。显然，您会根据 menu_id 属性分别处理每个树。为了做到这一点，您需要将此属性指定为作用域属性。

protected function getScopeAttributes()
{
    return [ 'menu_id' ];
}

但是，现在，为了执行一些自定义查询，您需要提供用于作用域的属性。

MenuItem::scoped([ 'menu_id' => 5 ])->withDepth()->get(); // OK
MenuItem::descendantsOf($id)->get(); // WRONG: returns nodes from other scope
MenuItem::scoped([ 'menu_id' => 5 ])->fixTree(); // OK

当使用模型实例请求节点时，作用域会根据该模型属性自动应用。

$node = MenuItem::findOrFail($id);

$node->siblings()->withDepth()->get(); // OK

使用实例获取作用域查询构建器

$node->newScopedQuery();

作用域和预加载

始终在使用预加载时使用作用域查询。

MenuItem::scoped([ 'menu_id' => 5])->with('descendants')->findOrFail($id); // OK
MenuItem::with('descendants')->findOrFail($id); // WRONG

要求

PHP >= 5.4
Laravel >= 4.1

强烈建议使用支持事务的数据库（如 MySQL 的 InnoDB）来确保树免受可能的损坏。

安装

要在终端中安装此包

composer require kalnoy/nestedset

从头开始设置

模式

Laravel 5.5 及以上版本用户

Schema::create('table', function (Blueprint $table) {
    ...
    $table->nestedSet();
});

// To drop columns
Schema::table('table', function (Blueprint $table) {
    $table->dropNestedSet();
});

Laravel 早期版本用户

...
use Kalnoy\Nestedset\NestedSet;

Schema::create('table', function (Blueprint $table) {
    ...
    NestedSet::columns($table);
});

删除列

...
use Kalnoy\Nestedset\NestedSet;

Schema::table('table', function (Blueprint $table) {
    NestedSet::dropColumns($table);
});

模型

您的模型应使用 Kalnoy\Nestedset\NodeTrait 特性来启用嵌套集。

use Kalnoy\Nestedset\NodeTrait;

class Foo extends Model {
    use NodeTrait;
}

迁移现有数据

从其他嵌套集扩展迁移

如果您的先前扩展使用了不同的列集，您只需要在您的模型类中覆盖以下方法

public function getLftName()
{
    return 'left';
}

public function getRgtName()
{
    return 'right';
}

public function getParentIdName()
{
    return 'parent';
}

// Specify parent id attribute mutator
public function setParentAttribute($value)
{
    $this->setParentIdAttribute($value);
}

从基本父级信息迁移

如果您的树包含 parent_id 信息，您需要向您的模式添加两个列

$table->unsignedInteger('_lft');
$table->unsignedInteger('_rgt');

在设置您的模型之后，您只需修复树以填充 _lft 和 _rgt 列。

MyModel::fixTree();

许可

特此授予任何获得本软件及其相关文档副本（以下简称“软件”）的人士，在不受限制的情况下处理软件的权利，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本，并允许软件的接收者进行此类操作，前提是遵守以下条件

sozidatel79 / nestedset

维护者

详细信息