HelpController::getShortcutTitle() - Code Metrics - Inspection of "[TASK] Enforce shortcut title to be set by control..." - TYPO3/TYPO3.CMS - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ff1a76...9dbd27 )

unknown

created 2020-12-14 20:20 UTC

HelpController::getShortcutTitle() A

↳ Parent: HelpController

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	6
dl	0
loc	10
rs	10
c	0
b	0
f	0
cc	3
nc	3
nop	1

<?php

declare(strict_types=1);

/*
 * 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\Backend\Controller;

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\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\Information\Typo3Information;
use TYPO3\CMS\Core\Localization\LanguageService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Fluid\View\StandaloneView;
use TYPO3Fluid\Fluid\View\ViewInterface;

/**
 * Main "CSH help" module controller
 * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
 */
class HelpController
{
    protected const ALLOWED_ACTIONS = ['index', 'all', 'detail'];

    /**
     * Section identifiers
     */
    const FULL = 0;

    /**
     * Show only Table of contents
     */
    const TOC_ONLY = 1;

    /**
     * @var TableManualRepository
     */
    protected $tableManualRepository;

    /** @var ModuleTemplate */
    protected $moduleTemplate;

    /** @var ViewInterface */
    protected $view;

    /**
     * @var Typo3Information
     */
    protected $typo3Information;

    /**
     * Instantiate the report controller
     *
     * @param Typo3Information $typo3Information
     */
    public function __construct(Typo3Information $typo3Information)
    {
        $this->moduleTemplate = GeneralUtility::makeInstance(ModuleTemplate::class);
        $this->tableManualRepository = GeneralUtility::makeInstance(TableManualRepository::class);
        $this->typo3Information = $typo3Information;
    }

