chore(laravel): code cleanup (#6526)

* chore(laravel): code cleanup

* fix ci

* fix phpdoc

* fix review

* fix review

Author: dunglas

features/http_cache/tag_collector_service.feature

@@ -17,7 +17,7 @@ Feature: Cache invalidation through HTTP Cache tags (custom TagCollector service
     Then the response status code should be 201
     And the header "Cache-Tags" should not exist
 
-  Scenario: TagCollector can identify $object (IRI is overriden with custom logic)
+  Scenario: TagCollector can identify $object (IRI is overridden with custom logic)
     When I send a "GET" request to "/relation_embedders/1"
     Then the response status code should be 200
     And the header "Cache-Tags" should be equal to "/RE/1#anotherRelated,/RE/1#related,/RE/1"
@@ -126,7 +126,7 @@ Feature: Cache invalidation through HTTP Cache tags (custom TagCollector service
     Then the response status code should be 201
     And the header "Cache-Tags" should not exist
 
-  Scenario: TagCollector can read propertyMetadata (tag is overriden with data from extraProperties)
+  Scenario: TagCollector can read propertyMetadata (tag is overridden with data from extraProperties)
     When I send a "GET" request to "/extra_properties_on_properties/1"
     Then the response status code should be 200
     And the header "Cache-Tags" should be equal to "/extra_properties_on_properties/1#overrideRelationTag,/extra_properties_on_properties/1"

src/Laravel/ApiResource/Error.php

@@ -68,7 +68,7 @@ public function __construct(
         private readonly string $detail,
         #[ApiProperty(identifier: true)] private int $status,
         private readonly array $originalTrace,
-        private ?string $instance = null,
+        private readonly ?string $instance = null,
         private string $type = 'about:blank',
         private array $headers = []
     ) {

src/Laravel/Controller/ApiPlatformController.php

@@ -42,11 +42,14 @@ public function __construct(
     public function __invoke(Request $request): Response
     {
         $operation = $request->attributes->get('_api_operation');
-
         if (!$operation) {
             throw new \RuntimeException('Operation not found.');
         }
 
+        if (!$operation instanceof HttpOperation) {
+            throw new \LogicException('Operation is not an HttpOperation.');
+        }
+
         $uriVariables = $this->getUriVariables($request, $operation);
         // at some point we could introduce that back
         // if ($this->uriVariablesConverter) {
@@ -64,12 +67,12 @@ public function __invoke(Request $request): Response
             $operation = $operation->withValidate(!$request->isMethodSafe() && !$request->isMethod('DELETE'));
         }
 
-        if (null === $operation->canRead() && $operation instanceof HttpOperation) {
-            $operation = $operation->withRead($operation->getUriVariables() || $request->isMethodSafe());
+        if (null === $operation->canRead()) {
+            $operation = $operation->withRead($operation->getUriVariables() || $request->isMethodSafe()); // @phpstan-ignore-line
         }
 
-        if (null === $operation->canDeserialize() && $operation instanceof HttpOperation) {
-            $operation = $operation->withDeserialize(\in_array($operation->getMethod(), ['POST', 'PUT', 'PATCH'], true));
+        if (null === $operation->canDeserialize()) {
+            $operation = $operation->withDeserialize(\in_array($operation->getMethod(), ['POST', 'PUT', 'PATCH'], true)); // @phpstan-ignore-line
         }
 
         $body = $this->provider->provide($operation, $uriVariables, $context);

src/Laravel/Eloquent/Metadata/Factory/Property/EloquentAttributePropertyMetadataFactory.php

@@ -20,8 +20,9 @@
 
 final class EloquentAttributePropertyMetadataFactory implements PropertyMetadataFactoryInterface
 {
-    public function __construct(private readonly ?PropertyMetadataFactoryInterface $decorated = null)
-    {
+    public function __construct(
+        private readonly ?PropertyMetadataFactoryInterface $decorated = null,
+    ) {
     }
 
     public function create(string $resourceClass, string $property, array $options = []): ApiProperty

src/Laravel/Eloquent/Metadata/Factory/Property/EloquentAttributePropertyNameCollectionFactory.php

@@ -19,8 +19,9 @@
 
 final class EloquentAttributePropertyNameCollectionFactory implements PropertyNameCollectionFactoryInterface
 {
-    public function __construct(private readonly ?PropertyNameCollectionFactoryInterface $decorated = null)
-    {
+    public function __construct(
+        private readonly ?PropertyNameCollectionFactoryInterface $decorated = null,
+    ) {
     }
 
     public function create(string $resourceClass, array $options = []): PropertyNameCollection

src/Laravel/Eloquent/Metadata/Factory/Property/EloquentPropertyMetadataFactory.php

@@ -22,14 +22,16 @@
 use Symfony\Component\PropertyInfo\Type;
 
 /**
- * Use Doctrine metadata to populate the identifier property.
+ * Uses Eloquent metadata to populate the identifier property.
  *
  * @author Kévin Dunglas <[email protected]>
  */
 final class EloquentPropertyMetadataFactory implements PropertyMetadataFactoryInterface
 {
-    public function __construct(private ModelMetadata $modelMetadata, private readonly ?PropertyMetadataFactoryInterface $decorated = null)
-    {
+    public function __construct(
+        private readonly ModelMetadata $modelMetadata,
+        private readonly ?PropertyMetadataFactoryInterface $decorated = null
+    ) {
     }
 
     /**

src/Laravel/Eloquent/Metadata/Factory/Property/EloquentPropertyNameCollectionMetadataFactory.php

@@ -21,8 +21,11 @@
 
 final class EloquentPropertyNameCollectionMetadataFactory implements PropertyNameCollectionFactoryInterface
 {
-    public function __construct(private ModelMetadata $modelMetadata, private PropertyNameCollectionFactoryInterface $decorated, private ResourceClassResolverInterface $resourceClassResolver)
-    {
+    public function __construct(
+        private readonly ModelMetadata $modelMetadata,
+        private readonly PropertyNameCollectionFactoryInterface $decorated,
+        private readonly ResourceClassResolverInterface $resourceClassResolver,
+    ) {
     }
 
     /**

src/Laravel/Eloquent/Metadata/Factory/Resource/EloquentResourceCollectionMetadataFactory.php

@@ -48,8 +48,8 @@ public function create(string $resourceClass): ResourceMetadataCollection
             return $resourceMetadataCollection;
         }
 
-        foreach ($resourceMetadataCollection as $i => $resourceMetatada) {
-            $operations = $resourceMetatada->getOperations();
+        foreach ($resourceMetadataCollection as $i => $resourceMetadata) {
+            $operations = $resourceMetadata->getOperations();
             foreach ($operations as $operationName => $operation) {
                 if (!$operation->getProvider()) {
                     $operation = $operation->withProvider($operation instanceof CollectionOperationInterface ? CollectionProvider::class : ItemProvider::class);
@@ -62,7 +62,7 @@ public function create(string $resourceClass): ResourceMetadataCollection
                 $operations->add($operationName, $operation);
             }
 
-            $resourceMetadataCollection[$i] = $resourceMetatada->withOperations($operations);
+            $resourceMetadataCollection[$i] = $resourceMetadata->withOperations($operations);
         }
 
         return $resourceMetadataCollection;

src/Laravel/Eloquent/Metadata/IdentifiersExtractor.php

@@ -22,8 +22,9 @@
 
 final class IdentifiersExtractor implements IdentifiersExtractorInterface
 {
-    public function __construct(private readonly IdentifiersExtractorInterface $inner)
-    {
+    public function __construct(
+        private readonly IdentifiersExtractorInterface $inner,
+    ) {
     }
 
     public function getIdentifiersFromItem(object $item, ?Operation $operation = null, array $context = []): array

src/Laravel/Eloquent/Metadata/ModelMetadata.php

@@ -46,27 +46,21 @@ final class ModelMetadata
     ];
 
     /**
-     * Get the first policy associated with this model.
-     *
-     * @param Model $model
-     *
-     * @return string
+     * Gets the first policy associated with this model.
      */
-    public function getPolicy($model)
+    public function getPolicy(Model $model): ?string
     {
         $policy = Gate::getPolicyFor($model::class);
 
         return $policy ? $policy::class : null;
     }
 
     /**
-     * Get the column attributes for the given model.
+     * Gets the column attributes for the given model.
      *
-     * @param Model $model
-     *
-     * @return \Illuminate\Support\Collection<string, mixed>
+     * @return Collection<string, mixed>
      */
-    public function getAttributes($model): Collection
+    public function getAttributes(Model $model): Collection
     {
         $connection = $model->getConnection();
         $schema = $connection->getSchemaBuilder();
@@ -110,9 +104,9 @@ private function isColumnPrimaryKey(array $indexes, string $column): bool
      *
      * @param array<string, mixed> $columns
      *
-     * @return \Illuminate\Support\Collection<int, mixed>
+     * @return Collection<int, mixed>
      */
-    public function getVirtualAttributes(Model $model, $columns): Collection
+    public function getVirtualAttributes(Model $model, array $columns): Collection
     {
         $class = new \ReflectionClass($model);
 
@@ -149,9 +143,9 @@ public function getVirtualAttributes(Model $model, $columns): Collection
     }
 
     /**
-     * Get the relations from the given model.
+     * Gets the relations from the given model.
      *
-     * @return \Illuminate\Support\Collection<int, mixed>
+     * @return Collection<int, mixed>
      */
     public function getRelations(Model $model): Collection
     {
@@ -206,9 +200,9 @@ public function getRelations(Model $model): Collection
     }
 
     /**
-     * Get the Events that the model dispatches.
+     * Gets the Events that the model dispatches.
      *
-     * @return \Illuminate\Support\Collection<int, mixed>
+     * @return Collection<int, mixed>
      */
     public function getEvents(Model $model): Collection
     {
@@ -220,7 +214,7 @@ public function getEvents(Model $model): Collection
     }
 
     /**
-     * Get the cast type for the given column.
+     * Gets the cast type for the given column.
      */
     private function getCastType(string $column, Model $model): ?string
     {
@@ -236,9 +230,9 @@ private function getCastType(string $column, Model $model): ?string
     }
 
     /**
-     * Get the model casts, including any date casts.
+     * Gets the model casts, including any date casts.
      *
-     * @return \Illuminate\Support\Collection<string, mixed>
+     * @return Collection<string, mixed>
      */
     private function getCastsWithDates(Model $model): Collection
     {
@@ -250,11 +244,9 @@ private function getCastsWithDates(Model $model): Collection
     }
 
     /**
-     * Get the default value for the given column.
+     * Gets the default value for the given column.
      *
      * @param array<string, mixed>&array{name: string, default: string} $column
-     *
-     * @return mixed|null
      */
     private function getColumnDefault(array $column, Model $model): mixed
     {
@@ -268,7 +260,7 @@ private function getColumnDefault(array $column, Model $model): mixed
     }
 
     /**
-     * Determine if the given attribute is hidden.
+     * Determines if the given attribute is hidden.
      */
     private function attributeIsHidden(string $attribute, Model $model): bool
     {
@@ -284,7 +276,7 @@ private function attributeIsHidden(string $attribute, Model $model): bool
     }
 
     /**
-     * Determine if the given attribute is unique.
+     * Determines if the given attribute is unique.
      *
      * @param array<int, array{columns: string[], unique: bool}> $indexes
      */