iulyanp / maintenance-bundle Goto Github PK

The MaintenanceBundle is a simple bundle that helps you to set your application in maintenance.

Open your terminal and run one of the following commands to download the bundle into your vendor directory.

• If you have composer installed globally you can run:

$ composer require iulyanp/maintenance-bundle

• Else you can go with:

$ php composer.phar require iulyanp/maintenance-bundle

Register the bundle in the app/AppKernel.php file of your project:

<?php
/** app/AppKernel.php */

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            
            ...
            
            new Iulyanp\MaintenanceBundle\IulyanpMaintenanceBundle(),
        );
    }
}

iulyanp_maintenance:
    resource: "@IulyanpMaintenanceBundle/Resources/config/routing.yml"
    prefix:   /

In order for the bundle to know when to set your website in maintenance you should configure it.

iulyanp_maintenance:
    enabled:   false
    due_date:  '14-10-2017 00:00:00'
    layout:
        signature: 'iulyanp'
        title: We are in maintenance
        description: Comming back soon...

You should use enabled and due_date configurations to chose when you want your application to be in maintenance and until what date. You activate the maintenance by changing the enabled config to true but your website will be in maintenance only if you set the due date configuration.

The layout parameters are for changing the default title, message and signature from the default layout. You can translate these configurations in the translation files.

Note! Do not forget to activate the translations on Symfony framework.

# config.yml

framework:
    translator:      { fallbacks: ["%locale%"] }
    ...