nuboxdevcom/maintenance-bundle

Maintenance bundle for Symfony 3.x 4.x

MaintenanceBundle v2

, _(*1)

, _(*2)

Requirements

• PHP >=7.1
• symfony/framework-bundle >= 3.4 || ^4.0
• Twig ^2.4

#, _(*3)

:warning: Symfony before version 3.4 NOTICE

Please use ^1.x branch versions., _(*4)

2.x versions is incompatible with versions lower than symfony 3.4, _(*5)

#, _(*6)

Installation:

Pretty simple with Composer, run:, _(*7)

$ composer require nuboxdevcom/maintenance-bundle

#, _(*8)

Simply Configuration

Enter your IPs here to allow you to access your site during a maintenance., _(*9)

In config/ndc_maintenance.yaml, _(*10)

ndc_maintenance:
    authorized_ips:
        - '127.0.0.1'
        - 'your.ip.domain.name.example'

#, _(*11)

Configuration

Symfony Flex takes care of everything!, _(*12)

#, _(*13)

How to Use

In your template, add this to let you know if the site is in maintenance, _(*14)

    {% if isMaintenanceMode() %}
        <p class="text-center bg-danger"><strong>Your site is in maintenance mode...</strong></p>
    {% endif %}

isMaintenanceMode() return boolean true or false., _(*15)

If you want to activate maintenance mode, you will need to call the following method, _(*16)

    $this->get('maintenance.service')->enableMaintenanceAction();

Or, _(*17)

    $this->get('maintenance.service')->disableMaintenanceAction();

To disable maintenance mode., _(*18)

If you want to know if maintenance is enabled from a controller, use this method, _(*19)

    $this->get('maintenance.service')->isMaintenanceMode();

isMaintenanceMode() return boolean true or false., _(*20)

#, _(*21)

How to change the view of maintenance page

If you want to change the view, create a new view file, _(*22)

    templates/bundles/NDCMaintenanceBundle/maintenance.html.twig