Model Updates (Relationships) (nabeelio#1573)

* Return Types and New Relationships

Added return types to current relationships

Added new relationships to Airport, Airline, Flight, Rank

* Update Aircraft.php

Fix for Znck BelongsToThrough return type check

* Update Aircraft.php

* StyleCi Fixes

* Update Flight.php

Switching from HasOne to BelongsTo for SimBrief test case

app/Models/Acars.php

@@ -7,6 +7,7 @@
 use App\Models\Casts\FuelCast;
 use App\Models\Traits\HashIdTrait;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 /**
  * @property string id
@@ -77,9 +78,9 @@ class Acars extends Model
     ];
 
     /**
-     * FKs
+     * Relationships
      */
-    public function pirep()
+    public function pirep(): BelongsTo
     {
         return $this->belongsTo(Pirep::class, 'pirep_id');
     }

app/Models/Aircraft.php

@@ -10,7 +10,11 @@
 use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Database\Eloquent\SoftDeletes;
+use Znck\Eloquent\Relations\BelongsToThrough as ZnckBelongsToThrough;
 use Znck\Eloquent\Traits\BelongsToThrough;
 
 /**
@@ -137,34 +141,34 @@ public function landingTime(): Attribute
     }
 
     /**
-     * foreign keys
+     * Relationships
      */
-    public function airline()
+    public function airline(): ZnckBelongsToThrough
     {
         return $this->belongsToThrough(Airline::class, Subfleet::class);
     }
 
-    public function airport()
+    public function airport(): BelongsTo
     {
         return $this->belongsTo(Airport::class, 'airport_id');
     }
 
-    public function hub()
+    public function hub(): HasOne
     {
         return $this->hasOne(Airport::class, 'id', 'hub_id');
     }
 
-    public function pireps()
+    public function pireps(): HasMany
     {
         return $this->hasMany(Pirep::class, 'aircraft_id');
     }
 
-    public function simbriefs()
+    public function simbriefs(): HasMany
     {
         return $this->hasMany(SimBrief::class, 'aircraft_id');
     }
 
-    public function subfleet()
+    public function subfleet(): BelongsTo
     {
         return $this->belongsTo(Subfleet::class, 'subfleet_id');
     }

app/Models/Airline.php

@@ -8,6 +8,9 @@
 use App\Models\Traits\JournalTrait;
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasManyThrough;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Support\Str;
 
@@ -110,26 +113,30 @@ public function icao(): Attribute
     }
 
     /*
-     * FKs
+     * Relationships
      */
-
-    public function subfleets()
+    public function subfleets(): HasMany
     {
-        return $this->hasMany(Subfleet::class, 'airline_id');
+        return $this->hasMany(Subfleet::class, 'id', 'airline_id');
     }
 
-    public function aircraft()
+    public function aircraft(): HasManyThrough
     {
         return $this->hasManyThrough(Aircraft::class, Subfleet::class);
     }
 
-    public function flights()
+    public function flights(): BelongsTo
     {
         return $this->belongsTo(Flight::class, 'airline_id');
     }
 
-    public function pireps()
+    public function pireps(): BelongsTo
     {
         return $this->belongsTo(Pirep::class, 'airline_id');
     }
+
+    public function users(): HasMany
+    {
+        return $this->hasMany(User::class, 'id', 'airline_id');
+    }
 }

app/Models/Airport.php

@@ -7,6 +7,7 @@
 use App\Models\Traits\FilesTrait;
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
 /**
@@ -138,4 +139,34 @@ public function tz(): Attribute
             ]
         );
     }
+
+    /**
+     * Relationships
+     */
+    public function departures(): HasMany
+    {
+        return $this->hasMany(Flight::class, 'dpt_airport_id');
+    }
+
+    public function arrivals(): HasMany
+    {
+        return $this->hasMany(Flight::class, 'arr_airport_id');
+    }
+
+    public function aircraft(): HasMany
+    {
+        return $this->hasMany(Aircraft::class, 'airport_id');
+    }
+
+    public function pilots(): HasMany
+    {
+        // Users currently at this airport
+        return $this->hasMany(User::class, 'curr_airport_id');
+    }
+
+    public function users(): HasMany
+    {
+        // Users based at this airport
+        return $this->hasMany(User::class, 'home_airport_id');
+    }
 }

app/Models/Bid.php

@@ -4,6 +4,7 @@
 
 use App\Contracts\Model;
 use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 /**
  * @property int    user_id
@@ -29,12 +30,12 @@ class Bid extends Model
     /**
      * Relationships
      */
-    public function flight()
+    public function flight(): BelongsTo
     {
         return $this->belongsTo(Flight::class, 'flight_id');
     }
 
-    public function user()
+    public function user(): BelongsTo
     {
         return $this->belongsTo(User::class, 'user_id');
     }

app/Models/Expense.php

@@ -6,6 +6,8 @@
 use App\Models\Casts\CommaDelimitedCast;
 use App\Models\Traits\ReferenceTrait;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
 
 /**
  * @property int     airline_id
@@ -53,14 +55,14 @@ class Expense extends Model
     ];
 
     /**
-     * Foreign Keys
+     * Relationships
      */
