MaintenanceScreen\MaintenanceScreen

Complexity

Total Complexity

5

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	render()	0	20	1
A	validateRequest()	0	6	2
A	send()	0	7	1

<?php

/* MIT License

Copyright (c) 2018 Eridan Domoratskiy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. */

namespace MaintenanceScreen;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;

use Symfony\Component\Config\Definition\Processor;

use MaintenanceScreen\Configurations\MainConfiguration;

use MaintenanceScreen\TranslatorProvider\ITranslatorProvider;
use MaintenanceScreen\TranslatorProvider\ArrayTranslatorProvider;

use ProgMinerUtils\TemplateRenderer\ITemplateRenderer;
use ProgMinerUtils\TemplateRenderer\CallableTemplateRenderer;

/**
 * Main class
 *
 * @author ProgMiner
 */
class MaintenanceScreen {

    /**
     * @var string[] Configuration (Key => Value)
     */
    protected $config;

    /**
     * @var ITranslatorProvider Translator provider
     */
    protected $translatorProvider;

    /**
     * @var ITemplateRenderer Template renderer
     */
    protected $templateRenderer;

    /**
     * @param array               $config             Configuration array
     * @param ITranslatorProvider $translatorProvider Translator provider
     * @param ITemplateRenderer   $templateRenderer   Template renderer
     */
    public function __construct(array $config, ITranslatorProvider $translatorProvider, ITemplateRenderer $templateRenderer) {
        $this->config = (new Processor())->
            processConfiguration(new MainConfiguration(), [$config]);

        $this->translatorProvider = $translatorProvider;
        $this->templateRenderer = $templateRenderer;
    }

    /**
     * Renders maintenance screen for Request to Response
     *
     * If Request is not provided uses
     * created from globals instance
     *
     * @param Request|null $request Request for rendering
     *
     * @return Response Rendered maintenance screen
     */
    public function render(Request $request = null): Response {
        $request = self::validateRequest($request);

        $translator = $this->translatorProvider->getPreferredTranslator(
            $request->getLanguages(),
            $this->config['default_language']
        );

        $response = new Response();

        $response->setContent($this->templateRenderer->render(
            $this->config['template_name'],
            array_merge($translator->getTranslations(), [
                'lang' => $translator->getLanguage(),
                'charset' => $this->config['charset']
            ])
        )."\n<!-- Powered by progminer/maintenance-screen (https://packagist.org/packages/progminer/maintenance-screen) -->\n");
        $response->headers->set('Content-Language', $translator->translate('lang'));

        return $response;
    }

    /**
     * Renders and sends maintenance screen for Request
     *
     * If Request is not provided uses
     * created from globals instance
     *
     * @param Request|null $request Request for rendering
     */
    public function send(Request $request = null) {
        $request = self::validateRequest($request);

        $this->
            render($request)->
            prepare($request)->
            send();
    }

    protected static function validateRequest(Request $request = null): Request {
        if (is_null($request)) {
            return Request::createFromGlobals();
        }

        return $request;
    }
}