9.5/_integrity_service_8php_source.html

<?php

namespace ‪TYPO3\CMS\Workspaces\Service;


/*

 * 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!

 */


use ‪TYPO3\CMS\Backend\Utility\BackendUtility;

use ‪TYPO3\CMS\Core\Versioning\VersionState;

use ‪TYPO3\CMS\Extbase\Utility\LocalizationUtility;

use ‪TYPO3\CMS\Workspaces\Domain\Model\CombinedRecord;


class ‪IntegrityService

{

    const ‪STATUS_Succes = 100;

    const ‪STATUS_Info = 101;

    const ‪STATUS_Warning = 102;

    const ‪STATUS_Error = 103;

    protected ‪$statusRepresentation = [

        self::STATUS_Succes => 'success',

        self::STATUS_Info => 'info',

        self::STATUS_Warning => 'warning',

        self::STATUS_Error => 'error'

    ];


    protected ‪$affectedElements;


    protected ‪$issues = [];


    public function ‪setAffectedElements(array ‪$affectedElements)

    {

        $this->affectedElements = ‪$affectedElements;

    }


    public function ‪check()

    {

        foreach ($this->affectedElements as $affectedElement) {

            $this->‪checkElement($affectedElement);

        }

    }


    public function ‪checkElement(CombinedRecord $element)

    {

        $this->‪checkLocalization($element);

    }


    protected function ‪checkLocalization(CombinedRecord $element)

    {

        $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 placeholder" record:

                if (‪VersionState::cast($languageParentRecord['t3ver_state'])->equals(‪VersionState::NEW_PLACEHOLDER)) {

                    $title = ‪BackendUtility::getRecordTitle($table, $versionRow);

                    // Add warning for current versionized record:

                    $this->‪addIssue($element->getLiveRecord()->getIdentifier(), self::STATUS_Warning, sprintf(‪LocalizationUtility::translate('integrity.dependsOnDefaultLanguageRecord', 'workspaces'), $title));

                    // Add info for related localization parent record:

                    $this->‪addIssue($table . ':' . $languageParentRecord['uid'], self::STATUS_Info, sprintf(‪LocalizationUtility::translate('integrity.isDefaultLanguageRecord', 'workspaces'), $title));

                }

            }

        }

    }


    public function ‪getStatus($identifier = null)

    {

        $status = ‪self::STATUS_Succes;

        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($identifier = null)

    {

        return $this->statusRepresentation[$this->‪getStatus($identifier)];

    }


    public function ‪getIssues($identifier = null)

    {

        if ($identifier === null) {

            return ‪$this->issues;

        }

        if (isset($this->issues[$identifier])) {

            return $this->issues[$identifier];

        }

        return [];

    }


    public function ‪getIssueMessages($identifier = null, $asString = false)

    {

        $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'];

            }

        }

        if ($asString) {

            $messages = implode('<br/>', $messages);

        }

        return $messages;

    }


    protected function ‪addIssue($identifier, $status, $message)

    {

        if (!isset($this->issues[$identifier])) {

            $this->issues[$identifier] = [];

        }

        $this->issues[$identifier][] = [

            'status' => $status,

            'message' => $message

        ];

    }

}