sfp_api_laravel_ginastica_cerebro/app/Models/Unit.php

<?php

namespace App\Models;

use App\ValueObjects\Cnpj;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\HasOne;
use Illuminate\Database\Eloquent\SoftDeletes;

/**
 * @property int $id
 * @property string|null $fantasy_name
 * @property string $social_reason
 * @property \App\ValueObjects\Cnpj $cnpj
 * @property string|null $phone_number
 * @property string|null $cell_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 $email
 * @property string|null $secondary_email
 * @property string|null $state_registration
 * @property string $name_responsible
 * @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 string|null $complement
 * @property string|null $name
 * @property bool|null $automatic_protocol
 * @property-read \App\Models\City $city
 * @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Franchisee> $franchisees
 * @property-read int|null $franchisees_count
 * @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Group> $groups
 * @property-read int|null $groups_count
 * @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\UnitPartner> $partners
 * @property-read int|null $partners_count
 * @property-read \App\Models\UnitPaymentAccount|null $paymentAccount
 * @property-read \App\Models\State $state
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit onlyTrashed()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit query()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereAddressNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereAutomaticProtocol($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereAvatarUrl($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereCellNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereCityId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereCnpj($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereComplement($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereDeletedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereEmail($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereFantasyName($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereName($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereNameResponsible($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereNeighborhood($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit wherePhoneNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit wherePostalCode($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereSecondaryEmail($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereSocialReason($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereStateId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereStateRegistration($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereStreet($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit withTrashed(bool $withTrashed = true)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Unit withoutTrashed()
 * @mixin \Eloquent
 */
class Unit extends Model
{
    use HasFactory, SoftDeletes;

    protected $table = 'units';

    protected $guarded = ['id'];

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

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

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

    public function partners(): HasMany
    {
        return $this->hasMany(UnitPartner::class, 'unit_id');
    }

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

    public function groups(): BelongsToMany
    {
        return $this->belongsToMany(Group::class, 'group_units');
    }

    public function paymentAccount(): HasOne
    {
        return $this->hasOne(UnitPaymentAccount::class, 'unit_id');
    }
}