add more types

composer.json

@@ -32,10 +32,10 @@
         "spatie/laravel-signal-aware-command": "^1.2|^2.0",
         "spatie/temporary-directory": "^2.0",
         "symfony/console": "^6.0|^7.0",
-        "symfony/finder": "^6.0|^7.0"
+        "symfony/finder": "^6.0|^7.0",
+        "ext-pcntl": "*"
     },
     "require-dev": {
-        "ext-pcntl": "*",
         "composer-runtime-api": "^2.0",
         "larastan/larastan": "^2.7.0",
         "laravel/slack-notification-channel": "^2.5|^3.0",

phpstan-baseline.neon

@@ -0,0 +1,56 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Parameter \\#1 \\$callback of method Illuminate\\\\Support\\\\Collection\\<int,Spatie\\\\Backup\\\\BackupDestination\\\\Backup\\>\\:\\:filter\\(\\) expects \\(callable\\(Spatie\\\\Backup\\\\BackupDestination\\\\Backup, int\\)\\: bool\\)\\|null, Closure\\(string\\)\\: bool given\\.$#"
+			count: 1
+			path: src/BackupDestination/BackupCollection.php
+
+		-
+			message: "#^Parameter \\#1 \\$callback of method Illuminate\\\\Support\\\\Collection\\<int,Spatie\\\\Backup\\\\BackupDestination\\\\Backup\\>\\:\\:map\\(\\) expects callable\\(Spatie\\\\Backup\\\\BackupDestination\\\\Backup, int\\)\\: Spatie\\\\Backup\\\\BackupDestination\\\\Backup, Closure\\(string\\)\\: Spatie\\\\Backup\\\\BackupDestination\\\\Backup given\\.$#"
+			count: 1
+			path: src/BackupDestination/BackupCollection.php
+
+		-
+			message: "#^Unable to resolve the template type TKey in call to function collect$#"
+			count: 1
+			path: src/BackupDestination/BackupDestinationFactory.php
+
+		-
+			message: "#^Unable to resolve the template type TValue in call to function collect$#"
+			count: 1
+			path: src/BackupDestination/BackupDestinationFactory.php
+
+		-
+			message: "#^Parameter \\#1 \\$callback of method Illuminate\\\\Support\\\\Collection\\<int,int\\>\\:\\:map\\(\\) expects callable\\(int, int\\)\\: string, Closure\\(string\\)\\: non\\-falsy\\-string given\\.$#"
+			count: 1
+			path: src/Exceptions/CannotCreateDbDumper.php
+
+		-
+			message: "#^Method Spatie\\\\Backup\\\\Notifications\\\\Channels\\\\Discord\\\\DiscordMessage\\:\\:toArray\\(\\) return type has no value type specified in iterable type array\\.$#"
+			count: 1
+			path: src/Notifications/Channels/Discord/DiscordMessage.php
+
+		-
+			message: "#^Method Spatie\\\\Backup\\\\Tasks\\\\Backup\\\\FileSelection\\:\\:sanitize\\(\\) return type with generic class Illuminate\\\\Support\\\\Collection does not specify its types\\: TKey, TValue$#"
+			count: 1
+			path: src/Tasks/Backup/FileSelection.php
+
+		-
+			message: "#^Method Spatie\\\\Backup\\\\Tasks\\\\Backup\\\\Manifest\\:\\:files\\(\\) return type has no value type specified in iterable type array\\.$#"
+			count: 1
+			path: src/Tasks/Backup/Manifest.php
+
+		-
+			message: "#^Method Spatie\\\\Backup\\\\Tasks\\\\Backup\\\\Manifest\\:\\:files\\(\\) return type has no value type specified in iterable type array\\|Generator\\.$#"
+			count: 1
+			path: src/Tasks/Backup/Manifest.php
+
+		-
+			message: "#^Method Spatie\\\\Backup\\\\Tasks\\\\Backup\\\\Zip\\:\\:add\\(\\) has parameter \\$files with no value type specified in iterable type iterable\\.$#"
+			count: 1
+			path: src/Tasks/Backup/Zip.php
+
+		-
+			message: "#^Parameter \\#1 \\$callback of method Illuminate\\\\Support\\\\Collection\\<int,Spatie\\\\Backup\\\\BackupDestination\\\\Backup\\>\\:\\:each\\(\\) expects callable\\(Spatie\\\\Backup\\\\BackupDestination\\\\Backup, int\\)\\: mixed, Closure\\(Spatie\\\\Backup\\\\BackupDestination\\\\BackupCollection\\)\\: void given\\.$#"
+			count: 1
+			path: src/Tasks/Cleanup/Strategies/DefaultStrategy.php

phpstan.neon.dist

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

src/BackupDestination/Backup.php

@@ -66,6 +66,7 @@ public function sizeInBytes(): float
         return $this->size;
     }
 
