sfp_api_laravel_ginastica_cerebro/app/Models/FranchiseeContract.php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\SoftDeletes;

/**
 * @property int $id
 * @property int $unit_id
 * @property int|null $protocol
 * @property \Illuminate\Support\Carbon|null $signature_date
 * @property string|null $name
 * @property string|null $description
 * @property int|null $validity_months
 * @property string|null $cancellation_fine
 * @property string|null $discount_until_due_date
 * @property string|null $tbr_fixed_value
 * @property string|null $tbr_fixed_value_percentage
 * @property string|null $marketing_fund_fixed_value
 * @property string|null $marketing_fund_percentage
 * @property string|null $maintance_tax_fixed_value
 * @property string|null $maintance_tax_percentage
 * @property int|null $maximum_time_to_freeze_registration
 * @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 $start_date
 * @property \Illuminate\Support\Carbon|null $end_date
 * @property int|null $invoice_due_date
 * @property int|null $municipality_size_id
 * @property-read \App\Models\MunicipalitySize|null $municipalitySize
 * @property-read \App\Models\Unit $unit
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract onlyTrashed()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract query()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereCancellationFine($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereDeletedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereDescription($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereDiscountUntilDueDate($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereEndDate($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereInvoiceDueDate($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereMaintanceTaxFixedValue($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereMaintanceTaxPercentage($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereMarketingFundFixedValue($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereMarketingFundPercentage($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereMaximumTimeToFreezeRegistration($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereMunicipalitySizeId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereName($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereProtocol($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereSignatureDate($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereStartDate($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereTbrFixedValue($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereTbrFixedValuePercentage($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereUnitId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract whereValidityMonths($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract withTrashed(bool $withTrashed = true)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FranchiseeContract withoutTrashed()
 * @mixin \Eloquent
 */
class FranchiseeContract extends Model
{
    use HasFactory, SoftDeletes;

    protected $table = 'franchisee_contracts';

    protected $guarded = ['id'];

    protected $casts = [
        'start_date'       => 'date',
        'end_date'         => 'date',
        'signature_date'   => 'date',
        'invoice_due_date' => 'integer',
        'created_at'       => 'datetime',
        'updated_at'       => 'datetime',
        'deleted_at'       => 'datetime',
    ];

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

    public function municipalitySize(): BelongsTo
    {
        return $this->belongsTo(MunicipalitySize::class, 'municipality_size_id');
    }
}