Files
cms-backend/Classes/Preview/StandardPreviewRendererResolver.php

100 lines
4.5 KiB
PHP

<?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\Backend\Preview;
use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Domain\RecordInterface;
use TYPO3\CMS\Core\Schema\TcaSchemaFactory;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* Scans TCA configuration to detect:
*
* - TCA.$table.types.$typeFromTypeField.previewRenderer
* - TCA.$table.ctrl.previewRenderer
*
* Depending on which one is defined and checking the first, type-specific
* variant first.
*/
#[Autoconfigure(public: true)]
readonly class StandardPreviewRendererResolver
{
public function __construct(
protected TcaSchemaFactory $tcaSchemaFactory
) {}
/**
* @param RecordInterface $record A record from $table which will be previewed - allows returning a different PreviewRenderer based on record attributes
* @throws \UnexpectedValueException
* @throws \RuntimeException
*/
public function resolveRendererFor(RecordInterface $record): PreviewRendererInterface
{
$table = $record->getMainType();
$row = $record->getRawRecord()?->toArray() ?? [];
$schema = $this->tcaSchemaFactory->get($table);
$previewRendererClassName = null;
if ($schema->supportsSubSchema()) {
$tcaTypeOfRow = '';
$subSchemaTypeInformation = $schema->getSubSchemaTypeInformation();
if ($subSchemaTypeInformation->isPointerToForeignFieldInForeignSchema()) {
if ($this->tcaSchemaFactory->has($subSchemaTypeInformation->getForeignSchemaName())) {
// Note: We override the schema here to work on the foreign schema from now on.
$schema = $this->tcaSchemaFactory->get($subSchemaTypeInformation->getForeignSchemaName());
if (isset($row[$subSchemaTypeInformation->getFieldName()]) && $schema->hasField($subSchemaTypeInformation->getForeignFieldName())) {
$foreignRecord = BackendUtility::getRecord($subSchemaTypeInformation->getForeignSchemaName(), $row[$subSchemaTypeInformation->getFieldName()], $subSchemaTypeInformation->getForeignFieldName());
$tcaTypeOfRow = (string)($foreignRecord[$subSchemaTypeInformation->getForeignFieldName()] ?? '');
}
}
} else {
$tcaTypeOfRow = (string)($row[$subSchemaTypeInformation->getFieldName()] ?? '');
}
if ($schema->hasSubSchema($tcaTypeOfRow)) {
// Outdated subschemas may still be present in the database fields, this must not block backend rendering and utilize fallback.
$subSchema = $schema->getSubSchema($record->getRecordType());
if (is_string($subSchema->getRawConfiguration()['previewRenderer'] ?? false) && $subSchema->getRawConfiguration()['previewRenderer'] !== '') {
// A type-specific preview renderer was configured for the TCA type
$previewRendererClassName = $subSchema->getRawConfiguration()['previewRenderer'];
}
}
}
if (!$previewRendererClassName) {
// Table either has no type field or no custom preview renderer was defined for the type.
// Use table's standard renderer if any is defined.
$previewRendererClassName = $schema->getRawConfiguration()['previewRenderer'] ?? null;
}
if (is_string($previewRendererClassName) && $previewRendererClassName !== '') {
if (!is_a($previewRendererClassName, PreviewRendererInterface::class, true)) {
throw new \UnexpectedValueException(
sprintf(
'Class %s must implement %s',
$previewRendererClassName,
PreviewRendererInterface::class
),
1477512798
);
}
return GeneralUtility::makeInstance($previewRendererClassName);
}
throw new \RuntimeException(sprintf('No Preview renderer registered for table %s', $table), 1477520356);
}
}