refactor(Models): enhance property annotations and add query methods for Contract, EmployeePayment, and Invoice models

Author: Barata-Ribeiro

app/Models/Contract.php

@@ -7,12 +7,31 @@
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 /**
- * @property-read \App\Models\EmployeeInfo|null $employeeInfo
+ * @property int $id
+ * @property int $employee_info_id
+ * @property string $start_date
+ * @property string $end_date
+ * @property string $rate_type
+ * @property string $rate
+ * @property string $contract_type
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property-read \App\Models\EmployeeInfo $employeeInfo
  * @property-read mixed $duration
- * @property-read mixed $total_earnings
+ *
  * @method static \Illuminate\Database\Eloquent\Builder<static>|Contract newModelQuery()
  * @method static \Illuminate\Database\Eloquent\Builder<static>|Contract newQuery()
  * @method static \Illuminate\Database\Eloquent\Builder<static>|Contract query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Contract whereContractType($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Contract whereCreatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Contract whereEmployeeInfoId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Contract whereEndDate($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Contract whereId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Contract whereRate($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Contract whereRateType($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Contract whereStartDate($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Contract whereUpdatedAt($value)
+ *
  * @mixin \Eloquent
  */
 class Contract extends Model
@@ -34,14 +53,6 @@ public function getDurationAttribute()
         return Carbon::parse($this->start_date)->diffForHumans($this->end_date);
     }
 
-    /**
-     * Calculate total earnings for the contract based on rate type.
-     */
-    public function getTotalEarningsAttribute($monthYear)
-    {
-        return $this->rate_type === 'monthly' ? $this->rate : $this->rate * Carbon::parse($monthYear)->daysInMonth;
-    }
-
     public function employeeInfo(): BelongsTo
     {
         return $this->belongsTo(EmployeeInfo::class);

app/Models/EmployeePayment.php

@@ -6,10 +6,28 @@
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 /**
- * @property-read \App\Models\EmployeeInfo|null $employeeInfo
+ * @property int $id
+ * @property int $employee_info_id
+ * @property string|null $payment_date
+ * @property string $amount
+ * @property string $payment_method
+ * @property string|null $transaction_reference
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property-read \App\Models\EmployeeInfo $employeeInfo
+ *
  * @method static \Illuminate\Database\Eloquent\Builder<static>|EmployeePayment newModelQuery()
  * @method static \Illuminate\Database\Eloquent\Builder<static>|EmployeePayment newQuery()
  * @method static \Illuminate\Database\Eloquent\Builder<static>|EmployeePayment query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|EmployeePayment whereAmount($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|EmployeePayment whereCreatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|EmployeePayment whereEmployeeInfoId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|EmployeePayment whereId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|EmployeePayment wherePaymentDate($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|EmployeePayment wherePaymentMethod($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|EmployeePayment whereTransactionReference($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|EmployeePayment whereUpdatedAt($value)
+ *
  * @mixin \Eloquent
  */
 class EmployeePayment extends Model

app/Models/Invoice.php

@@ -5,10 +5,32 @@
 use Illuminate\Database\Eloquent\Model;
 
 /**
- * @property-read \App\Models\PatientInfo|null $patientInfo
+ * @property int $id
+ * @property int $patient_info_id
+ * @property string $consultation_date
+ * @property string|null $notes
+ * @property string $due_date
+ * @property string $amount
+ * @property string $payment_method
+ * @property string $status
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property-read \App\Models\PatientInfo $patientInfo
+ *
  * @method static \Illuminate\Database\Eloquent\Builder<static>|Invoice newModelQuery()
  * @method static \Illuminate\Database\Eloquent\Builder<static>|Invoice newQuery()
  * @method static \Illuminate\Database\Eloquent\Builder<static>|Invoice query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Invoice whereAmount($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Invoice whereConsultationDate($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Invoice whereCreatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Invoice whereDueDate($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Invoice whereId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Invoice whereNotes($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Invoice wherePatientInfoId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Invoice wherePaymentMethod($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Invoice whereStatus($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Invoice whereUpdatedAt($value)
+ *
  * @mixin \Eloquent
  */
 class Invoice extends Model