README

Baum 是 Laravel 5 Eloquent ORM 的嵌套集模式实现。

Laravel 4.2.x 兼容性，请检查 1.0.x 分支或使用最新的 1.0.x 标签发布。

文档

关于嵌套集
理论的背后，简要版本
安装
入门
用法
更多信息
贡献

关于嵌套集

嵌套集是一种智能的方式来实现一个有序的树，允许进行快速、非递归的查询。例如，你可以通过单个查询获取一个节点的所有子节点，无论树的深度如何。缺点是插入/移动/删除需要复杂的 SQL，但这个包会在幕后处理！

嵌套集适合于有序树（例如菜单、商品分类）和必须高效查询的大树（例如线程帖子）。

有关嵌套集的更多信息，请参阅维基百科条目。此外，这是一个很好的入门教程：http://www.evanpetersen.com/item/nested-sets.html

理论的背后，简要版本

可视化嵌套集如何工作的一个简单方法是想象一个父实体包围所有子实体，父实体的父实体包围它，等等。所以这个树

root
  |_ Child 1
    |_ Child 1.1
    |_ Child 1.2
  |_ Child 2
    |_ Child 2.1
    |_ Child 2.2

可以这样可视化

 ___________________________________________________________________
|  Root                                                             |
|    ____________________________    ____________________________   |
|   |  Child 1                  |   |  Child 2                  |   |
|   |   __________   _________  |   |   __________   _________  |   |
|   |  |  C 1.1  |  |  C 1.2 |  |   |  |  C 2.1  |  |  C 2.2 |  |   |
1   2  3_________4  5________6  7   8  9_________10 11_______12 13  14
|   |___________________________|   |___________________________|   |
|___________________________________________________________________|

数字代表左右边界。然后表格可能看起来像这样

id | parent_id | lft  | rgt  | depth | data
 1 |           |    1 |   14 |     0 | root
 2 |         1 |    2 |    7 |     1 | Child 1
 3 |         2 |    3 |    4 |     2 | Child 1.1
 4 |         2 |    5 |    6 |     2 | Child 1.2
 5 |         1 |    8 |   13 |     1 | Child 2
 6 |         5 |    9 |   10 |     2 | Child 2.1
 7 |         5 |   11 |   12 |     2 | Child 2.2

要获取一个父节点的所有子节点，你可以

SELECT * WHERE lft IS BETWEEN parent.lft AND parent.rgt

要获取子节点的数量，它是

(right - left - 1)/2

要获取一个节点及其所有祖先节点回溯到根节点，你可以

SELECT * WHERE node.lft IS BETWEEN lft AND rgt

如你所见，在普通树上递归和非常慢的查询突然变得非常快。很酷，不是吗？

安装

Baum 与 Laravel 5 及以上版本兼容。您可以通过以下方式将其添加到您的 composer.json 文件中

"baum/baum": "~1.1"

运行 composer install 来安装它。

与大多数 Laravel 5 包一样，您还需要注册 Baum 服务提供者。要做到这一点，请转到您的 config/app.php 文件，并将以下行添加到 providers 数组中

'Baum\Providers\BaumServiceProvider',

入门

包正确安装后，开始使用最简单的方法是运行提供的生成器

php artisan baum:install MODEL

将模型替换为您计划用于嵌套集模型的类名。

生成器会将迁移文件和模型文件安装到您的应用程序中，这些文件配置为使用 Baum 提供的嵌套集行为。您应该查看这些文件，因为每个文件都描述了它们如何进行定制。

接下来，您可能会运行 artisan migrate 来应用迁移。

模型配置

为了与 Baum 一起工作，您必须确保您的模型类扩展 Baum\Node。

这是最简单的方式

class Category extends Baum\Node {

}

这是一个稍微复杂一些的例子，其中列出了自定义的列名

class Dictionary extends Baum\Node {

  protected $table = 'dictionary';

  // 'parent_id' column name
  protected $parentColumn = 'parent_id';

  // 'lft' column name
  protected $leftColumn = 'lidx';

  // 'rgt' column name
  protected $rightColumn = 'ridx';

  // 'depth' column name
  protected $depthColumn = 'nesting';

  // guard attributes from mass-assignment
  protected $guarded = array('id', 'parent_id', 'lidx', 'ridx', 'nesting');

}

请注意，显然，列名必须与数据库表中的列名匹配。

迁移配置

您必须确保支持Baum模型的数据库表包含以下列

parent_id：对父级的引用（整数）
lft：左索引边界（整数）
rgt：右索引边界（整数）
depth：深度或嵌套级别（整数）

以下是一个示例迁移文件

