<?php

namespace App\Models;

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

/**
 * @property int $id
 * @property int $franchisee_id
 * @property int $contract_id
 * @property int $inhabitant_classification_id
 * @property int $year
 * @property float $tbr_value
 * @property \Carbon\Carbon $start_date
 * @property int $invoice_due_day
 * @property float $base_royalties_percentage
 * @property float $base_fnm_percentage
 * @property int|null $franchisee_royalties_bracket_id
 * @property int|null $franchisee_fnm_bracket_id
 * @property int|null $franchisee_maintenance_bracket_id
 * @property \Carbon\Carbon $created_at
 * @property \Carbon\Carbon $updated_at
 * @property-read \App\Models\Franchisee $franchisee
 * @property-read \App\Models\FranchiseeContract $contract
 * @property-read \App\Models\InhabitantClassification $inhabitantClassification
 * @property-read \App\Models\FranchiseeRoyaltiesBracket|null $royaltiesBracket
 * @property-read \App\Models\FranchiseeFnmBracket|null $fnmBracket
 * @property-read \App\Models\FranchiseeMaintenanceBracket|null $maintenanceBracket
 */
class FranchiseeTbr extends Model
{
    use HasFactory;

    protected $table = 'franchisee_tbrs';

    protected $guarded = ['id'];

    protected $casts = [
        'tbr_value'               => 'decimal:2',
        'base_royalties_percentage' => 'decimal:4',
        'base_fnm_percentage'     => 'decimal:4',
        'start_date'              => 'date',
        'created_at'              => 'datetime',
        'updated_at'              => 'datetime',
    ];

    public function franchisee(): BelongsTo
    {
        return $this->belongsTo(Franchisee::class, 'franchisee_id');
    }

    public function contract(): BelongsTo
    {
        return $this->belongsTo(FranchiseeContract::class, 'contract_id');
    }

    public function inhabitantClassification(): BelongsTo
    {
        return $this->belongsTo(InhabitantClassification::class, 'inhabitant_classification_id');
    }

    public function royaltiesBracket(): BelongsTo
    {
        return $this->belongsTo(FranchiseeRoyaltiesBracket::class, 'franchisee_royalties_bracket_id');
    }

    public function fnmBracket(): BelongsTo
    {
        return $this->belongsTo(FranchiseeFnmBracket::class, 'franchisee_fnm_bracket_id');
    }

    public function maintenanceBracket(): BelongsTo
    {
        return $this->belongsTo(FranchiseeMaintenanceBracket::class, 'franchisee_maintenance_bracket_id');
    }
}