agroxy / yii2-tree-manager
一个增强的树管理模块,使用嵌套集进行树节点选择和操作。
Requires
README
来自Krajee的一个增强的树管理模块,使用嵌套集进行树节点选择和操作。以下是该扩展的功能列表
- 一个完整的树管理解决方案,能够管理使用嵌套集存储的层次数据。利用yii2-nested-sets扩展来管理数据库中的树结构。在开始使用此模块之前,请参阅yii2-nested-sets扩展的文档。
- 从头开始构建的纯树视图,不使用任何第三方插件。TreeView使用HTML5、jQuery和CSS3功能设计,与Yii PHP框架协同工作。
- 使用CSS3进行样式设计,包括jQuery过渡和用于ajax内容的加载部分,包含嵌入式警报,并使用Bootstrap CSS。
- 树管理功能选项和模式
- 使用TreeView小部件作为选择器和动态渲染的表单来编辑树节点,以查看、编辑或管理树结构
- 该表单既可以作为节点的详细视图,也可以作为管理工具来添加/编辑/删除节点。
- 表单通过ajax渲染。如果相同的节点再次点击(除非节点被修改),则智能地使用缓存。
- 独特的管理员模式,允许在树上执行管理员操作。
- 添加、编辑或删除树节点的能力
- 重新排序树节点(向上、向下、向左或向右移动)的能力。
- 配置树节点图标、样式,以及将复选框添加到树节点的能力
- 在整个模块中启用i18N翻译。
- 包括各种jQuery插件事件,用于在执行各种树操作时触发。
- 额外功能:包括一个名为TreeViewInput的小部件,允许您将树视图用作输入小部件。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类:
- kartik\tree\Module: 模块,允许您配置模块。您必须设置一个名为
treemanager
的模块。请参阅文档以获取详细信息。 - kartik\tree\TreeView: 小部件,允许您在管理员模式或普通用户模式下使用操作和工具栏来添加、编辑、重新排序或删除树节点。
- kartik\tree\TreeViewInput: 小部件,允许您将treeview用作下拉输入,无论是单选还是多选。
- kartik\tree\models\Tree: 模型,整个树数据结构,它使用来自yii2-nested-sets的嵌套集行为来管理树节点。
- kartik\tree\models\TreeQuery: 查询,用于嵌套集模型的查询类。
- kartik\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:准备数据库
创建数据库表以存储树结构。您可以通过以下方式之一完成此操作:
选项 1:运行数据库迁移
您可以从yii编程控制台运行提供的迁移脚本,以从数据库创建结构。
php yii migrate/up --migrationPath=@vendor/kartik-v/yii2-tree-manager/migrations
选项 2:执行SQL脚本
或者,您可以执行SQL脚本以生成您的数据库结构。复制并修改migrations/tree.sql
文件(MySQL示例),以创建表tbl_tree
(或您需要的任何表名)。
注意:您可以向此表添加需要的列,但不能跳过/删除脚本中提到的任何列。如果您选择重命名
id
、root
、lft
、rgt
、lvl
、name
、icon
、icon_type
列,则必须相应地在模块中设置它们。
步骤 2:设置模型
创建用于存储树结构的模型,该模型扩展kartik\tree\models\Tree
类。您还可以从yii\db\ActiveRecord
构建自己的模型,但必须修改它以使用kartik\tree\models\TreeTrait
。您必须在模型中提供表名。可选地,您可以添加规则,或编辑各种方法,如isVisible
、isDisabled
等,以识别节点的允许标志。
因此,当从\kartik\tree\models\Tree
扩展时,您可以设置如下:
namespace frontend\models; use Yii; class Tree extends \kartik\tree\models\Tree { /** * @inheritdoc */ public static function tableName() { return 'tbl_tree'; } }
或者,您可以配置您的模型不扩展kartik\tree\models\Tree
,而是实现和使用kartik\tree\models\TreeTrait
namespace frontend\models; use Yii; class Tree extends \yii\db\ActiveRecord { use kartik\tree\models\TreeTrait. /** * @inheritdoc */ public static function tableName() { return 'tbl_tree'; } }
步骤 3:设置模块
在您的Yii配置文件中模块部分配置名为treemanager
的模块。
'modules' => [ 'treemanager' => [ 'class' => '\kartik\tree\Module', // other module settings, refer detailed documentation ] ]
步骤4:使用TreeView小部件
在您的视图文件中,您现在可以直接使用树视图来管理树数据,如下所示
use kartik\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 kartik\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.md
文件。