ElementBrowserController.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\Controller;
 
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Backend\Routing\UriBuilder;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Http\HtmlResponse;
use ‪TYPO3\CMS\Core\Http\RedirectResponse;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Recordlist\Browser\ElementBrowserInterface;
 
class ‪ElementBrowserController
{
    protected string ‪$mode = '';
 
    public function ‪mainAction(ServerRequestInterface $request): ResponseInterface
    {
        $this->‪getLanguageService()->‪includeLLFile('EXT:recordlist/Resources/Private/Language/locallang_browse_links.xlf');
        $this->mode = $request->getQueryParams()['mode'] ?? $request->getQueryParams()['mode'] ?? '';
        // Fallback for old calls, which use mode "wizard" or "rte" for link selection
        if ($this->mode === 'wizard' || $this->mode === 'rte') {
            trigger_error('Calling ElementBrowserController::mainAction with "wizard" or "mode" as values will be removed in TYPO3 v12.0. Link to the "wizard_link" instead.', E_USER_DEPRECATED);
            $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
            return new ‪RedirectResponse((string)$uriBuilder->buildUriFromRoute('wizard_link', $_GET), 303);
        }
        return new ‪HtmlResponse($this->‪main($request));
    }
 
    protected function ‪main(ServerRequestInterface $request)
    {
        $content = '';
 
        // Render type by user func
        $browserRendered = false;
 
        // @deprecated will be removed in TYPO3 v12.0.
        if (!empty(‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/browse_links.php']['browserRendering'] ?? [])) {
            trigger_error('$TYPO3_CONF_VARS[SC_OPTIONS][typo3/browse_links.php][browserRendering] will be removed in TYPO3 v12.0. Use a custom ElementBrowser, as introduced in TYPO3 7.6, instead.', E_USER_DEPRECATED);
        }
        foreach (‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/browse_links.php']['browserRendering'] ?? [] as $className) {
            $browserRenderObj = GeneralUtility::makeInstance($className);
            if (is_object($browserRenderObj) && method_exists($browserRenderObj, 'isValid') && method_exists($browserRenderObj, 'render')) {
                if ($browserRenderObj->isValid($this->mode, $this)) {
                    $content = $browserRenderObj->render($this->mode, $this);
                    $browserRendered = true;
                    break;
                }
            }
        }
 
        // if type was not rendered use default rendering functions
        if (!$browserRendered) {
            $browser = $this->‪getElementBrowserInstance();
            if (is_callable([$browser, 'setRequest'])) {
                $browser->setRequest($request);
            }
 
            $backendUser = $this->‪getBackendUser();
            $modData = $backendUser->getModuleData('browse_links.php', 'ses');
            [$modData] = $browser->processSessionData($modData);
            $backendUser->pushModuleData('browse_links.php', $modData);
 
            $content = $browser->render();
        }
 
        return $content;
    }
 
    protected function ‪getElementBrowserInstance()
    {
        $className = ‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ElementBrowsers'][‪$this->mode];
        $browser = GeneralUtility::makeInstance($className);
        if (!$browser instanceof ‪ElementBrowserInterface) {
            throw new \UnexpectedValueException('The specified element browser "' . $className . '" does not implement the required ElementBrowserInterface', 1442763890);
        }
        return $browser;
    }
 
    protected function ‪getLanguageService()
    {
        return ‪$GLOBALS['LANG'];
    }
 
    protected function ‪getBackendUser()
    {
        return ‪$GLOBALS['BE_USER'];
    }
}