AbstractElementBrowser.php

Go to the documentation of this file.

<?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\Recordlist\Browser;
 
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Backend\Routing\UriBuilder;
use ‪TYPO3\CMS\Backend\Template\ModuleTemplate;
use ‪TYPO3\CMS\Backend\Template\ModuleTemplateFactory;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Imaging\IconFactory;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use TYPO3\CMS\Core\Page\PageRenderer;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
abstract class ‪AbstractElementBrowser
{
    protected ‪$moduleTemplate;
 
    protected ‪$thisScript = '';
 
    protected ‪$bparams = '';
 
    protected ?ServerRequestInterface ‪$request = null;
 
    protected ‪IconFactory ‪$iconFactory;
    protected PageRenderer ‪$pageRenderer;
    protected ‪UriBuilder ‪$uriBuilder;
    protected ‪ModuleTemplateFactory ‪$moduleTemplateFactory;
 
    public function ‪__construct(
        ‪IconFactory ‪$iconFactory,
        PageRenderer ‪$pageRenderer,
        ‪UriBuilder ‪$uriBuilder,
        ‪ModuleTemplateFactory ‪$moduleTemplateFactory
    ) {
        $this->iconFactory = ‪$iconFactory;
        $this->pageRenderer = ‪$pageRenderer;
        $this->uriBuilder = ‪$uriBuilder;
        $this->moduleTemplateFactory = ‪$moduleTemplateFactory;
    }
 
    protected function ‪initialize()
    {
        $this->moduleTemplate = $this->moduleTemplateFactory->create($this->‪getRequest());
        $this->moduleTemplate->getDocHeaderComponent()->disable();
        $this->moduleTemplate->getView()->setTemplate('ElementBrowser');
        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Recordlist/ElementBrowser');
        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/Viewport/ResizableNavigation');
        $this->pageRenderer->addInlineLanguageLabelFile('EXT:core/Resources/Private/Language/locallang_misc.xlf');
        $this->pageRenderer->addInlineLanguageLabelFile('EXT:core/Resources/Private/Language/locallang_core.xlf');
        $this->‪determineScriptUrl();
        $this->‪initVariables();
    }
 
    protected function ‪determineScriptUrl()
    {
        $this->thisScript = (string)$this->uriBuilder->buildUriFromRoute(
            $this->getRequest()->getAttribute('route')->getOption('_identifier')
        );
    }
 
    protected function ‪initVariables()
    {
        $this->bparams = $this->‪getRequest()->getParsedBody()['bparams'] ?? $this->‪getRequest()->getQueryParams()['bparams'] ?? '';
    }
 
    protected function ‪setBodyTagParameters()
    {
        $bodyDataAttributes = array_merge(
            $this->getBParamDataAttributes(),
            $this->getBodyTagAttributes()
        );
        $bodyTag = $this->moduleTemplate->getBodyTag();
        $bodyTag = str_replace('>', ' ' . GeneralUtility::implodeAttributes($bodyDataAttributes, true, true) . '>', $bodyTag);
        $this->moduleTemplate->setBodyTag($bodyTag);
    }
 
    protected function getBodyTagAttributes()
    {
        return [];
    }
 
    protected function getBParamDataAttributes()
    {
        $params = explode('|', $this->bparams);
        ‪$fieldRef = $params[0];
        $rteParams = $params[1];
        $rteConfig = $params[2];
        $irreObjectId = $params[4] ?? null;
 
        return [
            'data-form-field-name' => 'data[' . ‪$fieldRef . '][' . $rteParams . '][' . $rteConfig . ']',
            'data-field-reference' => ‪$fieldRef,
            'data-rte-parameters' => $rteParams,
            'data-rte-configuration' => $rteConfig,
            'data-irre-object-id' => $irreObjectId,
        ];
    }
 
    public function ‪setRequest(ServerRequestInterface ‪$request): void
    {
        $this->request = ‪$request;
        // initialize here, this is a dirty hack as long as the interface does not support setting a request object properly
        // see ElementBrowserController.php for the process on how the program code flow is used
        $this->‪initialize();
    }
 
    protected function ‪getRequest(): ServerRequestInterface
    {
        return $this->request ?? ‪$GLOBALS['TYPO3_REQUEST'];
    }
 
    protected function ‪getLanguageService()
    {
        return ‪$GLOBALS['LANG'];
    }
 
    protected function ‪getBackendUser()
    {
        return ‪$GLOBALS['BE_USER'];
    }
}