Make phpstan type checks happy

Author: BertalanD

app/Http/Controllers/Dormitory/Printing/PrintJobController.php

@@ -179,6 +179,7 @@ private function paginatorFrom(Builder $printJobs, array $columns)
         $paginator = TabulatorPaginator::from($printJobs)->sortable($columns)->filterable($columns)->paginate();
 
         // Process the data before showing it in a table.
+        // @phpstan-ignore-next-line
         $paginator->getCollection()->append([
             'translated_cost',
             'translated_state',

app/Models/FreePages.php

@@ -77,7 +77,7 @@ public function printAccount()
 
     /**
      * Wether the free pages are still available.
-     * @return bool
+     * @return Attribute
      */
     protected function available(): Attribute
     {

app/Models/PrintAccount.php

@@ -69,7 +69,7 @@ public function freePages()
 
     /**
      * The free pages which are currently available. Sorts the free pages by their deadline.
-     * @return Collection
+     * @return Collection|FreePages[]
      */
     public function availableFreePages()
     {
@@ -131,7 +131,7 @@ public function updateHistory(bool $useFreePages, int $cost)
             $availableFreePages = $this->availableFreePages()->where('amount', '>', 0);
 
             // Subtract the pages from the free pages pool, as many free pages as necessary
-            /** @var FreePages */
+            /** @var FreePages $freePages */
             foreach ($availableFreePages as $freePages) {
                 $subtractablePages = $freePages->calculateSubtractablePages($freePagesToSubtract);
                 $freePages->subtractPages($subtractablePages);

app/Models/PrintAccountHistory.php

@@ -3,8 +3,9 @@
 namespace App\Models;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
-// Note: the elements of this class should no be changed manually.
+// Note: the elements of this class should not be changed manually.
 // Observers for updating entries are set up.
 /**
  * App\Models\PrintAccountHistory
@@ -45,11 +46,21 @@ class PrintAccountHistory extends Model
         'modified_at',
     ];
 
+
+    /**
+     * `User` whose balance is affected by this change.
+     * @return BelongsTo
+     */
     public function user()
     {
         return $this->belongsTo(User::class);
     }
 
+
+    /**
+     * `User` who initiated this change.
+     * @return BelongsTo
+     */
     public function modifier()
     {
         return $this->belongsTo(User::class, 'modified_by');

app/Models/PrintJob.php

@@ -62,6 +62,10 @@ class PrintJob extends Model
         'used_free_pages' => 'boolean',
     ];
 
+    /**
+     * `User` that sent this `PrintJob`.
+     * @return BelongsTo
+     */
     public function user()
     {
         return $this->belongsTo(User::class);
@@ -116,7 +120,6 @@ public function translatedState(): Attribute
 
     /**
      * Attemts to cancel the given `PrintJob`. Returns wether it was successful.
-     * @param PrintJob $this
      * @return PrinterCancelResult
      */
     public function cancel()

app/Models/Printer.php

@@ -49,7 +49,7 @@ public function printJobs()
      * @param string $originalName
      * @param bool $twoSided
      * @param int $copyNumber
-     * @return Model
+     * @return PrintJob
      * @throws AuthenticationException
      * @throws PrinterException
      * @throws MassAssignmentException
@@ -73,13 +73,13 @@ public function createPrintJob(bool $useFreePages, int $cost, string $filePath,
      * @param bool $twoSided
      * @param int $copies
      * @param string $path
-     * @return int The `jobId` belonging to the printjob
+     * @return string The `jobId` belonging to the printjob
      * @throws PrinterException If the printing fails
      */
     public function print(bool $twoSided, int $copies, string $path)
     {
         if (config('app.debug')) {
-            return -1;
+            return "not_submitted";
         }
         $jobId = null;
         try {
@@ -135,7 +135,7 @@ public function getCompletedPrintJobs()
      */
     public function updateCompletedPrintJobs()
     {
-        return DB::transaction(function () {
+        DB::transaction(function () {
             PrintJob::where('state', PrintJobStatus::QUEUED)->whereIn(
                 'job_id',
                 $this->getCompletedPrintJobs()

app/Utils/PrinterHelper.php

@@ -6,6 +6,9 @@
 use App\Models\Printer;
 use App\Models\PrintJob;
 use App\Utils\Process;
+use Illuminate\Contracts\Container\BindingResolutionException;
+use Psr\Container\NotFoundExceptionInterface;
+use Psr\Container\ContainerExceptionInterface;
 
 class PrinterHelper
 {
@@ -48,9 +51,9 @@ public static function getPageTypesNeeded(int $pages, bool $twoSided)
     /**
      * Returns the number of free pages needed to print with given configuration.
      * @param int $pages
-     * @param mixed $copies
-     * @param mixed $twoSided
-     * @return int|float
+     * @param int $copies
+     * @param bool $twoSided
+     * @return int
      */
     public static function getFreePagesNeeded(int $pages, int $copies, bool $twoSided)
     {

app/Utils/Process.php

@@ -49,7 +49,6 @@ public function getOutput(string $debugOutput = ''): string
     /**
      * Get the exit code of the process.
      *
-     * @param string $debugOutput
      * @return int|null
      */
     public function getExitCode(): ?int