<?php

namespace App\Models;

use App\Lib\Helpers\ToolboxHelper;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

/**
 * @property integer                         $id                Id.
 * @property string                          $firstname         Firstname.
 * @property string                          $lastname          Lastname.
 * @property string                          $email             Email.
 * @property string                          $remember_token    Remember_token.
 * @property \Carbon\Carbon                  $last_connection   Last_connection.
 * @property-read \Illuminate\Support\Carbon $created_at        Created date.
 * @property-read \Illuminate\Support\Carbon $updated_at        Updated date.
 */
class User extends Authenticatable
{
    use HasFactory;
    use Notifiable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array<int, string>
     */
    protected $fillable = [
        'firstname',
        'lastname',
        'email'
    ];

    /**
     * The attributes that should be hidden for serialization.
     *
     * @var array<int, string>
     */
    protected $hidden = [
        'remember_token'
    ];

    /**
     * The attributes that should be cast.
     *
     * @var array<string, string>
     */
    protected $casts = [
        'last_connection'   => 'date',
    ];

    /**
     * Perform any actions required after the model boots.
     *
     * @return void
     */
    protected static function booted(): void
    {
        // * EVENT CLOSURES.
        static::creating(function (self $user) {
            self::assertEmailIsUnique($user->email);
        });
        static::updating(function (self $user) {
            self::assertEmailIsUnique($user->email, $user->id);
        });
    }

    // * METHODS

    /**
     * Asserts using validation that the email is unique
     *
     * @param string       $email
     * @param integer|null $id
     * @return void
     * @throws \Illuminate\Validation\ValidationException If user email as already used.
     */
    private static function assertEmailIsUnique(string $email, ?int $id = null): void
    {
        ToolboxHelper::assertFieldIsUnique((new self())->getTable(), 'email', $email, $id);
    }
}