feature #45094 Add generics to ArgumentMetadata::getAttributes (Seldaek)

fabpot · fabpot · commit d6be0d9b308b · 2022-03-17T07:52:39.000+01:00
This PR was merged into the 6.1 branch. Discussion ---------- Add generics to ArgumentMetadata::getAttributes | Q | A | ------------- | --- | Branch? | 5.3 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | Fix #...  | License | MIT | Doc PR | symfony/symfony-docs#...  This is a bit of an unfortunate situation because the function does too many things. If stronger typing was applied earlier on, it would have been evident that typing this correctly is pretty much impossible, and that would have helped guide the design to use a separate function to retrieve all attributes and some attributes. e.g. the ideal outcome would be for `getAttributes(Foo::class)` to be typed as such: ``` /** * @template T * @param class-string<T> $name * @return array<T> */ ``` So that the result is guaranteed to be an array of Foo objects. The fact that $name is nullable throws all this off though.. So I guess the only good way forward would be to deprecate null, or deprecate passing `$name` and add a `getAttributesByClassName(string $class, int $flags = 0)` ? I'm not sure if merging this as is is valuable or not, or if you'd rather get the deprecation and new method targetting 6.1? Commits ------- aad19dd Add generics to ArgumentMetadata::getAttributes
diff --git a/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadata.php b/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadata.php
@@ -101,14 +101,30 @@ public function getDefaultValue(): mixed
     }
 
     /**
-     * @return object[]
+     * @param class-string          $name
+     * @param self::IS_INSTANCEOF|0 $flags
+     *
+     * @return array<object>
      */
     public function getAttributes(string $name = null, int $flags = 0): array
     {
         if (!$name) {
             return $this->attributes;
         }
 
+        return $this->getAttributesOfType($name, $flags);
+    }
+
+    /**
+     * @template T of object
+     *
+     * @param class-string<T>       $name
+     * @param self::IS_INSTANCEOF|0 $flags
+     *
+     * @return array<T>
+     */
+    public function getAttributesOfType(string $name, int $flags = 0): array
+    {
         $attributes = [];
         if ($flags & self::IS_INSTANCEOF) {
             foreach ($this->attributes as $attribute) {
diff --git a/src/Symfony/Component/HttpKernel/Tests/ControllerMetadata/ArgumentMetadataTest.php b/src/Symfony/Component/HttpKernel/Tests/ControllerMetadata/ArgumentMetadataTest.php
@@ -48,4 +48,10 @@ public function testGetAttributes()
         $argument = new ArgumentMetadata('foo', 'string', false, true, 'default value', true, [new Foo('bar')]);
         $this->assertEquals([new Foo('bar')], $argument->getAttributes());
     }
+
+    public function testGetAttributesOfType()
+    {
+        $argument = new ArgumentMetadata('foo', 'string', false, true, 'default value', true, [new Foo('bar')]);
+        $this->assertEquals([new Foo('bar')], $argument->getAttributesOfType(Foo::class));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -48,4 +48,10 @@ public function testGetAttributes()`
`48`	`48`	`$argument = new ArgumentMetadata('foo', 'string', false, true, 'default value', true, [new Foo('bar')]);`
`49`	`49`	`$this->assertEquals([new Foo('bar')], $argument->getAttributes());`
`50`	`50`	`}`
	`51`	`+`
	`52`	`+ public function testGetAttributesOfType()`
	`53`	`+ {`
	`54`	`+ $argument = new ArgumentMetadata('foo', 'string', false, true, 'default value', true, [new Foo('bar')]);`
	`55`	`+ $this->assertEquals([new Foo('bar')], $argument->getAttributesOfType(Foo::class));`
	`56`	`+ }`
`51`	`57`	`}`