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: 

<?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\UserAndRole;

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

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

    /**
     * User or role unique id, representing primary key in database
     * or sequence number in system config.
     * Example: `0 | 1 | 2...`
     * @column id
     * @keyPrimary
     * @var int|NULL
     */
    #[Attrs\Column('id'), Attrs\KeyPrimary]
    protected $id = NULL;

    /**
     * User or role active state boolean.
     * @column active
     * @var bool
     */
    #[Attrs\Column('active')]
    protected $active = TRUE;

    /**
     * User unique id, representing primary key in database
     * or sequence number in system config.
     * Example: `0 | 1 | 2...`
     * @return int|NULL
     */
    public function GetId () {
        /** @var $this \MvcCore\Ext\Auths\Basics\User|\MvcCore\Ext\Auths\Basics\Role */
        return $this->id;
    }

    /**
     * Set user unique id, representing primary key in database
     * or sequence number in system config.
     * Example: `0 | 1 | 2...`
     * @param int|NULL $id
     * @return \MvcCore\Ext\Auths\Basics\User|\MvcCore\Ext\Auths\Basics\Role
     */
    public function SetId ($id) {
        /** @var $this \MvcCore\Ext\Auths\Basics\User|\MvcCore\Ext\Auths\Basics\Role */
        $this->id = $id;
        return $this;
    }

    /**
     * Get user active state boolean. `TRUE` for active, `FALSE` otherwise.
     * This function is only alias for `$user->GetActive();`.
     * @return bool
     */
    public function IsActive () {
        /** @var $this \MvcCore\Ext\Auths\Basics\User|\MvcCore\Ext\Auths\Basics\Role */
        return $this->active;
    }

    /**
     * Get user active state boolean. `TRUE` for active, `FALSE` otherwise.
     * @return bool
     */
    public function GetActive () {
        /** @var $this \MvcCore\Ext\Auths\Basics\User|\MvcCore\Ext\Auths\Basics\Role */
        return $this->active;
    }

    /**
     * Set user active state boolean. `TRUE` for active, `FALSE` otherwise.
     * @return \MvcCore\Ext\Auths\Basics\User|\MvcCore\Ext\Auths\Basics\Role
     */
    public function SetActive ($active) {
        /** @var $this \MvcCore\Ext\Auths\Basics\User|\MvcCore\Ext\Auths\Basics\Role */
        $this->active = (bool) $active;
        return $this;
    }
}