class Category extends Migration {

  public function up() {
    Schema::create('categories', function(Blueprint $table) {
      $table->increments('id');

      $table->integer('parent_id')->nullable();
      $table->integer('lft')->nullable();
      $table->integer('rgt')->nullable();
      $table->integer('depth')->nullable();

      $table->string('name', 255);

      $table->timestamps();
    });
  }

  public function down() {
    Schema::drop('categories');
  }

}

您可以自由修改列名，但需要在迁移和模型中同时更改。

用法

配置好模型并运行迁移后，您现在就可以开始使用Baum了。以下是一些示例。

创建根节点
插入节点
删除节点
获取节点的嵌套级别
移动节点
向节点提问
关系
根和叶作用域
访问祖先/后代链
限制返回的子级级别
自定义排序列
转储层次树
模型事件：moving 和 moved
作用域支持
验证
树重建
软删除
播种/批量赋值
其他/实用函数

创建根节点

默认情况下，所有节点都作为根节点创建

$root = Category::create(['name' => 'Root category']);

或者，您可能需要将现有的节点转换为根节点

$node->makeRoot();

您也可以将其parent_id列置为NULL以实现相同的行为

// This works the same as makeRoot()
$node->parent_id = null;
$node->save();

插入节点

// Directly with a relation
$child1 = $root->children()->create(['name' => 'Child 1']);

// with the `makeChildOf` method
$child2 = Category::create(['name' => 'Child 2']);
$child2->makeChildOf($root);

删除节点

$child1->delete();

被删除节点的后代也将被删除，并且所有的lft和rgt边界将重新计算。请注意，目前不会触发后代deleting和deleted模型事件。

获取节点的嵌套级别

getLevel()方法将返回节点的当前嵌套级别或深度。

$node->getLevel() // 0 when root

移动节点

Baum提供了一些方法来移动节点。

moveLeft()：找到左兄弟并将其移动到左边。
moveRight()：找到右兄弟并将其移动到右边。
moveToLeftOf($otherNode)：移动到...的左侧节点。
moveToRightOf($otherNode)：移动到...的右侧节点。
makeNextSiblingOf($otherNode)：是moveToRightOf的别名。
makeSiblingOf($otherNode)：是makeNextSiblingOf的别名。
makePreviousSiblingOf($otherNode)：是moveToLeftOf的别名。
makeChildOf($otherNode)：将节点作为...的子节点。
makeFirstChildOf($otherNode)：将节点作为...的第一个子节点。
makeLastChildOf($otherNode)：是makeChildOf的别名。
makeRoot()：将当前节点作为根节点。

例如

$root = Creatures::create(['name' => 'The Root of All Evil']);

$dragons = Creatures::create(['name' => 'Here Be Dragons']);
$dragons->makeChildOf($root);

$monsters = new Creatures(['name' => 'Horrible Monsters']);
$monsters->save();

$monsters->makeSiblingOf($dragons);

$demons = Creatures::where('name', '=', 'demons')->first();
$demons->moveToLeftOf($dragons);

向节点提问

您可以向Baum节点提出一些问题

isRoot()：如果这是根节点则返回true。
isLeaf()：如果这是叶节点（分支的末尾）则返回true。
isChild()：如果这是子节点则返回true。
isDescendantOf($other)：如果节点是其他节点的后代则返回true。
isSelfOrDescendantOf($other)：如果节点是自身或后代则返回true。
isAncestorOf($other)：如果节点是其他节点的祖先则返回true。
isSelfOrAncestorOf($other)：如果节点是自身或祖先则返回true。
equals($node)：当前节点实例等于其他。
insideSubtree($node)：检查给定节点是否在由左和右索引定义的子树中。
inSameScope($node)：如果给定节点与当前节点具有相同的范围则返回true。也就是说，如果每个在scoped属性中的列在两个节点中都有相同的值。

使用前面的示例中的节点

$demons->isRoot(); // => false

$demons->isDescendantOf($root) // => true

关系

Baum为您的节点提供了两个自引用Eloquent关系：parent和children。

$parent = $node->parent()->get();

$children = $node->children()->get();

根和叶作用域

Baum提供了一些基本的查询作用域来访问根和叶节点

// Query scope which targets all root nodes
Category::roots()

// All leaf nodes (nodes at the end of a branch)
Category:allLeaves()

您可能还感兴趣的是第一个根节点

$firstRootNode = Category::root();

访问祖先/后代链

Baum提供了几种方法来访问嵌套集树中节点的祖先/后代链。需要注意的是，它们以两种方式提供

