Adjust Neos.Flow Configuration subcontext

Author: Bernhard Schmitt

Neos.Flow/Classes/Configuration/ConfigurationManager.php

@@ -135,7 +135,7 @@ class ConfigurationManager
     /**
      * Storage of the raw special configurations
      *
-     * @var array
+     * @var array<string,mixed>
      */
     protected $configurations = [];
 
@@ -159,7 +159,7 @@ class ConfigurationManager
     protected $temporaryDirectoryPath = null;
 
     /**
-     * @var array
+     * @var array<string,mixed>
      */
     protected $unprocessedConfiguration = [];
 
@@ -229,9 +229,6 @@ public function registerConfigurationType(string $configurationType, $configurat
         } elseif (is_string($configurationLoader)) {
             $configurationLoader = $this->convertLegacyProcessingType($configurationType, $configurationLoader);
         }
-        if (!$configurationLoader instanceof LoaderInterface) {
-            throw new \InvalidArgumentException(sprintf('Specified invalid configuration loader of type "%s" while registering custom configuration type "%s". This should be an instance of %s', is_object($configurationLoader) ? get_class($configurationLoader) : gettype($configurationLoader), $configurationType, LoaderInterface::class), 1617895964);
-        }
 
         // if the configuration was already registered and the there is an unprocessed loaded configuration, the configuration needs to be loaded again
         // on the other hand, if there is a processed configuration loaded, but no unprocessed configuration, the config must be from the cache and is assumed to be valid
@@ -418,6 +415,7 @@ public function flushConfigurationCache(): void
      * Generate configuration with environment variables replaced without modifying or loading the cache
      *
      * @param string $configurationType The kind of configuration to fetch
+     * @return void
      */
     protected function processConfigurationType(string $configurationType)
     {
@@ -524,15 +522,15 @@ protected function replaceVariablesInPhpString(string $phpString): string
             }
             $replacement .= ($constantDoesNotStartAsBeginning ? $matchGroup['startString'] . "' . " : '=> ');
 
-            if (isset($matchGroup['prefix']) && $matchGroup['prefix'] === 'env') {
+            if ($matchGroup['prefix'] === 'env') {
                 if ($matchGroup['type'] === 'bool') {
                     $replacement .= "!in_array(strtolower(getenv('" . $matchGroup['name'] . "')), ['', '0', 'false'], true)";
                 } elseif ($matchGroup['type'] !== '') {
                     $replacement .= "(" . $matchGroup['type'] . ")getenv('" . $matchGroup['name'] . "')";
                 } else {
                     $replacement .= "getenv('" . $matchGroup['name'] . "')";
                 }
-            } elseif (isset($matchGroup['expression'])) {
+            } else {
                 $replacement .= "(defined('" . $matchGroup['expression'] . "') ? constant('" . $matchGroup['expression'] . "') : null)";
             }
 
@@ -548,7 +546,11 @@ protected function replaceVariablesInPhpString(string $phpString): string
             return $replacement;
         }, $phpString);
 
-        return $phpString;
+        if (is_string($phpString)) {
+            return $phpString;
+        }
+
+        throw new \RuntimeException('Failed to render PHP string', 1744468312);
     }
 
     /**

Neos.Flow/Classes/Configuration/ConfigurationSchemaValidator.php

@@ -64,9 +64,9 @@ class ConfigurationSchemaValidator
     /**
      * Validate the given $configurationType and $path
      *
-     * @param string $configurationType (optional) the configuration type to validate. if NULL, validates all configuration.
-     * @param string $path (optional) configuration path to validate
-     * @param array $loadedSchemaFiles (optional). if given, will be filled with a list of loaded schema files
+     * @param ?string $configurationType (optional) the configuration type to validate. if NULL, validates all configuration.
+     * @param ?string $path (optional) configuration path to validate
+     * @param array<int,string> $loadedSchemaFiles (optional). if given, will be filled with a list of loaded schema files
      * @return \Neos\Error\Messages\Result the result of the validation
      * @throws Exception\SchemaValidationException
      */
