PhpStan Workflow (#3341)

.github/workflows/phpstan.yml

@@ -0,0 +1,29 @@
+name: PHPStan
+
+on:
+    push:
+        paths:
+            - '**.php'
+            - 'phpstan.neon.dist'
+
+jobs:
+    phpstan:
+        name: phpstan
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Setup PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                  php-version: '8.2'
+                  extensions: dom, curl, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
+                  coverage: none
+
+            - name: Install dependencies
+              run: |
+                  composer require "php-ffmpeg/php-ffmpeg" --no-interaction --no-update
+                  composer update --prefer-dist --no-interaction
+
+            - name: Run PHPStan
+              run: ./vendor/bin/phpstan --error-format=github

phpstan.neon.dist

@@ -2,7 +2,7 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: 8
+    level: 5
     paths:
         - src
         - config
@@ -11,4 +11,13 @@ parameters:
     checkOctaneCompatibility: true
     checkModelProperties: true
     checkMissingIterableValueType: true
+    reportUnmatchedIgnoredErrors: false
 
+    ignoreErrors:
+        - '#Unsafe usage of new static#'
+
+        # For MediaLibraryPro dependencies
+        - "#MediaLibraryPro\\\\#"
+
+        # This must be removed after drop ZipStream V2
+        - "#ZipStream\\\\#"

src/Conversions/Commands/RegenerateCommand.php

@@ -108,7 +108,7 @@ protected function getMediaIds(): array
             $mediaIds = explode(',', (string) $mediaIds);
         }
 
