rhosocial / yii2-user

User.php

<?php

/**
 *  _   __ __ _____ _____ ___  ____  _____
 * | | / // // ___//_  _//   ||  __||_   _|
 * | |/ // /(__  )  / / / /| || |     | |
 * |___//_//____/  /_/ /_/ |_||_|     |_|
 * @link https://vistart.me/
 * @copyright Copyright (c) 2016 - 2017 vistart
 * @license https://vistart.me/license/
 */

namespace rhosocial\user;

use rhosocial\base\models\models\BaseUserModel;
use rhosocial\base\models\queries\BaseBlameableQuery;
use rhosocial\user\models\log\UserLoginTrait;
use rhosocial\user\security\UserPasswordHistoryTrait;
use Yii;
use yii\base\Event;
use yii\base\InvalidConfigException;
use yii\behaviors\AttributeBehavior;
use yii\caching\TagDependency;
use yii\db\ActiveRecord;
use yii\widgets\ActiveForm;

/**
 * Common User Model.
 * This model should be stored in a relational database. You can create a foreign
 * key constraint on other models and this model.
 *
 * If you're using MySQL, we recommend that you create a data table using the following statement:
 *
 * ```
 * CREATE TABLE `user` (
 *   `guid` varbinary(16) NOT NULL COMMENT 'GUID',
 *   `id` varchar(16) COLLATE utf8_unicode_ci NOT NULL COMMENT 'ID',
 *   `pass_hash` varchar(80) COLLATE utf8_unicode_ci NOT NULL COMMENT 'Password Hash',
 *   `ip` varbinary(16) NOT NULL DEFAULT '0' COMMENT 'IP',
 *   `ip_type` tinyint(3) unsigned NOT NULL DEFAULT '4' COMMENT 'IP Address Type',
 *   `created_at` datetime NOT NULL DEFAULT '1970-01-01 00:00:00' COMMENT 'Create Time',
 *   `updated_at` datetime NOT NULL DEFAULT '1970-01-01 00:00:00' COMMENT 'Update Time',
 *   `auth_key` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'Authentication Key',
 *   `access_token` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'Access Token',
 *   `password_reset_token` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'Password Reset Token',
 *   `status` tinyint(3) unsigned NOT NULL DEFAULT '1' COMMENT 'Status',
 *   `type` tinyint(3) unsigned NOT NULL DEFAULT '0' COMMENT 'Type',
 *   `source` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'Source',
 *   PRIMARY KEY (`guid`),
 *   UNIQUE KEY `user_id_unique` (`id`),
 *   UNIQUE KEY `user_username_unique` (`username`),
 *   KEY `user_auth_key_normal` (`auth_key`),
 *   KEY `user_access_token_normal` (`access_token`),
 *   KEY `user_password_reset_token` (`password_reset_token`),
 *   KEY `user_create_time_normal` (`created_at`)
 * ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci COMMENT='User';
 * ```
 *
 * The fields of User table in database are following:
 * @property string $guid User's GUID. This property is used to uniquely identify a user.
 * This property is automatically generated when the class is created, we do not
 * recommend that you modify this property, unless you know the consequences of doing so.
 * This property is also regareded as the foreign key target of other models associated
 * with this model. If you have to modify this property, the foreign key constraints
 * should be updating and deleting on cascade.
 * @property string $id User Identifier No. It is a 8-digit number beginning with 4 by default.
 * @property string $pass_hash Password Hash.
 * We strongly recommend you NOT to change this property directly!
 * If you want to set or reset password, please use setPassword() magic property instead.
 * @property integer $ip IP address.
 * @property integer $ipType
 * @property string $createdAt
 * @property string $updatedAt
 * @property string $auth_key
 * @property string $access_token
 * @property string $password_reset_token
 * @property integer $status
 * @property integer $type
 * @property string $source
 *
 * @property-read Profile $profile Profile. This magic property is read-only.
 * If you want to modify anyone property of Profile model, please get it first,
 * then change and save it, like following:
 * ```php
 * $profile = $user->profile;
 * $profile->nickname = 'vistart';
 * $profile->save();
 * ```
 * If $profileClass is `false`, `null` returned.
 * @version 1.0
 * @author vistart <i@vistart.me>
 */
