9.5/_help_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\Domain\Repository\TableManualRepository;

use ‪TYPO3\CMS\Backend\Routing\UriBuilder;

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\RedirectResponse;

use ‪TYPO3\CMS\Core\Imaging\Icon;

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

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

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

use TYPO3Fluid\Fluid\View\ViewInterface;


class ‪HelpController

{

    protected const ‪ALLOWED_ACTIONS = ['index', 'all', 'detail'];


    const ‪FULL = 0;


    const ‪TOC_ONLY = 1;


    protected ‪$tableManualRepository;


    protected ‪$moduleTemplate;


    protected ‪$view;


    public function ‪__construct()

    {

        $this->moduleTemplate = GeneralUtility::makeInstance(ModuleTemplate::class);

        $this->tableManualRepository = GeneralUtility::makeInstance(TableManualRepository::class);

    }


    public function ‪handleRequest(ServerRequestInterface $request): ResponseInterface

    {

        $action = $request->getQueryParams()['action'] ?? $request->getParsedBody()['action'] ?? 'index';


        if ($action === 'detail') {

            $table = $request->getQueryParams()['table'] ?? $request->getParsedBody()['table'];

            if (!$table) {

                $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

                return new ‪RedirectResponse((string)$uriBuilder->buildUriFromRoute('help_cshmanual', [

                    'action' => 'index',

                ]), 303);

            }

        }


        if (!in_array($action, self::ALLOWED_ACTIONS, true)) {

            return new HtmlResponse('Action not allowed', 400);

        }


        $this->‪initializeView($action);


        $result = call_user_func_array([$this, $action . 'Action'], [$request]);

        if ($result instanceof ResponseInterface) {

            return $result;

        }


        $this->‪registerDocheaderButtons($request);


        $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:backend/Resources/Private/Templates/ContextSensitiveHelp']);

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

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

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

        $this->view->assign('copyright', ‪BackendUtility::TYPO3_copyRightNotice());

    }


    public function ‪indexAction()

    {

        $this->view->assign('toc', $this->tableManualRepository->getSections(self::TOC_ONLY));

    }


    public function ‪allAction()

    {

        $this->view->assign('all', $this->tableManualRepository->getSections(self::FULL));

    }


    public function ‪detailAction(ServerRequestInterface $request)

    {

        $table = $request->getQueryParams()['table'] ?? $request->getParsedBody()['table'];

        $field = $request->getQueryParams()['field'] ?? $request->getParsedBody()['field'] ?? '*';


        $mainKey = $table;


        $this->view->assignMultiple([

            'table' => $table,

            'key' => $mainKey,

            'field' => $field,

            'manuals' => $field === '*'

                ? $this->tableManualRepository->getTableManual($mainKey)

                : [$this->tableManualRepository->getSingleManual($mainKey, $field)],

        ]);

    }


    protected function ‪registerDocheaderButtons(ServerRequestInterface $request)

    {

        $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();


        if ($this->‪getBackendUser()->mayMakeShortcut()) {

            $shortcutButton = $buttonBar->makeShortcutButton()

                ->setModuleName('help_cshmanual')

                ->setGetVariables(['table', 'field', 'route']);

            $buttonBar->addButton($shortcutButton);

        }


        $action = $request->getQueryParams()['action'] ?? $request->getParsedBody()['action'] ?? 'index';

        if ($action !== 'index') {

            $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

            $backButton = $buttonBar->makeLinkButton()

                ->setTitle($this->‪getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_common.xlf:back'))

                ->setIcon($this->moduleTemplate->getIconFactory()->getIcon('actions-view-go-up', ‪Icon::SIZE_SMALL))

                ->setHref((string)$uriBuilder->buildUriFromRoute('help_cshmanual'));

            $buttonBar->addButton($backButton);

        }

    }


    protected function ‪getBackendUser(): BackendUserAuthentication

    {

        return ‪$GLOBALS['BE_USER'];

    }


    protected function ‪getLanguageService(): LanguageService

    {

        return ‪$GLOBALS['LANG'];

    }

}