progminer/maintenance-screen

The "Maintenance mode" screen library

Sunday, July 22, 2018
by ProgMiner
Repository
1 Watchers
0 Stars
42 Installations

PHP
1 Dependents
0 Suggesters
0 Forks
0 Open issues
11 Versions
17 % Grown

The README.md

maintenance-screen

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

The "Maintenance mode" screen library, _(*2)

Install

Via Composer, _(*3)

``` bash composer require progminer/maintenance-screen, _(*4)


For using some included classes you also need to install more requrements:

- For `MaintenanceScreen\FileLoader\YamlFileLoader` - [Symfony Yaml](http://symfony.com/doc/current/components/yaml):
```bash
composer require symfony/yaml ^4.0

For ProgMinerUtils\TemplateRenderer\TwigTemplateRenderer - Twig:

composer require twig/twig ^2.4

Usage

An instance of MaintenanceScreen\MaintenanceScreen consists of configurations array, MaintenanceScreen\TranslatorProvider\TranslatorProviderInterface instance and ProgMinerUtils\TemplateRenderer\TemplateRendererInterface instance., _(*5)

This example step by step illustrates how works with the MaintenanceScreen\MaintenanceScreen., _(*6)

Example

In first order you have to write uses, include a vendor/autoload.php (ommited), etc. Also you could make configuration array for MaintenanceScreen\MaintenanceScreen., _(*7)

use MaintenanceScreen\ConfigurationLoader;
use MaintenanceScreen\MaintenanceScreen;

use MaintenanceScreen\TranslatorProvider\ArrayTranslatorProvider;

use ProgMinerUtils\TemplateRenderer\CallableTemplateRenderer;

$config = [
    'template_name'    => 'Default', // template name, not required
    'default_language' => 'en',      // uses if Accept-Language is not provided, not required
    'charset'          => 'utf-8'    // not required, charset for Response and TemplateRenderer
];

Here you have to make MaintenanceScreen\TranslatorProvider\TranslatorProviderInterface instance and you have two included methods: - Use translations from array (MaintenanceScreen\TranslatorProvider\ArrayTranslatorProvider class) - Use translations from config files (MaintenanceScreen\TranslatorProvider\FilesystemTranslatorProvider class), _(*8)

A simple example for first method here:, _(*9)

$translatorsProvider = new ArrayTranslatorProvider([
    'en' => ['title' => 'Site in maintenance mode', 'text' => 'Site in maintenance mode'],
    'ru' => ['title' => 'Сайт в режиме техобслуживания', 'text' => 'Сайт в режиме техобслуживания']
]);

Also you can create class that implements MaintenanceScreen\TranslatorProvider\ITranslatorProvider., _(*10)

Now you have to make a ProgMinerUtils\TemplateRenderer\TemplateRendererInterface instance, for example, ProgMinerUtils\TemplateRenderer\CallableTemplateRenderer:, _(*11)

$templateRenderer = new CallableTemplateRenderer([
    'Default' => function($vars) { ?>

<html lang="<?=$vars['lang']?>">
    <head><title><?=$vars['title']?></title></head>
    <body><h1><center><?=$vars['text']?></center></h1></body>
</html>

    <?php }
]);

And, finally, MaintenanceScreen\MaintenanceScreen instance:, _(*12)

$maintenanceScreen = new MaintenanceScreen($config, $translatorProvider, $templateRenderer);

When you have an instance of MaintenanceScreen\MaintenanceScreen you can render and/or send rendered Symfony\Component\HttpFoundation\Response:, _(*13)

Rendering:

$response = $maintenanceScreen->render();

Sending:

$maintenanceScreen->send();

Both methods have not required argument $request - instance of class Symfony\Component\HttpFoundation\Request. If it is not provided this methods calls a Symfony\Component\HttpFoundation\Request::createFromGlobals method for getting current request., _(*14)

Todo

Add more file loaders

Contributing

Please see CONTRIBUTING for details., _(*15)

Security

If you discover any security related issues, please email eridan200@mail.ru instead of using the issue tracker., _(*16)

Credits

API Documentation

This projects API documentation is built using Sami and available at https://progminer.github.io/maintenance-screen/master/., _(*17)

Build

In order to build the documentation first get Sami as a phar file:, _(*18)

# curl -O http://get.sensiolabs.org/sami.phar
composer install-sami

Next build the documentation:, _(*19)

# php sami.phar update sami-config.php
composer regen-docs

The API Documentation will be generated into the docs folder. If you would like to preview it locally you can easily do so with the built-in PHP server:, _(*20)

php -S 127.0.0.1:3000 -t docs

Then visit http://localhost:3000/master/ to view., _(*21)

License

The MIT License (MIT). Please see License File for more information., _(*22)

The Versions

22/07 2018

dev-master

9999999-dev

The "Maintenance mode" screen library

Sources Download

MIT

The Requires

symfony/config ^4.0
symfony/http-foundation ^4.0
progminer/util-template-renderer ^1.0
php ^7.1

The Development Requires

by ProgMiner

27/02 2018

v3.0

3.0.0.0

1.0.0.0

The Maintenance screen for your site

Sources Download

MIT

library maintenance-screen

The "Maintenance mode" screen library

progminer/maintenance-screen

The README.md

maintenance-screen

Install

Usage

Example

Todo

Contributing

Security

Credits

API Documentation

Build

License

The Versions

dev-master

The Requires

The Development Requires

by ProgMiner

by Eridan Domoratskiy

v4.0.1

The Requires

The Development Requires

by ProgMiner

v4.0

The Requires

The Development Requires

by ProgMiner

v3.0.1

The Requires

The Development Requires

by ProgMiner

v3.0

The Requires

The Development Requires

by ProgMiner

v2.0

The Requires

by ProgMiner

v1.3

The Requires

by ProgMiner

v1.2

The Requires

by ProgMiner

v1.1

The Requires

by ProgMiner

v1.0.1

The Requires

by ProgMiner

v1.0

The Requires

by ProgMiner