README

来自Krajee的增强型树管理模块，使用嵌套集进行树节点选择和操作。扩展功能如下：

• 一个完整的树管理解决方案，提供使用嵌套集管理存储的层次数据的权限。利用yii2-nested-sets扩展来管理数据库中的树结构。在开始使用此模块之前，请参阅yii2-nested-sets扩展的文档。
• 完全从头开始构建的树视图，不使用任何第三方插件。TreeView使用HTML5、jQuery和CSS3功能设计，以与Yii PHP框架协同工作。
• 使用CSS3样式，包括jQuery过渡和用于ajax内容的加载部分，包含嵌入式警报，并使用Bootstrap CSS。
• 树管理功能选项和模式
  • 使用TreeView小部件作为选择器和动态渲染的表单来编辑树节点，通过TreeView小部件查看、编辑或管理树结构
  • 该表单既用作节点的详细视图，也用作添加/编辑/删除节点的管理工具。
  • 表单通过ajax渲染。如果再次点击相同的节点（除非节点已修改），它会智能地使用缓存。
  • 独特的管理员模式，允许在树上执行管理员操作。
  • 添加、编辑或删除树节点的功能
  • 重新排序树节点（向上、向下、向左或向右移动）的能力。
  • 配置树节点图标、样式，并将复选框添加到树节点的能力
  • 模块支持i18N翻译。
• 包括各种jQuery插件事件，这些事件在执行各种树操作时被触发。
• 附加功能：包括一个名为 TreeViewInput 的小部件，允许您将TreeView用作输入小部件。TreeViewInput小部件由Krajee独特设计（使用jQuery、PHP以及HTML5/CSS），看起来像一个下拉选择菜单。它允许从树中选择多个值/节点或单个选择。
• 一个基于yii2-nested-set模型的树模型，易于扩展以适应各种用例。它包括每个树节点的预构建标志。有关更多信息，请参阅树模型文档。
• active:树节点是否处于活动状态（如果启用了软删除，则树节点将只是被禁用，而不是从数据库中删除）。
• selected:树节点是否默认选中。
• disabled:禁用树节点以进行编辑或重新排序。
• readonly:只读树节点，防止编辑，但可以重新排序或上下移动。
• visible:树节点是否默认可见。
• collapsed:树节点是否默认折叠。
• movable_u:树节点是否允许向上移动。
• movable_d:树节点是否允许向下移动。
• movable_l:树节点是否允许向左移动。
• movable_r:树节点是否允许向右移动。
• removable:树节点是否可删除 - 如果存在子节点，则不会删除。如果启用了软删除，则节点将被禁用 - 否则从数据库中删除。
• removable_all: 树节点是否可以删除，并且包含子节点。如果启用软删除，则节点及其子节点将被禁用 - 否则将从数据库中删除。

此模块提供以下重要的PHP类：

1. jaclise\tree\Module: 模块，允许您配置模块。您必须设置一个名为 treemanager 的模块。请参阅文档以获取详细信息。
2. jaclise\tree\TreeView: 小部件，允许您在管理模式或普通用户模式下使用操作和工具栏管理树，包括添加、编辑、重新排序或删除树节点。
3. jaclise\tree\TreeViewInput: 小部件，允许您将treeview用作下拉输入，可以是单选或多选。
4. jaclise\tree\models\Tree: 模型，使用来自 yii2-nested-sets 的嵌套集行为管理的整个树数据结构。
5. jaclise\tree\models\TreeQuery: 查询，嵌套集模型所需的查询类。
6. jaclise\tree\controllers\NodeController: 控制器，用于管理每个节点的编辑操作，包括创建、更新、删除或重新排序（移动）。

演示

您可以在 文档 和 TreeView 演示 或 TreeViewInput 演示 中查看该扩展的使用方法。

安装

安装此扩展的首选方式是通过 composer。

