Your IP : 216.73.217.13
<?php
/*
* 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\View;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Backend\View\BackendLayout\BackendLayout;
use TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection;
use TYPO3\CMS\Backend\View\BackendLayout\DataProviderContext;
use TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider;
use TYPO3\CMS\Core\Database\Connection;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Localization\LanguageService;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\TypoScript\TypoScriptStringFactory;
use TYPO3\CMS\Core\Utility\ArrayUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* Backend layout for CMS
* @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
*/
class BackendLayoutView implements SingletonInterface
{
protected array $selectedCombinedIdentifier = [];
protected array $selectedBackendLayout = [];
/**
* Create this object and initialize data providers.
*/
public function __construct(
private readonly DataProviderCollection $dataProviderCollection,
private readonly TypoScriptStringFactory $typoScriptStringFactory,
) {
$this->dataProviderCollection->add('default', DefaultDataProvider::class);
if (!empty($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['BackendLayoutDataProvider'])) {
$dataProviders = (array)$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['BackendLayoutDataProvider'];
foreach ($dataProviders as $identifier => $className) {
$this->dataProviderCollection->add($identifier, $className);
}
}
}
/**
* Gets backend layout items to be shown in the forms engine.
* This method is called as "itemsProcFunc" with the accordant context
* for pages.backend_layout and pages.backend_layout_next_level.
* Also used in the info module, since we need those items with
* the appropriate labels and backend layout identifiers there, too.
*
* @todo This method should return the items array instead of
* using the whole parameters array as reference. This
* has to be adjusted, as soon as the itemsProcFunc
* functionality is changed in this regard.
*/
public function addBackendLayoutItems(array &$parameters)
{
$pageId = $this->determinePageId($parameters['table'], $parameters['row']) ?: 0;
$pageTsConfig = (array)BackendUtility::getPagesTSconfig($pageId);
$identifiersToBeExcluded = $this->getIdentifiersToBeExcluded($pageTsConfig);
$dataProviderContext = $this->createDataProviderContext()
->setPageId($pageId)
->setData($parameters['row'])
->setTableName($parameters['table'])
->setFieldName($parameters['field'])
->setPageTsConfig($pageTsConfig);
$backendLayoutCollections = $this->dataProviderCollection->getBackendLayoutCollections($dataProviderContext);
foreach ($backendLayoutCollections as $backendLayoutCollection) {
$combinedIdentifierPrefix = '';
if ($backendLayoutCollection->getIdentifier() !== 'default') {
$combinedIdentifierPrefix = $backendLayoutCollection->getIdentifier() . '__';
}
foreach ($backendLayoutCollection->getAll() as $backendLayout) {
$combinedIdentifier = $combinedIdentifierPrefix . $backendLayout->getIdentifier();
if (in_array($combinedIdentifier, $identifiersToBeExcluded, true)) {
continue;
}
$parameters['items'][] = [
'label' => $this->getLanguageService()->sL($backendLayout->getTitle()),
'value' => $combinedIdentifier,
'icon' => $backendLayout->getIconPath(),
];
}
}
}
/**
* Determines the page id for a given record of a database table.
*
* @param string $tableName
* @return int|false Returns page id or false on error
*/
protected function determinePageId($tableName, array $data)
{
if (str_starts_with((string)$data['uid'], 'NEW')) {
// negative uid_pid values of content elements indicate that the element
// has been inserted after an existing element so there is no pid to get
// the backendLayout for and we have to get that first
if ($data['pid'] < 0) {
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable($tableName);
$queryBuilder->getRestrictions()
->removeAll();
$pageId = $queryBuilder
->select('pid')
->from($tableName)
->where(
$queryBuilder->expr()->eq(
'uid',
$queryBuilder->createNamedParameter(abs($data['pid']), Connection::PARAM_INT)
)
)
->executeQuery()
->fetchOne();
} else {
$pageId = $data['pid'];
}
} elseif ($tableName === 'pages') {
$pageId = $data['uid'];
} else {
$pageId = $data['pid'];
}
return $pageId;
}
/**
* Returns the backend layout which should be used for this page.
*
* @param int $pageId
* @return bool|string Identifier of the backend layout to be used, or FALSE if none
*/
public function getSelectedCombinedIdentifier($pageId)
{
if (!isset($this->selectedCombinedIdentifier[$pageId])) {
$page = $this->getPage($pageId);
$this->selectedCombinedIdentifier[$pageId] = (string)($page['backend_layout'] ?? null);
if ($this->selectedCombinedIdentifier[$pageId] === '-1') {
// If it is set to "none" - don't use any
$this->selectedCombinedIdentifier[$pageId] = false;
} elseif ($this->selectedCombinedIdentifier[$pageId] === '' || $this->selectedCombinedIdentifier[$pageId] === '0') {
// If it not set check the root-line for a layout on next level and use this
// (root-line starts with current page and has page "0" at the end)
$rootLine = $this->getRootLine($pageId);
// Remove first and last element (current and root page)
array_shift($rootLine);
array_pop($rootLine);
foreach ($rootLine as $rootLinePage) {
$this->selectedCombinedIdentifier[$pageId] = (string)$rootLinePage['backend_layout_next_level'];
if ($this->selectedCombinedIdentifier[$pageId] === '-1') {
// If layout for "next level" is set to "none" - don't use any and stop searching
$this->selectedCombinedIdentifier[$pageId] = false;
break;
}
if ($this->selectedCombinedIdentifier[$pageId] !== '' && $this->selectedCombinedIdentifier[$pageId] !== '0') {
// Stop searching if a layout for "next level" is set
break;
}
}
}
}
// If it is set to a positive value use this
return $this->selectedCombinedIdentifier[$pageId];
}
/**
* Gets backend layout identifiers to be excluded
*
* @return array
*/
protected function getIdentifiersToBeExcluded(array $pageTSconfig)
{
$identifiersToBeExcluded = [];
if (ArrayUtility::isValidPath($pageTSconfig, 'options./backendLayout./exclude')) {
$identifiersToBeExcluded = GeneralUtility::trimExplode(
',',
ArrayUtility::getValueByPath($pageTSconfig, 'options./backendLayout./exclude'),
true
);
}
return $identifiersToBeExcluded;
}
/**
* Gets colPos items to be shown in the forms engine.
* This method is called as "itemsProcFunc" with the accordant context
* for tt_content.colPos.
*/
public function colPosListItemProcFunc(array $parameters)
{
$pageId = $this->determinePageId($parameters['table'], $parameters['row']);
if ($pageId !== false) {
$parameters['items'] = $this->addColPosListLayoutItems($pageId, $parameters['items']);
}
}
/**
* Adds items to a colpos list
*
* @param int $pageId
* @param array $items
* @return array
*/
protected function addColPosListLayoutItems($pageId, $items)
{
$layout = $this->getSelectedBackendLayout($pageId);
if ($layout && !empty($layout['__items'])) {
$items = $layout['__items'];
}
return $items;
}
/**
* Gets the list of available columns for a given page id
*
* @param int $id
* @return array $tcaItems
*/
public function getColPosListItemsParsed($id)
{
$tsConfig = BackendUtility::getPagesTSconfig($id)['TCEFORM.']['tt_content.']['colPos.'] ?? [];
$tcaConfig = $GLOBALS['TCA']['tt_content']['columns']['colPos']['config'] ?? [];
$tcaItems = $tcaConfig['items'];
$tcaItems = $this->addItems($tcaItems, $tsConfig['addItems.'] ?? []);
if (isset($tcaConfig['itemsProcFunc']) && $tcaConfig['itemsProcFunc']) {
$tcaItems = $this->addColPosListLayoutItems($id, $tcaItems);
}
if (!empty($tsConfig['removeItems'])) {
foreach (GeneralUtility::trimExplode(',', $tsConfig['removeItems'], true) as $removeId) {
foreach ($tcaItems as $key => $item) {
if ($item[1] == $removeId) {
unset($tcaItems[$key]);
}
}
}
}
return $tcaItems;
}
/**
* Merges items into an item-array, optionally with an icon
* example:
* TCEFORM.pages.doktype.addItems.13 = My Label
* TCEFORM.pages.doktype.addItems.13.icon = EXT:t3skin/icons/gfx/i/pages.gif
*
* @param array $items The existing item array
* @param array $iArray An array of items to add. NOTICE: The keys are mapped to values, and the values and mapped to be labels. No possibility of adding an icon.
* @return array The updated $item array
* @internal
*/
protected function addItems($items, $iArray)
{
$languageService = $this->getLanguageService();
if (is_array($iArray)) {
foreach ($iArray as $value => $label) {
// if the label is an array (that means it is a subelement
// like "34.icon = mylabel.png", skip it (see its usage below)
if (is_array($label)) {
continue;
}
// check if the value "34 = mylabel" also has a "34.icon = myimage.png"
if (isset($iArray[$value . '.']) && $iArray[$value . '.']['icon']) {
$icon = $iArray[$value . '.']['icon'];
} else {
$icon = '';
}
$items[] = [$languageService->sL($label), $value, $icon];
}
}
return $items;
}
/**
* Gets the selected backend layout structure as an array
*
* @param int $pageId
* @return array|null $backendLayout
*/
public function getSelectedBackendLayout($pageId)
{
$layout = $this->getBackendLayoutForPage((int)$pageId);
return $layout?->getStructure();
}
/**
* Get the BackendLayout object and parse the structure based on the UserTSconfig
* @return BackendLayout
*/
public function getBackendLayoutForPage(int $pageId): ?BackendLayout
{
if (isset($this->selectedBackendLayout[$pageId])) {
return $this->selectedBackendLayout[$pageId];
}
$selectedCombinedIdentifier = $this->getSelectedCombinedIdentifier($pageId);
// If no backend layout is selected, use default
if (empty($selectedCombinedIdentifier)) {
$selectedCombinedIdentifier = 'default';
}
$backendLayout = $this->dataProviderCollection->getBackendLayout($selectedCombinedIdentifier, $pageId);
// If backend layout is not found available anymore, use default
if ($backendLayout === null) {
$backendLayout = $this->dataProviderCollection->getBackendLayout('default', $pageId);
}
if ($backendLayout instanceof BackendLayout) {
$this->selectedBackendLayout[$pageId] = $backendLayout;
}
return $backendLayout;
}
/**
* @internal
*/
public function parseStructure(BackendLayout $backendLayout): array
{
$typoScriptTree = $this->typoScriptStringFactory->parseFromStringWithIncludes('backend-layout', $backendLayout->getConfiguration());
$backendLayoutData = [];
$backendLayoutData['config'] = $backendLayout->getConfiguration();
$backendLayoutData['__config'] = $typoScriptTree->toArray();
$backendLayoutData['__items'] = [];
$backendLayoutData['__colPosList'] = [];
$backendLayoutData['usedColumns'] = [];
$backendLayoutData['colCount'] = (int)($backendLayoutData['__config']['backend_layout.']['colCount'] ?? 0);
$backendLayoutData['rowCount'] = (int)($backendLayoutData['__config']['backend_layout.']['rowCount'] ?? 0);
// create items and colPosList
if (!empty($backendLayoutData['__config']['backend_layout.']['rows.'])) {
$rows = $backendLayoutData['__config']['backend_layout.']['rows.'];
ksort($rows);
foreach ($rows as $row) {
if (!empty($row['columns.'])) {
foreach ($row['columns.'] as $column) {
if (!isset($column['colPos'])) {
continue;
}
$backendLayoutData['__items'][] = [
'label' => $this->getColumnName($column),
'value' => $column['colPos'],
'icon' => null,
];
$backendLayoutData['__colPosList'][] = $column['colPos'];
$backendLayoutData['usedColumns'][(int)$column['colPos']] = $column['name'];
}
}
}
}
return $backendLayoutData;
}
/**
* Get default columns layout
*
* @return string Default four column layout
* @static
*/
public static function getDefaultColumnLayout()
{
return '
backend_layout {
colCount = 1
rowCount = 1
rows {
1 {
columns {
1 {
name = LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:colPos.I.1
colPos = 0
}
}
}
}
}
';
}
/**
* Gets a page record.
*
* @param int $pageId
* @return array|false|null
*/
protected function getPage($pageId)
{
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable('pages');
$queryBuilder->getRestrictions()
->removeAll();
$page = $queryBuilder
->select('uid', 'pid', 'backend_layout')
->from('pages')
->where(
$queryBuilder->expr()->eq(
'uid',
$queryBuilder->createNamedParameter($pageId, Connection::PARAM_INT)
)
)
->executeQuery()
->fetchAssociative();
BackendUtility::workspaceOL('pages', $page);
return $page;
}
/**
* Gets the page root-line.
*
* @param int $pageId
* @return array
*/
protected function getRootLine($pageId)
{
return BackendUtility::BEgetRootLine($pageId, '', true);
}
/**
* @return DataProviderContext
*/
protected function createDataProviderContext()
{
return GeneralUtility::makeInstance(DataProviderContext::class);
}
protected function getLanguageService(): LanguageService
{
return $GLOBALS['LANG'];
}
/**
* Get column name from colPos item structure
*
* @param array $column
* @return string
*/
protected function getColumnName($column)
{
$columnName = $column['name'];
$columnName = $this->getLanguageService()->sL($columnName);
return $columnName;
}
}