FlashMessageRendererResolver.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Messaging;
 
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Http\ApplicationType;
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Core\Messaging\Renderer\BootstrapRenderer;
use ‪TYPO3\CMS\Core\Messaging\Renderer\FlashMessageRendererInterface;
use ‪TYPO3\CMS\Core\Messaging\Renderer\ListRenderer;
use ‪TYPO3\CMS\Core\Messaging\Renderer\PlaintextRenderer;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪FlashMessageRendererResolver
{
    protected ‪$renderer = [
        'BE' => BootstrapRenderer::class,
        'FE' => ListRenderer::class,
        'CLI' => PlaintextRenderer::class,
        '_default' => PlaintextRenderer::class,
    ];
 
    public function ‪resolve(): ‪FlashMessageRendererInterface
    {
        $rendererClass = $this->‪resolveFlashMessageRenderClass();
        ‪$renderer = GeneralUtility::makeInstance($rendererClass);
        if (!‪$renderer instanceof ‪FlashMessageRendererInterface) {
            throw new \RuntimeException('Renderer ' . get_class(‪$renderer)
                . ' does not implement FlashMessageRendererInterface', 1476958086);
        }
        return ‪$renderer;
    }
 
    protected function ‪resolveFlashMessageRenderClass(): string
    {
        $context = $this->‪resolveContext();
        $renderClass = $this->renderer['_default'];
 
        if (!empty($this->renderer[$context])) {
            $renderClass = $this->renderer[$context];
        }
 
        return $renderClass;
    }
 
    protected function ‪resolveContext(): string
    {
        $context = '';
        $request = ‪$GLOBALS['TYPO3_REQUEST'] ?? null;
        if (‪Environment::isCli()) {
            $context = 'CLI';
        } elseif ($request instanceof ‪ServerRequest && ‪ApplicationType::fromRequest($request)->isBackend()) {
            $context = 'BE';
        } elseif ($request instanceof ‪ServerRequest && ‪ApplicationType::fromRequest($request)->isFrontend()) {
            $context = 'FE';
        }
        return $context;
    }
}