README

已废弃 - 请不要再使用！将不再更新。

Baum

从gazsp/baum分支而来 - 修复了错误的数据库事务关键错误。

修复了当同时运行多个INSERT或DELETE操作时破坏嵌套集合的bug。

很难描述和重现，但是需要重建树的操作可能在同时进行时遇到错误。

在修复bug之前，只有树的重建在事务中。实际的操作，例如INSERT或DELETE一个节点不在事务中。

假设一个节点被删除，正在进行的重建...然后几乎在同一时间，第二个节点被删除，第二个重建因为表锁定而停止。之后树被破坏。

错误

应用程序日志显示以下错误。

SQLSTATE[40001]: Serialization failure: 1213 Deadlock found when trying to get lock; try restarting transaction

SQLSTATE[HY000]: General error: 2014 Cannot execute queries while other unbuffered queries are active.  Consider using PDOStatement::fetchAll().  Alternatively, if your code is only ever going to run against mysql, you may enable query buffering by setting the PDO::MYSQL_ATTR_USE_BUFFERED_QUERY attribute.

解决方案

我们通过在第一次写入数据库之前开始新的进一步事务来修复它。我们还需要稍后提交这些事务。因此我们在Node类中覆盖了delete和finishSave方法。

从etrepat/baum分支而来 - 继续开发和修复Laravel 5.x上的失败的单元测试

如果您发现一个bug，请提交一个问题，并提交一个包含失败单元测试的pull请求

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

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

关于嵌套集合

嵌套集合是一种实现有序树（例如，菜单、商业类别）和必须高效查询的大树（例如，线程化帖子）的智能方式。缺点是插入/移动/删除需要复杂的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文件中使用以下代码添加它

"dogado/baum": ">=1.3.0"

运行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:leaves()

您可能对第一个根节点也感兴趣

$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是否不为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时，请不要调用重建。

软删除

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

Seeding/Mass-assignment

由于嵌套集结构通常涉及许多方法调用来构建层次结构（这将导致多个数据库查询），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 = ' ', $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。
创建你的修复/特性分支并编写你的更改。为你的更改添加测试。
确保所有测试仍然通过：phpunit。
推送到你的分叉并提交新的pull请求。

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

许可证

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

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

ttbooking / baum

维护者

详情

README

Baum

从gazsp/baum分支而来 - 修复了错误的数据库事务关键错误。

从etrepat/baum分支而来 - 继续开发和修复Laravel 5.x上的失败的单元测试

文档

关于嵌套集合

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

安装

入门

模型配置

迁移配置

使用方法

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向节点提问

关系

根和叶子作用域

访问祖先/后代链

限制返回的子节点级别

自定义排序列

导出层次树

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

作用域支持

验证

树重建

软删除

Seeding/Mass-assignment

杂项/实用函数

节点提取查询范围

获取嵌套列表的列值

更多信息

贡献

许可证

ttbooking / baum

维护者

详情

README

Baum

从gazsp/baum分支而来 - 修复了错误的数据库事务关键错误。

从etrepat/baum分支而来 - 继续开发和修复Laravel 5.x上的失败的单元测试

文档

关于嵌套集合

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

安装

入门

模型配置

迁移配置

使用方法

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向节点提问

关系

根和叶子作用域

访问祖先/后代链

限制返回的子节点级别

自定义排序列

导出层次树

模型事件：moving和moved

作用域支持

验证

树重建

软删除

Seeding/Mass-assignment

杂项/实用函数

节点提取查询范围

获取嵌套列表的列值

更多信息

贡献

许可证

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