9.5/_backend_layout_view_8php_source.html

<?php

namespace ‪TYPO3\CMS\Backend\View;


/*

 * 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\Core\Database\ConnectionPool;

use ‪TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser;

use ‪TYPO3\CMS\Core\Utility\ArrayUtility;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;


class ‪BackendLayoutView implements ‪\TYPO3\CMS\Core\SingletonInterface

{

    protected ‪$dataProviderCollection;


    protected ‪$selectedCombinedIdentifier = [];


    protected ‪$selectedBackendLayout = [];


    public function ‪__construct()

    {

        $this->‪initializeDataProviderCollection();

    }


    protected function ‪initializeDataProviderCollection()

    {

        ‪$dataProviderCollection = GeneralUtility::makeInstance(

            BackendLayout\DataProviderCollection::class

        );


        ‪$dataProviderCollection->add(

            'default',

            \‪TYPO3\CMS\Backend\View\BackendLayout\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) {

                ‪$dataProviderCollection->add($identifier, $className);

            }

        }


        $this->‪setDataProviderCollection(‪$dataProviderCollection);

    }


    public function ‪setDataProviderCollection(BackendLayout\DataProviderCollection ‪$dataProviderCollection)

    {

        $this->dataProviderCollection = ‪$dataProviderCollection;

    }


    public function ‪getDataProviderCollection()

    {

        return ‪$this->dataProviderCollection;

    }


    public function ‪addBackendLayoutItems(array $parameters)

    {

        $pageId = $this->‪determinePageId($parameters['table'], $parameters['row']);

        $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->‪getDataProviderCollection()->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'][] = [

                    $this->‪getLanguageService()->‪sL($backendLayout->getTitle()),

                    $combinedIdentifier,

                    $backendLayout->getIconPath(),

                ];

            }

        }

    }


    protected function ‪determinePageId($tableName, array $data)

    {

        if (strpos($data['uid'], 'NEW') === 0) {

            // 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']), \PDO::PARAM_INT)

                        )

                    )

                    ->execute()

                    ->fetchColumn();

            } else {

                $pageId = $data['pid'];

            }

        } elseif ($tableName === 'pages') {

            $pageId = $data['uid'];

        } else {

            $pageId = $data['pid'];

        }


        return $pageId;

    }


    public function ‪getSelectedCombinedIdentifier($pageId)

    {

        if (!isset($this->selectedCombinedIdentifier[$pageId])) {

            $page = $this->‪getPage($pageId);

            $this->selectedCombinedIdentifier[$pageId] = (string)$page['backend_layout'];


            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];

    }


    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;

    }


    public function ‪colPosListItemProcFunc(array $parameters)

    {

        $pageId = $this->‪determinePageId($parameters['table'], $parameters['row']);


        if ($pageId !== false) {

            $parameters['items'] = $this->‪addColPosListLayoutItems($pageId, $parameters['items']);

        }

    }


    protected function ‪addColPosListLayoutItems($pageId, $items)

    {

        $layout = $this->‪getSelectedBackendLayout($pageId);

        if ($layout && $layout['__items']) {

            $items = $layout['__items'];

        }

        return $items;

    }


    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;

    }


    protected function ‪addItems($items, $iArray)

    {

        $languageService = static::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;

    }


    public function ‪getSelectedBackendLayout($pageId)

    {

        if (isset($this->selectedBackendLayout[$pageId])) {

            return $this->selectedBackendLayout[$pageId];

        }

        $backendLayoutData = null;


        ‪$selectedCombinedIdentifier = $this->‪getSelectedCombinedIdentifier($pageId);

        // If no backend layout is selected, use default

        if (empty(‪$selectedCombinedIdentifier)) {

            ‪$selectedCombinedIdentifier = 'default';

        }


        $backendLayout = $this->‪getDataProviderCollection()->getBackendLayout(‪$selectedCombinedIdentifier, $pageId);

        // If backend layout is not found available anymore, use default

        if ($backendLayout === null) {

            ‪$selectedCombinedIdentifier = 'default';

            $backendLayout = $this->‪getDataProviderCollection()->getBackendLayout(‪$selectedCombinedIdentifier, $pageId);

        }


        if (!empty($backendLayout)) {

            ‪$parser = GeneralUtility::makeInstance(TypoScriptParser::class);

            $conditionMatcher = GeneralUtility::makeInstance(\‪TYPO3\CMS\Backend\Configuration\TypoScript\ConditionMatching\ConditionMatcher::class);

            ‪$parser->parse(‪TypoScriptParser::checkIncludeLines($backendLayout->getConfiguration()), $conditionMatcher);


            $backendLayoutData = [];

            $backendLayoutData['config'] = $backendLayout->getConfiguration();

            $backendLayoutData['__config'] = ‪$parser->setup;

            $backendLayoutData['__items'] = [];

            $backendLayoutData['__colPosList'] = [];


            // create items and colPosList

            if (!empty($backendLayoutData['__config']['backend_layout.']['rows.'])) {

                foreach ($backendLayoutData['__config']['backend_layout.']['rows.'] as $row) {

                    if (!empty($row['columns.'])) {

                        foreach ($row['columns.'] as $column) {

                            if (!isset($column['colPos'])) {

                                continue;

                            }

                            $backendLayoutData['__items'][] = [

                                $this->‪getColumnName($column),

                                $column['colPos'],

                                null

                            ];

                            $backendLayoutData['__colPosList'][] = $column['colPos'];

                        }

                    }

                }

            }


            $this->selectedBackendLayout[$pageId] = $backendLayoutData;

        }


        return $backendLayoutData;

    }


    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

                        }

                    }

                }

            }

        }

        ';

    }


    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, \PDO::PARAM_INT)

                )

            )

            ->execute()

            ->fetch();

        ‪BackendUtility::workspaceOL('pages', $page);


        return $page;

    }


    protected function ‪getRootLine($pageId)

    {

        return ‪BackendUtility::BEgetRootLine($pageId, '', true);

    }


    protected function ‪createDataProviderContext()

    {

        return GeneralUtility::makeInstance(BackendLayout\DataProviderContext::class);

    }


    protected function ‪getLanguageService()

    {

        return ‪$GLOBALS['LANG'];

    }


    protected function ‪getColumnName($column)

    {

        $columnName = $column['name'];


        if (GeneralUtility::isFirstPartOfStr($columnName, 'LLL:')) {

            $columnName = $this->‪getLanguageService()->‪sL($columnName);

        }


        return $columnName;

    }

}