<?php

namespace App\Users\Models;

use Komma\KMS\Documents\DocumentsTrait;
use Komma\KMS\Documents\Kms\DocumentableInterface;
use Komma\KMS\Documents\Models\Document;
use Komma\KMS\ActionLog\HasActionLogs;
use App\Notifications\SiteResetPasswordNotification;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\MorphMany;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Komma\KMS\Core\Attributes\Models\Traits\HasThumbnailInterface;
use Komma\KMS\Core\Attributes\Models\Traits\HasThumbnailTrait;
use Komma\KMS\Core\Entities\DisplayNameInterface;
use Komma\KMS\Core\Entities\DisplayNameTrait;
use Komma\KMS\Core\Entities\HasSearchableAttributesForSidebarInterface;

/**
 * Class User
 *
 * @package App\Users\Models
 * @property int $id
 * @property string $password
 * @property string $email
 * @property string|null $first_name
 * @property string|null $last_name
 * @property \Carbon\Carbon $last_login_attempt
 * @property int $failed_login_attempts
 * @property int $telephone
 * @property string $culture
 * @property string $city
 * @property string $postal_code
 * @property int $house_number
 * @property string $street
 * @property int $company_vat_number_validated
 * @property string $company_vat_number
 * @property string $company_country
 * @property string $company_zip_code
 * @property string $company_city
 * @property string $company_house_number
 * @property string $company_street
 * @property string $chamber_of_commerce
 * @property string $company_name
 * @property boolean $guest
 * @property \Carbon\Carbon|null $created_at
 * @property \Carbon\Carbon|null $updated_at
 * @property string|null $remember_token
 * @property-read \Illuminate\Notifications\DatabaseNotificationCollection|\Illuminate\Notifications\DatabaseNotification[] $notifications
 * @property int $role
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereChamberOfCommerce($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereCity($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereCompanyCity($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereCompanyCountry($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereCompanyHouseNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereCompanyName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereCompanyStreet($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereCompanyVatNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereCompanyVatNumberValidated($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereCompanyZipCode($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereCountry($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereEmail($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereFailedLoginAttempts($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereFirstName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereHouseNumber($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereLastLoginAttempt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereLastName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser wherePassword($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereRememberToken($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereRoleId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereStreet($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereTelephone($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereZipCode($value)
 * @mixin \Eloquent
 * @property string $company_postal_code
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereCompanyPostalCode($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser wherePostalCode($value)
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Kms\ActionLog\ActionLog[] $actions
 * @property-read \Illuminate\Database\Eloquent\Collection|\Komma\KMS\Documents\Models\Document[] $documents
 * @property-read \Illuminate\Database\Eloquent\Collection|\Komma\KMS\Documents\Models\Document[] $images
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Components\Component\Component[] $components
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser query()
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereCulture($value)
 * @property int $gender
 * @method static \Illuminate\Database\Eloquent\Builder|\Komma\KMS\Users\Models\KmsUser whereGender($value)
 */
final class SiteUser extends Authenticatable implements DocumentableInterface, DisplayNameInterface, HasSearchableAttributesForSidebarInterface, HasThumbnailInterface {
    use Notifiable;
    use HasActionLogs;
    use DocumentsTrait;
    use DisplayNameTrait;
    use HasThumbnailTrait;

    public const USERNAME_COLUMN_NAME = 'email';
    public const PASSWORD_COLUMN_NAME = 'password';

    /**
     * The database table used by the model.
     *
     * @var string
     */
    protected $table = 'site_users';

    /**
     * The attributes excluded from the model's JSON form.
     *
     * @var array
     */
    protected $hidden = array('password', 'remember_token');

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['role', 'email', 'password', 'first_name', 'last_name', 'failed_login_attempts', 'culture', 'guest'];

    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = ['created_at', 'updated_at', 'last_login_attempt'];

    /**
     * Returns an array containing model attributes with their values,
     * that will be used to search trough in the sidebar.
     *
     * @return array
     */
    public function searchableAttributesForSidebar(): array
    {
        return [
            'email' => $this->email
        ];
    }

    /**
     * @return MorphMany
     */
    public function documents():MorphMany
    {
        return $this->morphMany(Document::class, 'documentable');
    }

    /**
     * Send the password reset notification.
     *
     * @param  string $token
     * @return void
     */
    public function sendPasswordResetNotification($token)
    {
        $this->notify(new SiteResetPasswordNotification($this, $token));
    }

    /**
     * @return null|string
     */
    public function getDisplayName():?string
    {
        // If it is a new model the section name will filled by model.section.new
        if(!$this->exists) return null;
        return $this->first_name . ' ' . $this->last_name;
    }

    /**
     * Checks if the user is at least a certain role
     *
     * @param int $role
     * @return bool
     * @see KmsUserRole
     */
    public function isAtLeast(int $role = null): bool
    {
        if(!$role) return true;
        if(!SiteUserRole::isValidItem($role)) throw new \InvalidArgumentException('The given role is not valid.');
        return ($this->role && $this->role <= $role);
    }

    /**
     * @param int $role
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public static function whereRoleIsAtLeast(int $role)
    {
        return static::query()->where('role', '<=', $role);
    }
}