README

从gazsp/baum分叉 - 修复了错误的数据库事务导致的严重错误。

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

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

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

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

错误

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

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 request提交。

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模型在每次节点在Nested Set树中移动时都会触发以下事件：moving和moved。这允许您挂钩到节点移动过程中的这些点。与正常的Eloquent模型事件一样，如果moving事件返回false，则移动操作将被取消。

挂钩到这些事件的推荐方法是使用模型的自带方法

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 是否不为空，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。

软删除

使用软删除/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 = ' ', $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'
// );

贡献

想要贡献？也许你发现了一些严重的错误？这是个好消息！

分支并克隆项目：git clone git@github.com:your-username/baum.git。
运行测试并确保它们在你的设置中通过：phpunit。
创建你的修复/功能分支并开始编写你的更改。为你的更改添加测试。
确保所有测试仍然通过：phpunit。
推送到你的分支并提交一个新的pull请求。

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

许可

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

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

tuimz / baum

维护者

详细信息

README

从gazsp/baum分叉 - 修复了错误的数据库事务导致的严重错误。

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

文档

关于嵌套集

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

安装

入门

模型配置

迁移配置

用法

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向您的节点提问

关系

根和叶作用域

访问谱系/后代链

限制返回子节点级别

自定义排序列

导出层次树

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

作用域支持

验证

重建树

软删除

播种/批量分配

杂项/实用函数

节点提取查询范围

获取嵌套列值列表

更多信息

贡献

许可

tuimz / baum

维护者

详细信息

README

从gazsp/baum分叉 - 修复了错误的数据库事务导致的严重错误。

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

文档

关于嵌套集

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

安装

入门

模型配置

迁移配置

用法

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向您的节点提问

关系

根和叶作用域

访问谱系/后代链

限制返回子节点级别

自定义排序列

导出层次树

模型事件：moving和moved

作用域支持

验证

重建树

软删除

播种/批量分配

杂项/实用函数

节点提取查询范围

获取嵌套列值列表

更多信息

贡献

许可

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