class User extends BaseUserModel
{
    use UserPasswordHistoryTrait, UserLoginTrait;

    /**
     * @var string|boolean
     */
    public $usernameAttribute = false;

    /**
     * @return mixed|null
     */
    public function getUsername()
    {
        if (is_string($this->usernameAttribute) && !empty($this->usernameAttribute)) {
            return $this->{$this->usernameAttribute};
        }
        return null;
    }

    /**
     * @param string $username
     * @return null|string
     */
    public function setUsername($username = '')
    {
        if (is_string($this->usernameAttribute) && !empty($this->usernameAttribute)) {
            return $this->{$this->usernameAttribute} = $username;
        }
        return null;
    }

    /**
     * @var string
     */
    public $searchClass = UserSearch::class;

    /**
     * @return null
     */
    public function getSearchModel()
    {
        $class = $this->searchClass;
        if (empty($class) || !class_exists($class)) {
            return null;
        }
        return new $class;
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        $labels = [
            $this->guidAttribute => Yii::t('user', 'GUID'),
            $this->idAttribute => Yii::t('user', 'ID'),
            $this->passwordHashAttribute => Yii::t('user', 'Password Hash'),
            $this->ipAttribute => Yii::t('user', 'IP Address'),
            $this->ipTypeAttribute => Yii::t('user', 'IP Address Type'),
            $this->createdAtAttribute => Yii::t('user', 'Creation Time'),
            $this->updatedAtAttribute => Yii::t('user', 'Last Updated Time'),
            $this->authKeyAttribute => Yii::t('user', 'Authentication Key'),
            $this->accessTokenAttribute => Yii::t('user', 'Access Token'),
            $this->passwordResetTokenAttribute => Yii::t('user', 'Password Reset Token'),
            $this->statusAttribute => Yii::t('user', 'Status'),
            'type' => Yii::t('user', 'Type'),
            $this->sourceAttribute => Yii::t('user', 'Source'),
            'createdAt' => Yii::t('user', 'Registration Time'),
            'updatedAt' => Yii::t('user', 'Last Updated Time'),
        ];
        if (is_string($this->username) && !empty($this->username)) {

The property username does not seem to exist. Did you mean usernameAttribute?

            $labels = array_merge($labels, [
                $this->usernameAttribute => Yii::t('user', 'Username'),
            ]);
        }
        return $labels;
    }

    /**
     * @inheritdoc
     */
    public $idAttributeType = 1;

    /**
     * @inheritdoc
     */
    public $idAttributeLength = 8;

    /**
     * @inheritdoc
     */
    public $idAttributePrefix = '4';

