From bb4206603a427e37dc581e0f863f2aa4ca86c2c0 Mon Sep 17 00:00:00 2001
From: Benni Mack <benni@typo3.org>
Date: Fri, 11 May 2018 07:33:11 +0200
Subject: [PATCH] [TASK] Various cleanups regarding comments and API calls
This patch is a small summary of clean ups in various
places of TYPO3 Core.
- EditDocumentController can be simplified to retrieve the closeUrl()
- Comment adaptions in GeneralUtility
- Comment adaptions and code simplification in ContentObjectRenderer
- HMENU debug option can be fetched from TSFE TypoScript directly
- TypoLinkBuilder can use "TSFE->initTemplate()" directly
to instantiate the TemplateService, and should hand over
proper values in the constructor.
Resolves: #84966
Releases: master
Change-Id: I145b99842eea2a2386742b1525b33a49022c9339
Reviewed-on: https://review.typo3.org/56919
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Mathias Schreiber <mathias.schreiber@typo3.com>
Tested-by: Mathias Schreiber <mathias.schreiber@typo3.com>
Reviewed-by: Frank Naegler <frank.naegler@typo3.org>
Tested-by: Frank Naegler <frank.naegler@typo3.org>
---
.../backend/Classes/Controller/EditDocumentController.php | 6 ++----
typo3/sysext/core/Classes/Utility/GeneralUtility.php | 4 ++--
.../Classes/ContentObject/ContentObjectRenderer.php | 8 ++------
.../ContentObject/Menu/AbstractMenuContentObject.php | 2 +-
.../frontend/Classes/Typolink/AbstractTypolinkBuilder.php | 8 +++-----
5 files changed, 10 insertions(+), 18 deletions(-)
diff --git a/typo3/sysext/backend/Classes/Controller/EditDocumentController.php b/typo3/sysext/backend/Classes/Controller/EditDocumentController.php
index e59e293a0b0b..af7879e40710 100644
--- a/typo3/sysext/backend/Classes/Controller/EditDocumentController.php
+++ b/typo3/sysext/backend/Classes/Controller/EditDocumentController.php
@@ -1626,7 +1626,8 @@ class EditDocumentController
$cshButton = $buttonBar->makeHelpButton()->setModuleName('xMOD_csh_corebe')->setFieldName('TCEforms');
$buttonBar->addButton($cshButton);
- if ($this->returnUrl !== $this->getCloseUrl()) {
+ $closeUrl = $this->getCloseUrl();
+ if ($this->returnUrl !== $closeUrl) {
$shortCutButton = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar()->makeShortcutButton();
$shortCutButton->setModuleName('xMOD_alt_doc.php')
->setGetVariables([
@@ -1638,10 +1639,7 @@ class EditDocumentController
'returnNewPageId',
'noView']);
$this->moduleTemplate->getDocHeaderComponent()->getButtonBar()->addButton($shortCutButton);
- }
- $closeUrl = $this->getCloseUrl();
- if ($this->returnUrl !== $closeUrl) {
$requestUri = GeneralUtility::linkThisScript([
'returnUrl' => $closeUrl,
]);
diff --git a/typo3/sysext/core/Classes/Utility/GeneralUtility.php b/typo3/sysext/core/Classes/Utility/GeneralUtility.php
index ebe24a87edd9..a294f9f04f16 100644
--- a/typo3/sysext/core/Classes/Utility/GeneralUtility.php
+++ b/typo3/sysext/core/Classes/Utility/GeneralUtility.php
@@ -2075,7 +2075,7 @@ class GeneralUtility
* sets permissions on newly created directories.
*
* @param string $directory Target directory to create. Must a have trailing slash
- * @param string $deepDirectory Directory to create. This second parameter
+ * @param string $deepDirectory Directory to create. This second parameter is deprecated since TYPO3 v9, and will be removed in TYPO3 v10.
* @throws \InvalidArgumentException If $directory or $deepDirectory are not strings
* @throws \RuntimeException If directory could not be created
*/
@@ -2333,7 +2333,7 @@ class GeneralUtility
*
* @param array $fileArr The file array to remove the prefix from
* @param string $prefixToRemove The prefix path to remove (if found as first part of string!)
- * @return array The input $fileArr processed.
+ * @return array|string The input $fileArr processed, or a string with an error message, when an error occurred.
*/
public static function removePrefixPathFromList(array $fileArr, $prefixToRemove)
{
diff --git a/typo3/sysext/frontend/Classes/ContentObject/ContentObjectRenderer.php b/typo3/sysext/frontend/Classes/ContentObject/ContentObjectRenderer.php
index 766ffdffb622..0ec55de49f09 100644
--- a/typo3/sysext/frontend/Classes/ContentObject/ContentObjectRenderer.php
+++ b/typo3/sysext/frontend/Classes/ContentObject/ContentObjectRenderer.php
@@ -5559,7 +5559,7 @@ class ContentObjectRenderer implements LoggerAwareInterface
*
* @param string $mailAddress Email address
* @param string $linktxt Link text, default will be the email address.
- * @return string Returns a numerical array with two elements: 1) $mailToUrl, string ready to be inserted into the href attribute of the <a> tag, b) $linktxt: The string between starting and ending <a> tag.
+ * @return array A numerical array with two elements: 1) $mailToUrl, string ready to be inserted into the href attribute of the <a> tag, b) $linktxt: The string between starting and ending <a> tag.
*/
public function getMailTo($mailAddress, $linktxt)
{
@@ -5730,11 +5730,7 @@ class ContentObjectRenderer implements LoggerAwareInterface
} else {
$newQueryArray = $currentQueryArray;
}
- if ($forceOverruleArguments) {
- ArrayUtility::mergeRecursiveWithOverrule($newQueryArray, $overruleQueryArguments);
- } else {
- ArrayUtility::mergeRecursiveWithOverrule($newQueryArray, $overruleQueryArguments, false);
- }
+ ArrayUtility::mergeRecursiveWithOverrule($newQueryArray, $overruleQueryArguments, $forceOverruleArguments);
return GeneralUtility::implodeArrayForUrl('', $newQueryArray, '', false, true);
}
diff --git a/typo3/sysext/frontend/Classes/ContentObject/Menu/AbstractMenuContentObject.php b/typo3/sysext/frontend/Classes/ContentObject/Menu/AbstractMenuContentObject.php
index 547079aad57e..d9ea71018a4c 100644
--- a/typo3/sysext/frontend/Classes/ContentObject/Menu/AbstractMenuContentObject.php
+++ b/typo3/sysext/frontend/Classes/ContentObject/Menu/AbstractMenuContentObject.php
@@ -258,7 +258,7 @@ abstract class AbstractMenuContentObject
$this->conf = $conf;
$this->menuNumber = $menuNumber;
$this->mconf = $conf[$this->menuNumber . $objSuffix . '.'];
- $this->debug = $tsfe->debug;
+ $this->debug = !empty($tsfe->config['config']['debug']);
$this->WMcObj = GeneralUtility::makeInstance(ContentObjectRenderer::class);
// In XHTML and HTML5 there is no "name" attribute anymore
switch ($tsfe->xhtmlDoctype) {
diff --git a/typo3/sysext/frontend/Classes/Typolink/AbstractTypolinkBuilder.php b/typo3/sysext/frontend/Classes/Typolink/AbstractTypolinkBuilder.php
index 11f40723ad06..721676f90e52 100644
--- a/typo3/sysext/frontend/Classes/Typolink/AbstractTypolinkBuilder.php
+++ b/typo3/sysext/frontend/Classes/Typolink/AbstractTypolinkBuilder.php
@@ -16,7 +16,6 @@ namespace TYPO3\CMS\Frontend\Typolink;
*/
use TYPO3\CMS\Core\Service\DependencyOrderingService;
-use TYPO3\CMS\Core\TypoScript\TemplateService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
@@ -196,14 +195,13 @@ abstract class AbstractTypolinkBuilder
// However, this is added to avoid any exceptions when trying to create a link
$GLOBALS['TSFE'] = GeneralUtility::makeInstance(
TypoScriptFrontendController::class,
- [],
- (int)GeneralUtility::_GP('id'),
+ null,
+ GeneralUtility::_GP('id'),
(int)GeneralUtility::_GP('type')
);
$GLOBALS['TSFE']->sys_page = GeneralUtility::makeInstance(PageRepository::class);
$GLOBALS['TSFE']->sys_page->init(false);
- $GLOBALS['TSFE']->tmpl = GeneralUtility::makeInstance(TemplateService::class);
- $GLOBALS['TSFE']->tmpl->init();
+ $GLOBALS['TSFE']->initTemplate();
}
return $GLOBALS['TSFE'];
}
--
GitLab