Context.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\Context;
 
use ‪TYPO3\CMS\Core\Context\Exception\AspectNotFoundException;
use ‪TYPO3\CMS\Core\Context\Exception\AspectPropertyNotFoundException;
use ‪TYPO3\CMS\Core\SingletonInterface;
 
class ‪Context implements ‪SingletonInterface
{
    protected array ‪$aspects = [];
 
    public function ‪__construct(array $defaultAspects = [])
    {
        foreach ($defaultAspects as $name => $defaultAspect) {
            if ($defaultAspect instanceof ‪AspectInterface) {
                $this->aspects[$name] = $defaultAspect;
            }
        }
    }
 
    public function ‪hasAspect(string $name): bool
    {
        return match ($name) {
            'date', 'visibility', 'backend.user', 'frontend.user', 'workspace', 'language' => true,
            default => isset($this->aspects[$name]),
        };
    }
 
    public function ‪getAspect(string $name): ‪AspectInterface
    {
        if (!isset($this->aspects[$name])) {
            // Ensure the default aspects are available, this is mostly necessary for tests to not set up everything
            switch ($name) {
                case 'date':
                    $this->‪setAspect('date', new ‪DateTimeAspect(new \DateTimeImmutable('@' . ‪$GLOBALS['EXEC_TIME'])));
                    break;
                case 'visibility':
                    $this->‪setAspect('visibility', new ‪VisibilityAspect());
                    break;
                case 'backend.user':
                    $this->‪setAspect('backend.user', new ‪UserAspect());
                    break;
                case 'frontend.user':
                    $this->‪setAspect('frontend.user', new ‪UserAspect());
                    break;
                case 'workspace':
                    $this->‪setAspect('workspace', new ‪WorkspaceAspect());
                    break;
                case 'language':
                    $this->‪setAspect('language', new ‪LanguageAspect());
                    break;
                default:
                    throw new ‪AspectNotFoundException('No aspect named "' . $name . '" found.', 1527777641);
            }
        }
        return $this->aspects[$name];
    }
 
    public function ‪getPropertyFromAspect(string $name, string $property, mixed $default = null): mixed
    {
        if (!$this->‪hasAspect($name)) {
            throw new ‪AspectNotFoundException('No aspect named "' . $name . '" found.', 1527777868);
        }
        try {
            return $this->‪getAspect($name)->get($property);
        } catch (‪AspectPropertyNotFoundException $e) {
            return $default;
        }
    }
 
    public function ‪setAspect(string $name, ‪AspectInterface $aspect): void
    {
        $this->aspects[$name] = $aspect;
    }
 
    public function ‪unsetAspect(string $name): void
    {
        unset($this->aspects[$name]);
    }
}