    /**
     * @var bool
     */
    public $idPreassigned = true;

    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return '{{%user}}';
    }

    /**
     * @var string|false Profile class name. If you do not need profile model,
     * please set it false.
     */
    public $profileClass = false;

    /**
     * @inheritdoc
     * -----------
     * When the user is updated or deleted, the cache contents tagged with the corresponding user tag will be invalidated.
     */
    public function init()
    {
        $this->on(static::$eventAfterRegister, [$this, 'onAddPasswordToHistory']);
        $this->on(static::$eventAfterResetPassword, [$this, 'onAddPasswordToHistory']);
        $this->on(static::EVENT_AFTER_UPDATE, [$this, 'onInvalidTags']);
        $this->on(static::EVENT_AFTER_DELETE, [$this, 'onInvalidTags']);
        parent::init();
    }

    /**
     * @var string
     */
    public $cacheTagPrefix = 'tag_user_';

    /**
     * Get cache tag.
     * The cache tag ends with the user ID, but after the user ID is modified, the old ID will prevail.
     * @return string
     */
    public function getCacheTag()
    {
        return $this->cacheTagPrefix .
            ($this->isAttributeChanged($this->idAttribute) ? $this->getOldAttribute($this->idAttribute) : $this->getID());
    }

    /**
     * @param Event $event
     * @return bool|string|array
     */
    public function onInvalidTags($event)
    {
        try {
            $cache = Yii::$app->get('cache');
        } catch (InvalidConfigException $ex) {
            return true;
        }
        $sender = $event->sender;
        /*@var $sender static */
        return TagDependency::invalidate($cache, $sender->getCacheTag());
    }

    /**
     * Create profile.
     * If profile of this user exists, it will be returned instead of creating it.
     * Meanwhile, the $config parameter will be skipped.
     * @param array $config Profile configuration. Skipped if it exists.
     * @return Profile
     */
    public function createProfile($config = [])
    {
        $profileClass = $this->profileClass;
        if (empty($profileClass) || !is_string($this->profileClass)) {
            return null;
        }
        $profile = $profileClass::findOne($this->getGUID());
        if (!$profile) {
            $profile = $this->create($profileClass, $config);
            $profile->setGUID($this->getGUID());
        }
        return $profile;
    }

    /**
     * 
     * @return boolean
     */
    public function hasProfile()
    {
        if ($this->profileClass === false || !is_string($this->profileClass) || !class_exists($this->profileClass)) {
            return false;
        }
        return true;
    }

    /**
     * Get Profile query.
     * If you want to get profile model, please access this method in magic property way,
     * like following:
     *
     * ```php
     * $user->profile;
     * ```
     *
     * @return BaseBlameableQuery
     */
    public function getProfile()
    {
        if (!$this->hasProfile()) {
            return null;
        }
        $profileClass = $this->profileClass;
        $profileModel = $profileClass::buildNoInitModel();
        return $this->hasOne($profileClass,
                [$profileModel->createdByAttribute => $this->guidAttribute])->inverseOf('user');
    }

    /**
     * @param $event
     * @return mixed
     */
    public function onGenerateId($event)
    {
        $sender = $event->sender;
        /* @var $sender static */
        return $sender->generateId();
    }

    /**
     * @return array
     */
    public function generateIdBehavior()
    {
        return [
            'class' => AttributeBehavior::class,
            'attributes' => [
                ActiveRecord::EVENT_BEFORE_INSERT => $this->idAttribute,
            ],
            'value' => [$this, 'onGenerateId'],
        ];
    }

    /**
     * @return array
     */
    public function behaviors()
    {
        $behaviors = parent::behaviors();
        $behavior = $this->generateIdBehavior();
        if (!empty($behavior)) {
            $behaviors[] = $behavior;
        }
        return $behaviors;
    }

    /**
     * @var string
     */
    public static $idRegex = '\d{5,8}';

    /**
     * @return array
     */
    public function getIdRules()
    {
        return [
            [$this->idAttribute, 'safe'],
        ];
    }

    /**
     * @var string
     */
    public static $usernameRegex = '\w{1,32}';

    /**
     * Get the rules associated with `username` property.
     * The `username` must not be empty, and its length must not be greater than 32.
     * This property should be confirmed unique among all users.
     * If you do not need this property, please override this method and return empty array.
     * @return array
     */
    public function getUsernameRules()
    {
        if (is_string($this->usernameAttribute) && !empty($this->usernameAttribute)) {
            return [
                [$this->usernameAttribute, 'required'],
                [$this->usernameAttribute, 'string', 'max' => 32],
                [$this->usernameAttribute, 'unique'],
            ];
        }
        return [];
    }

    /**
     * @return array
     */
    public function rules()
    {
        $rules = $this->getUsernameRules();
        if (!empty($rules)) {
            return array_merge(parent::rules(), $rules);
        }
        return parent::rules();
    }
}