README

为Yii 2的Admin包

此扩展提供控制器、操作、小部件和其他工具，用于在Yii2项目中创建管理面板。

有关许可证信息，请参阅LICENSE文件。

安装

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

运行以下命令

php composer.phar require --prefer-dist yii2tech/admin

或者

"yii2tech/admin": "*"

将以下内容添加到您的composer.json的require部分。

使用

此扩展为Yii2项目中创建管理面板提供控制器、操作、小部件和其他工具。这些工具旨在协同使用，以快速构建网络应用的管理面板。

此软件包支持以下扩展的使用

• yii2tech/ar-position
• yii2tech/ar-role
• yii2tech/ar-search
• yii2tech/ar-softdelete
• yii2tech/ar-variation

注意：默认情况下，这些扩展都不是必需的，如果需要，您需要自己安装它们。

操作

此扩展提供了一些独立的行为类，提供了特定的操作支持

• [[\yii2tech\admin\actions\Index]] - 显示带有搜索支持的模型列表。
• [[\yii2tech\admin\actions\Create]] - 支持使用Web表单创建新的模型。
• [[\yii2tech\admin\actions\Update]] - 支持使用Web表单更新现有模型。
• [[\yii2tech\admin\actions\Delete]] - 执行现有记录的删除操作。
• [[\yii2tech\admin\actions\View]] - 显示现有模型。
• [[\yii2tech\admin\actions\SoftDelete]] - 执行现有记录的“软”删除。
• [[\yii2tech\admin\actions\SafeDelete]] - 执行现有记录的“安全”删除。
• [[\yii2tech\admin\actions\Restore]] - 执行已“软”删除的记录的恢复。
• [[\yii2tech\admin\actions\Callback]] - 允许调用模型的指定方法。
• [[\yii2tech\admin\actions\Position]] - 允许更改特定模型的自定义排序位置。
• [[\yii2tech\admin\actions\VariationCreate]] - 支持使用Web表单创建带有变体的新模型。
• [[\yii2tech\admin\actions\VariationUpdate]] - 支持使用Web表单更新带有变体的新模型。
• [[\yii2tech\admin\actions\RoleCreate]] - 支持使用Web表单创建带有角色的新模型。
• [[\yii2tech\admin\actions\RoleUpdate]] - 支持使用Web表单更新带有角色的新模型。

请参阅特定行为类以获取更多详细信息。

例如，基于提供的行为的CRUD控制器可能如下所示

namespace app\controllers;

use yii\web\Controller;

class ItemController extends Controller
{
    public function actions()
    {
        return [
            'index' => [
                'class' => \yii2tech\admin\actions\Index::class,
                'newSearchModel' => function () {
                    return new ItemSearch();
                },
            ],
            'view' => [
                'class' => \yii2tech\admin\actions\View::class,
            ],
            'create' => [
                'class' => \yii2tech\admin\actions\Create::class,
            ],
            'update' => [
                'class' => \yii2tech\admin\actions\Update::class,
            ],
            'delete' => [
                'class' => \yii2tech\admin\actions\Delete::class,
            ],
        ];
    }

    public function findModel($id)
    {
        if (($model = Item::findOne($id)) !== null) {
            return $model;
        }
        throw new NotFoundHttpException('The requested page does not exist.');
    }

    public function newModel()
    {
        return new Item();
    }
}

控制器

此扩展提供了一些预定义的控制器，可以作为创建特定控制器时的基础控制器类使用

• [[\yii2tech\admin\CrudController]] - 实现支持ActiveRecord的CRUD的通用动作集。

请参考特定的控制器类以获取更多详细信息。

小部件

此扩展提供了一些小部件，这简化了典型用例的视图组合。

• [[\yii2tech\admin\widgets\Alert]] - 从会话闪存中渲染消息。
• [[\yii2tech\admin\widgets\ActionAlert]] - 根据特定条件（通常是会话标志）渲染动作建议。
• [[\yii2tech\admin\widgets\ButtonContextMenu]] - 简化了“更新”、“查看”、“删除”等上下文链接的渲染。
• [[\yii2tech\admin\widgets\Nav]] - [[\yii\bootstrap\Nav]] 的增强版本，简化了图标渲染。

此外，还为 [[\yii\grid\GridView]] 提供了一些增强功能。

• [[\yii2tech\admin\grid\ActionColumn]] - 简化了动作按钮的组合。
• [[\yii2tech\admin\grid\DeleteStatusColumn]] - 用于显示“软删除”状态。
• [[\yii2tech\admin\grid\PositionColumn]] - 为模型自定义排序位置切换提供简单界面。
• [[\yii2tech\admin\grid\VariationColumn]] - 允许显示变体列的值。

使用 Gii

此扩展提供了一个代码生成器，可以与 yii 'gii' 模块集成。为了启用它们，您应按照以下方式调整应用程序配置

return [
    //....
    'modules' => [
        // ...
        'gii' => [
            'class' => yii\gii\Module::class,
            'generators' => [
                'adminMainFrame' => [
                    'class' => yii2tech\admin\gii\mainframe\Generator::class
                ],
                'adminCrud' => [
                    'class' => yii2tech\admin\gii\crud\Generator::class
                ]
            ],
        ],
    ]
];

"MainFrame" 生成器创建一个基本的 admin 面板代码，包括布局文件、主控制器文件和基本视图文件。创建的结构对于正确渲染“Admin CRUD”生成器创建的代码是必要的。

"Admin CRUD" 生成器类似于常规 "CRUD" 生成器，但它生成的代码使用此扩展的工具，因此生成的代码更加整洁。

国际化

在此扩展中引入的所有文本和消息都在 'yii2tech-admin' 类别下可翻译。您可以使用以下应用程序配置使用此扩展提供的翻译

return [
    'components' => [
        'i18n' => [
            'translations' => [
                'yii2tech-admin' => [
                    'class' => yii\i18n\PhpMessageSource::class,
                    'basePath' => '@yii2tech/admin/messages',
                ],
                // ...
            ],
        ],
        // ...
    ],
    // ...
];