PageTitle.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\Adminpanel\Modules\Debug;
 
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Adminpanel\Log\InMemoryLogWriter;
use ‪TYPO3\CMS\Adminpanel\ModuleApi\AbstractSubModule;
use ‪TYPO3\CMS\Adminpanel\ModuleApi\DataProviderInterface;
use ‪TYPO3\CMS\Adminpanel\ModuleApi\ModuleData;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Fluid\View\StandaloneView;
 
class ‪PageTitle extends ‪AbstractSubModule implements ‪DataProviderInterface
{
    protected const ‪LOG_COMPONENT = 'TYPO3.CMS.Core.PageTitle.PageTitleProviderManager';
 
    public function ‪getIdentifier(): string
    {
        return 'debug_pagetitle';
    }
 
    public function ‪getLabel(): string
    {
        return $this->‪getLanguageService()->sL(
            'LLL:EXT:adminpanel/Resources/Private/Language/locallang_debug.xlf:submodule.pageTitle.label'
        );
    }
 
    public function ‪getDataToStore(ServerRequestInterface $request): ‪ModuleData
    {
        $data = [
            'cacheEnabled' => true,
        ];
        if (!$this->‪isCachingAllowed($request)) {
            $data = [
                'orderedProviders' => [],
                'usedProvider' => null,
                'skippedProviders' => [],
            ];
            $logRecords = GeneralUtility::makeInstance(InMemoryLogWriter::class)->getLogEntries();
            foreach ($logRecords as $logEntry) {
                if ($logEntry->getComponent() === self::LOG_COMPONENT) {
                    $logEntryData = $logEntry->getData();
                    if (isset($logEntryData['orderedTitleProviders'])) {
                        $data['orderedProviders'] = $logEntryData['orderedTitleProviders'];
                    } elseif (isset($logEntryData['providerUsed'])) {
                        $data['usedProvider'] = $logEntryData;
                    } elseif (isset($logEntry->getData()['skippedProvider'])) {
                        $data['skippedProviders'][] = $logEntryData;
                    }
                }
            }
        }
        return new ‪ModuleData($data);
    }
 
    public function ‪getContent(‪ModuleData $data): string
    {
        $view = new ‪StandaloneView();
        $view->setTemplatePathAndFilename(
            'EXT:adminpanel/Resources/Private/Templates/Modules/Debug/PageTitle.html'
        );
        $view->assignMultiple($data->getArrayCopy());
        $view->assign('languageKey', $this->‪getBackendUser()->user['lang'] ?? null);
        return $view->render();
    }
 
    protected function ‪isCachingAllowed(ServerRequestInterface $request): bool
    {
        return $request->getAttribute('frontend.cache.instruction')->isCachingAllowed();
    }
}