注意：请检查此扩展的 composer.json 文件，以了解其要求和依赖项。请阅读有关为您的应用程序的 composer.json 设置 minimum-stability 设置的 网络提示/维基。

运行以下命令之一：

$ php composer.phar require kartik-v/yii2-tree-manager "@dev"

或添加以下内容到您的 composer.json 文件的 require 部分：

"kartik-v/yii2-tree-manager": "@dev"

使用

用法

步骤 1：准备数据库

创建数据库表以存储树结构。复制并修改 schema/tree.sql 文件（MySQL 示例），以创建表 tbl_tree（或您需要的任何表名）。您可以向此表添加所需的列，但不能跳过/删除脚本中提到的任何列。您可以选择重命名 id、root、lft、rgt、lvl、name、icon、icon_type 列，但如果您选择这样做，则必须在模块中相应地设置这些列。

步骤 2：设置模型

创建一个模型以存储树结构，并扩展 jaclise\tree\models\Tree 类。您可以选择从 yii\db\ActiveRecord 扩展自己的模型，但将其修改为使用 jaclise\tree\models\TreeTrait。您必须在模型中提供表名。可选地，您可以添加规则或编辑各种方法，如 isVisible、isDisabled 等，以确定节点的允许标志。

因此，从 \jaclise\tree\models\Tree 扩展时，可以设置如下：

namespace frontend\models;

use Yii;

class Tree extends \jaclise\tree\models\Tree
{
    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return 'tbl_tree';
    }    
}

或者，您可以将模型配置为不扩展 jaclise\tree\models\Tree，而是实现并使用 jaclise\tree\models\TreeTrait

namespace frontend\models;

use Yii;

class Tree extends \yii\db\ActiveRecord
{
    use jaclise\tree\models\TreeTrait.

    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return 'tbl_tree';
    }    
}

步骤 3：设置模块

在您的 Yii 配置文件的模块部分中配置名为 treemanager 的模块。

'modules' => [
   'treemanager' =>  [
        'class' => '\jaclise\tree\Module',
        // other module settings, refer detailed documentation
    ]
]

步骤 4：使用 TreeView 小部件

在您的视图文件中，您现在可以直接使用树视图来管理树数据，如下所示：

use jaclise\tree\TreeView;
echo TreeView::widget([
    // single query fetch to render the tree
    'query'             => Tree::find()->addOrderBy('root, lft'), 
    'headingOptions'    => ['label' => 'Categories'],
    'isAdmin'           => false,                       // optional (toggle to enable admin mode)
    'displayValue'      => 1,                           // initial display value
    //'softDelete'      => true,                        // normally not needed to change
    //'cacheSettings'   => ['enableCache' => true]      // normally not needed to change
]);

步骤 5：使用 TreeViewInput 小部件

如果您想使用树形输入来选择树项，可以使用下面的TreeViewInput小部件。通常，您会将其用作下拉菜单，并将asDropdown属性设置为true。如果将asDropdown设置为false，则树形视图输入小部件将作为内联选项进行渲染。

use jaclise\tree\TreeViewInput;
echo TreeViewInput::widget([
    // single query fetch to render the tree
    'query'             => Tree::find()->addOrderBy('root, lft'), 
    'headingOptions'    => ['label' => 'Categories'],
    'name'              => 'kv-product',    // input name
    'value'             => '1,2,3',         // values selected (comma separated for multiple select)
    'asDropdown'        => true,            // will render the tree input widget as a dropdown.
    'multiple'          => true,            // set to false if you do not need multiple selection
    'fontAwesome'       => true,            // render font awesome icons
    'rootOptions'       => [
        'label' => '<i class="fa fa-tree"></i>', 
        'class'=>'text-success'
    ],                                      // custom root label
    //'options'         => ['disabled' => true],
]);

许可

yii2-tree-manager是在BSD 3-Clause License下发布的。有关详细信息，请参阅附带文件LICENSE.md。