9.5/_shortcut_controller_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Backend\Controller;


/*

 * 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 Psr\Http\Message\ResponseInterface;

use Psr\Http\Message\ServerRequestInterface;

use ‪TYPO3\CMS\Backend\Backend\Shortcut\ShortcutRepository;

use ‪TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem;

use ‪TYPO3\CMS\Backend\Module\ModuleLoader;

use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;

use ‪TYPO3\CMS\Core\Http\HtmlResponse;

use ‪TYPO3\CMS\Core\Http\JsonResponse;

use ‪TYPO3\CMS\Core\Localization\LanguageService;

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

use ‪TYPO3\CMS\Fluid\View\StandaloneView;


class ‪ShortcutController

{

    protected ‪$shortcutToolbarItem;


    protected ‪$shortcutRepository;


    protected ‪$moduleLoader;


    public function ‪__construct()

    {

        $this->shortcutToolbarItem = GeneralUtility::makeInstance(ShortcutToolbarItem::class);

        $this->shortcutRepository = GeneralUtility::makeInstance(ShortcutRepository::class);

        // Needed to get the correct icons when reloading the menu after saving it

        $this->moduleLoader = GeneralUtility::makeInstance(ModuleLoader::class);

        $this->moduleLoader->load(‪$GLOBALS['TBE_MODULES']);

    }


    public function ‪menuAction(): ResponseInterface

    {

        return new ‪HtmlResponse($this->shortcutToolbarItem->getDropDown());

    }


    public function ‪addAction(ServerRequestInterface $request): ResponseInterface

    {

        $result = 'success';

        $parsedBody = $request->getParsedBody();

        $queryParams = $request->getQueryParams();

        $url = rawurldecode($parsedBody['url'] ?? $queryParams['url'] ?? '');


        if ($this->shortcutRepository->shortcutExists($url)) {

            $result = 'alreadyExists';

        } else {

            $moduleName = $parsedBody['module'] ?? '';

            $parentModuleName = $parsedBody['motherModName'] ?? '';

            $shortcutName = $parsedBody['displayName'] ?? '';

            $success = $this->shortcutRepository->addShortcut($url, $moduleName, $parentModuleName, $shortcutName);


            if (!$success) {

                $result = 'failed';

            }

        }


        return new ‪HtmlResponse($result);

    }


    public function ‪showEditFormAction(ServerRequestInterface $request): ResponseInterface

    {

        $parsedBody = $request->getParsedBody();

        $queryParams = $request->getQueryParams();


        $selectedShortcutId = (int)($parsedBody['shortcutId'] ?? $queryParams['shortcutId']);

        $selectedShortcutGroupId = (int)($parsedBody['shortcutGroup'] ?? $queryParams['shortcutGroup']);

        $selectedShortcut = $this->shortcutRepository->getShortcutById($selectedShortcutId);

        $shortcutGroups = $this->shortcutRepository->getShortcutGroups();


        $editFormView = $this->‪getFluidTemplateObject('EditForm.html');

        $editFormView->assign('selectedShortcutId', $selectedShortcutId);

        $editFormView->assign('selectedShortcutGroupId', $selectedShortcutGroupId);

        $editFormView->assign('selectedShortcut', $selectedShortcut);

        $editFormView->assign('shortcutGroups', $shortcutGroups);


        return new ‪HtmlResponse($editFormView->render());

    }


    public function ‪updateAction(ServerRequestInterface $request): ResponseInterface

    {

        $parsedBody = $request->getParsedBody();

        $queryParams = $request->getQueryParams();

        $shortcutId = (int)($parsedBody['shortcutId'] ?? $queryParams['shortcutId'] ?? 0);

        $shortcutTitle = strip_tags($parsedBody['shortcutTitle'] ?? $queryParams['shortcutTitle'] ?? '');

        $shortcutGroupId = (int)($parsedBody['shortcutGroup'] ?? $queryParams['shortcutGroup'] ?? 0);


        $success = $this->shortcutRepository->updateShortcut($shortcutId, $shortcutTitle, $shortcutGroupId);


        return new ‪HtmlResponse($success ? $shortcutTitle : 'failed');

    }


    public function ‪removeAction(ServerRequestInterface $request): ResponseInterface

    {

        $parsedBody = $request->getParsedBody();

        $queryParams = $request->getQueryParams();

        $shortcutId = (int)($parsedBody['shortcutId'] ?? $queryParams['shortcutId'] ?? 0);

        $success = $this->shortcutRepository->removeShortcut($shortcutId);


        return new ‪JsonResponse(['success' => $success]);

    }


    protected function ‪getFluidTemplateObject(string $templateFilename): ‪StandaloneView

    {

        $view = GeneralUtility::makeInstance(StandaloneView::class);

        $view->setLayoutRootPaths(['EXT:backend/Resources/Private/Layouts']);

        $view->setPartialRootPaths(['EXT:backend/Resources/Private/Partials']);

        $view->setTemplateRootPaths(['EXT:backend/Resources/Private/Templates/ShortcutToolbarItem']);

        $view->setTemplate($templateFilename);

        $view->getRequest()->setControllerExtensionName('Backend');


        return $view;

    }


    protected function ‪getBackendUser(): ‪BackendUserAuthentication

    {

        return ‪$GLOBALS['BE_USER'];

    }


    protected function ‪getLanguageService(): ‪LanguageService

    {

        return ‪$GLOBALS['LANG'];

    }

}