feat!: core 5.0 cleanups (getProperties interface, json:api status string) (#8366)

Author: soyuka

src/Doctrine/Common/Filter/PropertyAwareFilterInterface.php

@@ -14,11 +14,7 @@
 namespace ApiPlatform\Doctrine\Common\Filter;
 
 /**
- * TODO: 5.x uncomment method.
- *
  * @author Antoine Bluchet <soyuka@gmail.com>
- *
- * @method array<string>|null getProperties()
  */
 interface PropertyAwareFilterInterface
 {
@@ -27,8 +23,8 @@ interface PropertyAwareFilterInterface
      */
     public function setProperties(array $properties): void;
 
-    // /**
-    //  * @return string[]
-    //  */
-    // public function getProperties(): ?array;
+    /**
+     * @return string[]
+     */
+    public function getProperties(): ?array;
 }

src/Doctrine/Common/ParameterExtensionTrait.php

@@ -51,11 +51,7 @@ private function configureFilter(object $filter, Parameter $parameter): void
         }
 
         if ($filter instanceof PropertyAwareFilterInterface) {
-            $properties = [];
-            // Check if the filter has getProperties method (e.g., if it's an AbstractFilter)
-            if (method_exists($filter, 'getProperties')) { // @phpstan-ignore-line todo 5.x remove this check @see interface
-                $properties = $filter->getProperties() ?? [];
-            }
+            $properties = $filter->getProperties() ?? [];
 
             $propertyKey = $parameter->getProperty() ?? $parameter->getKey();
             foreach ($parameter->getProperties() ?? [$propertyKey] as $property) {

src/JsonApi/Serializer/ErrorNormalizer.php

@@ -45,10 +45,9 @@ public function normalize(mixed $data, ?string $format = null, array $context =
             $error['code'] = $data->getId();
         }
 
-        // TODO: change this 5.x
-        // if (isset($error['status'])) {
-        //     $error['status'] = (string) $error['status'];
-        // }
+        if (isset($error['status'])) {
+            $error['status'] = (string) $error['status'];
+        }
 
         if (!isset($error['violations'])) {
             return ['errors' => [$error]];

src/Laravel/State/ValidateProvider.php

@@ -115,12 +115,6 @@ private function getBodyForValidation(mixed $body): array
             return $v;
         }
 
-        // hopefully this path never gets used, its there for BC-layer only
-        // TODO: remove in 5.0
-        if ($s = json_encode($body)) {
-            return json_decode($s, true);
-        }
-
         throw new RuntimeException('Could not transform the denormalized body in an array for validation');
     }
 }

src/Laravel/Tests/JsonApiTest.php

@@ -250,13 +250,13 @@ public function testValidateJsonApi(): void
                 [
                     'detail' => 'The prop field is required.',
                     'title' => 'Validation Error',
-                    'status' => 422,
+                    'status' => '422',
                     'code' => '58350900e0fc6b8e/prop',
                 ],
                 [
                     'detail' => 'The max field must be less than 2.',
                     'title' => 'Validation Error',
-                    'status' => 422,
+                    'status' => '422',
                     'code' => '58350900e0fc6b8e/max',
                 ],
             ],
@@ -294,7 +294,7 @@ public function testNotFound(): void
         $this->assertJsonContains([
             'links' => ['type' => '/errors/404'],
             'title' => 'An error occurred',
-            'status' => 404,
+            'status' => '404',
             'detail' => 'Not Found',
         ], $response->json()['errors'][0]);
     }

src/Metadata/Resource/Factory/ParameterResourceMetadataCollectionFactory.php

@@ -212,13 +212,7 @@ private function getProperties(string $resourceClass, ?Parameter $parameter = nu
         }
 
         if (($filter = $this->getFilterInstance($parameter->getFilter())) && $filter instanceof PropertyAwareFilterInterface) {
-            if (!method_exists($filter, 'getProperties')) { // todo 5.x remove this check
-                trigger_deprecation('api-platform/core', 'In API Platform 5.0 "%s" will implement a method named "getProperties"', PropertyAwareFilterInterface::class);
-                $refl = new \ReflectionClass($filter);
-                $filterProperties = $refl->hasProperty('properties') ? $refl->getProperty('properties')->getValue($filter) : [];
-            } else {
-                $filterProperties = array_keys($filter->getProperties() ?? []);
-            }
+            $filterProperties = array_keys($filter->getProperties() ?? []);
 
             foreach ($filterProperties as $prop) {
                 if (!\in_array($prop, $propertyNames, true)) {

tests/Functional/JsonApi/ErrorTest.php

@@ -43,8 +43,7 @@ public function testErrorResourceRendersInJsonApiFormat(): void
         $this->assertJsonContains([
             'errors' => [
                 [
-                    // TODO: change this to '400' in 5.x
-                    'status' => 400,
+                    'status' => '400',
                     'detail' => 'Resource "nonexistent" not found.',
                 ],
             ],
@@ -91,7 +90,7 @@ public function testRfc7807ErrorRendersJsonApiFormat(): void
         $this->assertResponseHeaderSame('content-type', 'application/vnd.api+json; charset=utf-8');
         $body = $response->toArray(false);
         $this->assertSame('An error occurred', $body['errors'][0]['title']);
-        $this->assertSame(400, $body['errors'][0]['status']);
+        $this->assertSame('400', $body['errors'][0]['status']);
         $this->assertArrayHasKey('detail', $body['errors'][0]);
         $this->assertArrayHasKey('type', $body['errors'][0]);
     }
@@ -110,7 +109,7 @@ public function testNotFoundRouteRendersJsonApiFormat(): void
         $this->assertResponseHeaderSame('content-type', 'application/vnd.api+json; charset=utf-8');
         $body = $response->toArray(false);
         $this->assertSame('An error occurred', $body['errors'][0]['title']);
-        $this->assertSame(404, $body['errors'][0]['status']);
+        $this->assertSame('404', $body['errors'][0]['status']);
         $this->assertArrayHasKey('detail', $body['errors'][0]);
         $this->assertArrayHasKey('type', $body['errors'][0]);
     }