feat(metadata): use a custom Attribute extends ApiResource (#5076) (#5175)

yobrx · soyuka · web-flow · commit a5275049663c · 2022-11-10T20:11:02.000+01:00
Co-authored-by: Antoine Bluchet &lt;soyuka@users.noreply.github.com&gt;
diff --git a/src/Metadata/Resource/Factory/AttributesResourceMetadataCollectionFactory.php b/src/Metadata/Resource/Factory/AttributesResourceMetadataCollectionFactory.php
@@ -84,7 +84,7 @@ private function buildResourceOperations(array $attributes, string $resourceClas
         $operationPriority = 0;
 
         foreach ($attributes as $attribute) {
-            if (ApiResource::class === $attribute->getName()) {
+            if (is_a($attribute->getName(), ApiResource::class, true)) {
                 $resource = $this->getResourceWithDefaults($resourceClass, $shortName, $attribute->newInstance());
                 $operations = [];
                 foreach ($resource->getOperations() ?? new Operations() as $operation) {
@@ -165,7 +165,7 @@ private function buildResourceOperations(array $attributes, string $resourceClas
     private function hasResourceAttributes(\ReflectionClass $reflectionClass): bool
     {
         foreach ($reflectionClass->getAttributes() as $attribute) {
-            if (ApiResource::class === $attribute->getName() || is_subclass_of($attribute->getName(), HttpOperation::class) || is_subclass_of($attribute->getName(), GraphQlOperation::class)) {
+            if (is_a($attribute->getName(), ApiResource::class, true) || is_subclass_of($attribute->getName(), HttpOperation::class) || is_subclass_of($attribute->getName(), GraphQlOperation::class)) {
                 return true;
             }
         }
diff --git a/src/Metadata/Resource/Factory/AttributesResourceNameCollectionFactory.php b/src/Metadata/Resource/Factory/AttributesResourceNameCollectionFactory.php
@@ -57,7 +57,7 @@ public function create(): ResourceNameCollection
 
     private function isResource(\ReflectionClass $reflectionClass): bool
     {
-        if ($reflectionClass->getAttributes(ApiResource::class)) {
+        if ($reflectionClass->getAttributes(ApiResource::class, \ReflectionAttribute::IS_INSTANCEOF)) {
             return true;
         }
 
diff --git a/tests/Fixtures/TestBundle/Attributes/RestfulApi.php b/tests/Fixtures/TestBundle/Attributes/RestfulApi.php
@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\Attributes;
+
+use ApiPlatform\Metadata\ApiResource;
+
+#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
+class RestfulApi extends ApiResource
+{
+}
diff --git a/tests/Fixtures/TestBundle/Entity/InstanceOfApiResource.php b/tests/Fixtures/TestBundle/Entity/InstanceOfApiResource.php
@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Tests\Fixtures\TestBundle\Attributes\RestfulApi;
+use Doctrine\ORM\Mapping as ORM;
+
+#[RestfulApi]
+#[ORM\Entity]
+class InstanceOfApiResource
+{
+    #[ORM\Id]
+    #[ORM\Column(type: 'integer')]
+    #[ORM\GeneratedValue(strategy: 'AUTO')]
+    private $id;
+
+    public function __construct()
+    {
+    }
+
+    public function getId()
+    {
+        return $this->id;
+    }
+}
diff --git a/tests/Metadata/Resource/Factory/AttributesResourceNameCollectionFactoryTest.php b/tests/Metadata/Resource/Factory/AttributesResourceNameCollectionFactoryTest.php
@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Metadata\Resource\Factory;
+
+use ApiPlatform\Metadata\Resource\Factory\AttributesResourceNameCollectionFactory;
+use ApiPlatform\Tests\Fixtures\TestBundle\Entity\InstanceOfApiResource;
+use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+
+/**
+ * @author Yoann Brieux <github@brieux.net>
+ */
+class AttributesResourceNameCollectionFactoryTest extends TestCase
+{
+    use ProphecyTrait;
+
+    public function testCreateWithInstanceOfApiResource(): void
+    {
+        $attributesResourceNameCollectionFactory = new AttributesResourceNameCollectionFactory(paths: [__DIR__.'/../../../Fixtures/TestBundle/Entity/']);
+
+        $this->assertContains(InstanceOfApiResource::class, $attributesResourceNameCollectionFactory->create()->getIterator());
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ private function buildResourceOperations(array $attributes, string $resourceClas`
`84`	`84`	`$operationPriority = 0;`
`85`	`85`
`86`	`86`	`foreach ($attributes as $attribute) {`
`87`		`- if (ApiResource::class === $attribute->getName()) {`
	`87`	`+ if (is_a($attribute->getName(), ApiResource::class, true)) {`
`88`	`88`	`$resource = $this->getResourceWithDefaults($resourceClass, $shortName, $attribute->newInstance());`
`89`	`89`	`$operations = [];`
`90`	`90`	`foreach ($resource->getOperations() ?? new Operations() as $operation) {`
`@@ -165,7 +165,7 @@ private function buildResourceOperations(array $attributes, string $resourceClas`
`165`	`165`	`private function hasResourceAttributes(\ReflectionClass $reflectionClass): bool`
`166`	`166`	`{`
`167`	`167`	`foreach ($reflectionClass->getAttributes() as $attribute) {`
`168`		`- if (ApiResource::class === $attribute->getName() \|\| is_subclass_of($attribute->getName(), HttpOperation::class) \|\| is_subclass_of($attribute->getName(), GraphQlOperation::class)) {`
	`168`	`+ if (is_a($attribute->getName(), ApiResource::class, true) \|\| is_subclass_of($attribute->getName(), HttpOperation::class) \|\| is_subclass_of($attribute->getName(), GraphQlOperation::class)) {`
`169`	`169`	`return true;`
`170`	`170`	`}`
`171`	`171`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public function create(): ResourceNameCollection`
`57`	`57`
`58`	`58`	`private function isResource(\ReflectionClass $reflectionClass): bool`
`59`	`59`	`{`
`60`		`- if ($reflectionClass->getAttributes(ApiResource::class)) {`
	`60`	`+ if ($reflectionClass->getAttributes(ApiResource::class, \ReflectionAttribute::IS_INSTANCEOF)) {`
`61`	`61`	`return true;`
`62`	`62`	`}`
`63`	`63`