README

Tree是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

如您所见，在普通树上递归且速度过慢的查询现在突然变得很快。是不是很巧妙？

安装

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

"sonars/tree": "~1.1"

运行composer install进行安装。

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

'Tree\Providers\TreeServiceProvider',

入门

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

php artisan tree:install MODEL

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

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

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

模型配置

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

这很简单

class Category extends Tree\Node {

}

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

class Dictionary extends Tree\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');

}

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

迁移配置

您必须确保支持您的Tree模型的数据库表具有以下列

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');
  }

}

您可以自由修改列名，前提是在迁移和模型中同时更改它们。

使用

配置完模型并运行迁移后，您现在可以开始使用与模型关联的Tree了。以下是一些示例。

创建根节点
插入节点
删除节点
获取节点的嵌套级别
移动节点
向节点提问
关系
根和叶作用域
访问祖先/后代链
限制返回的子级级别
自定义排序列
转储层次结构树
模型事件：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

移动节点

Tree提供了移动节点的方法

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);

向节点提问

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

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

关系

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

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

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

根和叶作用域

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

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

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

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

$firstRootNode = Category::root();

访问祖先/后代链

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

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

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

其次，作为返回实际 Tree\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}";
}

限制返回的子节点级别

在某些情况下，如果层次深度很大，可能希望限制返回的子节点级别（深度）。您可以通过在 Tree 中使用 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'));

自定义排序列

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

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

protected $orderColumn = 'name';

转储层次结构树

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

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

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

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

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

挂钩到这些事件的最佳方法是使用模型的 boot 方法。

class Category extends Tree\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.
    });
  }

}

作用域支持

Tree 提供了一种简单的方法来实现嵌套集 "作用域"，这限制了我们认为属于嵌套集树的元素。这应该允许在同一数据库表中存在多个嵌套集树。

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

class Category extends Tree\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 即可。

Category::rebuild(true);

软删除

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

目前，您可以将以下操作视为安全的 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）
  - 台式机
  - 显示器
- 手机
健康健身与美容
小家电
大家电

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

杂项/实用函数

节点提取查询范围

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

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文件以获取更详细的指南和建议。

许可

Tree是根据MIT许可证许可的（有关详细信息，请参阅LICENSE文件）。

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

sonars / tree

维护者

详细信息

README

文档

关于嵌套集

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

安装

入门

模型配置

迁移配置

使用

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向节点提问

关系

根和叶作用域

访问祖先/后代链

限制返回的子节点级别

自定义排序列

转储层次结构树

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

作用域支持

验证

重建树

软删除

播种/批量赋值

杂项/实用函数

节点提取查询范围

获取嵌套列值列表

更多信息

贡献

许可

sonars / tree

维护者

详细信息

README

文档

关于嵌套集

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

安装

入门

模型配置

迁移配置

使用

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向节点提问

关系

根和叶作用域

访问祖先/后代链

限制返回的子节点级别

自定义排序列

转储层次结构树

模型事件：moving 和 moved

作用域支持

验证

重建树

软删除

播种/批量赋值

杂项/实用函数

节点提取查询范围

获取嵌套列值列表

更多信息

贡献

许可

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