Your IP : 216.73.217.13
<?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\PageTitle;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use TYPO3\CMS\Core\Service\DependencyOrderingService;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\TypoScript\TypoScriptService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* This class will take care of the different providers and returns the title with the highest priority
*/
class PageTitleProviderManager implements SingletonInterface, LoggerAwareInterface
{
use LoggerAwareTrait;
/**
* @var array
*/
private $pageTitleCache = [];
public function getTitle(): string
{
$pageTitle = '';
$titleProviders = $this->getPageTitleProviderConfiguration();
$titleProviders = $this->setProviderOrder($titleProviders);
$orderedTitleProviders = GeneralUtility::makeInstance(DependencyOrderingService::class)
->orderByDependencies($titleProviders);
$this->logger->debug('Page title providers ordered', [
'orderedTitleProviders' => $orderedTitleProviders,
]);
foreach ($orderedTitleProviders as $provider => $configuration) {
if (class_exists($configuration['provider']) && is_subclass_of($configuration['provider'], PageTitleProviderInterface::class)) {
/** @var PageTitleProviderInterface $titleProviderObject */
$titleProviderObject = GeneralUtility::makeInstance($configuration['provider']);
if (($pageTitle = $titleProviderObject->getTitle())
|| ($pageTitle = $this->pageTitleCache[$configuration['provider']] ?? '') !== ''
) {
$this->logger->debug('Page title provider {provider} used on page {title}', [
'title' => $pageTitle,
'provider' => $configuration['provider'],
]);
$this->pageTitleCache[$configuration['provider']] = $pageTitle;
break;
}
$this->logger->debug('Page title provider {provider} skipped on page {title}', [
'title' => $pageTitle,
'provider' => $configuration['provider'],
'providerUsed' => $configuration['provider'],
]);
}
}
return $pageTitle;
}
/**
* @internal
*/
public function getPageTitleCache(): array
{
return $this->pageTitleCache;
}
/**
* @internal
*/
public function setPageTitleCache(array $pageTitleCache): void
{
$this->pageTitleCache = $pageTitleCache;
}
/**
* Get the TypoScript configuration for pageTitleProviders
*/
private function getPageTitleProviderConfiguration(): array
{
$typoscriptService = GeneralUtility::makeInstance(TypoScriptService::class);
$config = $typoscriptService->convertTypoScriptArrayToPlainArray(
$GLOBALS['TSFE']->config['config'] ?? []
);
return $config['pageTitleProviders'] ?? [];
}
/**
* @return string[]
* @throws \UnexpectedValueException
*/
protected function setProviderOrder(array $orderInformation): array
{
foreach ($orderInformation as $provider => &$configuration) {
if (isset($configuration['before'])) {
if (is_string($configuration['before'])) {
$configuration['before'] = GeneralUtility::trimExplode(',', $configuration['before'], true);
} elseif (!is_array($configuration['before'])) {
throw new \UnexpectedValueException(
'The specified "before" order configuration for provider "' . $provider . '" is invalid.',
1535803185
);
}
}
if (isset($configuration['after'])) {
if (is_string($configuration['after'])) {
$configuration['after'] = GeneralUtility::trimExplode(',', $configuration['after'], true);
} elseif (!is_array($configuration['after'])) {
throw new \UnexpectedValueException(
'The specified "after" order configuration for provider "' . $provider . '" is invalid.',
1535803186
);
}
}
}
return $orderInformation;
}
}