ApplicationType.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\Http;
 
use Psr\Http\Message\ServerRequestInterface;
use RuntimeException;
use ‪TYPO3\CMS\Core\Core\SystemEnvironmentBuilder;
 
enum ‪ApplicationType: string
{
    // SystemEnvironmentBuilder::REQUESTTYPE_BE
    case BACKEND = 'backend';
    // SystemEnvironmentBuilder::REQUESTTYPE_FE
    case FRONTEND = 'frontend';
 
    public static function ‪fromRequest(ServerRequestInterface $request): self
    {
        $type = $request->getAttribute('applicationType');
        if (!is_int($type)) {
            // Request object has no valid type. Type is set by the Frontend / Backend / Install
            // application. If it's missing, we've not been called behind a legit TYPO3 application object.
            // This is bogus, we throw a generic RuntimeException that should not be caught.
            throw new \RuntimeException('No valid attribute "applicationType" found in request object.', 1606222812);
        }
        if (($type & ‪SystemEnvironmentBuilder::REQUESTTYPE_FE) === ‪SystemEnvironmentBuilder::REQUESTTYPE_FE) {
            return self::FRONTEND;
        }
        if (($type & ‪SystemEnvironmentBuilder::REQUESTTYPE_BE) === ‪SystemEnvironmentBuilder::REQUESTTYPE_BE) {
            return self::BACKEND;
        }
        throw new \LogicException('Could not resolve application type to either frontend or backend', 1678875015);
    }
 
    public function abbreviate(): ?string
    {
        return self::abbreviations()[$this] ?? null;
    }
 
    public function isFrontend(): bool
    {
        return $this === self::FRONTEND;
    }
 
    public function isBackend(): bool
    {
        return $this === self::BACKEND;
    }
 
    private static function abbreviations(): \WeakMap
    {
        $map = new \WeakMap();
        $map[self::FRONTEND] = 'FE';
        $map[self::BACKEND] = 'BE';
        return $map;
    }
}