-        if (count($mediaIds) === 1 && Str::contains($mediaIds[0], ',')) {
+        if (count($mediaIds) === 1 && Str::contains((string) $mediaIds[0], ',')) {
             $mediaIds = explode(',', (string) $mediaIds[0]);
         }
 

src/Conversions/ConversionCollection.php

@@ -11,9 +11,9 @@
 
 /**
  * @template TKey of array-key
- * @template TValue of \Spatie\MediaLibrary\Conversions\Conversion
+ * @template TValue of Conversion
  *
- * @extends \Illuminate\Support\Collection<TKey, TValue>
+ * @extends Collection<TKey, TValue>
  */
 class ConversionCollection extends Collection
 {
@@ -52,11 +52,13 @@ protected function addConversionsFromRelatedModel(Media $media): void
     {
         $modelName = Arr::get(Relation::morphMap(), $media->model_type, $media->model_type);
 
-        /** @var \Spatie\MediaLibrary\HasMedia $model */
-        if (class_exists($modelName)) {
-            $model = new $modelName();
+        if (! class_exists($modelName)) {
+            return;
         }
 
+        /** @var \Spatie\MediaLibrary\HasMedia $model */
+        $model = new $modelName();
+
         /*
          * In some cases the user might want to get the actual model
          * instance so conversion parameters can depend on model
@@ -93,7 +95,7 @@ public function getConversions(string $collectionName = ''): self
 
     protected function addManipulationToConversion(Manipulations $manipulations, string $conversionName)
     {
-        /** @var \Spatie\MediaLibrary\Conversions\Conversion|null $conversion */
+        /** @var Conversion|null $conversion */
         $conversion = $this->first(function (Conversion $conversion) use ($conversionName) {
             if (! in_array($this->media->collection_name, $conversion->getPerformOnCollections())) {
                 return false;

src/Conversions/ImageGenerators/Pdf.php

@@ -33,7 +33,7 @@ public function requirementsAreInstalled(): bool
 
     public function supportedExtensions(): Collection
     {
-        return collect('pdf');
+        return collect(['pdf']);
     }
 
     public function supportedMimeTypes(): Collection

src/Conversions/ImageGenerators/Svg.php

@@ -30,11 +30,11 @@ public function requirementsAreInstalled(): bool
 
     public function supportedExtensions(): Collection
     {
-        return collect('svg');
+        return collect(['svg']);
     }
 
     public function supportedMimeTypes(): Collection
     {
-        return collect('image/svg+xml');
+        return collect(['image/svg+xml']);
     }
 }

src/HasMedia.php

@@ -9,6 +9,12 @@
 use Spatie\MediaLibrary\MediaCollections\Models\Media;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 
+/**
+ * @mixin \Illuminate\Database\Eloquent\Model
+ * @method void prepareToAttachMedia(Media $media, FileAdder $fileAdder)
+ * @property bool $registerMediaConversionsUsingModelInstance
+ * @property ?\Spatie\MediaLibrary\MediaCollections\MediaCollection $mediaCollections
+ */
 interface HasMedia
 {
     public function media(): MorphMany;

src/InteractsWithMedia.php

@@ -25,13 +25,14 @@
 use Spatie\MediaLibrary\MediaCollections\Models\Media;
 use Spatie\MediaLibrary\Support\MediaLibraryPro;
 use Spatie\MediaLibraryPro\PendingMediaLibraryRequestHandler;
+use Symfony\Component\HttpFoundation\File\UploadedFile;
 
 trait InteractsWithMedia
 {
-    /** @var \Spatie\MediaLibrary\Conversions\Conversion[] */
+    /** @var Conversion[] */
     public array $mediaConversions = [];
 
-    /** @var \Spatie\MediaLibrary\MediaCollections\MediaCollection[] */
+    /** @var MediaCollection[] */
     public array $mediaCollections = [];
 
     protected bool $deletePreservingMedia = false;
@@ -65,7 +66,7 @@ public function media(): MorphMany
      *
      *
      */
-    public function addMedia(string|\Symfony\Component\HttpFoundation\File\UploadedFile $file): FileAdder
+    public function addMedia(string|UploadedFile $file): FileAdder
     {
         return app(FileAdderFactory::class)->create($this, $file);
     }
@@ -245,7 +246,7 @@ public function addMediaFromStream($stream): FileAdder
      *
      *
      */
-    public function copyMedia(string|\Symfony\Component\HttpFoundation\File\UploadedFile $file): FileAdder
+    public function copyMedia(string|UploadedFile $file): FileAdder
     {
         return $this->addMedia($file)->preservingOriginal();
     }

src/MediaCollections/FileAdder.php

@@ -23,18 +23,15 @@
 use Symfony\Component\HttpFoundation\File\File as SymfonyFile;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 
-/**
- * @template TModel of \Spatie\MediaLibrary\MediaCollections\Models\Media
- */
 class FileAdder
 {
     use Macroable;
 
-    protected ?Model $subject = null;
+    protected ?HasMedia $subject = null;
 
     protected bool $preserveOriginal = false;
 
-    /** @var \Symfony\Component\HttpFoundation\File\UploadedFile|string */
+    /** @var UploadedFile|RemoteFile|SymfonyFile|string */
     protected $file;
 
     protected array $properties = [];
@@ -69,6 +66,7 @@ public function __construct(
 
     public function setSubject(Model $subject): self
     {
+        /** @var HasMedia $subject */
         $this->subject = $subject;
 
         return $this;
@@ -77,7 +75,7 @@ public function setSubject(Model $subject): self
     /*
      * Set the file that needs to be imported.
      *
-     * @param string|\Symfony\Component\HttpFoundation\File\UploadedFile $file
+     * @param string|UploadedFile $file
      *
      * @return $this
      */
@@ -218,17 +216,11 @@ public function addCustomHeaders(array $customRemoteHeaders): self
         return $this;
     }
 
-    /**
-     * @return TModel
-     */
     public function toMediaCollectionOnCloudDisk(string $collectionName = 'default'): Media
     {
         return $this->toMediaCollection($collectionName, config('filesystems.cloud'));
     }
 
-    /**
-     * @return TModel
-     */
     public function toMediaCollectionFromRemote(string $collectionName = 'default', string $diskName = ''): Media
     {
         $storage = Storage::disk($this->file->getDisk());
@@ -242,7 +234,7 @@ public function toMediaCollectionFromRemote(string $collectionName = 'default',
         }
 
         $mediaClass = config('media-library.media_model');
-        /** @var \Spatie\MediaLibrary\MediaCollections\Models\Media $media */
+        /** @var Media $media */
         $media = new $mediaClass();
 
         $media->name = $this->mediaName;
@@ -280,9 +272,6 @@ public function toMediaCollectionFromRemote(string $collectionName = 'default',
         return $media;
     }
 
-    /**
-     * @return TModel
-     */
     public function toMediaCollection(string $collectionName = 'default', string $diskName = ''): Media
     {
         $sanitizedFileName = ($this->fileNameSanitizer)($this->fileName);
@@ -306,7 +295,7 @@ public function toMediaCollection(string $collectionName = 'default', string $di
         }
 
         $mediaClass = config('media-library.media_model');
-        /** @var \Spatie\MediaLibrary\MediaCollections\Models\Media $media */
+        /** @var Media $media */
         $media = new $mediaClass();
 
         $media->name = $this->mediaName;
@@ -346,9 +335,6 @@ public function toMediaCollection(string $collectionName = 'default', string $di
         return $media;
     }
 
-    /**
-     * @return TModel
-     */
     public function toMediaLibrary(string $collectionName = 'default', string $diskName = ''): Media
     {
         return $this->toMediaCollection($collectionName, $diskName);
@@ -477,7 +463,9 @@ protected function processMediaItem(HasMedia $model, Media $media, self $fileAdd
         }
 
         if ($collectionSizeLimit = optional($this->getMediaCollection($media->collection_name))->collectionSizeLimit) {
-            $collectionMedia = $this->subject->fresh()->getMedia($media->collection_name);
+            /** @var HasMedia */
+            $subject = $this->subject->fresh();
+            $collectionMedia = $subject->getMedia($media->collection_name);
 
             if ($collectionMedia->count() > $collectionSizeLimit) {
                 $model->clearMediaCollectionExcept($media->collection_name, $collectionMedia->slice(-$collectionSizeLimit, $collectionSizeLimit));
@@ -524,6 +512,7 @@ protected function toMediaCollectionFromTemporaryUpload(string $collectionName,
         /** @var TemporaryUpload $temporaryUpload */
         $temporaryUpload = $this->file;
 
+        /** @var Media */
         $media = $temporaryUpload->getFirstMedia();
 
         $media->name = $this->mediaName;

src/MediaCollections/FileAdderFactory.php

@@ -13,7 +13,7 @@ class FileAdderFactory
 {
     public static function create(Model $subject, string|UploadedFile $file): FileAdder
     {
-        /** @var \Spatie\MediaLibrary\MediaCollections\FileAdder $fileAdder */
+        /** @var FileAdder $fileAdder */
         $fileAdder = app(FileAdder::class);
 
         return $fileAdder
@@ -23,7 +23,7 @@ public static function create(Model $subject, string|UploadedFile $file): FileAd
 
     public static function createFromDisk(Model $subject, string $key, string $disk): FileAdder
     {
-        /** @var \Spatie\MediaLibrary\MediaCollections\FileAdder $fileAdder */
+        /** @var FileAdder $fileAdder */
         $fileAdder = app(FileAdder::class);
 
         return $fileAdder
@@ -68,7 +68,7 @@ public static function createAllFromRequest(Model $subject): Collection
 
     public static function createForPendingMedia(Model $subject, PendingMediaItem $pendingMedia): FileAdder
     {
-        /** @var \Spatie\MediaLibrary\MediaCollections\FileAdder $fileAdder */
+        /** @var FileAdder $fileAdder */
         $fileAdder = app(FileAdder::class);
 
         return $fileAdder

src/MediaCollections/MediaRepository.php

@@ -34,10 +34,10 @@ public function getCollection(
     /**
      * Apply given filters on media.
      *
-     * @param \Illuminate\Support\Collection $media
+     * @param Collection $media
      * @param array|callable $filter
      *
-     * @return \Illuminate\Support\Collection
+     * @return Collection
      */
     protected function applyFilterToMediaCollection(
         Collection $media,

src/MediaCollections/Models/Collections/MediaCollection.php

@@ -10,7 +10,7 @@
  * @template TKey of array-key
  * @template TModel of \Spatie\MediaLibrary\MediaCollections\Models\Media
  *
- * @extends \Illuminate\Database\Eloquent\Collection<TKey, TModel>
+ * @extends Collection<TKey, TModel>
  */
 class MediaCollection extends Collection implements Htmlable
 {

src/MediaCollections/Models/Concerns/HasUuid.php

@@ -10,6 +10,7 @@ trait HasUuid
     public static function bootHasUuid()
     {
         static::creating(function (Model $model) {
+            /** @var \Spatie\MediaLibrary\MediaCollections\Models\Media $model */
             if (empty($model->uuid)) {
                 $model->uuid = (string) Str::uuid();
             }