From 894ec08f7e2013dea66fd77e86e680aac85503cc Mon Sep 17 00:00:00 2001
From: Oliver Hader <oliver@typo3.org>
Date: Mon, 17 May 2021 17:01:42 +0200
Subject: [PATCH] [TASK] Streamline routing related phpDoc comments &
annotations
Resolves: #94148
Releases: master, 10.4, 9.5
Change-Id: If1378f2d471f18099b55b05a84dc81adc247bc69
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/69158
Tested-by: core-ci <typo3@b13.com>
Tested-by: Benni Mack <benni@typo3.org>
Tested-by: Oliver Bartsch <bo@cedev.de>
Tested-by: Oliver Hader <oliver.hader@typo3.org>
Reviewed-by: Benni Mack <benni@typo3.org>
Reviewed-by: Oliver Bartsch <bo@cedev.de>
Reviewed-by: Oliver Hader <oliver.hader@typo3.org>
---
.../Routing/Enhancer/PluginEnhancer.php | 2 +-
.../Routing/Enhancer/SimpleEnhancer.php | 4 +-
.../core/Classes/Routing/PageArguments.php | 47 ++++++++++++-------
...-RemoveReqCHashFunctionalityForPlugins.rst | 2 +-
.../Middleware/PageArgumentValidator.php | 12 ++---
5 files changed, 40 insertions(+), 27 deletions(-)
diff --git a/typo3/sysext/core/Classes/Routing/Enhancer/PluginEnhancer.php b/typo3/sysext/core/Classes/Routing/Enhancer/PluginEnhancer.php
index 48af48a3da67..d94ad370328f 100644
--- a/typo3/sysext/core/Classes/Routing/Enhancer/PluginEnhancer.php
+++ b/typo3/sysext/core/Classes/Routing/Enhancer/PluginEnhancer.php
@@ -80,7 +80,7 @@ class PluginEnhancer extends AbstractEnhancer implements RoutingEnhancerInterfac
// dynamic arguments, that don't have a static mapper
$dynamicArguments = $variableProcessor
->inflateNamespaceParameters($dynamicCandidates, $this->namespace);
- // static arguments, that don't appear in dynamic arguments
+ // route arguments, that don't appear in dynamic arguments
$staticArguments = ArrayUtility::arrayDiffKeyRecursive($routeArguments, $dynamicArguments);
$page = $route->getOption('_page');
diff --git a/typo3/sysext/core/Classes/Routing/Enhancer/SimpleEnhancer.php b/typo3/sysext/core/Classes/Routing/Enhancer/SimpleEnhancer.php
index 8855e7b8fd5c..745b8b718987 100644
--- a/typo3/sysext/core/Classes/Routing/Enhancer/SimpleEnhancer.php
+++ b/typo3/sysext/core/Classes/Routing/Enhancer/SimpleEnhancer.php
@@ -64,11 +64,11 @@ class SimpleEnhancer extends AbstractEnhancer implements RoutingEnhancerInterfac
$dynamicCandidates = array_diff_key($parameters, $staticMappers);
// all route arguments
- $routeArguments = $this->getVariableProcessor()->inflateParameters($parameters, $route->getArguments());
+ $routeArguments = $variableProcessor->inflateParameters($parameters, $route->getArguments());
// dynamic arguments, that don't have a static mapper
$dynamicArguments = $variableProcessor
->inflateNamespaceParameters($dynamicCandidates, '');
- // static arguments, that don't appear in dynamic arguments
+ // route arguments, that don't appear in dynamic arguments
$staticArguments = ArrayUtility::arrayDiffKeyRecursive($routeArguments, $dynamicArguments);
$page = $route->getOption('_page');
diff --git a/typo3/sysext/core/Classes/Routing/PageArguments.php b/typo3/sysext/core/Classes/Routing/PageArguments.php
index 5c535e5770e3..6257bd78f6e5 100644
--- a/typo3/sysext/core/Classes/Routing/PageArguments.php
+++ b/typo3/sysext/core/Classes/Routing/PageArguments.php
@@ -35,27 +35,40 @@ class PageArguments implements RouteResultInterface
protected $pageType;
/**
- * @var array
+ * All (merged) arguments of this URI (routeArguments + dynamicArguments)
+ *
+ * @var array<string, string|array>
*/
protected $arguments;
/**
- * @var array
+ * Route arguments mapped by static mappers
+ * "static" means the provided values in a URI maps to a finite number of values
+ * (routeArguments - "arguments mapped by non static mapper")
+ *
+ * @var array<string, string|array>
*/
protected $staticArguments;
/**
- * @var array
+ * Route arguments, that have an infinite number of possible values
+ * AND query string arguments. These arguments require a cHash.
+ *
+ * @var array<string, string|array>
*/
protected $dynamicArguments;
/**
- * @var array
+ * Arguments defined in and mapped by a route enhancer
+ *
+ * @var array<string, string|array>
*/
protected $routeArguments;
/**
- * @var array
+ * Query arguments in the generated URI
+ *
+ * @var array<string, string|array>
*/
protected $queryArguments = [];
@@ -93,7 +106,7 @@ class PageArguments implements RouteResultInterface
}
/**
- * @return array
+ * @return array<string, string|array>
*/
public function getRouteArguments(): array
{
@@ -118,7 +131,7 @@ class PageArguments implements RouteResultInterface
/**
* @param string $name
- * @return mixed|null
+ * @return string|array<string, string|array>|null
*/
public function get(string $name)
{
@@ -126,7 +139,7 @@ class PageArguments implements RouteResultInterface
}
/**
- * @return array
+ * @return array<string, string|array>
*/
public function getArguments(): array
{
@@ -134,7 +147,7 @@ class PageArguments implements RouteResultInterface
}
/**
- * @return array
+ * @return array<string, string|array>
*/
public function getStaticArguments(): array
{
@@ -142,7 +155,7 @@ class PageArguments implements RouteResultInterface
}
/**
- * @return array
+ * @return array<string, string|array>
*/
public function getDynamicArguments(): array
{
@@ -150,7 +163,7 @@ class PageArguments implements RouteResultInterface
}
/**
- * @return array
+ * @return array<string, string|array>
*/
public function getQueryArguments(): array
{
@@ -158,7 +171,7 @@ class PageArguments implements RouteResultInterface
}
/**
- * @param array $queryArguments
+ * @param array<string, string|array> $queryArguments
*/
protected function updateQueryArguments(array $queryArguments)
{
@@ -191,7 +204,7 @@ class PageArguments implements RouteResultInterface
/**
* Cleans empty array recursively.
*
- * @param array $array
+ * @param array<string, string|array> $array
* @return array
*/
protected function clean(array $array): array
@@ -213,7 +226,7 @@ class PageArguments implements RouteResultInterface
/**
* Sorts array keys recursively.
*
- * @param array $array
+ * @param array<string, string|array> $array
* @return array
*/
protected function sort(array $array): array
@@ -226,8 +239,8 @@ class PageArguments implements RouteResultInterface
/**
* Removes keys that are defined in $second from $first recursively.
*
- * @param array $first
- * @param array $second
+ * @param array<string, string|array> $first
+ * @param array<string, string|array> $second
* @return array
*/
protected function diff(array $first, array $second): array
@@ -246,7 +259,7 @@ class PageArguments implements RouteResultInterface
/**
* @param mixed $offset
- * @return mixed
+ * @return string|array<string, string|array>|null
*/
public function offsetGet($offset)
{
diff --git a/typo3/sysext/core/Documentation/Changelog/10.3/Deprecation-89868-RemoveReqCHashFunctionalityForPlugins.rst b/typo3/sysext/core/Documentation/Changelog/10.3/Deprecation-89868-RemoveReqCHashFunctionalityForPlugins.rst
index a7a25b82afe7..29a5688bb648 100644
--- a/typo3/sysext/core/Documentation/Changelog/10.3/Deprecation-89868-RemoveReqCHashFunctionalityForPlugins.rst
+++ b/typo3/sysext/core/Documentation/Changelog/10.3/Deprecation-89868-RemoveReqCHashFunctionalityForPlugins.rst
@@ -23,7 +23,7 @@ was used to enable the cHash validation for non-cacheable plugins.
Both plugin systems triggered the method :php:`TypoScriptFrontendController->reqCHash` which
validated relevant GET parameters. However, the :php:`PageArgumentValidator` PSR-15 middleware now
always validates the cHash, so a plugin does not need to know about cHash validation anymore and
-therefor does not need to set the option.
+therefore does not need to set the option.
This means the options are not needed anymore, as the validation already happens during the Frontend
request handling process. The options are removed.
diff --git a/typo3/sysext/frontend/Classes/Middleware/PageArgumentValidator.php b/typo3/sysext/frontend/Classes/Middleware/PageArgumentValidator.php
index a7471f486edc..0f776ebc4729 100644
--- a/typo3/sysext/frontend/Classes/Middleware/PageArgumentValidator.php
+++ b/typo3/sysext/frontend/Classes/Middleware/PageArgumentValidator.php
@@ -96,11 +96,11 @@ class PageArgumentValidator implements MiddlewareInterface, LoggerAwareInterface
return $handler->handle($request);
}
// Evaluate the cache hash parameter or dynamic arguments when coming from a Site-based routing
- $cHash = $pageArguments->getArguments()['cHash'] ?? '';
+ $cHash = (string)($pageArguments->getArguments()['cHash'] ?? '');
$queryParams = $pageArguments->getDynamicArguments();
- if ($cHash || !empty($queryParams)) {
+ if ($cHash !== '' || !empty($queryParams)) {
$relevantParametersForCacheHashArgument = $this->getRelevantParametersForCacheHashCalculation($pageArguments);
- if ($cHash) {
+ if ($cHash !== '') {
if (empty($relevantParametersForCacheHashArgument)) {
// cHash was given, but nothing to be calculated, so let's do a redirect to the current page
// but without the cHash
@@ -135,7 +135,7 @@ class PageArgumentValidator implements MiddlewareInterface, LoggerAwareInterface
* Filters out the arguments that are necessary for calculating cHash
*
* @param PageArguments $pageArguments
- * @return array
+ * @return array<string, string>
*/
protected function getRelevantParametersForCacheHashCalculation(PageArguments $pageArguments): array
{
@@ -149,7 +149,7 @@ class PageArgumentValidator implements MiddlewareInterface, LoggerAwareInterface
* This is used to cache pages with more parameters than just id and type.
*
* @param string $cHash the chash to check
- * @param array $relevantParameters GET parameters necessary for cHash calculation
+ * @param array<string, string> $relevantParameters GET parameters necessary for cHash calculation
* @param bool $pageNotFoundOnCacheHashError see $GLOBALS['TYPO3_CONF_VARS']['FE']['pageNotFoundOnCHashError']
* @return bool if false, then a PageNotFound response is triggered
*/
@@ -174,7 +174,7 @@ class PageArgumentValidator implements MiddlewareInterface, LoggerAwareInterface
*
* Should only be called if NO cHash parameter is given.
*
- * @param array $dynamicArguments
+ * @param array<string, string|array> $dynamicArguments
* @param bool $pageNotFoundOnCacheHashError
* @return bool
*/
--
GitLab