sfp_api_laravel_ginastica_cerebro/app/Models/StudentContract.php

<?php

namespace App\Models;

use App\Rules\StudentContractVariationConsistency;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Validation\ValidationException;

/**
 * @property int $id
 * @property string|null $protocol
 * @property int $student_id
 * @property int $unit_id
 * @property int|null $class_package_unit_id
 * @property int|null $class_package_unit_variation_id
 * @property \Illuminate\Support\Carbon|null $end_date
 * @property string|null $start_time
 * @property string|null $end_time
 * @property string|null $tax_register
 * @property string|null $fine_cancelled
 * @property string|null $notes
 * @property string $status
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @property \Illuminate\Support\Carbon|null $deleted_at
 * @property \Illuminate\Support\Carbon|null $signature_date
 * @property int|null $class_quantity
 * @property int|null $weekday
 * @property int|null $second_weekday
 * @property string|null $second_start_time
 * @property string|null $second_end_time
 * @property int|null $recurring_day
 * @property \Illuminate\Database\Eloquent\Collection<int, \App\Models\StudentContractInstallment> $installments
 * @property string|null $early_payment_discount
 * @property string|null $interest_rate
 * @property string|null $payment_method
 * @property string|null $file_url
 * @property string|null $file_type
 * @property \Illuminate\Support\Carbon|null $enrollment_due_date
 * @property string|null $package_value
 * @property int|null $package_installments
 * @property \Illuminate\Support\Carbon|null $package_due_date
 * @property int $version
 * @property int|null $derived_from_contract_id
 * @property int|null $created_by_user_id
 * @property string|null $signed_file_url
 * @property string|null $signed_file_type
 * @property string|null $material_value
 * @property int|null $material_installments
 * @property \Illuminate\Support\Carbon|null $material_due_date
 * @property-read \App\Models\ClassPackageUnit|null $classPackageUnit
 * @property-read \App\Models\ClassPackageUnitVariation|null $classPackageUnitVariation
 * @property-read \App\Models\User|null $createdBy
 * @property-read StudentContract|null $derivedFrom
 * @property-read \Illuminate\Database\Eloquent\Collection<int, StudentContract> $derivedVersions
 * @property-read int|null $derived_versions_count
 * @property-read int|null $installments_count
 * @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\StudentMedia> $medias
 * @property-read int|null $medias_count
 * @property-read \App\Models\Student $student
 * @property-read \App\Models\Unit $unit
 * @method static Builder<static>|StudentContract latestVersion()
 * @method static Builder<static>|StudentContract newModelQuery()
 * @method static Builder<static>|StudentContract newQuery()
 * @method static Builder<static>|StudentContract onlyTrashed()
 * @method static Builder<static>|StudentContract query()
 * @method static Builder<static>|StudentContract whereClassPackageUnitId($value)
 * @method static Builder<static>|StudentContract whereClassQuantity($value)
 * @method static Builder<static>|StudentContract whereCreatedAt($value)
 * @method static Builder<static>|StudentContract whereCreatedByUserId($value)
 * @method static Builder<static>|StudentContract whereDeletedAt($value)
 * @method static Builder<static>|StudentContract whereDerivedFromContractId($value)
 * @method static Builder<static>|StudentContract whereEarlyPaymentDiscount($value)
 * @method static Builder<static>|StudentContract whereEndDate($value)
 * @method static Builder<static>|StudentContract whereEndTime($value)
 * @method static Builder<static>|StudentContract whereEnrollmentDueDate($value)
 * @method static Builder<static>|StudentContract whereFileType($value)
 * @method static Builder<static>|StudentContract whereFileUrl($value)
 * @method static Builder<static>|StudentContract whereFineCancelled($value)
 * @method static Builder<static>|StudentContract whereId($value)
 * @method static Builder<static>|StudentContract whereInstallments($value)
 * @method static Builder<static>|StudentContract whereInterestRate($value)
 * @method static Builder<static>|StudentContract whereMaterialDueDate($value)
 * @method static Builder<static>|StudentContract whereMaterialInstallments($value)
 * @method static Builder<static>|StudentContract whereMaterialValue($value)
 * @method static Builder<static>|StudentContract whereNotes($value)
 * @method static Builder<static>|StudentContract wherePackageDueDate($value)
 * @method static Builder<static>|StudentContract wherePackageInstallments($value)
 * @method static Builder<static>|StudentContract wherePackageValue($value)
 * @method static Builder<static>|StudentContract wherePaymentMethod($value)
 * @method static Builder<static>|StudentContract whereProtocol($value)
 * @method static Builder<static>|StudentContract whereRecurringDay($value)
 * @method static Builder<static>|StudentContract whereSecondEndTime($value)
 * @method static Builder<static>|StudentContract whereSecondStartTime($value)
 * @method static Builder<static>|StudentContract whereSecondWeekday($value)
 * @method static Builder<static>|StudentContract whereSignatureDate($value)
 * @method static Builder<static>|StudentContract whereSignedFileType($value)
 * @method static Builder<static>|StudentContract whereSignedFileUrl($value)
 * @method static Builder<static>|StudentContract whereStartTime($value)
 * @method static Builder<static>|StudentContract whereStatus($value)
 * @method static Builder<static>|StudentContract whereStudentId($value)
 * @method static Builder<static>|StudentContract whereTaxRegister($value)
 * @method static Builder<static>|StudentContract whereUnitId($value)
 * @method static Builder<static>|StudentContract whereUpdatedAt($value)
 * @method static Builder<static>|StudentContract whereVariation($value)
 * @method static Builder<static>|StudentContract whereVersion($value)
 * @method static Builder<static>|StudentContract whereWeekday($value)
 * @method static Builder<static>|StudentContract withTrashed(bool $withTrashed = true)
 * @method static Builder<static>|StudentContract withoutTrashed()
 * @mixin \Eloquent
 */
