PageTreeItemsHighlighter.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\EventListener;
 
use ‪TYPO3\CMS\Backend\Controller\Event\AfterPageTreeItemsPreparedEvent;
use ‪TYPO3\CMS\Backend\Dto\Tree\Status\StatusInformation;
use ‪TYPO3\CMS\Core\Attribute\AsEventListener;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
use ‪TYPO3\CMS\Core\Versioning\VersionState;
use ‪TYPO3\CMS\Workspaces\Service\WorkspaceService;
 
final class ‪PageTreeItemsHighlighter
{
    public function ‪__construct(
        private readonly ‪WorkspaceService $workspaceService
    ) {}
 
    #[AsEventListener('typo3-workspaces/page-tree-items-highlighter')]
    public function ‪__invoke(‪AfterPageTreeItemsPreparedEvent $event): void
    {
        $items = $event->‪getItems();
        $workspaceId = $this->‪getBackendUser()->workspace;
 
        if ($workspaceId <= 0 || $items === []) {
            return;
        }
 
        foreach ($items as &$item) {
            $page = $item['_page'] ?? [];
            if (!is_array($page) || $page === []) {
                continue;
            }
 
            if ((int)($page['t3ver_wsid'] ?? 0) === $workspaceId
                && (
                    (int)($page['t3ver_oid'] ?? 0) > 0
                    || VersionState::tryFrom($page['t3ver_state'] ?? 0) === VersionState::NEW_PLACEHOLDER
                )
            ) {
                $label = $this->‪getLanguageService()->sL('LLL:EXT:workspaces/Resources/Private/Language/locallang.xlf:status.has_changes');
                if (VersionState::tryFrom($page['t3ver_state'] ?? 0) === VersionState::NEW_PLACEHOLDER) {
                    $label = $this->‪getLanguageService()->sL('LLL:EXT:workspaces/Resources/Private/Language/locallang.xlf:status.is_new');
                }
                $item['statusInformation'][] = new ‪StatusInformation(
                    label: $label,
                    severity: ContextualFeedbackSeverity::WARNING,
                );
            } elseif (
                $this->workspaceService->hasPageRecordVersions(
                    $workspaceId,
                    (int)(($page['t3ver_oid'] ?? 0) ?: ($page['uid'] ?? 0))
                )
            ) {
                $item['statusInformation'][] = new ‪StatusInformation(
                    label: $this->‪getLanguageService()->sL('LLL:EXT:workspaces/Resources/Private/Language/locallang.xlf:status.contains_changes'),
                    severity: ContextualFeedbackSeverity::WARNING,
                );
            }
        }
        unset($item);
 
        $event->‪setItems($items);
    }
 
    protected function ‪getLanguageService(): ‪LanguageService
    {
        return ‪$GLOBALS['LANG'];
    }
 
    protected function ‪getBackendUser(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
}