+    /** @return resource */
     public function stream()
     {
         return throw_unless(

src/BackupDestination/BackupCollection.php

@@ -6,10 +6,12 @@
 use Illuminate\Support\Collection;
 use Spatie\Backup\Helpers\File;
 
+/** @extends Collection<int,Backup> */
 class BackupCollection extends Collection
 {
     protected ?float $sizeCache = null;
 
+    /** @param array<string> $files */
     public static function createFromFiles(?FileSystem $disk, array $files): self
     {
         return (new static($files))

src/BackupDestination/BackupDestination.php

@@ -114,6 +114,7 @@ public function connectionError(): Exception
         return $this->connectionError;
     }
 
+    /** @return array<string, string> */
     public function getDiskOptions(): array
     {
         return config("filesystems.disks.{$this->diskName()}.backup_options") ?? [];

src/BackupDestination/BackupDestinationFactory.php

@@ -6,6 +6,10 @@
 
 class BackupDestinationFactory
 {
+    /**
+     * @param array<string, mixed> $config
+     * @return Collection<int, BackupDestination>
+     */
     public static function createFromArray(array $config): Collection
     {
         return collect($config['destination']['disks'])

src/BackupServiceProvider.php

@@ -52,7 +52,7 @@ public function packageRegistered(): void
         $this->registerDiscordChannel();
     }
 
-    protected function registerDiscordChannel()
+    protected function registerDiscordChannel(): void
     {
         Notification::resolved(function (ChannelManager $service) {
             $service->extend('discord', function ($app) {

src/Commands/BackupCommand.php

@@ -95,7 +95,7 @@ public function handle(): int
         }
     }
 
-    protected function guardAgainstInvalidOptions()
+    protected function guardAgainstInvalidOptions(): void
     {
         if (! $this->option('only-db')) {
             return;

src/Commands/BaseCommand.php

@@ -10,6 +10,7 @@
 
 abstract class BaseCommand extends SignalAwareCommand
 {
+    /** @var array<int> */
     protected array $handlesSignals = [];
 
     public function __construct()
@@ -33,6 +34,7 @@ protected function runningInConsole(): bool
         return in_array(PHP_SAPI, ['cli', 'phpdbg']);
     }
 
+    /** @return array<int> */
     public function getSubscribedSignals(): array
     {
         return $this->handlesSignals;

src/Commands/ListCommand.php

@@ -30,7 +30,10 @@ public function handle(): int
         return static::SUCCESS;
     }
 
-    protected function displayOverview(Collection $backupDestinationStatuses)
+    /**
+     * @param Collection<int, BackupDestinationStatus> $backupDestinationStatuses
+     */
+    protected function displayOverview(Collection $backupDestinationStatuses): static
     {
         $headers = ['Name', 'Disk', 'Reachable', 'Healthy', '# of backups', 'Newest backup', 'Used storage'];
 
@@ -46,6 +49,7 @@ protected function displayOverview(Collection $backupDestinationStatuses)
         return $this;
     }
 
+    /** @return array{0: string, 1: string, 2: string, disk: string, amount: integer, newest: string, usedStorage: string} */
     public function convertToRow(BackupDestinationStatus $backupDestinationStatus): array
     {
         $destination = $backupDestinationStatus->backupDestination();
@@ -73,7 +77,8 @@ public function convertToRow(BackupDestinationStatus $backupDestinationStatus):
         return $row;
     }
 
-    protected function displayFailures(Collection $backupDestinationStatuses)
+    /** @param Collection<int, BackupDestinationStatus> $backupDestinationStatuses */
+    protected function displayFailures(Collection $backupDestinationStatuses): static
     {
         $failed = $backupDestinationStatuses
             ->filter(function (BackupDestinationStatus $backupDestinationStatus) {
@@ -98,7 +103,7 @@ protected function displayFailures(Collection $backupDestinationStatuses)
         return $this;
     }
 
-    protected function getFormattedBackupDate(?Backup $backup = null)
+    protected function getFormattedBackupDate(?Backup $backup = null): string
     {
         return is_null($backup)
             ? 'No backups present'

src/Exceptions/CannotCreateDbDumper.php

@@ -6,11 +6,13 @@
 
 class CannotCreateDbDumper extends Exception
 {
-    public static function unsupportedDriver(string $driver): self
+    public static function unsupportedDriver(string $driver): static
     {
-        $supportedDrivers = collect(config('database.connections'))->keys();
+        /** @var array<int, string> $supportedDrivers */
+        $supportedDrivers = config('database.connections');
 
-        $formattedSupportedDrivers = $supportedDrivers
+        $formattedSupportedDrivers = collect($supportedDrivers)
+            ->keys()
             ->map(fn (string $supportedDriver) => "`{$supportedDriver}`")
             ->join(glue: ', ', finalGlue: ' or ');
 

src/Exceptions/NotificationCouldNotBeSent.php

@@ -6,7 +6,7 @@
 
 class NotificationCouldNotBeSent extends Exception
 {
-    public static function noNotificationClassForEvent($event): self
+    public static function noNotificationClassForEvent(object $event): static
     {
         $eventClass = $event::class;
 

src/Helpers/ConsoleOutput.php

@@ -18,7 +18,8 @@ public function setCommand(Command $command): void
         $this->command = $command;
     }
 
-    public function __call(string $method, array $arguments)
+    /** @param array<int, mixed> $arguments */
+    public function __call(string $method, array $arguments): void
     {
         $consoleOutput = app(static::class);
 

src/Helpers/File.php

@@ -7,6 +7,7 @@
 
 class File
 {
+    /** @var array<string> */
     protected static array $allowedMimeTypes = [
         'application/zip',
         'application/x-zip',

src/Notifications/BaseNotification.php

@@ -9,6 +9,7 @@
 
 abstract class BaseNotification extends Notification
 {
+    /** @return array<string, string> */
     public function via(): array
     {
         $notificationChannels = config('backup.notifications.notifications.'.static::class);
@@ -34,6 +35,7 @@ public function diskName(): string
         return $this->backupDestination()->diskName();
     }
 
+    /** @return Collection<string, string>  */
     protected function backupDestinationProperties(): Collection
     {
         $backupDestination = $this->backupDestination();

src/Notifications/Channels/Discord/DiscordChannel.php

@@ -4,10 +4,11 @@
 
 use Illuminate\Notifications\Notification;
 use Illuminate\Support\Facades\Http;
+use Spatie\Backup\Notifications\Notifiable;
 
 class DiscordChannel
 {
-    public function send($notifiable, Notification $notification): void
+    public function send(Notifiable $notifiable, Notification $notification): void
     {
         $discordMessage = $notification->toDiscord(); // @phpstan-ignore-line
 

src/Notifications/Channels/Discord/DiscordMessage.php

@@ -20,6 +20,7 @@ class DiscordMessage
 
     protected string $description = '';
 
+    /** @var array<string> */
     protected array $fields = [];
 
     protected ?string $timestamp = null;
@@ -48,7 +49,7 @@ public function url(string $url): self
         return $this;
     }
 
-    public function title($title): self
+    public function title(string $title): self
     {
         $this->title = $title;
 
@@ -97,6 +98,7 @@ public function error(): self
         return $this;
     }
 
+    /** @param array<string, string> $fields */
     public function fields(array $fields, bool $inline = true): self
     {
         foreach ($fields as $label => $value) {

src/Notifications/EventHandler.php

@@ -31,18 +31,21 @@ public function subscribe(Dispatcher $events): void
         });
     }
 
-    protected function determineNotifiable()
+    protected function determineNotifiable(): Notifiable
     {
         $notifiableClass = $this->config->get('backup.notifications.notifiable');
 
         return app($notifiableClass);
     }
 
-    protected function determineNotification($event): Notification
+    protected function determineNotification(object $event): Notification
     {
         $lookingForNotificationClass = class_basename($event).'Notification';
 
-        $notificationClass = collect($this->config->get('backup.notifications.notifications'))
+        /** @var array<class-string, array<int, string>> $notificationClasses */
+        $notificationClasses = $this->config->get('backup.notifications.notifications');
+
+        $notificationClass = collect($notificationClasses)
             ->keys()
             ->first(fn (string $notificationClass) => class_basename($notificationClass) === $lookingForNotificationClass);
 
@@ -53,6 +56,7 @@ protected function determineNotification($event): Notification
         return new $notificationClass($event);
     }
 
+    /** @return array<int, class-string> */
     protected function allBackupEventClasses(): array
     {
         return [

src/Notifications/Notifiable.php

@@ -8,6 +8,7 @@ class Notifiable
 {
     use NotifiableTrait;
 
+    /** @return string|array{int, string} */
     public function routeNotificationForMail(): string|array
     {
         return config('backup.notifications.mail.to');