    /**
     * Injects the request object for the current request, and renders correct action
     *
     * @param ServerRequestInterface $request the current request
     * @return ResponseInterface the response with the content
     */
    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 = $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());
    }

    /**
     * @param string $templateName
     */
    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', $this->typo3Information->getCopyrightNotice());
    }

    /**
     * Show table of contents
     */
    public function indexAction()
    {
        $this->view->assign('toc', $this->tableManualRepository->getSections(self::TOC_ONLY));
    }

    /**
     * Show the table of contents and all manuals
     */
    public function allAction()
    {
        $this->view->assign('all', $this->tableManualRepository->getSections(self::FULL));
    }

    /**
     * Show a single manual
     *
     * @param ServerRequestInterface $request
     */
    public function detailAction(ServerRequestInterface $request)
    {
        $table = $request->getQueryParams()['table'] ?? $request->getParsedBody()['table'];
        $field = $request->getQueryParams()['field'] ?? $request->getParsedBody()['field'] ?? '*';

        $this->view->assignMultiple([
            'table' => $table,
            'key' => $table,
            'field' => $field,
            'manuals' => $this->getManuals($request)
        ]);
    }

    /**
     * Registers the Icons into the docheader
     *
     * @param ServerRequestInterface $request
     */
    protected function registerDocheaderButtons(ServerRequestInterface $request)
    {
        $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();

        $action = $request->getQueryParams()['action'] ?? $request->getParsedBody()['action'] ?? 'index';
        $shortcutButton = $buttonBar->makeShortcutButton()
            ->setModuleName('help_cshmanual')
            ->setDisplayName($this->getShortcutTitle($request))
            ->setArguments([
                'route' => $request->getQueryParams()['route'],
                'action' => $action,
                'table' => $request->getQueryParams()['table'] ?? '',
                'field' => $request->getQueryParams()['field'] ?? ''
            ]);
        $buttonBar->addButton($shortcutButton);

        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 getManuals(ServerRequestInterface $request): array
    {
        $table = $request->getQueryParams()['table'] ?? $request->getParsedBody()['table'];
        $field = $request->getQueryParams()['field'] ?? $request->getParsedBody()['field'] ?? '*';

        return $field === '*'
            ? $this->tableManualRepository->getTableManual($table)
            : [$this->tableManualRepository->getSingleManual($table, $field)];
    }

    /**
     * Returns the shortcut title for the current page
     *
     * @param ServerRequestInterface $request
     * @return string
     */
    protected function getShortcutTitle(ServerRequestInterface $request): string
    {
        $title = $this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_mod_help_cshmanual.xlf:mlang_labels_tablabel');
        if (($manuals = $this->getManuals($request)) !== []) {
            $manualTitle = array_shift($manuals)['headerLine'] ?? '';
            if ($manualTitle !== '') {
                $title .= ': ' . $manualTitle;
            }
        }
        return $title;
    }

    /**
     * Returns the currently logged in BE user
     *
     * @return BackendUserAuthentication
     */
    protected function getBackendUser(): BackendUserAuthentication
    {
        return $GLOBALS['BE_USER'];
    }

    /**
     * Returns the LanguageService
     *
     * @return LanguageService
     */
    protected function getLanguageService(): LanguageService
    {
        return $GLOBALS['LANG'];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the TYPO3 CMS project.
7			*
8			* It is free software; you can redistribute it and/or modify it under
9			* the terms of the GNU General Public License, either version 2
10			* of the License, or any later version.
11			*
12			* For the full copyright and license information, please read the
13			* LICENSE.txt file that was distributed with this source code.
14			*
15			* The TYPO3 project - inspiring people to share!
16			*/
17
18			namespace TYPO3\CMS\Backend\Controller;
19
20			use Psr\Http\Message\ResponseInterface;
21			use Psr\Http\Message\ServerRequestInterface;
22			use TYPO3\CMS\Backend\Domain\Repository\TableManualRepository;
23			use TYPO3\CMS\Backend\Routing\UriBuilder;
24			use TYPO3\CMS\Backend\Template\ModuleTemplate;
25			use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
26			use TYPO3\CMS\Core\Http\HtmlResponse;
27			use TYPO3\CMS\Core\Http\RedirectResponse;
28			use TYPO3\CMS\Core\Imaging\Icon;
29			use TYPO3\CMS\Core\Information\Typo3Information;
30			use TYPO3\CMS\Core\Localization\LanguageService;
31			use TYPO3\CMS\Core\Utility\GeneralUtility;
32			use TYPO3\CMS\Fluid\View\StandaloneView;
33			use TYPO3Fluid\Fluid\View\ViewInterface;
34
35			/**
36			* Main "CSH help" module controller
37			* @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
38			*/
39			class HelpController
40			{
41			protected const ALLOWED_ACTIONS = ['index', 'all', 'detail'];
42
43			/**
44			* Section identifiers
45			*/
46			const FULL = 0;
47
48			/**
49			* Show only Table of contents
50			*/
51			const TOC_ONLY = 1;
52
53			/**
54			* @var TableManualRepository
55			*/
56			protected $tableManualRepository;
57
58			/** @var ModuleTemplate */
59			protected $moduleTemplate;
60
61			/** @var ViewInterface */
62			protected $view;
63
64			/**
65			* @var Typo3Information
66			*/
67			protected $typo3Information;
68
69			/**
70			* Instantiate the report controller
71			*
72			* @param Typo3Information $typo3Information
73			*/
74			public function __construct(Typo3Information $typo3Information)
75			{
76			$this->moduleTemplate = GeneralUtility::makeInstance(ModuleTemplate::class);
77			$this->tableManualRepository = GeneralUtility::makeInstance(TableManualRepository::class);
78			$this->typo3Information = $typo3Information;
79			}
80
81			/**
82			* Injects the request object for the current request, and renders correct action
83			*
84			* @param ServerRequestInterface $request the current request
85			* @return ResponseInterface the response with the content
86			*/
87			public function handleRequest(ServerRequestInterface $request): ResponseInterface
88			{
89			$action = $request->getQueryParams()['action'] ?? $request->getParsedBody()['action'] ?? 'index';
90
91			if ($action === 'detail') {
92			$table = $request->getQueryParams()['table'] ?? $request->getParsedBody()['table'];
93			if (!$table) {
94			$uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
95			return new RedirectResponse((string)$uriBuilder->buildUriFromRoute('help_cshmanual', [
96			'action' => 'index',
97			]), 303);
98			}
99			}
100
101			if (!in_array($action, self::ALLOWED_ACTIONS, true)) {
102			return new HtmlResponse('Action not allowed', 400);
103			}
104
105			$this->initializeView($action);
106
107			$result = $this->{$action . 'Action'}($request);
108			if ($result instanceof ResponseInterface) {
109			return $result;
110			}
111
112			$this->registerDocheaderButtons($request);
113
114			$this->moduleTemplate->setContent($this->view->render());
115			return new HtmlResponse($this->moduleTemplate->renderContent());
116			}
117
118			/**
119			* @param string $templateName
120			*/
121			protected function initializeView(string $templateName)
122			{
123			$this->view = GeneralUtility::makeInstance(StandaloneView::class);
124			$this->view->setTemplate($templateName);
125			$this->view->setTemplateRootPaths(['EXT:backend/Resources/Private/Templates/ContextSensitiveHelp']);
126			$this->view->setPartialRootPaths(['EXT:backend/Resources/Private/Partials']);
127			$this->view->setLayoutRootPaths(['EXT:backend/Resources/Private/Layouts']);
128			$this->view->getRequest()->setControllerExtensionName('Backend');
129			$this->view->assign('copyright', $this->typo3Information->getCopyrightNotice());
130			}
131
132			/**
133			* Show table of contents
134			*/
135			public function indexAction()
136			{
137			$this->view->assign('toc', $this->tableManualRepository->getSections(self::TOC_ONLY));
138			}
139
140			/**
141			* Show the table of contents and all manuals
142			*/
143			public function allAction()
144			{
145			$this->view->assign('all', $this->tableManualRepository->getSections(self::FULL));
146			}
147
148			/**
149			* Show a single manual
150			*
151			* @param ServerRequestInterface $request
152			*/
153			public function detailAction(ServerRequestInterface $request)
154			{
155			$table = $request->getQueryParams()['table'] ?? $request->getParsedBody()['table'];
156			$field = $request->getQueryParams()['field'] ?? $request->getParsedBody()['field'] ?? '*';
157
158			$this->view->assignMultiple([
159			'table' => $table,
160			'key' => $table,
161			'field' => $field,
162			'manuals' => $this->getManuals($request)
163			]);
164			}
165
166			/**
167			* Registers the Icons into the docheader
168			*
169			* @param ServerRequestInterface $request
170			*/
171			protected function registerDocheaderButtons(ServerRequestInterface $request)
172			{
173			$buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
174
175			$action = $request->getQueryParams()['action'] ?? $request->getParsedBody()['action'] ?? 'index';
176			$shortcutButton = $buttonBar->makeShortcutButton()
177			->setModuleName('help_cshmanual')
178			->setDisplayName($this->getShortcutTitle($request))
179			->setArguments([
180			'route' => $request->getQueryParams()['route'],
181			'action' => $action,
182			'table' => $request->getQueryParams()['table'] ?? '',
183			'field' => $request->getQueryParams()['field'] ?? ''
184			]);
185			$buttonBar->addButton($shortcutButton);
186
187			if ($action !== 'index') {
188			$uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
189			$backButton = $buttonBar->makeLinkButton()
190			->setTitle($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_common.xlf:back'))
191			->setIcon($this->moduleTemplate->getIconFactory()->getIcon('actions-view-go-up', Icon::SIZE_SMALL))
192			->setHref((string)$uriBuilder->buildUriFromRoute('help_cshmanual'));
193			$buttonBar->addButton($backButton);
194			}
195			}
196
197			protected function getManuals(ServerRequestInterface $request): array
198			{
199			$table = $request->getQueryParams()['table'] ?? $request->getParsedBody()['table'];
200			$field = $request->getQueryParams()['field'] ?? $request->getParsedBody()['field'] ?? '*';
201
202			return $field === '*'
203			? $this->tableManualRepository->getTableManual($table)
204			: [$this->tableManualRepository->getSingleManual($table, $field)];
205			}
206
207			/**
208			* Returns the shortcut title for the current page
209			*
210			* @param ServerRequestInterface $request
211			* @return string
212			*/
213			protected function getShortcutTitle(ServerRequestInterface $request): string
214			{
215			$title = $this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_mod_help_cshmanual.xlf:mlang_labels_tablabel');
216			if (($manuals = $this->getManuals($request)) !== []) {
217			$manualTitle = array_shift($manuals)['headerLine'] ?? '';
218			if ($manualTitle !== '') {
219			$title .= ': ' . $manualTitle;
220			}
221			}
222			return $title;
223			}
224
225			/**
226			* Returns the currently logged in BE user
227			*
228			* @return BackendUserAuthentication
229			*/
230			protected function getBackendUser(): BackendUserAuthentication
231			{
232			return $GLOBALS['BE_USER'];
233			}
234
235			/**
236			* Returns the LanguageService
237			*
238			* @return LanguageService
239			*/
240			protected function getLanguageService(): LanguageService
241			{
242			return $GLOBALS['LANG'];
243			}
244			}
245

TYPO3 / TYPO3.CMS

Push — master ( ff1a76...9dbd27 )

HelpController::getShortcutTitle() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like