sfp_api_laravel_ginastica_cerebro/app/Models/Franchisee.php

<?php

namespace App\Models;

use App\ValueObjects\Cnpj;
use App\ValueObjects\Cpf;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\SoftDeletes;

/**
 * @property int $id
 * @property string $name
 * @property \App\ValueObjects\Cpf|null $cpf
 * @property string|null $rg
 * @property \App\ValueObjects\Cnpj|null $cnpj
 * @property string|null $phone
 * @property string|null $cellphone_number
 * @property string $street
 * @property string|null $address_number
 * @property string $neighborhood
 * @property string $postal_code
 * @property int $city_id
 * @property int $state_id
 * @property string|null $birth_date
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @property \Illuminate\Support\Carbon|null $deleted_at
 * @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Unit> $units
 * @property-read int|null $units_count
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee onlyTrashed()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee query()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereAddressNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereBirthDate($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereCellphoneNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereCityId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereCnpj($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereCpf($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereDeletedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereName($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereNeighborhood($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee wherePhone($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee wherePostalCode($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereRg($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereStateId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereStreet($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee withTrashed(bool $withTrashed = true)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Franchisee withoutTrashed()
 * @mixin \Eloquent
 */
class Franchisee extends Model
{
    use HasFactory, SoftDeletes;

    protected $table = 'franchisees';

    protected $guarded = ['id'];

    protected $casts = [
        'cnpj'       => Cnpj::class,
        'cpf'        => Cpf::class,
        'created_at' => 'datetime',
        'updated_at' => 'datetime',
        'deleted_at' => 'datetime',
    ];

    public function units(): BelongsToMany
    {
        return $this->belongsToMany(Unit::class, 'franchisee_units');
    }
}