README

Neste 是为 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

如您所见，在普通树上会递归且非常缓慢的查询现在变得非常快。不错，是吧？

安装

Neste 与 Laravel 5 及更高版本兼容。您可以通过以下方式将其添加到您的 composer.json 文件中

composer requier ramiawadallah/neste

运行 composer install 来安装它。

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

'Neste\Providers\NesteServiceProvider',

入门

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

php artisan neste:install MODEL

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

生成器将安装迁移文件和模型文件到您配置的应用程序中，以便与Neste提供的嵌套集行为协同工作。您应该查看这些文件，因为它们各自描述了如何进行自定义。

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

模型配置

为了与Neste协同工作，您必须确保您的模型类扩展了Neste\Node。

这是最简单的实现方式

class Category extends Neste\Node {

}

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

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

}

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

迁移配置

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

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

}

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

使用方法

在您配置了模型并运行了迁移后，您现在可以使用Neste与您的模型一起使用。以下是些示例。

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

移动节点

Neste提供了一些移动节点的方法

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

向您的节点提问

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

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

关系

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

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

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

根和叶作用域

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

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

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

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

$firstRootNode = Category::root();

访问祖先/后代链

有几个Neste提供的方法，可以访问嵌套集合树中节点在祖先/后代链中的位置。需要注意的是，它们以两种方式提供

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

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

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

限制返回子节点的层级

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

自定义排序列

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

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

protected $orderColumn = 'name';

导出层次树

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

将完整的树层次结构检索到一个常规的Collection对象中，并正确嵌套其子节点，就像这样

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

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

Neste模型在节点在Nested Set树中移动时触发以下事件：moving和moved。这允许您在节点移动过程中挂钩。与正常的Eloquent模型事件一样，如果从moving事件中返回false，则移动操作将被取消。

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

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

}

作用域支持

Neste提供了一个简单的方法来提供Nested Set“作用域”，这限制了我们认为属于嵌套集合树的部分。这应该允许在同一个数据库表中存在多个嵌套集合树。

要使用作用域功能，您可以在子类中覆盖scoped模型属性。该属性应包含一个数组，其中包含用于限制Nested Set查询的列名（数据库字段）

class Category extends Neste\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

所有请求或遍历Nested Set树的函数都将使用scoped属性（如果提供）。

请注意，目前不支持在不同作用域之间移动节点。

验证

::isValidNestedSet()静态方法允许您检查您的底层树结构是否正确。它主要检查以下三件事

检查绑定的索引lft、rgt是否不为空，rgt值大于lft且在父节点的边界内（如果设置）。
lft和rgt列值没有重复。
由于第一个检查实际上没有检查根节点，请检查每个根节点是否有其子节点的lft和rgt索引在边界内。

所有检查都是作用域感知的，如果需要，将分别检查每个作用域。

示例用法，给定一个Category节点类

Category::isValidNestedSet()
=> true

树重建

Neste支持通过::rebuild()静态方法进行完整的树结构重建（或重新索引）。

此方法将重新索引所有lft、rgt和depth列的值，只从父节点与子节点的关系角度检查您的树。这意味着您只需要正确填写parent_id列，Neste将尽力重新计算其余部分。

当索引值出了严重问题或者需要从其他实现（可能有一个parent_id列）转换时，这可能非常有用。

此操作也是范围意识的，如果定义了范围，将单独重建所有范围。

简单示例用法，给定一个Category节点类

Category::rebuild()

有效的树（根据isValidNestedSet方法）不会重建。要强制索引重建过程，只需将重建方法的第一参数设为true

Category::rebuild(true);

软删除

Neste对软删除操作的支持有限。我所说的有限是指测试仍然有限，并且软删除功能在框架即将到来的4.2版本中会发生变化，所以请谨慎使用此功能。

目前，您可以将一个restore()操作视为是以下之一

恢复一个叶子节点
恢复一个父节点未软删除的整个子树

播种/批量赋值

由于嵌套集结构通常涉及许多方法调用以构建层次结构（这将导致多个数据库查询），Neste提供了两个方便的方法，可以将提供的节点属性数组映射到其中，并从中创建层次树

buildTree($nodeList)：将提供的节点属性数组映射到数据库中。（静态方法）
makeTree($nodeList)：使用当前节点实例作为提供的子树的父节点，将提供的节点属性数组映射到数据库中。（实例方法）

这两个方法将在主键未提供时创建新节点，在提供时更新或创建，并删除所有不在影响范围中的节点。请理解，对于buildTree静态方法，影响范围是整个嵌套集树，而对于makeTree实例方法，是当前节点的所有后代。

例如，假设我们想要将以下分类层次结构映射到我们的数据库中

电视 & 家庭影院
平板电脑 & 电子阅读器
电脑
- 笔记本电脑
  - PC 笔记本
  - Macbooks (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 笔记本
    - Macbooks (Air/Pro)
  - 台式机
  - 显示器
- 手机
健康与美容
小家电
大型家电

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

杂项/实用函数

节点提取查询范围

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

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/neste.git。
运行测试并确保它们在你的设置中通过： phpunit。
创建你的错误修复/特性分支并开始编写代码。为你的更改添加测试。
确保所有测试仍然通过： phpunit。
将更改推送到你的分支并提交一个新的 pull request。

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

ramiawadallah / neste

维护者

详细信息

README

文档

关于嵌套集

理论背景，简单版本

安装

入门

模型配置

迁移配置

使用方法

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向您的节点提问

关系

根和叶作用域

访问祖先/后代链

限制返回子节点的层级

自定义排序列

导出层次树

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

作用域支持

验证

树重建

软删除

播种/批量赋值

杂项/实用函数

节点提取查询范围

获取嵌套列值的列表

更多信息

贡献

ramiawadallah / neste

维护者

详细信息

README

文档

关于嵌套集

理论背景，简单版本

安装

入门

模型配置

迁移配置

使用方法

创建根节点

插入节点

删除节点

获取节点的嵌套级别

移动节点

向您的节点提问

关系

根和叶作用域

访问祖先/后代链

限制返回子节点的层级

自定义排序列

导出层次树

模型事件：moving和moved

作用域支持

验证

树重建

软删除

播种/批量赋值

杂项/实用函数

节点提取查询范围

获取嵌套列值的列表

更多信息

贡献

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