phpstan 2.x

.github/workflows/tests.yml

@@ -42,3 +42,6 @@ jobs:
 
       - name: Run test suite
         run: php artisan test
+
+      - name: Run Phpstan
+        run: ./vendor/bin/phpstan analyze --no-progress

app/Actions/FirewallRule/CreateRule.php

@@ -21,7 +21,6 @@ public function create(Server $server, array $input): FirewallRule
             'mask' => $input['mask'] ?? null,
         ]);
 
-        /** @var Firewall $firewallHandler */
         $firewallHandler = $server->firewall()->handler();
         $firewallHandler->addRule(
             $rule->type,

app/Actions/NotificationChannels/AddChannel.php

@@ -59,7 +59,7 @@ public static function rules(array $input): array
             'label' => 'required',
         ];
 
-        return array_merge($rules, static::providerRules($input));
+        return array_merge($rules, self::providerRules($input));
     }
 
     private static function providerRules(array $input): array

app/Actions/ServerProvider/CreateServerProvider.php

@@ -17,7 +17,7 @@ class CreateServerProvider
      */
     public function create(User $user, Project $project, array $input): ServerProvider
     {
-        $provider = static::getProvider($input['provider']);
+        $provider = self::getProvider($input['provider']);
 
         try {
             $provider->connect($input);
@@ -60,7 +60,7 @@ public static function rules(array $input): array
             ],
         ];
 
-        return array_merge($rules, static::providerRules($input));
+        return array_merge($rules, self::providerRules($input));
     }
 
     private static function providerRules(array $input): array
@@ -69,6 +69,6 @@ private static function providerRules(array $input): array
             return [];
         }
 
-        return static::getProvider($input['provider'])->credentialValidationRules($input);
+        return self::getProvider($input['provider'])->credentialValidationRules($input);
     }
 }

app/Actions/SourceControl/ConnectSourceControl.php

@@ -46,7 +46,7 @@ public static function rules(array $input): array
             ],
         ];
 
