PageTsBackendLayoutDataProvider.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Backend\Provider;
 
/*
 * 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!
 */
 
use ‪TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Backend\View\BackendLayout\BackendLayout;
use ‪TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection;
use ‪TYPO3\CMS\Backend\View\BackendLayout\DataProviderContext;
use ‪TYPO3\CMS\Backend\View\BackendLayout\DataProviderInterface;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪PageTsBackendLayoutDataProvider implements ‪DataProviderInterface
{
    protected ‪$backendLayouts = [];
 
    protected ‪$pageTsConfig = [];
 
    protected ‪$pageId = 0;
 
    protected function ‪setPageTsConfig(array ‪$pageTsConfig)
    {
        $this->pageTsConfig = ‪$pageTsConfig;
    }
 
    protected function ‪getPageTsConfig()
    {
        return ‪$this->pageTsConfig;
    }
 
    protected function ‪setPageId(‪$pageId)
    {
        $this->pageId = (int)‪$pageId;
    }
 
    protected function ‪getPageId()
    {
        return (int)‪$this->pageId;
    }
 
    protected function ‪generatePageTsConfig($dataProviderContext = null)
    {
        if ($dataProviderContext === null) {
            ‪$pageId = $this->‪getPageId();
            ‪$pageId = ‪$pageId > 0 ? ‪$pageId : (int)GeneralUtility::_GP('id');
            ‪$pageTsConfig = ‪BackendUtility::getPagesTSconfig(‪$pageId);
        } else {
            ‪$pageTsConfig = $dataProviderContext->getPageTsConfig();
        }
        $this->‪setPageTsConfig($pageTsConfig);
    }
 
    protected function ‪generateBackendLayouts($dataProviderContext = null)
    {
        $this->‪generatePageTsConfig($dataProviderContext);
        ‪$pageTsConfig = $this->‪getPageTsConfig();
        if (!empty(‪$pageTsConfig['mod.']['web_layout.']['BackendLayouts.'])) {
            ‪$backendLayouts = (array)‪$pageTsConfig['mod.']['web_layout.']['BackendLayouts.'];
            foreach (‪$backendLayouts as $identifier => $data) {
                $backendLayout = $this->‪generateBackendLayoutFromTsConfig($identifier, $data);
                $this->‪attachBackendLayout($backendLayout);
            }
        }
    }
 
    protected function ‪generateBackendLayoutFromTsConfig($identifier, $data)
    {
        if (!empty($data['config.']['backend_layout.']) && is_array($data['config.']['backend_layout.'])) {
            $backendLayout['uid'] = substr($identifier, 0, -1);
            $backendLayout['title'] = $data['title'] ? $data['title'] : $backendLayout['uid'];
            $backendLayout['icon'] = $data['icon'] ?: '';
            // Convert PHP array back to plain TypoScript so it can be procecced
            $config = ‪\TYPO3\CMS\Core\Utility\ArrayUtility::flatten($data['config.']);
            $backendLayout['config'] = '';
            foreach ($config as $row => $value) {
                $backendLayout['config'] .= $row . ' = ' . $value . "\r\n";
            }
            return $backendLayout;
        }
        return null;
    }
 
    protected function ‪attachBackendLayout($backendLayout = null)
    {
        if ($backendLayout) {
            $this->backendLayouts[$backendLayout['uid']] = $backendLayout;
        }
    }
 
    public function ‪addBackendLayouts(‪DataProviderContext $dataProviderContext, ‪BackendLayoutCollection $backendLayoutCollection)
    {
        $this->‪generateBackendLayouts($dataProviderContext);
        foreach ($this->backendLayouts as $backendLayoutConfig) {
            $backendLayout = $this->‪createBackendLayout($backendLayoutConfig);
            $backendLayoutCollection->‪add($backendLayout);
        }
    }
 
    public function ‪getBackendLayout($identifier, ‪$pageId)
    {
        $this->‪setPageId(‪$pageId);
        $this->‪generateBackendLayouts();
        $backendLayout = null;
        if (array_key_exists($identifier, $this->backendLayouts)) {
            return $this->‪createBackendLayout($this->backendLayouts[$identifier]);
        }
        return $backendLayout;
    }
 
    protected function ‪createBackendLayout(array $data)
    {
        $backendLayout = ‪BackendLayout::create($data['uid'], $data['title'], $data['config']);
        $backendLayout->setIconPath($this->‪getIconPath($data['icon']));
        $backendLayout->setData($data);
        return $backendLayout;
    }
 
    protected function ‪getIconPath($icon)
    {
        $iconPath = '';
        if (!empty($icon)) {
            $iconPath = $icon;
        }
        return $iconPath;
    }
}