class StudentContract extends Model
{
    use HasFactory, SoftDeletes;

    protected $table = 'student_contracts';

    protected $guarded = ['id'];

    protected $casts = [
        'version'             => 'integer',
        'signature_date'      => 'date:Y-m-d',
        'end_date'            => 'date:Y-m-d',
        'enrollment_due_date' => 'date:Y-m-d',
        'package_due_date'    => 'date:Y-m-d',
        'material_due_date'   => 'date:Y-m-d',
        'created_at'          => 'datetime',
        'updated_at'          => 'datetime',
    ];

    protected static function booted(): void
    {
        // rede de seguranca: nenhum fluxo grava contrato incongruente com a
        // proposta, mesmo quando nao passa pelo StudentContractRequest

        static::saving(function (StudentContract $contract): void {
            $errors = (new StudentContractVariationConsistency)->errors($contract->getAttributes());

            if ($errors !== []) {
                throw ValidationException::withMessages($errors);
            }
        });
    }

    public function scopeLatestVersion(Builder $query): Builder
    {
        return $query->whereDoesntHave(
            'derivedVersions',
            fn (Builder $derivedQuery) => $derivedQuery->withTrashed(),
        );
    }

    public function derivedFrom(): BelongsTo
    {
        return $this->belongsTo(self::class, 'derived_from_contract_id');
    }

    public function derivedVersions(): HasMany
    {
        return $this->hasMany(self::class, 'derived_from_contract_id');
    }

    public function createdBy(): BelongsTo
    {
        return $this->belongsTo(User::class, 'created_by_user_id');
    }

    public function student(): BelongsTo
    {
        return $this->belongsTo(Student::class);
    }

    public function unit(): BelongsTo
    {
        return $this->belongsTo(Unit::class);
    }

    public function classPackageUnit(): BelongsTo
    {
        return $this->belongsTo(ClassPackageUnit::class);
    }

    public function classPackageUnitVariation(): BelongsTo
    {
        return $this->belongsTo(ClassPackageUnitVariation::class);
    }

    public function medias(): HasMany
    {
        return $this->hasMany(StudentMedia::class);
    }

    public function installments(): HasMany
    {
        return $this->hasMany(StudentContractInstallment::class);
    }
}