-    public function airline()
+    public function airline(): BelongsTo
     {
         return $this->belongsTo(Airline::class, 'airline_id');
     }
 
-    public function ref_model()
+    public function ref_model(): MorphTo
     {
         return $this->morphTo();
     }

app/Models/Fare.php

@@ -4,6 +4,7 @@
 
 use App\Contracts\Model;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
 /**
@@ -53,11 +54,10 @@ class Fare extends Model
     ];
 
     /**
-     * any foreign keys
+     * Relationships
      */
-    public function subfleets()
+    public function subfleets(): BelongsToMany
     {
-        return $this->belongsToMany(Subfleet::class, 'subfleet_fare')
-            ->withPivot('price', 'cost', 'capacity');
+        return $this->belongsToMany(Subfleet::class, 'subfleet_fare')->withPivot('price', 'cost', 'capacity');
     }
 }

app/Models/Flight.php

@@ -10,6 +10,10 @@
 use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Support\Collection;
 
@@ -224,46 +228,53 @@ public function days(): Attribute
     /*
      * Relationships
      */
-
-    public function airline()
+    public function airline(): BelongsTo
     {
         return $this->belongsTo(Airline::class, 'airline_id');
     }
 
-    public function dpt_airport()
+    public function dpt_airport(): HasOne
     {
-        return $this->belongsTo(Airport::class, 'dpt_airport_id');
+        return $this->hasOne(Airport::class, 'id', 'dpt_airport_id');
     }
 
-    public function arr_airport()
+    public function arr_airport(): HasOne
     {
-        return $this->belongsTo(Airport::class, 'arr_airport_id');
+        return $this->hasOne(Airport::class, 'id', 'arr_airport_id');
     }
 
-    public function alt_airport()
+    public function alt_airport(): HasOne
     {
-        return $this->belongsTo(Airport::class, 'alt_airport_id');
+        return $this->hasOne(Airport::class, 'id', 'alt_airport_id');
     }
 
-    public function fares()
+    public function fares(): BelongsToMany
     {
-        return $this->belongsToMany(Fare::class, 'flight_fare')
-            ->withPivot('price', 'cost', 'capacity');
+        return $this->belongsToMany(Fare::class, 'flight_fare')->withPivot('price', 'cost', 'capacity');
     }
 
-    public function field_values()
+    public function field_values(): HasMany
     {
-        return $this->hasMany(FlightFieldValue::class, 'flight_id');
+        return $this->hasMany(FlightFieldValue::class, 'flight_id', 'id');
     }
 
-    public function simbrief()
+    public function simbrief(): BelongsTo
     {
-        // id = key from table, flight_id = reference key
         return $this->belongsTo(SimBrief::class, 'id', 'flight_id');
     }
 
-    public function subfleets()
+    public function subfleets(): BelongsToMany
     {
         return $this->belongsToMany(Subfleet::class, 'flight_subfleet');
     }
+
+    public function user(): BelongsTo
+    {
+        return $this->belongsTo(User::class, 'id', 'user_id');
+    }
+
+    public function event(): BelongsTo
+    {
+        return $this->belongsTo(Event::class, 'id', 'event_id');
+    }
 }

app/Models/FlightFieldValue.php

@@ -4,6 +4,7 @@
 
 use App\Contracts\Model;
 use Illuminate\Database\Eloquent\Casts\Attribute;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 /**
  * Class FlightFieldValue
@@ -43,7 +44,7 @@ public function name(): Attribute
     /**
      * Relationships
      */
-    public function flight()
+    public function flight(): BelongsTo
     {
         return $this->belongsTo(Flight::class, 'flight_id');
     }

app/Models/Journal.php

@@ -11,6 +11,9 @@
 use App\Support\Money;
 use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
 
 /**
  * Holds various journals, depending on the morphed_type and morphed_id columns
@@ -46,29 +49,20 @@ class Journal extends Model
     ];
 
     /**
-     * Get all of the morphed models.
+     * Relationships
      */
-    public function morphed()
+    public function morphed(): MorphTo
     {
+        // Get all of the morphed models
         return $this->morphTo();
     }
 
-    /**
-     * Relationship
-     *
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function ledger()
+    public function ledger(): BelongsTo
     {
         return $this->belongsTo(Ledger::class);
     }
 
-    /**
-     * Relationship
-     *
-     * @return \Illuminate\Database\Eloquent\Relations\HasMany
-     */
-    public function transactions()
+    public function transactions(): HasMany
     {
         return $this->hasMany(JournalTransaction::class);
     }

app/Models/JournalTransaction.php

@@ -9,6 +9,7 @@
 use App\Contracts\Model;
 use App\Models\Traits\ReferenceTrait;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 /**
  * @property string  id  UUID type
@@ -54,7 +55,7 @@ class JournalTransaction extends Model
     /**
      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
-    public function journal()
+    public function journal(): BelongsTo
     {
         return $this->belongsTo(Journal::class);
     }