crewli/api/app/Models/Person.php

<?php

declare(strict_types=1);

namespace App\Models;

use App\Enums\IdentityMatchStatus;
use App\Models\Scopes\OrganisationScope;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Concerns\HasUlids;
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\Relations\MorphMany;
use Illuminate\Database\Eloquent\SoftDeletes;

final class Person extends Model
{
    use HasFactory;
    use HasUlids;
    use SoftDeletes;

    /** @var string Used by OrganisationScope to determine filtering strategy */
    public string $organisationScopeColumn = 'event_id';

    protected static function booted(): void
    {
        static::addGlobalScope(new OrganisationScope());
    }

    protected $table = 'persons';

    protected $fillable = [
        'event_id',
        'crowd_type_id',
        'company_id',
        'first_name',
        'last_name',
        'date_of_birth',
        'email',
        'phone',
        'status',
        'registration_source',
        'is_blacklisted',
        'admin_notes',
        'remarks',
        'custom_fields',
    ];

    public function getFullNameAttribute(): string
    {
        return trim("{$this->first_name} {$this->last_name}");
    }

    public function getNameAttribute(): string
    {
        return $this->full_name;
    }

    protected function casts(): array
    {
        return [
            'date_of_birth' => 'date',
            'is_blacklisted' => 'boolean',
            'custom_fields' => 'array',
        ];
    }

    public function event(): BelongsTo
    {
        return $this->belongsTo(Event::class);
    }

    public function crowdType(): BelongsTo
    {
        return $this->belongsTo(CrowdType::class);
    }

    public function company(): BelongsTo
    {
        return $this->belongsTo(Company::class);
    }

    public function user(): BelongsTo
    {
        return $this->belongsTo(User::class);
    }

    public function crowdLists(): BelongsToMany
    {
        return $this->belongsToMany(CrowdList::class, 'crowd_list_persons')
            ->using(\App\Models\Pivots\CrowdListPerson::class)
            ->withPivot('added_at', 'added_by_user_id');
    }

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

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

    public function formSubmissions(): MorphMany
    {
        return $this->morphMany(\App\Models\FormBuilder\FormSubmission::class, 'subject');
    }

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

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

    public function pendingIdentityMatch(): HasOne
    {
        return $this->hasOne(PersonIdentityMatch::class)
            ->where('status', IdentityMatchStatus::PENDING)
            ->latest();
    }

    public function confirmedIdentityMatch(): HasOne
    {
        return $this->hasOne(PersonIdentityMatch::class)
            ->where('status', IdentityMatchStatus::CONFIRMED)
            ->latest();
    }

    public function scopeApproved(Builder $query): Builder
    {
        return $query->where('status', 'approved');
    }

    public function scopePending(Builder $query): Builder
    {
        return $query->where('status', 'pending');
    }

    public function scopeForCrowdType(Builder $query, string $type): Builder
    {
        return $query->whereHas('crowdType', fn (Builder $q) => $q->where('system_type', $type));
    }
}