-        return array_merge($rules, static::providerRules($input));
+        return array_merge($rules, self::providerRules($input));
     }
 
     /**

app/Actions/SourceControl/EditSourceControl.php

@@ -35,7 +35,7 @@ public static function rules(SourceControl $sourceControl, array $input): array
             ],
         ];
 
-        return array_merge($rules, static::providerRules($sourceControl, $input));
+        return array_merge($rules, self::providerRules($sourceControl, $input));
     }
 
     /**

app/Facades/FTP.php

@@ -7,12 +7,12 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @method static bool|Connection connect(string $host, string $port, bool $ssl = false)
- * @method static bool login(string $username, string $password, bool|Connection $connection)
- * @method static void close(bool|Connection $connection)
- * @method static bool passive(bool|Connection $connection, bool $passive)
- * @method static bool delete(bool|Connection $connection, string $path)
- * @method static void assertConnected(string $host)
+ * @ method static bool|Connection connect(string $host, string $port, bool $ssl = false)
+ * @ method static bool login(string $username, string $password, bool|Connection $connection)
+ * @ method static void close(bool|Connection $connection)
+ * @ method static bool passive(bool|Connection $connection, bool $passive)
+ * @ method static bool delete(bool|Connection $connection, string $path)
+ * @ method static void assertConnected(string $host)
  */
 class FTP extends Facade
 {

app/Facades/SSH.php

@@ -10,15 +10,15 @@
 /**
  * Class SSH
  *
- * @method static init(Server $server, string $asUser = null)
- * @method static setLog(?ServerLog $log)
- * @method static connect()
- * @method static string exec(string $command, string $log = '', int $siteId = null, ?bool $stream = false, callable $streamCallback = null)
- * @method static string assertExecuted(array|string $commands)
- * @method static string assertExecutedContains(string $command)
- * @method static string assertFileUploaded(string $toPath, ?string $content = null)
- * @method static string getUploadedLocalPath()
- * @method static disconnect()
+ * @ method static \App\Helpers\SSH init(Server $server, string $asUser = null)
+ * @ method static \App\Helpers\SSH setLog(?ServerLog $log)
+ * @ method static void connect()
+ * @ method static string exec(string $command, string $log = '', int $siteId = null, ?bool $stream = false, callable $streamCallback = null)
+ * @ method static string assertExecuted(array|string $commands)
+ * @ method static string assertExecutedContains(string $command)
+ * @ method static string assertFileUploaded(string $toPath, ?string $content = null)
+ * @ method static string getUploadedLocalPath()
+ * @ method static void disconnect()
  */
 class SSH extends FacadeAlias
 {

app/Models/Backup.php

@@ -8,19 +8,6 @@
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\HasOne;
 
-/**
- * @property string $type
- * @property int $server_id
- * @property int $storage_id
- * @property int $database_id
- * @property string $interval
- * @property int $keep_backups
- * @property string $status
- * @property Server $server
- * @property StorageProvider $storage
- * @property Database $database
- * @property BackupFile[] $files
- */
 class Backup extends AbstractModel
 {
     use HasFactory;
@@ -58,26 +45,41 @@ public static function boot(): void
         BackupStatus::FAILED => 'danger',
     ];
 
+    /**
+     * @return BelongsTo<Server, $this>
+     */
     public function server(): BelongsTo
     {
         return $this->belongsTo(Server::class);
     }
 
+    /**
+     * @return BelongsTo<StorageProvider, $this>
+     */
     public function storage(): BelongsTo
     {
         return $this->belongsTo(StorageProvider::class, 'storage_id');
     }
 
+    /**
+     * @return BelongsTo<Database, $this>
+     */
     public function database(): BelongsTo
     {
         return $this->belongsTo(Database::class)->withTrashed();
     }
 
+    /**
+     * @return HasMany<BackupFile, $this>
+     */
     public function files(): HasMany
     {
         return $this->hasMany(BackupFile::class, 'backup_id');
     }
 
+    /**
+     * @return HasOne<BackupFile, $this>
+     */
     public function lastFile(): HasOne
     {
         return $this->hasOne(BackupFile::class, 'backup_id')->latest();

app/Models/BackupFile.php

@@ -7,15 +7,6 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
-/**
- * @property int $backup_id
- * @property string $name
- * @property int $size
- * @property string $status
- * @property string $restored_to
- * @property Carbon $restored_at
- * @property Backup $backup
- */
 class BackupFile extends AbstractModel
 {
     use HasFactory;
@@ -39,7 +30,7 @@ protected static function booted(): void
         static::created(function (BackupFile $backupFile) {
             $keep = $backupFile->backup->keep_backups;
             if ($backupFile->backup->files()->count() > $keep) {
-                /* @var BackupFile $lastFileToKeep */
+                /** @var BackupFile $lastFileToKeep */
                 $lastFileToKeep = $backupFile->backup->files()->orderByDesc('id')->skip($keep)->first();
                 if ($lastFileToKeep) {
                     $files = $backupFile->backup->files()
@@ -71,6 +62,9 @@ protected static function booted(): void
         BackupFileStatus::RESTORE_FAILED => 'danger',
     ];
 
+    /**
+     * @return BelongsTo<Backup, $this>
+     */
     public function backup(): BelongsTo
     {
         return $this->belongsTo(Backup::class);

app/Models/CronJob.php

@@ -6,16 +6,6 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
-/**
- * @property int $server_id
- * @property string $command
- * @property string $user
- * @property string $frequency
- * @property bool $hidden
- * @property string $status
- * @property string $crontab
- * @property Server $server
- */
 class CronJob extends AbstractModel
 {
     use HasFactory;
@@ -43,6 +33,9 @@ class CronJob extends AbstractModel
         CronjobStatus::DISABLED => 'gray',
     ];
 
+    /**
+     * @return BelongsTo<Server, $this>
+     */
     public function server(): BelongsTo
     {
         return $this->belongsTo(Server::class);

app/Models/Database.php

@@ -9,14 +9,6 @@
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
-/**
- * @property int $server_id
- * @property string $name
- * @property string $status
- * @property Server $server
- * @property Backup[] $backups
- * @property Carbon $deleted_at
- */
 class Database extends AbstractModel
 {
     use HasFactory;
@@ -55,11 +47,17 @@ public static function boot(): void
         DatabaseStatus::FAILED => 'danger',
     ];
 
+    /**
+     * @return BelongsTo<Server, $this>
+     */
     public function server(): BelongsTo
     {
         return $this->belongsTo(Server::class);
     }
 
+    /**
+     * @return HasMany<Backup, $this>
+     */
     public function backups(): HasMany
     {
         return $this->hasMany(Backup::class)->where('type', 'database');

app/Models/DatabaseUser.php

@@ -6,15 +6,6 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
-/**
- * @property int $server_id
- * @property string $username
- * @property string $password
- * @property array $databases
- * @property string $host
- * @property string $status
- * @property Server $server
- */
 class DatabaseUser extends AbstractModel
 {
     use HasFactory;
@@ -38,6 +29,9 @@ class DatabaseUser extends AbstractModel
         'password',
     ];
 
+    /**
+     * @return BelongsTo<Server, $this>
+     */
     public function server(): BelongsTo
     {
         return $this->belongsTo(Server::class);

app/Models/Deployment.php

@@ -6,18 +6,6 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
-/**
- * @property int $site_id
- * @property int $deployment_script_id
- * @property int $log_id
- * @property string $commit_id
- * @property string $commit_id_short
- * @property array $commit_data
- * @property string $status
- * @property Site $site
- * @property DeploymentScript $deploymentScript
- * @property ServerLog $log
- */
 class Deployment extends AbstractModel
 {
     use HasFactory;
@@ -44,16 +32,25 @@ class Deployment extends AbstractModel
         DeploymentStatus::FAILED => 'danger',
     ];
 
+    /**
+     * @return BelongsTo<Site, $this>
+     */
     public function site(): BelongsTo
     {
         return $this->belongsTo(Site::class);
     }
 
+    /**
+     * @return BelongsTo<DeploymentScript, $this>
+     */
     public function deploymentScript(): BelongsTo
     {
         return $this->belongsTo(DeploymentScript::class);
     }
 
+    /**
+     * @return BelongsTo<ServerLog, $this>
+     */
     public function log(): BelongsTo
     {
         return $this->belongsTo(ServerLog::class, 'log_id');

app/Models/DeploymentScript.php

@@ -5,12 +5,6 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
-/**
- * @property int $site_id
- * @property string $name
- * @property string $content
- * @property Site $site
- */
 class DeploymentScript extends AbstractModel
 {
     use HasFactory;
@@ -25,6 +19,9 @@ class DeploymentScript extends AbstractModel
         'site_id' => 'integer',
     ];
 
+    /**
+     * @return BelongsTo<Site, $this>
+     */
     public function site(): BelongsTo
     {
         return $this->belongsTo(Site::class);

app/Models/FirewallRule.php

@@ -5,17 +5,6 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
-/**
- * @property int $server_id
- * @property string $type
- * @property string $protocol
- * @property int $port
- * @property string $source
- * @property ?string $mask
- * @property string $note
- * @property string $status
- * @property Server $server
- */
 class FirewallRule extends AbstractModel
 {
     use HasFactory;
@@ -36,6 +25,9 @@ class FirewallRule extends AbstractModel
         'port' => 'integer',
     ];
 
+    /**
+     * @return BelongsTo<Server, $this>
+     */
     public function server(): BelongsTo
     {
         return $this->belongsTo(Server::class);