sfp_api_laravel_ginastica_cerebro/app/Models/UnitPartner.php

<?php

namespace App\Models;

use App\ValueObjects\Cpf;
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 string $name
 * @property string|null $social_name
 * @property string|null $role
 * @property Cpf $cpf
 * @property string|null $rg
 * @property \Illuminate\Support\Carbon|null $birth_date
 * @property numeric|null $participation
 * @property string|null $email
 * @property string|null $secondary_email
 * @property string|null $phone_number
 * @property string|null $cell_number
 * @property string|null $postal_code
 * @property string|null $street
 * @property string|null $address_number
 * @property string|null $neighborhood
 * @property string|null $complement
 * @property int|null $city_id
 * @property int|null $state_id
 * @property string|null $avatar_url
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @property \Illuminate\Support\Carbon|null $deleted_at
 * @property-read \App\Models\City|null $city
 * @property-read \App\Models\State|null $state
 * @property-read \App\Models\Unit $unit
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner onlyTrashed()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner query()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereAddressNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereAvatarUrl($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereBirthDate($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereCellNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereCityId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereComplement($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereCpf($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereDeletedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereEmail($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereName($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereNeighborhood($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereParticipation($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner wherePhoneNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner wherePostalCode($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereRg($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereRole($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereSecondaryEmail($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereSocialName($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereStateId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereStreet($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereUnitId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner withTrashed(bool $withTrashed = true)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|UnitPartner withoutTrashed()
 * @mixin \Eloquent
 */
class UnitPartner extends Model
{
    use HasFactory, SoftDeletes;

    protected $table = 'unit_partners';

    protected $guarded = ['id'];

    protected $casts = [
        'cpf'           => Cpf::class,
        'birth_date'    => 'date',
        'participation' => 'decimal:2',
        'created_at'    => 'datetime',
        'updated_at'    => 'datetime',
        'deleted_at'    => 'datetime',
    ];

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

    public function city(): BelongsTo
    {
        return $this->belongsTo(City::class, 'city_id');
    }

    public function state(): BelongsTo
    {
        return $this->belongsTo(State::class, 'state_id');
    }
}