chore: bump PHPStan level to 6, add array shape annotations

Author: ace-of-aces

phpstan.neon.dist

@@ -2,7 +2,7 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: 5
+    level: 6
     paths:
         - src
         - config

src/Enums/AllowedMimeTypes.php

@@ -11,11 +11,17 @@ enum AllowedMimeTypes: string
     case Webp = 'image/webp';
     case Gif = 'image/gif';
 
+    /**
+     * @return array<string>
+     */
     public static function all(): array
     {
         return array_map(fn (self $mimeType) => $mimeType->value, self::cases());
     }
 
+    /**
+     * @return array<array{mime: string, extension: string}>
+     */
     public static function withExtension(): array
     {
         return array_map(

src/Enums/AllowedOptions.php

@@ -16,11 +16,17 @@ enum AllowedOptions: string
     case Version = 'version';
     case Background = 'background';
 
+    /**
+     * @return array<string>
+     */
     public static function all(): array
     {
         return array_map(fn (self $option) => $option->value, self::cases());
     }
 
+    /**
+     * @return array<string, string>
+     */
     public static function withTypes(): array
     {
         return [

src/Exceptions/InvalidConfigurationException.php

@@ -9,7 +9,7 @@
 
 class InvalidConfigurationException extends RuntimeException
 {
-    public function __construct(string $message, $code = 0, ?Throwable $previous = null)
+    public function __construct(string $message, int $code = 0, ?Throwable $previous = null)
     {
         parent::__construct($message, $code, $previous);
     }

src/Facades/ImageTransformUrl.php

@@ -7,10 +7,10 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @method static string make(string $path, array|string $options = [], ?string $pathPrefix = null)
- * @method static string url(string $path, array|string $options = [], ?string $pathPrefix = null)
- * @method static string signedUrl(string $path, array|string $options = [], ?string $pathPrefix = null, \DateTimeInterface|\DateInterval|int|null $expiration = null, ?bool $absolute = true)
- * @method static string temporarySignedUrl(string $path, array|string $options = [], \DateTimeInterface|\DateInterval|int $expiration, ?string $pathPrefix = null, ?bool $absolute = true)
+ * @method static string make(string $path, array<string, int|string>|string $options = [], ?string $pathPrefix = null)
+ * @method static string url(string $path, array<string, int|string>|string $options = [], ?string $pathPrefix = null)
+ * @method static string signedUrl(string $path, array<string, int|string>|string $options = [], ?string $pathPrefix = null, \DateTimeInterface|\DateInterval|int|null $expiration = null, ?bool $absolute = true)
+ * @method static string temporarySignedUrl(string $path, array<string, int|string>|string $options = [], \DateTimeInterface|\DateInterval|int $expiration, ?string $pathPrefix = null, ?bool $absolute = true)
  *
  * @see \AceOfAces\LaravelImageTransformUrl\ImageTransformUrl
  */

src/Http/Controllers/ImageTransformerController.php

@@ -268,7 +268,7 @@ protected function rateLimit(Request $request, string $path): void
     /**
      * Parse the given options.
      *
-     * @return array<string, int>
+     * @return array<string, int|string>
      */
     protected static function parseOptions(string $options): array
     {

src/ImageTransformUrl.php

@@ -15,7 +15,7 @@ class ImageTransformUrl
      * Generate a regular URL for the image transformation.
      *
      * @param  string  $path  The path to the image.
-     * @param  array|string  $options  The transformation options.
+     * @param  array<string, int|string>|string  $options  The transformation options.
      * @param  string|null  $pathPrefix  The path prefix to use. Defaults to the default path prefix.
      * @return string The generated URL.
      */
@@ -34,7 +34,7 @@ public function make(string $path, array|string $options = [], ?string $pathPref
      * Generate a regular URL for the image transformation.
      *
      * @param  string  $path  The path to the image.
-     * @param  array|string  $options  The transformation options.
+     * @param  array<string, int|string>|string  $options  The transformation options.
      * @param  string|null  $pathPrefix  The path prefix to use. Defaults to the default path prefix.
      * @return string The generated URL.
      */
@@ -47,7 +47,7 @@ public function url(string $path, array|string $options = [], ?string $pathPrefi
      * Generate a signed URL for the image transformation.
      *
      * @param  string  $path  The path to the image.
-     * @param  array|string  $options  The transformation options.
+     * @param  array<string, int|string>|string  $options  The transformation options.
      * @param  string|null  $pathPrefix  The path prefix to use. Defaults to the default path prefix.
      * @param  DateTimeInterface|\DateInterval|int|null  $expiration  The expiration time for the signed URL.
      * @return string The signed URL.
@@ -83,7 +83,7 @@ public function signedUrl(string $path, array|string $options = [], ?string $pat
      * Generate a temporary signed URL for the image transformation.
      *
      * @param  string  $path  The path to the image.
-     * @param  array|string  $options  The transformation options.
+     * @param  array<string, int|string>|string  $options  The transformation options.
      * @param  DateTimeInterface|DateInterval|int  $expiration  The expiration time for the signed URL.
      * @param  string|null  $pathPrefix  The path prefix to use. Defaults to the default path prefix.
      * @param  bool|null  $absolute  Whether the URL should be absolute. Defaults to true.
@@ -98,6 +98,8 @@ public function temporarySignedUrl(string $path, array|string $options, DateTime
 
     /**
      * Convert array options to a string format suitable for URL generation.
+     *
+     * @param  array<string, int|string>|string  $options
      */
     protected function optionsToString(array|string $options): string
     {

src/Traits/ManagesImageCache.php

@@ -97,6 +97,8 @@ protected function cleanupOldCacheFiles(Filesystem $disk, string $cacheBasePath,
 
     /**
      * Store image in cache with size management.
+     *
+     * @param  array<string, int|string>  $options
      */
     protected function storeCachedImage(?string $pathPrefix, ?string $path, array $options, EncodedImageInterface $encoded): void
     {
@@ -118,6 +120,8 @@ protected function storeCachedImage(?string $pathPrefix, ?string $path, array $o
 
     /**
      * Get the cache path for the given path and options.
+     *
+     * @param  array<string, int|string>  $options
      */
     protected function getCachePath(?string $pathPrefix, ?string $path, array $options): string
     {
@@ -126,6 +130,11 @@ protected function getCachePath(?string $pathPrefix, ?string $path, array $optio
         return Storage::disk(config()->string('image-transform-url.cache.disk'))->path($cachePath);
     }
 
+    /**
+     * Get the end (relative) path for storing the cached image.
+     *
+     * @param  array<string, int|string>  $options
+     */
     protected function getCacheEndPath(?string $pathPrefix, ?string $path, array $options): string
     {
         $optionsHash = md5(json_encode($options));

src/Traits/ResolvesOptions.php

@@ -10,6 +10,8 @@ trait ResolvesOptions
 {
     /**
      * Get the positive int value of the given option.
+     *
+     * @param  array<string, int|string|null>  $options
      */
     protected static function getPositiveIntOptionValue(array $options, string $option, ?int $max = null, ?int $fallback = null): ?int
     {
@@ -23,6 +25,8 @@ protected static function getPositiveIntOptionValue(array $options, string $opti
 
     /**
      * Get the unsigned int value of the given option.
+     *
+     * @param  array<string, int|string|null>  $options
      */
     protected static function getUnsignedIntOptionValue(array $options, string $option, ?int $fallback = null, ?int $min = null, ?int $max = null): ?int
     {
@@ -37,6 +41,8 @@ protected static function getUnsignedIntOptionValue(array $options, string $opti
 
     /**
      * Get the string value of the given option.
+     *
+     * @param  array<string, int|string|null>  $options
      */
     protected static function getStringOptionValue(array $options, string $option, ?string $default = null): ?string
     {
@@ -48,6 +54,7 @@ protected static function getStringOptionValue(array $options, string $option, ?
      * Get the select option value of the given option.
      *
      * @param  array<string>  $allowedValues
+     * @param  array<string, int|string|null>  $options
      */
     protected static function getSelectOptionValue(array $options, string $option, array $allowedValues, ?string $default = null): ?string
     {