LanguageAspect.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\AspectPropertyNotFoundException;
 
class ‪LanguageAspect implements ‪AspectInterface
{
    protected ‪$id = 0;
 
    protected ‪$contentId = 0;
 
    protected ‪$fallbackChain = [];
 
    protected ‪$overlayType;
 
    public const ‪OVERLAYS_OFF = 'off';  // config.sys_language_overlay = 0
    public const ‪OVERLAYS_MIXED = 'mixed';  // config.sys_language_overlay = 1 (keep the ones that are only available in default language)
    public const ‪OVERLAYS_ON = 'on';    // "hideNonTranslated"
    public const ‪OVERLAYS_ON_WITH_FLOATING = 'includeFloating';    // "hideNonTranslated" + records that are only available in polish
 
    public function ‪__construct(int ‪$id = 0, int ‪$contentId = null, string ‪$overlayType = self::OVERLAYS_ON_WITH_FLOATING, array ‪$fallbackChain = [])
    {
        $this->overlayType = ‪$overlayType;
        $this->id = ‪$id;
        $this->contentId = ‪$contentId ?? ‪$this->id;
        $this->fallbackChain = ‪$fallbackChain;
    }
 
    public function ‪getOverlayType(): string
    {
        return ‪$this->overlayType;
    }
 
    public function ‪getId(): int
    {
        return ‪$this->id;
    }
 
    public function ‪getContentId(): int
    {
        return ‪$this->contentId;
    }
 
    public function ‪getFallbackChain(): array
    {
        return ‪$this->fallbackChain;
    }
 
    public function ‪doOverlays(): bool
    {
        return $this->contentId > 0 && $this->overlayType !== ‪self::OVERLAYS_OFF;
    }
 
    public function ‪getLegacyLanguageMode(): string
    {
        if ($this->fallbackChain === ['off']) {
            return '';
        }
        if (empty($this->fallbackChain)) {
            return 'strict';
        }
        if ($this->fallbackChain === [-1]) {
            return 'ignore';
        }
        return 'content_fallback';
    }
 
    public function ‪getLegacyOverlayType(): string
    {
        switch ($this->overlayType) {
            case ‪self::OVERLAYS_ON_WITH_FLOATING:
            case ‪self::OVERLAYS_ON:
                return 'hideNonTranslated';
            case ‪self::OVERLAYS_MIXED:
                return '1';
            case ‪self::OVERLAYS_OFF:
            default:
                return '0';
        }
    }
 
    public function get(string $name)
    {
        switch ($name) {
            case 'id':
                return ‪$this->id;
            case 'contentId':
                return ‪$this->contentId;
            case 'fallbackChain':
                return ‪$this->fallbackChain;
            case 'overlayType':
                return ‪$this->overlayType;
            case 'legacyLanguageMode':
                return $this->‪getLegacyLanguageMode();
            case 'legacyOverlayType':
                return $this->‪getLegacyOverlayType();
        }
        throw new AspectPropertyNotFoundException('Property "' . $name . '" not found in Aspect "' . __CLASS__ . '".', 1530448504);
    }
}