<?php declare(strict_types=1);

namespace App\Users;


use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\MorphMany;

/**
 * Komma\SiteUsers\Models\SiteUser
 *
 * @property int                             $id
 * @property int|null                        $role
 * @property string                          $password
 * @property string                          $email
 * @property string                          $telephone
 * @property string|null                     $first_name
 * @property string|null                     $last_name_prefix
 * @property string|null                     $last_name
 * @property string                          $culture
 * @property int                             $gender
 * @property integer                         $account_address_id
 * @property bool                            $is_guest When false, this user did not create the account himself (Ordered as guest for example). When true, he did register.
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @mixin Model
 */
interface SiteUserInterface
{
    /**
     * @return MorphMany
     */
    public function documents(): MorphMany;

    /**
     * Send the password reset notification.
     *
     * @param string $token
     *
     * @return void
     */
    public function sendPasswordResetNotification($token);

    /**
     * Send the password set notification.
     *
     * @param string $token
     *
     * @return void
     */
    public function sendPasswordSetNotification($token);

    /**
     * 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 null|string
     */
    public function getDisplayName(): ?string;

    /**
     * @return BelongsTo
     */
    public function accountAddress(): BelongsTo;

    /**
     * @return HasMany
     */
    public function addresses(): HasMany;
}