Fix even more type errors

app/Http/Middleware/EncryptCookies.php

@@ -9,7 +9,7 @@ class EncryptCookies extends Middleware
     /**
      * The names of the cookies that should not be encrypted.
      *
-     * @var array
+     * @var array<int, string>
      */
     protected $except = [
         //

app/Http/Middleware/PreventRequestsDuringMaintenance.php

@@ -9,7 +9,7 @@ class PreventRequestsDuringMaintenance extends Middleware
     /**
      * The URIs that should be reachable while maintenance mode is enabled.
      *
-     * @var array
+     * @var array<int, string>
      */
     protected $except = [
         //

app/Http/Middleware/VerifyCsrfToken.php

@@ -9,7 +9,7 @@ class VerifyCsrfToken extends Middleware
     /**
      * The URIs that should be excluded from CSRF verification.
      *
-     * @var array
+     * @var array<int, string>
      */
     protected $except = [
         //

app/Http/Requests/SchoolSetRequest.php

@@ -16,6 +16,8 @@ public function authorize()
         if (auth()->user()->hasRole('super-admin')) {
             return true;
         }
+
+        return false;
     }
 
     /**

app/Http/Requests/UpdateExamStatusRequest.php

@@ -6,13 +6,7 @@
 
 class UpdateExamStatusRequest extends FormRequest
 {
-    /**
-     * Determine if the user is authorized to make this request.
-     *
-     * @return bool
-     */
 
-    //prepare attribute for validation
     protected function prepareForValidation()
     {
         if ($this->status == 'active' || $this->status == 1 || $this->status == 'on') {

app/Models/AcademicYear.php

@@ -16,6 +16,8 @@ class AcademicYear extends Model
 
     public $name;
 
+    public AcademicYearStudentRecord $studentAcademicYearBasedRecords;
+
     protected $fillable = [
         'start_year',
         'stop_year',

app/Models/AccountApplication.php

@@ -5,6 +5,7 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Support\Collection;
 use Spatie\ModelStatus\HasStatuses;
 use Spatie\Permission\Models\Role;
 
@@ -33,10 +34,8 @@ public function role(): BelongsTo
 
     /**
      * Possible account application statuses.
-     *
-     * @return void
      */
-    public function getAllStatuses()
+    public function getAllStatuses() : Collection
     {
         return collect(['approved', 'rejected', 'under review', 'user action required']);
     }

app/Models/Exam.php

@@ -24,7 +24,7 @@ class Exam extends Model
     /**
      * The attributes that should be cast.
      *
-     * @var array
+     * @var array<string, string>
      */
     protected $casts = [
         'email_verified_at' => 'datetime',

app/Models/MyClass.php

@@ -53,20 +53,16 @@ public function studentRecords()
 
     /**
      * The subjects that belong to the MyClass.
-     *
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
      */
-    public function subjects()
+    public function subjects() : HasMany
     {
         return $this->hasMany(Subject::class);
     }
 
     /**
      * Get the students in class.
-     *
-     * @return Collection
      */
-    public function students()
+    public function students() : Collection
     {
         $students = User::students()->inSchool()->whereRelation('studentRecord.myClass', 'id', $this->id)->get();
 

app/Models/Promotion.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 class Promotion extends Model
 {
@@ -28,27 +29,27 @@ public function getLabelAttribute()
         return "{$this->oldClass->name} - {$this->oldSection->name} to {$this->newClass->name} - {$this->newSection->name} year: {$this->academicYear->start_year} - {$this->academicYear->stop_year}";
     }
 
-    public function oldClass()
+    public function oldClass() : BelongsTo
     {
         return $this->belongsTo(MyClass::class, 'old_class_id');
     }
 
-    public function newClass()
+    public function newClass() : BelongsTo
     {
         return $this->belongsTo(MyClass::class, 'new_class_id');
     }
 
-    public function oldSection()
+    public function oldSection() : BelongsTo
     {
         return $this->belongsTo(Section::class, 'old_section_id');
     }
 
-    public function newSection()
+    public function newSection() : BelongsTo
     {
         return $this->belongsTo(Section::class, 'new_section_id');
     }
 
-    public function academicYear()
+    public function academicYear() : BelongsTo
     {
         return $this->belongsTo(AcademicYear::class, 'academic_year_id');
     }

app/Models/StudentRecord.php

@@ -17,7 +17,7 @@ class StudentRecord extends Model
     /**
      * The attributes that should be cast.
      *
-     * @var array
+     * @var array<string, string>
      */
     protected $casts = [
         'admission_date' => 'datetime:Y-m-d',

app/Models/User.php

@@ -7,6 +7,7 @@
 use Illuminate\Contracts\Auth\MustVerifyEmail;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Database\Eloquent\SoftDeletes;
@@ -52,7 +53,7 @@ class User extends Authenticatable implements MustVerifyEmail
     /**
      * The attributes that should be hidden for serialization.
      *
-     * @var array
+     * @var array<int, string>
      */
     protected $hidden = [
         'password',
@@ -64,7 +65,7 @@ class User extends Authenticatable implements MustVerifyEmail
     /**
      * The attributes that should be cast.
      *
-     * @var array
+     * @var array<string, string>
      */
     protected $casts = [
         'email_verified_at' => 'datetime',
@@ -94,9 +95,9 @@ public function scopeStudents($query)
      */
     public function scopeApplicants($query)
     {
-        return $query->role('applicant')->whereHas('accountApplication', function (Builder $query) {
+        return $query->whereHas('accountApplication', function (Builder $query) {
             $query->otherCurrentStatus('rejected');
-        });
+        })->role('applicant');
     }
 
     /**
@@ -120,10 +121,8 @@ public function scopeActiveStudents($query)
 
     /**
      * Get the school that owns the User.
-     *
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
-    public function school()
+    public function school() : BelongsTo
     {
         return $this->belongsTo(School::class);
     }

app/Services/Fee/FeeInvoiceRecordService.php

@@ -14,10 +14,8 @@ class FeeInvoiceRecordService
      * Store a new fee invoice record.
      *
      * @param array $records
-     *
-     * @return $feeInvoiceRecord
      */
-    public function storeFeeInvoiceRecord($records)
+    public function storeFeeInvoiceRecord($records) : FeeInvoiceRecord
     {
         $fee = Fee::where('id', $records['fee_id'])->whereRelation('feeCategory', 'school_id', auth()->user()->school_id)->get();
         $feeInvoice = FeeInvoice::where('id', $records['fee_invoice_id'])->whereRelation('user', 'school_id', auth()->user()->school_id)->get();
@@ -26,24 +24,24 @@ public function storeFeeInvoiceRecord($records)
             throw new InvalidValueException("The fee you selected doesn't exist");
         }
 
-        FeeInvoiceRecord::create([
+        $feeInvoiceRecord =  FeeInvoiceRecord::create([
             'fee_invoice_id' => $records['fee_invoice_id'],
             'fee_id'         => $records['fee_id'],
             'amount'         => $records['amount'],
             'waiver'         => $records['waiver'] ?? 0,
             'fine'           => $records['fine'] ?? 0,
         ]);
+
+        return $feeInvoiceRecord;
     }
 
     /**
      * Update a fee invoice record.
      *
      * @param FeeInvoiceRecord $feeInvoiceRecord
      * @param                  $records
-     *
-     * @return void
      */
-    public function updateFeeInvoiceRecord(FeeInvoiceRecord $feeInvoiceRecord, $records)
+    public function updateFeeInvoiceRecord(FeeInvoiceRecord $feeInvoiceRecord, $records) : FeeInvoiceRecord
     {
         $amount = Money::ofMinor($records['amount'], config('app.currency'));
         $waiver = Money::ofMinor($records['waiver'] ?? 0, config('app.currency'));
@@ -58,16 +56,16 @@ public function updateFeeInvoiceRecord(FeeInvoiceRecord $feeInvoiceRecord, $reco
             'waiver' => $records['waiver'] ?? 0,
             'fine'   => $records['fine'] ?? 0,
         ]);
+
+        return $feeInvoiceRecord;
     }
 
     /**
      * Delete a fee invoice.
      *
      * @param FeeInvoiceRecord $feeInvoiceRecord
-     *
-     * @return void
      */
-    public function deleteFeeInvoiceRecord(FeeInvoiceRecord $feeInvoiceRecord)
+    public function deleteFeeInvoiceRecord(FeeInvoiceRecord $feeInvoiceRecord) : void
     {
         $feeInvoiceRecord->delete();
     }
@@ -77,10 +75,8 @@ public function deleteFeeInvoiceRecord(FeeInvoiceRecord $feeInvoiceRecord)
      *
      * @param FeeInvoiceRecord $feeInvoiceRecord
      * @param array            $records
-     *
-     * @return void
      */
-    public function addPayment(FeeInvoiceRecord $feeInvoiceRecord, $records)
+    public function addPayment(FeeInvoiceRecord $feeInvoiceRecord, $records) : FeeInvoiceRecord
     {
         $pay = Money::of($records['pay'], config('app.currency'));
         $paid = $feeInvoiceRecord->paid;
@@ -93,9 +89,11 @@ public function addPayment(FeeInvoiceRecord $feeInvoiceRecord, $records)
         $feeInvoiceRecord->update([
             'paid' => $newAmount,
         ]);
+
+        return $feeInvoiceRecord;
     }
 
-    public function isPaymentHigherThanDue(Money $amount, Money $paid, Money $waiver, Money $fine)
+    public function isPaymentHigherThanDue(Money $amount, Money $paid, Money $waiver, Money $fine) : bool
     {
         $due = $amount->plus($fine)->minus($waiver);
 

app/Services/Parent/ParentService.php

@@ -2,11 +2,12 @@
 
 namespace App\Services\Parent;
 
-use App\Exceptions\InvalidUserException;
 use App\Models\User;
-use App\Services\Print\PrintService;
 use App\Services\User\UserService;
 use Illuminate\Support\Facades\DB;
+use App\Services\Print\PrintService;
+use App\Exceptions\InvalidUserException;
+use Illuminate\Database\Eloquent\Collection;
 
 class ParentService
 {
@@ -22,10 +23,8 @@ public function __construct(UserService $user)
 
     /**
      * Get all parents in school.
-     *
-     * @return Illuminate\Eloquent\Database\Collection|static[]
      */
-    public function getAllParents()
+    public function getAllParents() : Collection|static
     {
         return $this->user->getUsersByRole('parent')->load('parentRecord');
     }

app/Services/User/UserService.php

@@ -2,9 +2,10 @@
 
 namespace App\Services\User;
 
+use App\Models\User;
 use App\Actions\Fortify\CreateNewUser;
+use Illuminate\Database\Eloquent\Collection;
 use App\Actions\Fortify\UpdateUserProfileInformation;
-use App\Models\User;
 
 class UserService
 {
@@ -26,10 +27,8 @@ public function __construct(CreateNewUser $createUserAction, UpdateUserProfileIn
 
     /**
      * Get all users.
-     *
-     * @return \Illuminate\Database\Eloquent\Collection|static[]
      */
-    public function getAllUsers()
+    public function getAllUsers() : Collection|static
     {
         return User::school()->get();
     }

app/Traits/EnvEditorTrait.php

@@ -9,11 +9,8 @@ trait EnvEditorTrait
 {
     /**
      * Write a new Env value to the env file the app is currently using.
-     *
-     *
-     * @return void
      */
-    public function setEnvironmentValue(array $values)
+    public function setEnvironmentValue(array $values) : bool
     {
         $envFile = app()->environmentFilePath();
         $str = file_get_contents($envFile);

app/Traits/InSchool.php

@@ -3,17 +3,16 @@
 namespace App\Traits;
 
 use App\Models\School;
+use Illuminate\Database\Eloquent\Builder;
 
 trait InSchool
 {
     /**
      * Scopes school procied else scopes school of currently authenticated user.
      *
-     * @param Illuminate\Database\Eloquent\Builder $query
-     *
-     * @return Illuminate\Database\Eloquent\Builder
+     * @param \Illuminate\Database\Eloquent\Builder $query
      */
-    public function scopeInSchool($query, ?School $school = null)
+    public function scopeInSchool($query, ?School $school = null) : Builder
     {
         $school == null ? $school = auth()->user()->school_id : $school->id;
 

phpstan.neon

@@ -9,6 +9,7 @@ parameters:
     # Level 9 is the highest level
     level: 5
 
+
 #    ignoreErrors:
 #        - '#PHPDoc tag @var#'
 #