ShortcutButton.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Backend\Template\Components\Buttons\Action;
 
/*
 * 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\Template\Components\ButtonBar;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\PositionInterface;
use ‪TYPO3\CMS\Backend\Template\ModuleTemplate;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext;
 
class ‪ShortcutButton implements ‪ButtonInterface, ‪PositionInterface
{
    protected ‪$moduleName;
 
    protected ‪$displayName;
 
    protected ‪$setVariables = [];
 
    protected ‪$getVariables = [];
 
    protected ‪$controllerContext;
 
    public function ‪getModuleName()
    {
        return ‪$this->moduleName;
    }
 
    public function ‪setModuleName(‪$moduleName)
    {
        $this->moduleName = ‪$moduleName;
        return $this;
    }
 
    public function ‪getDisplayName()
    {
        return ‪$this->displayName;
    }
 
    public function ‪setDisplayName(‪$displayName)
    {
        $this->displayName = ‪$displayName;
        return $this;
    }
 
    public function ‪getSetVariables()
    {
        return ‪$this->setVariables;
    }
 
    public function ‪setSetVariables(array ‪$setVariables)
    {
        $this->setVariables = ‪$setVariables;
        return $this;
    }
 
    public function ‪getGetVariables()
    {
        return ‪$this->getVariables;
    }
 
    public function ‪setGetVariables(array ‪$getVariables)
    {
        $this->getVariables = ‪$getVariables;
        return $this;
    }
 
    public function ‪getPosition()
    {
        return ‪ButtonBar::BUTTON_POSITION_RIGHT;
    }
 
    public function ‪getGroup()
    {
        return 91;
    }
 
    public function ‪getType()
    {
        return static::class;
    }
 
    public function ‪isValid()
    {
        $this->‪preProcess();
 
        return
            !empty($this->moduleName)
        ;
    }
 
    public function ‪__toString()
    {
        return $this->‪render();
    }
 
    public function ‪render()
    {
        if ($this->‪getBackendUser()->mayMakeShortcut()) {
            $moduleTemplate = GeneralUtility::makeInstance(ModuleTemplate::class);
            $shortcutMarkup = $moduleTemplate->makeShortcutIcon(
                implode(',', $this->getVariables),
                implode(',', $this->setVariables),
                $this->moduleName,
                '',
                $this->displayName
            );
        } else {
            $shortcutMarkup = '';
        }
 
        return $shortcutMarkup;
    }
 
    protected function ‪preProcess()
    {
        $emptyGetVariables = (count($this->getVariables) === 0);
 
        // Set default GET parameters
        if ($emptyGetVariables) {
            $this->getVariables = ['id', 'route'];
        }
 
        // Automatically determine module name in Extbase context
        if ($this->controllerContext !== null) {
            $currentRequest = $this->controllerContext->getRequest();
            $extensionName = $currentRequest->getControllerExtensionName();
            $this->moduleName = $currentRequest->getPluginName();
            // Extend default GET parameters
            if ($emptyGetVariables) {
                $modulePrefix = strtolower('tx_' . $extensionName . '_' . $this->moduleName);
                $this->getVariables[] = $modulePrefix;
            }
        }
    }
 
    protected function ‪getBackendUser()
    {
        return ‪$GLOBALS['BE_USER'];
    }
}