jc-it / yii2-maintenance-mode

Yii2 的维护模式实现

维护者

详细信息

github.com/JC-IT/yii2-maintenance-mode

源代码

问题

安装: 49

依赖: 0

建议者: 0

安全性: 0

星标: 1

关注者: 1

分支: 0

开放问题: 0

类型：yii2-extension

v1.1.0 2022-09-29 07:04 UTC

Requires

MIT dfc816b26eb660e2c62e68ff75352b428e0fef26

  • Joey Claessen <joey_claessen.woop@hotmail.com>

This package is auto-updated.

Last update: 2024-08-29 06:01:49 UTC

README

此扩展为 Yii2 提供维护模式实现。

安装

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

运行以下命令：

$ composer require jc-it/yii2-maintenance-mode

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

"jc-it/yii2-maintenance-mode": "^<latest version>"

jc-it/yii2-maintenance-mode

配置

  • 将维护模式添加为组件
...
'bootstrap' => ['maintenance'],
'components' => [
    'maintenance' => [
        'class' => \JCIT\maintenance\components\MaintenanceMode::class,
    ],
],
  • 添加控制台控制器
class MaintenanceController extens \JCIT\maintenance\controllers\Maintenance
  • 将维护操作添加到您的 SiteController（例如）
class SiteController extends \yii\web\Controller
{
    public function actions(): array
    {
        return [
            'maintenance' => \JCIT\maintenance\actions\Maintenance::class,
        ];      
    }
}

用法

要启用维护模式，请使用带有可选的持续时间消息的 maintenance/enable 控制台命令。

src/yii maintenance/enable --message "We are performing maintenance." --duration 3600

要延长维护模式持续时间，请使用 maintenance/extend 控制台命令。

src/yii maintenance/extend --duration 3600

要添加更新到维护模式，请使用 maintenance/update 控制台命令。

src/yii maintenance/update --message "Maintenance update"

要禁用维护模式，请运行 maintenance/disable 控制台命令。

src/yii maintenance/disable

待办事项

  • 添加测试

致谢