首先作为 查询作用域，返回一个 Illuminate\Database\Eloquent\Builder 实例以继续进行查询。要从这些作用域中获取实际的结果，请记得调用 get() 或 first()。

ancestorsAndSelf()：目标包括当前在内的所有祖先链节点。
ancestors()：查询不包括当前在内的祖先链节点。
siblingsAndSelf()：实例作用域，目标为父级的所有子节点，包括自身。
siblings()：实例作用域，目标为父级的所有子节点，除了自身。
leaves()：实例作用域，目标为其嵌套子节点，这些子节点没有子节点。
descendantsAndSelf()：作用域，目标为自己及其所有嵌套子节点。
descendants()：所有子节点和嵌套子节点集合。
immediateDescendants()：所有子节点集合（非递归）。

其次，作为返回实际 Baum\Node 实例（在适当的 Collection 对象中）的方法

getRoot()：返回从当前节点开始的根节点。
getAncestorsAndSelf()：检索包括当前节点在内的所有祖先链。
getAncestorsAndSelfWithoutRoot()：所有祖先（包括当前节点），但不包括根节点。
getAncestors()：从数据库中获取所有祖先链，不包括当前节点。
getAncestorsWithoutRoot()：不包括当前节点和根节点的所有祖先。
getSiblingsAndSelf()：获取包括自身在内的所有父级子节点。
getSiblings()：返回所有父级子节点，除了自身。
getLeaves()：返回所有嵌套子节点，这些子节点没有子节点。
getDescendantsAndSelf()：检索所有嵌套子节点和自身。
getDescendants()：检索所有子节点和嵌套子节点。
getImmediateDescendants()：检索所有子节点（非递归）。

以下是一个简单的示例，用于迭代节点的后代（假设有一个名称属性可用）

$node = Category::where('name', '=', 'Books')->first();

foreach($node->getDescendantsAndSelf() as $descendant) {
  echo "{$descendant->name}";
}

限制返回子节点的级别

在某些情况下，如果层次结构的深度很大，可能希望限制返回的子节点级别的数量（深度）。您可以在 Baum 中通过使用 limitDepth 查询作用域来实现这一点。

以下代码片段将获取当前节点的后代，最多向下5个深度级别

$node->descendants()->limitDepth(5)->get();

同样，您可以通过将所需的深度限制作为第一个参数提供，使用 getDescendants 和 getDescendantsAndSelf 方法限制后代级别。

// This will work without depth limiting
// 1. As usual
$node->getDescendants();
// 2. Selecting only some attributes
$other->getDescendants(array('id', 'parent_id', 'name'));
...
// With depth limiting
// 1. A maximum of 5 levels of children will be returned
$node->getDescendants(5);
// 2. A max. of 5 levels of children will be returned selecting only some attrs
$other->getDescendants(5, array('id', 'parent_id', 'name'));

自定义排序列

默认情况下，在 Baum 中所有结果都是按 lft 索引列的值排序的，以确保一致性。

如果您希望更改此默认行为，您需要在模型中指定您希望用于排序结果的列名，如下所示

protected $orderColumn = 'name';

转储层次树

Baum 扩展了默认的 Eloquent\Collection 类，并为其提供了 toHierarchy 方法，该方法返回表示查询树的嵌套集合。

将完整的树层次结构检索到带有其子节点的常规 Collection 对象中（子节点正确嵌套）非常简单

$tree = Category::where('name', '=', 'Books')->first()->getDescendantsAndSelf()->toHierarchy();

模型事件：`moving` 和 `moved`

Baum 模型在每次节点在嵌套集树中移动时都会触发以下事件：每次移动节点时都会触发 moving 和 moved。这允许您在节点移动过程中挂钩这些点。与正常的 Eloquent 模型事件一样，如果 moving 事件返回 false，则移动操作将被取消。

挂钩这些事件的建议方法是使用模型的 boot 方法

class Category extends Baum\Node {

  public static function boot() {
    parent::boot();

    static::moving(function($node) {
      // Before moving the node this function will be called.
    });

    static::moved(function($node) {
      // After the move operation is processed this function will be
      // called.
    });
  }

}

作用域支持

Baum 提供了一个简单的方法来提供嵌套集 "作用域"，这限制了我们将什么视为嵌套集树的一部分。这应该允许在同一个数据库表中存在多个嵌套集树。

要使用作用域功能，您可以在子类中重写 scoped 模型属性。该属性应包含一个列名（数据库字段）数组，用于限制嵌套集查询。

class Category extends Baum\Node {
  ...
  protected $scoped = array('company_id');
  ...
}

在上一个示例中，company_id 有效地限制了（或“作用域”）嵌套集树。因此，对于该字段的每个值，我们都可以构建一个完全不同的树。

