sfp_api_laravel_ginastica_cerebro/app/Models/Student.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\Relations\HasMany;
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Validation\ValidationException;

/**
 * @property int $id
 * @property string $name
 * @property \Illuminate\Support\Carbon|null $birth_date
 * @property \App\ValueObjects\Cpf|null $document_number
 * @property string|null $gender
 * @property string|null $email
 * @property string|null $phone
 * @property string|null $postal_code
 * @property string|null $street
 * @property string|null $address_number
 * @property string|null $neighborhood
 * @property int|null $state_id
 * @property string|null $complement
 * @property string|null $payer_name
 * @property string|null $how_did_you_know_us
 * @property string|null $notes
 * @property string $status
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @property \Illuminate\Support\Carbon|null $deleted_at
 * @property int $unit_id
 * @property int|null $city_id
 * @property string|null $photo_url
 * @property-read \App\Models\City|null $city
 * @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\StudentContract> $contracts
 * @property-read int|null $contracts_count
 * @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\StudentResponsible> $responsibles
 * @property-read int|null $responsibles_count
 * @property-read \App\Models\State|null $state
 * @property-read \App\Models\Unit $unit
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student onlyTrashed()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student query()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereAddressNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereBirthDate($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereCityId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereComplement($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereDeletedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereDocumentNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereEmail($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereGender($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereHowDidYouKnowUs($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereName($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereNeighborhood($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereNotes($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student wherePayerName($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student wherePhone($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student wherePhotoUrl($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student wherePostalCode($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereStateId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereStatus($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereStreet($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereUnitId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student withTrashed(bool $withTrashed = true)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Student withoutTrashed()
 * @mixin \Eloquent
 */
class Student extends Model
{
    use HasFactory, SoftDeletes;

    private ?array $responsibleForCreation = null;

    protected $table = 'students';

    protected $guarded = ['id'];

    protected $casts = [
        'birth_date'      => 'date',
        'document_number' => Cpf::class,
        'created_at'      => 'datetime',
        'updated_at'      => 'datetime',
        'deleted_at'      => 'datetime',
    ];

    protected static function booted(): void
    {
        static::creating(function (Student $student): void {
            if ($student->isMinor() && empty($student->responsibleForCreation)) {
                throw ValidationException::withMessages([
                    'responsible' => __('validation.minor_requires_responsible'),
                ]);
            }
        });
    }

    public function withResponsibleForCreation(?array $responsible): self
    {
        $this->responsibleForCreation = $responsible;

        return $this;
    }

    public function isMinor(): bool
    {
        return $this->birth_date !== null && $this->birth_date->age < 18;
    }

    public function contracts(): HasMany
    {
        return $this->hasMany(StudentContract::class);
    }

    public function responsibles(): HasMany
    {
        return $this->hasMany(StudentResponsible::class);
    }

    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');
    }
}