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 文件中

"luckykenlin/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()：检索所有子节点（非递归）。

以下是一个迭代节点子节点的简单示例（假设有一个名为name的属性）

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

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

许可证

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

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

luckykenlin / baum

维护者

详细信息

README

文档

关于嵌套集合

理论背后的内容，简而言之

安装

入门指南

模型配置

迁移配置

用法

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向节点提问

关系

根和叶作用域

访问祖先/后代链

限制返回子节点的层级

自定义排序列

导出层次树

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

作用域支持

验证

树重建

软删除

播种/大量赋值

杂项/实用函数

节点提取查询范围

获取嵌套列值列表

更多信息

贡献

许可证

luckykenlin / baum

维护者

详细信息

README

文档

关于嵌套集合

理论背后的内容，简而言之

安装

入门指南

模型配置

迁移配置

用法

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向节点提问

关系

根和叶作用域

访问祖先/后代链

限制返回子节点的层级

自定义排序列

导出层次树

模型事件： moving 和 moved

作用域支持

验证

树重建

软删除

播种/大量赋值

杂项/实用函数

节点提取查询范围

获取嵌套列值列表

更多信息

贡献

许可证

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