RecyclerModuleController.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\Recycler\Controller;
 
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Backend\Template\Components\ButtonBar;
use ‪TYPO3\CMS\Backend\Template\ModuleTemplate;
use ‪TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Http\HtmlResponse;
use ‪TYPO3\CMS\Core\Http\NormalizedParams;
use ‪TYPO3\CMS\Core\Imaging\Icon;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Type\Bitmask\Permission;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\MathUtility;
use ‪TYPO3\CMS\Fluid\View\StandaloneView;
 
class ‪RecyclerModuleController
{
 
    protected ‪$pageRecord = [];
 
    protected ‪$isAccessibleForCurrentUser = false;
 
    protected ‪$allowDelete = false;
 
    protected ‪$recordsPageLimit = 50;
 
    protected ‪$id;
 
    protected ‪$view;
 
    protected ‪$moduleTemplate;
 
    public function ‪handleRequest(ServerRequestInterface $request): ResponseInterface
    {
        $this->id = (int)($request->getQueryParams()['id'] ?? $request->getParsedBody()['id'] ?? 0);
        $backendUser = $this->‪getBackendUser();
        $this->pageRecord = ‪BackendUtility::readPageAccess($this->id, $backendUser->getPagePermsClause(‪Permission::PAGE_SHOW));
        $this->isAccessibleForCurrentUser = $this->id && is_array($this->pageRecord) || !$this->id && $this->‪getBackendUser()->‪isAdmin();
        $this->moduleTemplate = GeneralUtility::makeInstance(ModuleTemplate::class);
 
        // don't access in workspace
        if ($backendUser->workspace !== 0) {
            $this->isAccessibleForCurrentUser = false;
        }
 
        // read configuration
        if ($backendUser->isAdmin()) {
            $this->allowDelete = true;
        } else {
            $this->allowDelete = (bool)($backendUser->getTSConfig()['mod.']['recycler.']['allowDelete'] ?? false);
        }
 
        $this->recordsPageLimit = ‪MathUtility::forceIntegerInRange(
            (int)($backendUser->getTSConfig()['mod.']['recycler.']['recordsPageLimit'] ?? 25),
            1
        );
 
        $action = 'index';
        $this->‪initializeView($action);
 
        $result = call_user_func_array([$this, $action . 'Action'], [$request]);
        if ($result instanceof ResponseInterface) {
            return $result;
        }
 
        $this->‪registerDocheaderButtons();
 
        $this->moduleTemplate->setContent($this->view->render());
        return new ‪HtmlResponse($this->moduleTemplate->renderContent());
    }
 
    protected function ‪initializeView(string $templateName)
    {
        $this->view = GeneralUtility::makeInstance(StandaloneView::class);
        $this->view->setTemplate($templateName);
        $this->view->setTemplateRootPaths(['EXT:recycler/Resources/Private/Templates/RecyclerModule']);
        $this->view->setPartialRootPaths(['EXT:recycler/Resources/Private/Partials']);
        $this->view->setLayoutRootPaths(['EXT:recycler/Resources/Private/Layouts']);
        $this->view->getRequest()->setControllerExtensionName('Recycler');
    }
 
    public function ‪indexAction(ServerRequestInterface $request)
    {
        $this->moduleTemplate->getPageRenderer()->addInlineSettingArray('Recycler', $this->‪getJavaScriptConfiguration($request->getAttribute('normalizedParams')));
        $this->moduleTemplate->getPageRenderer()->addInlineLanguageLabelFile('EXT:recycler/Resources/Private/Language/locallang.xlf');
        if ($this->isAccessibleForCurrentUser) {
            $this->moduleTemplate->getDocHeaderComponent()->setMetaInformation($this->pageRecord);
        }
 
        $this->view->assign('allowDelete', $this->allowDelete);
    }
 
    protected function ‪registerDocheaderButtons()
    {
        $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
 
        $shortcutButton = $buttonBar->makeShortcutButton()
            ->setModuleName('web_recycler')
            ->setGetVariables(['id', 'route']);
        $buttonBar->addButton($shortcutButton);
 
        $reloadButton = $buttonBar->makeLinkButton()
            ->setHref('#')
            ->setDataAttributes(['action' => 'reload'])
            ->setTitle($this->‪getLanguageService()->sL('LLL:EXT:recycler/Resources/Private/Language/locallang.xlf:button.reload'))
            ->setIcon($this->moduleTemplate->getIconFactory()->getIcon('actions-refresh', ‪Icon::SIZE_SMALL));
        $buttonBar->addButton($reloadButton, ‪ButtonBar::BUTTON_POSITION_RIGHT);
    }
 
    protected function ‪getJavaScriptConfiguration(‪NormalizedParams $normalizedParams): array
    {
        return [
            'pagingSize' => ‪$this->recordsPageLimit,
            'showDepthMenu' => true,
            'startUid' => ‪$this->id,
            'isSSL' => $normalizedParams->‪isHttps(),
            'deleteDisable' => !‪$this->allowDelete,
            'depthSelection' => $this->‪getDataFromSession('depthSelection', '0'),
            'tableSelection' => $this->‪getDataFromSession('tableSelection', ''),
            'States' => $this->‪getBackendUser()->uc['moduleData']['web_recycler']['States']
        ];
    }
 
    protected function ‪getDataFromSession($identifier, $default = null)
    {
        $sessionData = &$this->‪getBackendUser()->uc['tx_recycler'];
        if (isset($sessionData[$identifier]) && $sessionData[$identifier]) {
            $data = $sessionData[$identifier];
        } else {
            $data = $default;
        }
        return $data;
    }
 
    protected function ‪getBackendUser(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
 
    protected function ‪getLanguageService(): ‪LanguageService
    {
        return ‪$GLOBALS['LANG'];
    }
}