$root1 = Category::create(['name' => 'R1', 'company_id' => 1]);
$root2 = Category::create(['name' => 'R2', 'company_id' => 2]);

$child1 = Category::create(['name' => 'C1', 'company_id' => 1]);
$child2 = Category::create(['name' => 'C2', 'company_id' => 2]);

$child1->makeChildOf($root1);
$child2->makeChildOf($root2);

$root1->children()->get(); // <- returns $child1
$root2->children()->get(); // <- returns $child2

所有询问或遍历嵌套集树的方法都将使用 scoped 属性（如果提供）。

请注意，目前不支持在作用域之间移动节点。

验证

::isValidNestedSet() 静态方法允许您检查您的底层树结构是否正确。它主要检查以下3件事

检查绑定索引 lft、rgt 是否不为空，rgt 值大于 lft 并且在父节点（如果设置）的范围内。
没有重复的 lft 和 rgt 列值。
由于第一个检查实际上没有检查根节点，请检查每个根节点是否具有在子节点范围内的 lft 和 rgt 索引。

所有检查都是 作用域感知 的，并且如果需要，将分别检查每个作用域。

示例用法，给定一个 Category 节点类

Category::isValidNestedSet()
=> true

树重建

Baum 支持通过 ::rebuild() 静态方法进行完整的树结构重建（或重新索引）。

此方法将重新索引所有 lft、rgt 和 depth 列值，仅从父 <-> 子关系的角度检查您的树。这意味着您只需要一个正确填充的 parent_id 列，Baum 将尽力重新计算其余部分。

当索引值出现严重问题时，这非常有用，或者当需要转换到另一个实现（可能有一个 parent_id 列）时，它可能非常有用。

此操作也是 作用域感知 的，如果定义了作用域，将分别重建所有作用域。

简单示例用法，给定一个 Category 节点类

Category::rebuild()

有效的树（根据 isValidNestedSet 方法）将不会重建。要强制索引重建过程，只需将重建方法的第一参数设置为 true。

Category::rebuild(true);

软删除

Baum 对软删除操作提供 有限支持。我所说的有限是指测试仍然有限，并且 软删除 功能将在框架的即将发布的 4.2 版本中发生变化，因此请明智地使用此功能。

目前，您可以考虑安全的 restore() 操作为以下之一

恢复一个叶节点
恢复一个父节点未被软删除的整个子树

种子/批量赋值

由于嵌套集结构通常涉及多个方法调用来构建层次结构（这将导致多个数据库查询），Baum 提供了两个方便的方法，这些方法将映射提供的节点属性数组，并从中创建层次树

buildTree($nodeList)：(静态方法) 将提供的节点属性数组映射到数据库中。
makeTree($nodeList)：(实例方法) 使用当前节点实例作为提供的子树的父节点，将提供的节点属性数组映射到数据库中。

这两个方法都会在主键未提供时创建新节点，如果提供了主键，则更新或创建，并删除所有不在 影响作用域 中的节点。请理解，对于 buildTree 静态方法，影响作用域 是整个嵌套集树，对于 makeTree 实例方法，是当前节点所有后代。

例如，假设我们想将以下类别层次结构映射到我们的数据库中

电视 & 家庭影院
平板电脑 & 电子阅读器
电脑
- 笔记本电脑
  - PC 笔记本
  - Macbook（Air/Pro）
- 台式机
- 显示器
手机

这可以通过以下代码轻松完成

$categories = [
  ['id' => 1, 'name' => 'TV & Home Theather'],
  ['id' => 2, 'name' => 'Tablets & E-Readers'],
  ['id' => 3, 'name' => 'Computers', 'children' => [
    ['id' => 4, 'name' => 'Laptops', 'children' => [
      ['id' => 5, 'name' => 'PC Laptops'],
      ['id' => 6, 'name' => 'Macbooks (Air/Pro)']
    ]],
    ['id' => 7, 'name' => 'Desktops'],
    ['id' => 8, 'name' => 'Monitors']
  ]],
  ['id' => 9, 'name' => 'Cell Phones']
];

Category::buildTree($categories) // => true

之后，我们可以根据需要更新层次结构。

