README

从 etrepat/baum 分叉 - 继续开发并修复 Laravel 5.x 的失败单元测试（目前支持 Laravel 5.2 - 5.4）

2.0 版本支持 Laravel 5.5、特性等正在开发中。请查看 feature/2.0 分支以获取更多信息。

如果您发现一个错误，请提交一个问题，并提交一个带有失败单元测试的拉取请求

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

对于 Laravel 4.2.x 兼容性，请查看 1.0.x 分支或使用最新的 1.0.x 标签版本。

文档

关于嵌套集
理论背后的，一个 TL;DR 版本
安装
入门
使用
更多信息
贡献

关于嵌套集

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

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

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

理论背后的，一个 TL;DR 版本

一个简单的方式来可视化嵌套集的工作方式是想象一个父实体包围了它的所有子实体，父实体的父实体包围它，依此类推。所以这个树

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 文件中添加它：

"gazsp/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。
isChildOf($other)：如果此节点是其他节点的子节点，则返回true。
isDescendantOf($other)：如果节点是其他节点的后代，则返回true。
isSelfOrDescendantOf($other)：如果节点是自身或后代，则返回true。
isAncestorOf($other)：如果节点是其他节点的祖先，则返回true。
isSelfOrAncestorOf($other)：如果节点是自身或祖先，则返回true。
equals($node)：当前节点实例等于其他节点。
insideSubtree($node)：检查给定的节点是否在由左索引和右索引定义的子树内。
inSameScope($node)：如果给定的节点与当前节点处于同一作用域，则返回true。也就是说，如果每个作用域属性中的列在两个节点中都有相同的值。

使用上一个示例中的节点

$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`

鲍姆模型触发以下事件：每次节点在嵌套集合树中移动时都会触发 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.
    });
  }

}

作用域支持

鲍姆提供了一个简单的方法来提供嵌套集合“范围”，这限制了我们认为嵌套集合树的一部分的内容。这应该允许在同一个数据库表中存在多个嵌套集合树。

为了使用范围功能，你可以在你的子类中重写 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() 允许你检查你的底层树结构是否正确。它主要检查以下三个方面：

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

所有检查都是 范围感知的，如果需要，将单独检查每个范围。

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

Category::isValidNestedSet()
=> true

树重建

鲍姆支持通过 ::rebuild() 静态方法完全重建（或重新索引）树结构。

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

当索引值出了大问题或当你需要从另一个实现（可能有一个 parent_id 列）转换时，这可能会非常有用。

此操作也是 范围感知的，如果定义了范围，将单独重建所有范围。

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

Category::rebuild()

不会检查树是否已经有效，这意味着调用重建将始终重建树，不管它是否有效。如果你不希望这种行为，如果 isValidNestedSet 返回 true，请不要调用 rebuild。

软删除

不推荐使用软删除 / restore()，如果树在软删除操作后已被修改，可能会导致问题。

种子/批量赋值

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

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 = ' ', $symbol = '');

一个示例用例

$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。
创建您的bug修复/功能分支并开始编写代码。为您的更改添加测试。
确保所有测试仍然通过：phpunit。
将您的分支推送到您的分支并提交新的pull请求。

有关更详细的指南和建议，请参阅CONTRIBUTING.md文件。

许可

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

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

infab / baum

维护者

详细信息

README

从 etrepat/baum 分叉 - 继续开发并修复 Laravel 5.x 的失败单元测试（目前支持 Laravel 5.2 - 5.4）

2.0 版本支持 Laravel 5.5、特性等正在开发中。请查看 feature/2.0 分支以获取更多信息。

文档

关于嵌套集

理论背后的，一个 TL;DR 版本

安装

入门

模型配置

迁移配置

使用

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向您的节点提问

关系

根和叶作用域

访问祖先/后代链

限制返回子节点的级别

自定义排序列

转储层次结构树

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

作用域支持

验证

树重建

软删除

种子/批量赋值

杂项/实用函数

节点提取查询范围

获取嵌套列表的列值

更多信息

贡献

许可

infab / baum

维护者

详细信息

README

从 etrepat/baum 分叉 - 继续开发并修复 Laravel 5.x 的失败单元测试（目前支持 Laravel 5.2 - 5.4）

2.0 版本支持 Laravel 5.5、特性等正在开发中。请查看 feature/2.0 分支以获取更多信息。

文档

关于嵌套集

理论背后的，一个 TL;DR 版本

安装

入门

模型配置

迁移配置

使用

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向您的节点提问

关系

根和叶作用域

访问祖先/后代链

限制返回子节点的级别

自定义排序列

转储层次结构树

模型事件：moving和moved

作用域支持

验证

树重建

软删除

种子/批量赋值

杂项/实用函数

节点提取查询范围

获取嵌套列表的列值

更多信息

贡献

许可

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