IntegrityService.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\Workspaces\Service;
 
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Versioning\VersionState;
use ‪TYPO3\CMS\Workspaces\Domain\Model\CombinedRecord;
 
class ‪IntegrityService
{
    public const ‪STATUS_Success = 100;
    public const ‪STATUS_Info = 101;
    public const ‪STATUS_Warning = 102;
    public const ‪STATUS_Error = 103;
 
    protected array ‪$statusRepresentation = [
        self::STATUS_Success => 'success',
        self::STATUS_Info => 'info',
        self::STATUS_Warning => 'warning',
        self::STATUS_Error => 'error',
    ];
 
    protected array ‪$affectedElements = [];
 
    protected array ‪$issues = [];
 
    public function ‪setAffectedElements(array ‪$affectedElements): void
    {
        $this->affectedElements = ‪$affectedElements;
    }
 
    public function ‪check(): void
    {
        foreach ($this->affectedElements as $affectedElement) {
            $this->‪checkElement($affectedElement);
        }
    }
 
    public function ‪checkElement(‪CombinedRecord $element): void
    {
        $this->‪checkLocalization($element);
    }
 
    protected function ‪checkLocalization(‪CombinedRecord $element): void
    {
        $table = $element->‪getTable();
        if (BackendUtility::isTableLocalizable($table)) {
            $languageField = ‪$GLOBALS['TCA'][$table]['ctrl']['languageField'];
            $languageParentField = ‪$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'];
            $versionRow = $element->‪getVersionRecord()->getRow();
            // If element is a localization:
            if ($versionRow[$languageField] > 0) {
                // Get localization parent from live workspace
                $languageParentRecord = BackendUtility::getRecord($table, $versionRow[$languageParentField], 'uid,t3ver_state');
                // If localization parent is a new version....
                if (is_array($languageParentRecord) && VersionState::tryFrom($languageParentRecord['t3ver_state'] ?? 0) === VersionState::NEW_PLACEHOLDER) {
                    $title = BackendUtility::getRecordTitle($table, $versionRow);
                    $languageService = $this->‪getLanguageService();
                    // Add warning for current versionized record:
                    $this->‪addIssue(
                        $element->‪getLiveRecord()->getIdentifier(),
                        self::STATUS_Warning,
                        sprintf($languageService->sL('LLL:EXT:workspaces/Resources/Private/Language/locallang.xlf:integrity.dependsOnDefaultLanguageRecord'), $title)
                    );
                    // Add info for related localization parent record:
                    $this->‪addIssue(
                        $table . ':' . $languageParentRecord['uid'],
                        self::STATUS_Info,
                        sprintf($languageService->sL('LLL:EXT:workspaces/Resources/Private/Language/locallang.xlf:integrity.isDefaultLanguageRecord'), $title)
                    );
                }
            }
        }
    }
 
    public function ‪getStatus(string ‪$identifier = null): int
    {
        $status = ‪self::STATUS_Success;
        if (‪$identifier === null) {
            foreach ($this->issues as $idenfieriferIssues) {
                foreach ($idenfieriferIssues as $issue) {
                    if ($status < $issue['status']) {
                        $status = $issue['status'];
                    }
                }
            }
        } else {
            foreach ($this->‪getIssues(‪$identifier) as $issue) {
                if ($status < $issue['status']) {
                    $status = $issue['status'];
                }
            }
        }
        return $status;
    }
 
    public function ‪getStatusRepresentation(string ‪$identifier = null): string
    {
        return $this->statusRepresentation[$this->‪getStatus(‪$identifier)];
    }
 
    public function ‪getIssues(string ‪$identifier = null): array
    {
        if (‪$identifier === null) {
            return ‪$this->issues;
        }
        if (isset($this->issues[‪$identifier])) {
            return $this->issues[‪$identifier];
        }
        return [];
    }
 
    public function ‪getIssueMessages(string ‪$identifier = null): array
    {
        $messages = [];
        if (‪$identifier === null) {
            foreach ($this->issues as $idenfieriferIssues) {
                foreach ($idenfieriferIssues as $issue) {
                    $messages[] = $issue['message'];
                }
            }
        } else {
            foreach ($this->‪getIssues(‪$identifier) as $issue) {
                $messages[] = $issue['message'];
            }
        }
        return $messages;
    }
 
    protected function ‪addIssue(string ‪$identifier, int $status, string $message): void
    {
        if (!isset($this->issues[‪$identifier])) {
            $this->issues[‪$identifier] = [];
        }
        $this->issues[‪$identifier][] = [
            'status' => $status,
            'message' => $message,
        ];
    }
 
    protected function ‪getLanguageService(): ‪LanguageService
    {
        return ‪$GLOBALS['LANG'];
    }
}