Merge pull request #8994 from kenjis/normalizer-filters-filter-args

fix: [Filters] normalize `$filters` arguments

Author: kenjis

phpstan-baseline.php

@@ -5257,12 +5257,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/system/Filters/Filters.php',
 ];
-$ignoreErrors[] = [
-	// identifier: missingType.iterableValue
-	'message' => '#^Method CodeIgniter\\\\Filters\\\\Filters\\:\\:enableFilters\\(\\) has parameter \\$names with no value type specified in iterable type array\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Filters/Filters.php',
-];
 $ignoreErrors[] = [
 	// identifier: missingType.iterableValue
 	'message' => '#^Method CodeIgniter\\\\Filters\\\\Filters\\:\\:getRequiredFilters\\(\\) return type has no value type specified in iterable type array\\.$#',

system/Filters/Filters.php

@@ -574,14 +574,14 @@ public function addFilter(string $class, ?string $alias = null, string $position
      * after the filter name, followed by a comma-separated list of arguments that
      * are passed to the filter when executed.
      *
-     * @param         string           $name     filter_name or filter_name:arguments like 'role:admin,manager'
+     * @param         string           $filter   filter_name or filter_name:arguments like 'role:admin,manager'
      *                                           or filter classname.
      * @phpstan-param 'before'|'after' $position
      */
-    private function enableFilter(string $name, string $position = 'before'): void
+    private function enableFilter(string $filter, string $position = 'before'): void
     {
         // Normalize the arguments.
-        [$alias, $arguments] = $this->getCleanName($name);
+        [$alias, $arguments] = $this->getCleanName($filter);
         $filter              = ($arguments === []) ? $alias : $alias . ':' . implode(',', $arguments);
 
         if (class_exists($alias)) {
@@ -602,24 +602,26 @@ private function enableFilter(string $name, string $position = 'before'): void
     /**
      * Get clean name and arguments
      *
-     * @param string $name filter_name or filter_name:arguments like 'role:admin,manager'
+     * @param string $filter filter_name or filter_name:arguments like 'role:admin,manager'
      *
      * @return array{0: string, 1: list<string>} [name, arguments]
      */
-    private function getCleanName(string $name): array
+    private function getCleanName(string $filter): array
     {
         $arguments = [];
 
-        if (str_contains($name, ':')) {
-            [$name, $arguments] = explode(':', $name);
-
-            $arguments = explode(',', $arguments);
-            array_walk($arguments, static function (&$item) {
-                $item = trim($item);
-            });
+        if (! str_contains($filter, ':')) {
+            return [$filter, $arguments];
         }
 
-        return [$name, $arguments];
+        [$alias, $arguments] = explode(':', $filter);
+
+        $arguments = explode(',', $arguments);
+        array_walk($arguments, static function (&$item) {
+            $item = trim($item);
+        });
+
+        return [$alias, $arguments];
     }
 
     /**
@@ -629,13 +631,13 @@ private function getCleanName(string $name): array
      * after the filter name, followed by a comma-separated list of arguments that
      * are passed to the filter when executed.
      *
-     * @params array<string> $names filter_name or filter_name:arguments like 'role:admin,manager'
+     * @param list<string> $filters filter_name or filter_name:arguments like 'role:admin,manager'
      *
      * @return Filters
      */
-    public function enableFilters(array $names, string $when = 'before')
+    public function enableFilters(array $filters, string $when = 'before')
     {
-        foreach ($names as $filter) {
+        foreach ($filters as $filter) {
             $this->enableFilter($filter, $when);
         }
 
@@ -777,21 +779,25 @@ protected function processFilters(?string $uri = null)
         // Add any filters that apply to this URI
         $filters = [];
 
-        foreach ($this->config->filters as $alias => $settings) {
+        foreach ($this->config->filters as $filter => $settings) {
+            // Normalize the arguments.
+            [$alias, $arguments] = $this->getCleanName($filter);
+            $filter              = ($arguments === []) ? $alias : $alias . ':' . implode(',', $arguments);
+
             // Look for inclusion rules
             if (isset($settings['before'])) {
                 $path = $settings['before'];
 
                 if ($this->pathApplies($uri, $path)) {
-                    $filters['before'][] = $alias;
+                    $filters['before'][] = $filter;
                 }
             }
 
             if (isset($settings['after'])) {
                 $path = $settings['after'];
 
                 if ($this->pathApplies($uri, $path)) {
-                    $filters['after'][] = $alias;
+                    $filters['after'][] = $filter;
                 }
             }
         }

tests/system/Filters/FiltersTest.php

@@ -282,14 +282,18 @@ public function testProcessMethodProcessesFiltersBefore(): void
                     'before' => ['admin/*'],
                     'after'  => ['/users/*'],
                 ],
+                'bar: arg1, arg2' => [
+                    'before' => ['admin/*'],
+                    'after'  => ['/users/*'],
+                ],
             ],
         ];
         $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
         $filters       = $this->createFilters($filtersConfig);
 
         $uri      = 'admin/foo/bar';
         $expected = [
-            'before' => ['foo'],
+            'before' => ['foo', 'bar:arg1,arg2'],
             'after'  => [],
         ];
         $this->assertSame($expected, $filters->initialize($uri)->getFilters());
@@ -311,6 +315,10 @@ public function testProcessMethodProcessesFiltersAfter(): void
                     'before' => ['admin/*'],
                     'after'  => ['/users/*'],
                 ],
+                'bar: arg1, arg2' => [
+                    'before' => ['admin/*'],
+                    'after'  => ['/users/*'],
+                ],
             ],
         ];
         $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
@@ -319,9 +327,7 @@ public function testProcessMethodProcessesFiltersAfter(): void
         $uri      = 'users/foo/bar';
         $expected = [
             'before' => [],
-            'after'  => [
-                'foo',
-            ],
+            'after'  => ['bar:arg1,arg2', 'foo'],
         ];
         $this->assertSame($expected, $filters->initialize($uri)->getFilters());
     }