README

此扩展包允许您通过简单的参数更改和快速部署来显示自定义模板，当您的站点处于维护状态时。这允许您立即纠正应用程序中的任何错误并通知您的用户。

您还可以仅定义一些路由（使用PHP正则表达式）来显示消息。

安装

下载扩展包。

composer require "devtia/maintenance-bundle"

启用扩展包

// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...

            new  Devtia\MaintenanceBundle\MaintenanceBundle(),
        );

        // ...
    }

    // ...
}

使用方法

您需要在config.yml中添加类似以下内容

maintenance:
  #default false. Set to true for enable the bundle and deploy your code
  enable_maintenance: false 
  #not required. You can set multiple routes and a custom template for each one. The routes must be compatible with PHP regex but without initial and end slash ('/')
  routes_prefixes:
    - ['\/admin\/', '%kernel.project_dir%/src/Resources/views/Maintenance/custom_maintenance.html.twig'] #if you left second parameter empty, the bundle use the default template
            

模板功能

此扩展包提供如下默认模板

您可以在以下路径创建自定义模板

ROOT_PATH_TO_YOUR_PROJECT . '/app/Resources/Devtia/MaintenanceBundle/views/maintenance.html.twig

如果您需要更多控制模板或需要多个模板，您可以在配置中定义多个模板。

每个模板都需要与一组路由的正则表达式相关联。在配置示例中，该扩展包在所有匹配“admin”模式的路由中显示自定义_maintenance.html.twig模板。

正则表达式

您可以在这里了解PHP正则表达式，并在此处尝试它们。

MaintenanceBundle通过将初始和结束斜杠（'/'）和末尾的通配符 .* 添加到所有路由前缀，简化了配置。上面的配置示例显示了此扩展包创建的此正则表达式

/\/admin\/.*/

此示例与路由（如）/admin/、/admin/login、/admin/users/create 等相匹配

联系

您可以通过 jaime@devtia.com 联系我。