fix stan

api-platform · Jun 25, 2024 · e23c175 · e23c175
1 parent db81e02
commit e23c175
Show file tree

Hide file tree

Showing 19 changed files with 122 additions and 81 deletions.
diff --git a/src/Laravel/ApiPlatformProvider.php b/src/Laravel/ApiPlatformProvider.php
@@ -279,7 +279,6 @@ public function register(): void
                         )
                     )
                 ),
-                $app->make(ModelMetadata::class)
             );
         });
 
@@ -316,7 +315,7 @@ public function register(): void
         });
 
         $this->app->singleton(ValidateProvider::class, function (Application $app) {
-            return new ValidateProvider($app->make(ReadProvider::class), $app, $app->make(SerializerInterface::class), $app->make(SerializerContextBuilderInterface::class));
+            return new ValidateProvider($app->make(ReadProvider::class), $app);
         });
 
         $this->app->singleton(JsonApiProvider::class, function (Application $app) use ($config) {

diff --git a/src/Laravel/ApiResource/ValidationError.php b/src/Laravel/ApiResource/ValidationError.php
@@ -67,16 +67,19 @@
 class ValidationError extends RuntimeException implements \Stringable, ProblemExceptionInterface, HttpExceptionInterface, SymfonyHttpExceptionInterface
 {
     private int $status = 422;
-    private mixed $id;
+    private string $id;
 
-    public function __construct(string $message = '', mixed $code = null, int|\Throwable|null $previous = null, protected array $violations = [])
+    /**
+     * @param array<int, array{propertyPath: string, message: string, code?: string}> $violations
+     */
+    public function __construct(string $message = '', mixed $code = null, ?\Throwable $previous = null, protected array $violations = [])
     {
-        $this->id = $code;
+        $this->id = (string) $code;
         $this->setDetail($message);
         parent::__construct($message ?: $this->__toString(), 422, $previous);
     }
 
-    public function getId()
+    public function getId(): string
     {
         return $this->id;
     }
@@ -130,11 +133,11 @@ public function getInstance(): ?string
         return null;
     }
 
-    #[SerializedName('violations')]
-    #[Groups(['json', 'jsonld'])]
     /**
-     * @return array<int, array{propertyPath: string, message: string}>
+     * @return array<int,array{propertyPath:string,message:string,code?:string}>
      */
+    #[SerializedName('violations')]
+    #[Groups(['json', 'jsonld'])]
     public function getViolations(): array
     {
         return $this->violations;
@@ -145,6 +148,9 @@ public function getStatusCode(): int
         return $this->status;
     }
 
+    /**
+     * @return array<string, string>
+     */
     public function getHeaders(): array
     {
         return [];

diff --git a/src/Laravel/Eloquent/Metadata/Factory/Property/EloquentAttributePropertyMetadataFactory.php b/src/Laravel/Eloquent/Metadata/Factory/Property/EloquentAttributePropertyMetadataFactory.php
@@ -26,6 +26,10 @@ public function __construct(private readonly ?PropertyMetadataFactoryInterface $
 
     public function create(string $resourceClass, string $property, array $options = []): ApiProperty
     {
+        if (!class_exists($resourceClass)) {
+            return $this->decorated?->create($resourceClass, $property, $options) ?? new ApiProperty();
+        }
+
         $refl = new \ReflectionClass($resourceClass);
         $model = $refl->newInstanceWithoutConstructor();
 

diff --git a/...vel/Eloquent/Metadata/Factory/Property/EloquentAttributePropertyNameCollectionFactory.php b/...vel/Eloquent/Metadata/Factory/Property/EloquentAttributePropertyNameCollectionFactory.php
@@ -27,6 +27,10 @@ public function create(string $resourceClass, array $options = []): PropertyName
     {
         $properties = $this->decorated ? iterator_to_array($this->decorated->create($resourceClass, $options)) : [];
 
+        if (!class_exists($resourceClass)) {
+            return new PropertyNameCollection($properties);
+        }
+
         $refl = new \ReflectionClass($resourceClass);
         $attributes = $refl->getAttributes(ApiProperty::class);
         foreach ($attributes as $attribute) {

diff --git a/...avel/Eloquent/Metadata/Factory/Property/EloquentPropertyNameCollectionMetadataFactory.php b/...avel/Eloquent/Metadata/Factory/Property/EloquentPropertyNameCollectionMetadataFactory.php
@@ -32,6 +32,10 @@ public function __construct(private ModelMetadata $modelMetadata, private Proper
      */
     public function create(string $resourceClass, array $options = []): PropertyNameCollection
     {
+        if (!class_exists($resourceClass)) {
+            return $this->decorated->create($resourceClass, $options);
+        }
+
         try {
             $refl = new \ReflectionClass($resourceClass);
             $model = $refl->newInstanceWithoutConstructor();
@@ -45,7 +49,7 @@ public function create(string $resourceClass, array $options = []): PropertyName
 
         $properties = [];
         // When it's an Eloquent model we read attributes from database (@see ShowModelCommand)
-        foreach ($this->modelMetadata->getAttributes($model) as $property) { // @phpstan-ignore-line
+        foreach ($this->modelMetadata->getAttributes($model) as $property) {
             if (!$property['primary'] && $property['hidden']) {
                 continue;
             }

diff --git a/src/Laravel/Eloquent/Metadata/Factory/Resource/EloquentResourceCollectionMetadataFactory.php b/src/Laravel/Eloquent/Metadata/Factory/Resource/EloquentResourceCollectionMetadataFactory.php
@@ -13,7 +13,6 @@
 
 namespace ApiPlatform\Laravel\Eloquent\Metadata\Factory\Resource;
 
-use ApiPlatform\Laravel\Eloquent\Metadata\ModelMetadata;
 use ApiPlatform\Laravel\Eloquent\State\CollectionProvider;
 use ApiPlatform\Laravel\Eloquent\State\ItemProvider;
 use ApiPlatform\Laravel\Eloquent\State\PersistProcessor;
@@ -24,11 +23,10 @@
 use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
 use Illuminate\Database\Eloquent\Model;
 
-class EloquentResourceCollectionMetadataFactory implements ResourceMetadataCollectionFactoryInterface
+final class EloquentResourceCollectionMetadataFactory implements ResourceMetadataCollectionFactoryInterface
 {
     public function __construct(
         private readonly ResourceMetadataCollectionFactoryInterface $decorated,
-        private readonly ModelMetadata $modelMetadata
     ) {
     }
 

diff --git a/src/Laravel/Eloquent/Metadata/ModelMetadata.php b/src/Laravel/Eloquent/Metadata/ModelMetadata.php
@@ -15,6 +15,7 @@
 
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Relation;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Gate;
 use Illuminate\Support\Str;
 
@@ -28,7 +29,7 @@ final class ModelMetadata
     /**
      * The methods that can be called in a model to indicate a relation.
      *
-     * @var array
+     * @var string[]
      */
     public const RELATION_METHODS = [
         'hasMany',
@@ -63,9 +64,9 @@ public function getPolicy($model)
      *
      * @param Model $model
      *
-     * @return \Illuminate\Support\Collection
+     * @return \Illuminate\Support\Collection<string, mixed>
      */
-    public function getAttributes($model)
+    public function getAttributes($model): Collection
     {
         $connection = $model->getConnection();
         $schema = $connection->getSchemaBuilder();
@@ -90,6 +91,9 @@ public function getAttributes($model)
             ->merge($this->getVirtualAttributes($model, $columns));
     }
 
+    /**
+     * @param array<int, array{columns: string[]}> $indexes
+     */
     private function isColumnPrimaryKey(array $indexes, string $column): bool
     {
         foreach ($indexes as $index) {
@@ -104,12 +108,11 @@ private function isColumnPrimaryKey(array $indexes, string $column): bool
     /**
      * Get the virtual (non-column) attributes for the given model.
      *
-     * @param Model $model
-     * @param array $columns
+     * @param array<string, mixed> $columns
      *
-     * @return \Illuminate\Support\Collection
+     * @return \Illuminate\Support\Collection<int, mixed>
      */
-    public function getVirtualAttributes($model, $columns)
+    public function getVirtualAttributes(Model $model, $columns): Collection
     {
         $class = new \ReflectionClass($model);
 
@@ -148,11 +151,9 @@ public function getVirtualAttributes($model, $columns)
     /**
      * Get the relations from the given model.
      *
-     * @param Model $model
-     *
-     * @return \Illuminate\Support\Collection
+     * @return \Illuminate\Support\Collection<int, mixed>
      */
-    public function getRelations($model)
+    public function getRelations(Model $model): Collection
     {
         return collect(get_class_methods($model))
             ->map(fn ($method) => new \ReflectionMethod($model, $method))
@@ -168,11 +169,19 @@ public function getRelations($model)
                     return true;
                 }
 
+                if (false === $method->getFileName()) {
+                    return false;
+                }
+
                 $file = new \SplFileObject($method->getFileName());
                 $file->seek($method->getStartLine() - 1);
                 $code = '';
                 while ($file->key() < $method->getEndLine()) {
-                    $code .= trim($file->current());
+                    $current = $file->current();
+                    if (\is_string($current)) {
+                        $code .= trim($current);
+                    }
+
                     $file->next();
                 }
 
@@ -199,11 +208,9 @@ public function getRelations($model)
     /**
      * Get the Events that the model dispatches.
      *
-     * @param Model $model
-     *
-     * @return \Illuminate\Support\Collection
+     * @return \Illuminate\Support\Collection<int, mixed>
      */
-    public function getEvents($model)
+    public function getEvents(Model $model): Collection
     {
         return collect($model->dispatchesEvents())
             ->map(fn (string $class, string $event) => [
@@ -214,13 +221,8 @@ public function getEvents($model)
 
     /**
      * Get the cast type for the given column.
-     *
-     * @param string $column
-     * @param Model  $model
-     *
-     * @return string|null
      */
-    private function getCastType($column, $model)
+    private function getCastType(string $column, Model $model): ?string
     {
         if ($model->hasGetMutator($column) || $model->hasSetMutator($column)) {
             return 'accessor';
@@ -236,11 +238,9 @@ private function getCastType($column, $model)
     /**
      * Get the model casts, including any date casts.
      *
-     * @param Model $model
-     *
-     * @return \Illuminate\Support\Collection
+     * @return \Illuminate\Support\Collection<string, mixed>
      */
-    private function getCastsWithDates($model)
+    private function getCastsWithDates(Model $model): Collection
     {
         return collect($model->getDates())
             ->filter()
@@ -252,12 +252,11 @@ private function getCastsWithDates($model)
     /**
      * Get the default value for the given column.
      *
-     * @param array $column
-     * @param Model $model
+     * @param array<string, mixed>&array{name: string, default: string} $column
      *
      * @return mixed|null
      */
-    private function getColumnDefault($column, $model)
+    private function getColumnDefault(array $column, Model $model): mixed
     {
         $attributeDefault = $model->getAttributes()[$column['name']] ?? null;
 
@@ -270,13 +269,8 @@ private function getColumnDefault($column, $model)
 
     /**
      * Determine if the given attribute is hidden.
-     *
-     * @param string $attribute
-     * @param Model  $model
-     *
-     * @return bool
      */
-    private function attributeIsHidden($attribute, $model)
+    private function attributeIsHidden(string $attribute, Model $model): bool
     {
         if (\count($model->getHidden()) > 0) {
             return \in_array($attribute, $model->getHidden(), true);
@@ -292,12 +286,9 @@ private function attributeIsHidden($attribute, $model)
     /**
      * Determine if the given attribute is unique.
      *
-     * @param string $column
-     * @param array  $indexes
-     *
-     * @return bool
+     * @param array<int, array{columns: string[], unique: bool}> $indexes
      */
-    private function columnIsUnique($column, $indexes)
+    private function columnIsUnique(string $column, array $indexes): bool
     {
         return collect($indexes)->contains(
             fn ($index) => 1 === \count($index['columns']) && $index['columns'][0] === $column && $index['unique']

diff --git a/src/Laravel/Eloquent/PropertyAccess/PropertyAccessor.php b/src/Laravel/Eloquent/PropertyAccess/PropertyAccessor.php
@@ -26,11 +26,17 @@ public function __construct(private readonly PropertyAccessorInterface $inner)
     {
     }
 
+    /**
+     * @param array<mixed, mixed>|object $objectOrArray
+     */
     public function setValue(object|array &$objectOrArray, string|PropertyPathInterface $propertyPath, mixed $value): void
     {
         $this->inner->setValue($objectOrArray, $propertyPath, $value);
     }
 
+    /**
+     * @param array<mixed, mixed>|object $objectOrArray
+     */
     public function getValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath): mixed
     {
         $value = $this->inner->getValue($objectOrArray, $propertyPath);
@@ -42,11 +48,17 @@ public function getValue(object|array $objectOrArray, string|PropertyPathInterfa
         return $value;
     }
 
+    /**
+     * @param array<mixed, mixed>|object $objectOrArray
+     */
     public function isWritable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath): bool
     {
         return $this->inner->isWritable($objectOrArray, $propertyPath);
     }
 
+    /**
+     * @param array<mixed, mixed>|object $objectOrArray
+     */
     public function isReadable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath): bool
     {
         return $this->inner->isReadable($objectOrArray, $propertyPath);

diff --git a/src/Laravel/Eloquent/State/CollectionProvider.php b/src/Laravel/Eloquent/State/CollectionProvider.php
@@ -29,6 +29,9 @@ class CollectionProvider implements ProviderInterface
 {
     use LinksHandlerLocatorTrait;
 
+    /**
+     * @param LinksHandlerInterface<Model> $linksHandler
+     */
     public function __construct(private readonly Pagination $pagination, private readonly LinksHandlerInterface $linksHandler, ?ContainerInterface $handleLinksLocator = null)
     {
         $this->handleLinksLocator = $handleLinksLocator;
@@ -44,9 +47,9 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
         $model = new ($operation->getClass())();
 
         if ($handleLinks = $this->getLinksHandler($operation)) {
-            $query = $handleLinks($model->query(), $uriVariables, ['operation' => $operation] + $context);
+            $query = $handleLinks($model->query(), $uriVariables, ['operation' => $operation, 'modelClass' => $operation->getClass()] + $context);
         } else {
-            $query = $this->linksHandler->handleLinks($model->query(), $uriVariables, ['operation' => $operation] + $context);
+            $query = $this->linksHandler->handleLinks($model->query(), $uriVariables, ['operation' => $operation, 'modelClass' => $operation->getClass()] + $context);
         }
 
         if (false === $this->pagination->isEnabled($operation, $context)) {

diff --git a/src/Laravel/Eloquent/State/ItemProvider.php b/src/Laravel/Eloquent/State/ItemProvider.php
@@ -15,6 +15,7 @@
 
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\ProviderInterface;
+use Illuminate\Database\Eloquent\Model;
 use Psr\Container\ContainerInterface;
 
 /**
@@ -24,6 +25,9 @@ class ItemProvider implements ProviderInterface
 {
     use LinksHandlerLocatorTrait;
 
+    /**
+     * @param LinksHandlerInterface<Model> $linksHandler
+     */
     public function __construct(private readonly LinksHandlerInterface $linksHandler, ?ContainerInterface $handleLinksLocator = null)
     {
         $this->handleLinksLocator = $handleLinksLocator;