DefaultDataProvider.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\Backend\View\BackendLayout;
 
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Backend\View\BackendLayoutView;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\WorkspaceRestriction;
use ‪TYPO3\CMS\Core\Resource\FileRepository;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪DefaultDataProvider implements ‪DataProviderInterface
{
    protected string ‪$tableName = 'backend_layout';
 
    public function ‪addBackendLayouts(
        ‪DataProviderContext $dataProviderContext,
        ‪BackendLayoutCollection $backendLayoutCollection
    ): void {
        $layoutData = $this->‪getLayoutData(
            $dataProviderContext->‪getFieldName(),
            $dataProviderContext->‪getPageTsConfig(),
            $dataProviderContext->‪getPageId()
        );
 
        foreach ($layoutData as ‪$data) {
            $backendLayout = $this->‪createBackendLayout($data);
            $backendLayoutCollection->‪add($backendLayout);
        }
    }
 
    public function ‪getBackendLayout(‪$identifier, $pageId): ?‪BackendLayout
    {
        $backendLayout = null;
 
        if ((string)‪$identifier === 'default') {
            return $this->‪createDefaultBackendLayout();
        }
 
        ‪$data = BackendUtility::getRecordWSOL($this->tableName, (int)‪$identifier);
 
        if (is_array(‪$data)) {
            $backendLayout = $this->‪createBackendLayout(‪$data);
        }
 
        return $backendLayout;
    }
 
    protected function ‪createDefaultBackendLayout(): ‪BackendLayout
    {
        return ‪BackendLayout::create(
            'default',
            'LLL:EXT:frontend/Resources/Private/Language/locallang_tca.xlf:pages.backend_layout.default',
            ‪BackendLayoutView::getDefaultColumnLayout()
        );
    }
 
    protected function ‪createBackendLayout(array ‪$data): ‪BackendLayout
    {
        $backendLayout = ‪BackendLayout::create((string)‪$data['uid'], ‪$data['title'], ‪$data['config']);
        $backendLayout->setIconPath($this->‪getIconPath($data));
        $backendLayout->setData(‪$data);
        return $backendLayout;
    }
 
    protected function ‪getIconPath(array $icon): string
    {
        $fileRepository = GeneralUtility::makeInstance(FileRepository::class);
        $references = $fileRepository->findByRelation($this->tableName, 'icon', (int)$icon['uid']);
        if (!empty($references)) {
            $icon = reset($references);
            return $icon->getPublicUrl();
        }
        return '';
    }
 
    protected function ‪getLayoutData(string $fieldName, array $pageTsConfig, int $pageUid): array
    {
        $storagePid = $this->‪getStoragePid($pageTsConfig);
        $pageTsConfigId = $this->‪getPageTSconfigIds($pageTsConfig);
 
        // Add layout records
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable($this->tableName);
        $queryBuilder->getRestrictions()
            ->add(
                GeneralUtility::makeInstance(
                    WorkspaceRestriction::class,
                    GeneralUtility::makeInstance(Context::class)->getPropertyFromAspect('workspace', 'id')
                )
            );
        $queryBuilder
            ->select('*')
            ->from($this->tableName)
            ->where(
                $queryBuilder->expr()->or(
                    $queryBuilder->expr()->and(
                        $queryBuilder->expr()->comparison(
                            $queryBuilder->createNamedParameter($pageTsConfigId[$fieldName], ‪Connection::PARAM_INT),
                            ExpressionBuilder::EQ,
                            $queryBuilder->createNamedParameter(0, ‪Connection::PARAM_INT)
                        ),
                        $queryBuilder->expr()->comparison(
                            $queryBuilder->createNamedParameter($storagePid, ‪Connection::PARAM_INT),
                            ExpressionBuilder::EQ,
                            $queryBuilder->createNamedParameter(0, ‪Connection::PARAM_INT)
                        )
                    ),
                    $queryBuilder->expr()->or(
                        $queryBuilder->expr()->eq(
                            'backend_layout.pid',
                            $queryBuilder->createNamedParameter($pageTsConfigId[$fieldName], ‪Connection::PARAM_INT)
                        ),
                        $queryBuilder->expr()->eq(
                            'backend_layout.pid',
                            $queryBuilder->createNamedParameter($storagePid, ‪Connection::PARAM_INT)
                        )
                    ),
                    $queryBuilder->expr()->and(
                        $queryBuilder->expr()->comparison(
                            $queryBuilder->createNamedParameter($pageTsConfigId[$fieldName], ‪Connection::PARAM_INT),
                            ExpressionBuilder::EQ,
                            $queryBuilder->createNamedParameter(0, ‪Connection::PARAM_INT)
                        ),
                        $queryBuilder->expr()->eq(
                            'backend_layout.pid',
                            $queryBuilder->createNamedParameter($pageUid, ‪Connection::PARAM_INT)
                        )
                    )
                )
            );
 
        if (!empty(‪$GLOBALS['TCA'][$this->tableName]['ctrl']['sortby'])) {
            $queryBuilder->orderBy(‪$GLOBALS['TCA'][$this->tableName]['ctrl']['sortby']);
        }
 
        $statement = $queryBuilder->executeQuery();
 
        $results = [];
        while (‪$record = $statement->fetchAssociative()) {
            BackendUtility::workspaceOL($this->tableName, ‪$record);
            if (is_array(‪$record)) {
                $results[‪$record['t3ver_oid'] ?: ‪$record['uid']] = ‪$record;
            }
        }
 
        return $results;
    }
 
    protected function ‪getStoragePid(array $pageTsConfig): int
    {
        $storagePid = 0;
 
        if (!empty($pageTsConfig['TCEFORM.']['pages.']['_STORAGE_PID'])) {
            $storagePid = (int)$pageTsConfig['TCEFORM.']['pages.']['_STORAGE_PID'];
        }
 
        return $storagePid;
    }
 
    protected function ‪getPageTSconfigIds(array $pageTsConfig): array
    {
        $pageTsConfigIds = [
            'backend_layout' => 0,
            'backend_layout_next_level' => 0,
        ];
 
        if (!empty($pageTsConfig['TCEFORM.']['pages.']['backend_layout.']['PAGE_TSCONFIG_ID'])) {
            $pageTsConfigIds['backend_layout'] = (int)$pageTsConfig['TCEFORM.']['pages.']['backend_layout.']['PAGE_TSCONFIG_ID'];
        }
 
        if (!empty($pageTsConfig['TCEFORM.']['pages.']['backend_layout_next_level.']['PAGE_TSCONFIG_ID'])) {
            $pageTsConfigIds['backend_layout_next_level'] = (int)$pageTsConfig['TCEFORM.']['pages.']['backend_layout_next_level.']['PAGE_TSCONFIG_ID'];
        }
 
        return $pageTsConfigIds;
    }
}