README

Baum是实现嵌套集模式（Nested Set）的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：对父节点的引用（int）
lft：左索引边界（int）
rgt：右索引边界（int）
depth：深度或嵌套级别（int）

以下是一个示例迁移文件

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 列设为空以实现相同的行为

// 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() 静态方法允许您检查您的基础树结构是否正确。它主要检查以下三件事：

检查边界索引 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 作为第一个参数调用 rebuild 方法。

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

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

许可证

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

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

seedgabo / baum

维护者

详细信息

README

文档

关于嵌套集

理论背后的简要说明

安装

入门

模型配置

迁移配置

使用方法

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向您的节点提问

关系

根和叶作用域

访问祖先/后代链

限制返回子节点的层级

自定义排序列

转储层次结构树

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

作用域支持

验证

树重建

软删除

初始化/大量赋值

杂项/实用函数

节点提取查询范围

获取嵌套列值列表

更多信息

贡献

许可证

seedgabo / baum

维护者

详细信息

README

文档

关于嵌套集

理论背后的简要说明

安装

入门

模型配置

迁移配置

使用方法

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向您的节点提问

关系

根和叶作用域

访问祖先/后代链

限制返回子节点的层级

自定义排序列

转储层次结构树

模型事件： moving 和 moved

作用域支持

验证

树重建

软删除

初始化/大量赋值

杂项/实用函数

节点提取查询范围

获取嵌套列值列表

更多信息

贡献

许可证

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