1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license     https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Ext\Auths\Basics\User;

use \MvcCore\Ext\Models\Db\Attrs;

/**
 * Trait for `\MvcCore\Ext\Auths\Basics\User` class. Trait contains:
 * - Instance properties `$aserName`, `$fullName` and `$passwordHash` with their public getters and setters.
 */
trait Base {

    /**
     * Unique user name to log in. It could be email,
     * unique user name or anything uniquelse.
     * Example: `"admin" | "john" | "tom@gmail.com"`
     * @column user_name
     * @keyUnique
     * @var string
     */
    #[Attrs\Column('user_name'), Attrs\KeyUnique]
    protected $userName = NULL;

    /**
     * User full name string to display in application
     * for authenticated user at sign out button.
     * Example: `"Administrator" | "John" | "Tom"`
     * @column full_name
     * @var string
     */
    #[Attrs\Column('full_name')]
    protected $fullName = NULL;

    /**
     * Password hash, usually `NULL`. It exists only for authentication moment.
     * From moment, when is user instance loaded with password hash by session username to
     * moment, when is compared hashed sent password and stored password hash.
     * After password hashes comparison, password hash is un-setted.
     * @column password_hash
     * @var string|NULL`
     */
    #[Attrs\Column('password_hash')]
    protected $passwordHash = NULL;

    /**
     * Unique user name to log in. It could be email,
     * unique user name or anything uniquelse.
     * Example: `"admin" | "john" | "tom@gmail.com"`
     * @var string
     */
    public function GetUserName () {
        /** @var $this \MvcCore\Ext\Auths\Basics\User */
        return $this->userName;
    }

    /**
     * Set unique user name to log in. It could be email,
     * unique user name or anything uniquelse.
     * Example: `"admin" | "john" | "tom@gmail.com"`
     * @param string $userName
     * @return \MvcCore\Ext\Auths\Basics\User
     */
    public function SetUserName ($userName) {
        /** @var $this \MvcCore\Ext\Auths\Basics\User */
        $this->userName = $userName;
        return $this;
    }

    /**
     * User full name string to display in application
     * for authenticated user at sign out button.
     * Example: `"Administrator" | "John" | "Tom"`
     * @var string
     */
    public function GetFullName () {
        /** @var $this \MvcCore\Ext\Auths\Basics\User */
        return $this->fullName;
    }

    /**
     * Set user full name string to display in application
     * for authenticated user at sign out button.
     * Example: `"Administrator" | "John" | "Tom"`
     * @param string $fullName
     * @return \MvcCore\Ext\Auths\Basics\User
     */
    public function SetFullName ($fullName) {
        /** @var $this \MvcCore\Ext\Auths\Basics\User */
        $this->fullName = $fullName;
        return $this;
    }

    /**
     * Password hash, usually `NULL`. It exists only for authentication moment.
     * From moment, when is user instance loaded with password hash by session username to
     * moment, when is compared hashed sent password and stored password hash.
     * After password hashes comparison, password hash is un-setted.
     * @var string|NULL
     */
    public function GetPasswordHash () {
        /** @var $this \MvcCore\Ext\Auths\Basics\User */
        return $this->passwordHash;
    }

    /**
     * Set password hash, usually `NULL`. It exists only for authentication moment.
     * From moment, when is user instance loaded with password hash by session username to
     * moment, when is compared hashed sent password and stored password hash.
     * After password hashes comparison, password hash is un-setted.
     * @param string|NULL $passwordHash
     * @return \MvcCore\Ext\Auths\Basics\User
     */
    public function SetPasswordHash ($passwordHash) {
        /** @var $this \MvcCore\Ext\Auths\Basics\User */
        $this->passwordHash = $passwordHash;
        return $this;
    }
}