@@ -91,7 +91,7 @@ public function validate(?string $configurationType = null, ?string $path = null
      *
      * @param string $configurationType the configuration typr to validate
      * @param string|null $path configuration path to validate, or NULL.
-     * @param array $loadedSchemaFiles will be filled with a list of loaded schema files
+     * @param array<int,string> $loadedSchemaFiles will be filled with a list of loaded schema files
      * @return \Neos\Error\Messages\Result
      * @throws Exception\SchemaValidationException
      */
@@ -121,7 +121,7 @@ protected function validateSingleType(string $configurationType, ?string $path =
                     $schemaType = $schemaNameParts[0];
                     $schemaPath = isset($schemaNameParts[1]) ? $schemaNameParts[1] : null;
 
-                    if ($schemaType === $configurationType && ($path === null || strpos($schemaPath, $path) === 0)) {
+                    if ($schemaType === $configurationType && ($path === null || (is_string($schemaPath) && strpos($schemaPath, $path) === 0))) {
                         $schemaFileInfos[] = [
                             'file' => $schemaFile,
                             'name' => $schemaName,
@@ -138,6 +138,7 @@ protected function validateSingleType(string $configurationType, ?string $path =
         }
 
         $result = new Result();
+        /** @var array<int,array{file: string, name: string, path: ?string, packageKey: string}> $schemaFileInfos */
         foreach ($schemaFileInfos as $schemaFileInfo) {
             $loadedSchemaFiles[] = $schemaFileInfo['file'];
 

Neos.Flow/Classes/Configuration/Loader/AppendLoader.php

@@ -15,6 +15,7 @@
 
 use Neos\Flow\Configuration\Source\YamlSource;
 use Neos\Flow\Core\ApplicationContext;
+use Neos\Flow\Package\FlowPackageInterface;
 
 class AppendLoader implements LoaderInterface
 {
@@ -34,6 +35,10 @@ public function __construct(YamlSource $yamlSource, string $filePrefix)
         $this->filePrefix = $filePrefix;
     }
 
+    /**
+     * @param array<FlowPackageInterface> $packages
+     * @return array<int,array<mixed>>
+     */
     public function load(array $packages, ApplicationContext $context): array
     {
         $configuration = [];

Neos.Flow/Classes/Configuration/Loader/LoaderInterface.php

@@ -14,6 +14,7 @@
  */
 
 use Neos\Flow\Core\ApplicationContext;
+use Neos\Flow\Package\PackageInterface;
 
 /**
  * The interface for a configuration loader
@@ -23,9 +24,9 @@ interface LoaderInterface
     /**
      * Read configuration resources and return the final configuration array for the given configurationType
      *
-     * @param array $packages An array of Package objects (indexed by package key) to consider
+     * @param array<PackageInterface> $packages An array of Package objects (indexed by package key) to consider
      * @param ApplicationContext $context
-     * @return array The Configuration array for the current configurationType
+     * @return array<mixed> The Configuration array for the current configurationType
      */
     public function load(array $packages, ApplicationContext $context) : array;
 }

Neos.Flow/Classes/Configuration/Loader/MergeLoader.php

@@ -15,6 +15,7 @@
 
 use Neos\Flow\Configuration\Source\YamlSource;
 use Neos\Flow\Core\ApplicationContext;
+use Neos\Flow\Package\FlowPackageInterface;
 use Neos\Utility\Arrays;
 
 class MergeLoader implements LoaderInterface
@@ -35,6 +36,10 @@ public function __construct(YamlSource $yamlSource, string $filePrefix)
         $this->filePrefix = $filePrefix;
     }
 
+    /**
+     * @param array<FlowPackageInterface> $packages
+     * @return array<mixed>
+     */
     public function load(array $packages, ApplicationContext $context): array
     {
         $configuration = [];

Neos.Flow/Classes/Configuration/Loader/ObjectsLoader.php

@@ -16,6 +16,7 @@
 use Neos\Flow\Configuration\ConfigurationManager;
 use Neos\Flow\Configuration\Source\YamlSource;
 use Neos\Flow\Core\ApplicationContext;
+use Neos\Flow\Package\FlowPackageInterface;
 use Neos\Utility\Arrays;
 
 class ObjectsLoader implements LoaderInterface
@@ -30,6 +31,10 @@ public function __construct(YamlSource $yamlSource)
         $this->yamlSource = $yamlSource;
     }
 
+    /**
+     * @param array<string, FlowPackageInterface> $packages
+     * @return array<string,array<mixed>>
+     */
     public function load(array $packages, ApplicationContext $context): array
     {
         $configuration = [];

Neos.Flow/Classes/Configuration/Loader/PolicyLoader.php

@@ -16,8 +16,12 @@
 use Neos\Flow\Configuration\ConfigurationManager;
 use Neos\Flow\Configuration\Source\YamlSource;
 use Neos\Flow\Core\ApplicationContext;
+use Neos\Flow\Package\FlowPackageInterface;
 use Neos\Utility\Arrays;
 
+/**
+ * @phpstan-type PolicyDefinition array{roles?: array<string, array{privileges: array<mixed>}>}
+ */
 class PolicyLoader implements LoaderInterface
 {
     /**
@@ -47,6 +51,10 @@ public function setTemporaryDirectoryPath(string $temporaryDirectoryPath): void
         $this->temporaryDirectoryPath = $temporaryDirectoryPath;
     }
 
+    /**
+     * @param array<FlowPackageInterface> $packages
+     * @return PolicyDefinition
+     */
     public function load(array $packages, ApplicationContext $context): array
     {
         if ($context->isTesting()) {
@@ -77,9 +85,9 @@ public function load(array $packages, ApplicationContext $context): array
     /**
      * Merges two policy configuration arrays.
      *
-     * @param array $firstConfigurationArray
-     * @param array $secondConfigurationArray
-     * @return array
+     * @param PolicyDefinition $firstConfigurationArray
+     * @param PolicyDefinition $secondConfigurationArray
+     * @return PolicyDefinition
      */
     private function mergePolicyConfiguration(array $firstConfigurationArray, array $secondConfigurationArray): array
     {

Neos.Flow/Classes/Configuration/Loader/RoutesLoader.php

@@ -26,6 +26,26 @@
 use Neos\Utility\Arrays;
 use Neos\Utility\PositionalArraySorter;
 
+/**
+ * @phpstan-type RouteDefinition array{
+ *      name: string,
+ *      providerFactory?: class-string,
+ *      providerOptions?: array<mixed>,
+ *      uriPattern?: string,
+ *      subRoutes?: array<string,array{
+ *          package: string,
+ *          variables?: array<mixed>,
+ *          suffix?: string,
+ *      }>
+ *  }
+ * @phpstan-type SubrouteDefinition array{
+ *     name?: string,
+ *     uriPattern?: string,
+ *     defaults?: mixed,
+ *     routeParts?: mixed,
+ *     subRoutes?: mixed,
+ * }
+ */
 class RoutesLoader implements LoaderInterface
 {
     /**
@@ -52,9 +72,9 @@ public function __construct(YamlSource $yamlSource, ConfigurationManager $config
     }
 
     /**
-     * @param array $packages
+     * @param array<PackageInterface> $packages
      * @param ApplicationContext $context
-     * @return array
+     * @return array<int,array<mixed>>
      * @throws ConfigurationException | InvalidConfigurationException | InvalidConfigurationTypeException | ParseErrorException | RecursionException
      */
     public function load(array $packages, ApplicationContext $context): array
@@ -77,9 +97,9 @@ public function load(array $packages, ApplicationContext $context): array
      * Merges routes from Neos.Flow.mvc.routes settings into $routeDefinitions
      * NOTE: Routes from settings will always be appended to existing route definitions from the main Routes configuration!
      *
-     * @param array $routeDefinitions
-     * @param array $routeSettings
-     * @return array
+     * @param array<int,RouteDefinition> $routeDefinitions
+     * @param array<mixed> $routeSettings
+     * @return array<int,RouteDefinition>
      */
     protected function includeSubRoutesFromSettings(array $routeDefinitions, array $routeSettings): array
     {
@@ -121,9 +141,9 @@ protected function includeSubRoutesFromSettings(array $routeDefinitions, array $
      *
      * @param PackageInterface[] $packages
      * @param ApplicationContext $context
-     * @param array $routesConfiguration
+     * @param array<mixed> $routesConfiguration
      * @param int $subRoutesRecursionLevel Counts how many SubRoutes have been loaded. If this number exceeds MAXIMUM_SUBROUTE_RECURSIONS, an exception is thrown
-     * @return array
+     * @return array<int,array<mixed>>
      * @throws ParseErrorException | RecursionException| ConfigurationException
      */
     protected function mergeRoutesWithSubRoutes(array $packages, ApplicationContext $context, array $routesConfiguration, int $subRoutesRecursionLevel = 0): array
@@ -176,11 +196,11 @@ protected function mergeRoutesWithSubRoutes(array $packages, ApplicationContext
     /**
      * Merges all routes in $routesConfiguration with the sub routes in $subRoutesConfiguration
      *
-     * @param array $routesConfiguration
-     * @param array $subRoutesConfiguration
+     * @param array<array{name?: string, uriPattern: string}> $routesConfiguration
+     * @param array<SubrouteDefinition> $subRoutesConfiguration
      * @param string $subRouteKey the key of the sub route: <subRouteKey>
-     * @param array $subRouteOptions
-     * @return array the merged route configuration
+     * @param array{variables?: array<mixed>} $subRouteOptions
+     * @return array<int,SubrouteDefinition> the merged route configuration
      * @throws ParseErrorException
      */
     protected function buildSubRouteConfigurations(array $routesConfiguration, array $subRoutesConfiguration, string $subRouteKey, array $subRouteOptions): array
@@ -190,7 +210,11 @@ protected function buildSubRouteConfigurations(array $routesConfiguration, array
         foreach ($subRoutesConfiguration as $subRouteConfiguration) {
             foreach ($routesConfiguration as $routeConfiguration) {
                 $mergedSubRouteConfiguration = $subRouteConfiguration;
-                $mergedSubRouteConfiguration['name'] = sprintf('%s :: %s', $routeConfiguration['name'] ?? 'Unnamed Route', $subRouteConfiguration['name'] ?? 'Unnamed Subroute');
+                $mergedSubRouteConfiguration['name'] = sprintf(
+                    '%s :: %s',
+                    $routeConfiguration['name'] ?? 'Unnamed Route',
+                    $subRouteConfiguration['name'] ?? 'Unnamed Subroute'
+                );
                 $mergedSubRouteConfiguration['name'] = $this->replacePlaceholders($mergedSubRouteConfiguration['name'], $variables);
                 if (!isset($mergedSubRouteConfiguration['uriPattern'])) {
                     throw new ParseErrorException('No uriPattern defined in route configuration "' . $mergedSubRouteConfiguration['name'] . '".', 1274197615);
@@ -207,6 +231,7 @@ protected function buildSubRouteConfigurations(array $routesConfiguration, array
                 if (isset($mergedSubRouteConfiguration['routeParts'])) {
                     $mergedSubRouteConfiguration['routeParts'] = $this->replacePlaceholders($mergedSubRouteConfiguration['routeParts'], $variables);
                 }
+                /** @var SubrouteDefinition $mergedSubRouteConfiguration arrayMergeRecursiveOverrule does not change that */
                 $mergedSubRouteConfiguration = Arrays::arrayMergeRecursiveOverrule($routeConfiguration, $mergedSubRouteConfiguration);
                 unset($mergedSubRouteConfiguration['subRoutes']);
                 $mergedSubRoutesConfigurations[] = $mergedSubRouteConfiguration;
@@ -219,9 +244,10 @@ protected function buildSubRouteConfigurations(array $routesConfiguration, array
     /**
      * Replaces placeholders in the format <variableName> with the corresponding variable of the specified $variables collection.
      *
-     * @param string|array $value
-     * @param array $variables
-     * @return array|string
+     * @param string|array<mixed> $value
+     * @param array<mixed> $variables
+     *
+     * @return ($value is string ? string : array<mixed>)
      */
     private function replacePlaceholders($value, array $variables)
     {

Neos.Flow/Classes/Configuration/Loader/SettingsLoader.php

@@ -16,6 +16,7 @@
 use Neos\Flow\Configuration\ConfigurationManager;
 use Neos\Flow\Configuration\Source\YamlSource;
 use Neos\Flow\Core\ApplicationContext;
+use Neos\Flow\Package\FlowPackageInterface;
 use Neos\Utility\Arrays;
 
 class SettingsLoader implements LoaderInterface
@@ -30,6 +31,10 @@ public function __construct(YamlSource $yamlSource)
         $this->yamlSource = $yamlSource;
     }
 
+    /**
+     * @param array<string,FlowPackageInterface> $packages
+     * @return array<mixed>
+     */
     public function load(array $packages, ApplicationContext $context): array
     {
         // Make sure that the Flow package is the first item of the packages array: