uam/maintenance-bundle

0.2.0 2017-03-23 05:03 UTC

Requires

• symfony/http-kernel: ^2.3|^3.0
• uam/datatables-bundle: ^5.0
• uam/twig-i18n-extension: @stable

Requires (Dev)

• fzaninotto/faker: ^1.5
• phpunit/phpunit: ^4.6|^5.4

MIT

README

A symfony 2 bundle to manage maintenance periods for your symfony app.

Requirements

• Propel ORM

Installation

Add repository to your project's composer.json:

"repositories": [
		{
			"type": "composer",
			"url": "http://satis.united-asian.com/symfony"
		},
		...
]

Add the bundle to your project's composer.json:

{
    "require": {
        "uam/maintenance-bundle": "dev-master",
        "uam/twig-i18n-extension": "dev-master",
        ...
    }
}

Run composer update to install the bundle:

$ php bin/composer.phar update

assuming composer.phar is in bin directory.

Enable the bundle in the app's kernel:

enable the UAMMaintenanceBundle, UAMDatatablesBundle and UAMTwigI18nBundle in app's kernel.

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new UAM\Bundle\DatatablesBundle\UAMDatatablesBundle(),
        new UAM\Bundle\MaintenanceBundle\UAMMaintenanceBundle(),
        new UAM\Twig\Extension\I18n\Bridge\Symfony\UAMTwigI18nBundle(),
    );
}

Add the bundle to the assetic configuration:

#config.yml
assetic:
    - UAMDatatablesBundle
    - UAMMaintenanceBundle

If your composer.json does not include the post-install or post-update installAssets script handler, then run the following command:

$ php app/console assets:install

or

$ php app/console assets:install --symlink

Update your database schema

Run the following command to update the database schema.

$ php app/console propel:model:build

Then run the below command to generate the migration file.

$ php app/console propel:migration:generate-diff

After generating migration file open the migration file and copy the query to create uam_maintenence and uam_maintenance_i18n table and run the query.

Or

run the command to execute generated sql.

$ php app/console propel:migration:migrate

Usage

Create maintenance periods

Display a warning to users about an implending maintenance period

Typically, if you have planned a maintenance operation in the near future, you want to publish a warning to your users on your app, in otder to let them know that the app will be unavailable during that time.

To do this with the UAMMaintenanceBndle, include the following code in the appropraite template of your app. If you want the warning to be displayed in all pages of your app, include this in the base template.

{% render(controller("UAMMaintenanceBundle:Maintenance:warning")) %}

Customizing the "Under maintenance" page

Import routing file

uam_maintenance:
    resource: "@UAMMaintenanceBundle/Resources/config/routing/maintenance.yml"

override the layout

override the layout.html.twig template into your app so that page/message displayed will be consistent with the style of your app.

Or you can also override the progress.html.twig template for the "Under maintenence page".

Customizing the Admin pages

Import routing file

uam_maintenance_admin:
    resource: "@UAMMaintenanceBundle/Resources/config/routing/admin.yml"

override the layout

override the layout.html.twig template into your app so that admin pages displayed will be consistent with the style of your app.

To access the admin pages, the user must have the role ROLE_UAM_MAINTENANCE_ADMIN.

Security

To access the admin pages

Admin pages are restricted to certain users. To access the admin pages, the user must have the role ROLE_UAM_MAINTENANCE_ADMIN.