$categories = [
  ['id' => 1, 'name' => 'TV & Home Theather'],
  ['id' => 2, 'name' => 'Tablets & E-Readers'],
  ['id' => 3, 'name' => 'Computers', 'children' => [
    ['id' => 4, 'name' => 'Laptops', 'children' => [
      ['id' => 5, 'name' => 'PC Laptops'],
      ['id' => 6, 'name' => 'Macbooks (Air/Pro)']
    ]],
    ['id' => 7, 'name' => 'Desktops', 'children' => [
      // These will be created
      ['name' => 'Towers Only'],
      ['name' => 'Desktop Packages'],
      ['name' => 'All-in-One Computers'],
      ['name' => 'Gaming Desktops']
    ]]
    // This one, as it's not present, will be deleted
    // ['id' => 8, 'name' => 'Monitors'],
  ]],
  ['id' => 9, 'name' => 'Cell Phones']
];

Category::buildTree($categories); // => true

makeTree 实例方法的工作方式与此类似。唯一的区别是它只对调用节点实例的后代执行操作。

现在假设我们在数据库中已经有了以下层次结构

电子产品
健康与美容
小家电
大家电

如果我们执行以下代码

$children = [
  ['name' => 'TV & Home Theather'],
  ['name' => 'Tablets & E-Readers'],
  ['name' => 'Computers', 'children' => [
    ['name' => 'Laptops', 'children' => [
      ['name' => 'PC Laptops'],
      ['name' => 'Macbooks (Air/Pro)']
    ]],
    ['name' => 'Desktops'],
    ['name' => 'Monitors']
  ]],
  ['name' => 'Cell Phones']
];

$electronics = Category::where('name', '=', 'Electronics')->first();
$electronics->makeTree($children); // => true

将得到以下结果

电子产品
- 电视 & 家庭影院
- 平板电脑 & 电子阅读器
- 电脑
  - 笔记本电脑
    - PC 笔记本
    - Macbook（Air/Pro）
  - 台式机
  - 显示器
- 手机
健康与美容
小家电
大家电

更新和删除子树中的节点的工作方式相同。

其他/实用函数

节点提取查询范围

Baum 提供了一些查询范围，可以用来从当前结果集中提取（移除）选定的节点。

withoutNode(node)：从当前结果集中提取指定的节点。
withoutSelf()：从当前结果集中提取自身。
withoutRoot()：从结果集中提取当前根节点。

$node = Category::where('name', '=', 'Some category I do not want to see.')->first();

$root = Category::where('name', '=', 'Old boooks')->first();
var_dump($root->descendantsAndSelf()->withoutNode($node)->get());
... // <- This result set will not contain $node

获取嵌套列表的列值

::getNestedList() 静态方法返回一个键值对数组，表示节点的深度。对于填充 select 元素等非常有用。

它期望返回列名，可选：用作数组键的列（如果没有提供，将使用 id）和/或分隔符

public static function getNestedList($column, $key = null, $seperator = ' ');

一个示例用法

$nestedList = Category::getNestedList('name');
// $nestedList will contain an array like the following:
// array(
//   1 => 'Root 1',
//   2 => ' Child 1',
//   3 => ' Child 2',
//   4 => '  Child 2.1',
//   5 => ' Child 3',
//   6 => 'Root 2'
// );

贡献

想要贡献吗？也许你发现了一些讨厌的 bug？这是个好消息！

创建并克隆项目： git clone git@github.com:your-username/baum.git。
运行测试并确保它们在你的配置下通过： phpunit。
创建你的修复/特性分支并编写你的更改。为你的更改添加测试。
确保所有测试仍然通过： phpunit。
将更改推送到你的分支并提交新的 pull request。

请参阅 CONTRIBUTING.md 文件以获取更详细的指南和建议。

许可证

Baum 在 MIT 许可证的条款下授权（有关详细信息，请参阅 LICENSE 文件）。

由 Estanislau Trepat (etrepat) 编码。我还在 twitter 上 @etrepat。

vishalmandora/baum

维护者

详细信息

README

文档

关于嵌套集

理论的背后，简要版本

安装

入门

模型配置

迁移配置

用法

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向节点提问

关系

根和叶作用域

访问祖先/后代链

限制返回子节点的级别

自定义排序列

转储层次树

模型事件：`moving` 和 `moved`

作用域支持

验证

树重建

软删除

种子/批量赋值

其他/实用函数

节点提取查询范围

获取嵌套列表的列值

更多信息

贡献

许可证

vishalmandora/baum

维护者

详细信息

README

文档

关于嵌套集

理论的背后，简要版本

安装

入门

模型配置

迁移配置

用法

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向节点提问

关系

根和叶作用域

访问祖先/后代链

限制返回子节点的级别

自定义排序列

转储层次树

模型事件：moving 和 moved

作用域支持

验证

树重建

软删除

种子/批量赋值

其他/实用函数

节点提取查询范围

获取嵌套列表的列值

更多信息

贡献

许可证

模型事件：`moving` 和 `moved`