User::getCacheTag() - Code Metrics - Inspection of "add user-profile-modal-widget." - rhosocial/yii2-user - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 49f7b7...3b2b8f )

by vistart

created 2017-04-20 15:44 UTC

User::getCacheTag() A

↳ Parent: User

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
ccs	1
cts	1
cp	1
cc	1
eloc	2
nc	1
nop	0
crap	1

<?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\behaviors\AttributeBehavior;
use yii\caching\TagDependency;
use yii\db\ActiveRecord;

/**
 * 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`),
 *   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 <[email protected]>
 */
class User extends BaseUserModel
{
    use UserPasswordHistoryTrait, UserLoginTrait;
    public $searchClass = UserSearch::class;
    public function getSearchModel()
    {
        $class = $this->searchClass;
        if (empty($class) || !class_exists($class)) {
            return null;
        }
        return new $class;
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            $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'),
        ];
    }

    /**
     * @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
     */
    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_';

    /**
     * @return string
     */
    public function getCacheTag()
    {
        return $this->cacheTagPrefix . $this->getID();
    }

    /**
     * @param Event $event
     */
    public function onInvalidTags($event)
    {
        $sender = $event->sender;
        /*@var $sender static */
        TagDependency::invalidate(Yii::$app->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');
    }

    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;
    }

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


1		<?php
2
3		/**
4		* _ __ __ _____ _____ ___ ____ _____
5		* \| \| / // // ___//_ _// \|\| __\|\|_ _\|
6		* \| \|/ // /(__ ) / / / /\| \|\| \| \| \|
7		* \|___//_//____/ /_/ /_/ \|_\|\|_\| \|_\|
8		* @link https://vistart.me/
9		* @copyright Copyright (c) 2016 - 2017 vistart
10		* @license https://vistart.me/license/
11		*/
12
13		namespace rhosocial\user;
14
15		use rhosocial\base\models\models\BaseUserModel;
16		use rhosocial\base\models\queries\BaseBlameableQuery;
17		use rhosocial\user\models\log\UserLoginTrait;
18		use rhosocial\user\security\UserPasswordHistoryTrait;
19		use Yii;
20		use yii\base\Event;
21		use yii\behaviors\AttributeBehavior;
22		use yii\caching\TagDependency;
23		use yii\db\ActiveRecord;
24
25		/**
26		* Common User Model.
27		* This model should be stored in a relational database. You can create a foreign
28		* key constraint on other models and this model.
29		*
30		* If you're using MySQL, we recommend that you create a data table using the following statement:
31		*
32		* ```
33		* CREATE TABLE `user` (
34		* `guid` varbinary(16) NOT NULL COMMENT 'GUID',
35		* `id` varchar(16) COLLATE utf8_unicode_ci NOT NULL COMMENT 'ID',
36		* `pass_hash` varchar(80) COLLATE utf8_unicode_ci NOT NULL COMMENT 'Password Hash',
37		* `ip` varbinary(16) NOT NULL DEFAULT '0' COMMENT 'IP',
38		* `ip_type` tinyint(3) unsigned NOT NULL DEFAULT '4' COMMENT 'IP Address Type',
39		* `created_at` datetime NOT NULL DEFAULT '1970-01-01 00:00:00' COMMENT 'Create Time',
40		* `updated_at` datetime NOT NULL DEFAULT '1970-01-01 00:00:00' COMMENT 'Update Time',
41		* `auth_key` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'Authentication Key',
42		* `access_token` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'Access Token',
43		* `password_reset_token` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'Password Reset Token',
44		* `status` tinyint(3) unsigned NOT NULL DEFAULT '1' COMMENT 'Status',
45		* `type` tinyint(3) unsigned NOT NULL DEFAULT '0' COMMENT 'Type',
46		* `source` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'Source',
47		* PRIMARY KEY (`guid`),
48		* UNIQUE KEY `user_id_unique` (`id`),
49		* KEY `user_auth_key_normal` (`auth_key`),
50		* KEY `user_access_token_normal` (`access_token`),
51		* KEY `user_password_reset_token` (`password_reset_token`),
52		* KEY `user_create_time_normal` (`created_at`)
53		* ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci COMMENT='User';
54		* ```
55		*
56		* The fields of User table in database are following:
57		* @property string $guid User's GUID. This property is used to uniquely identify a user.
58		* This property is automatically generated when the class is created, we do not
59		* recommend that you modify this property, unless you know the consequences of doing so.
60		* This property is also regareded as the foreign key target of other models associated
61		* with this model. If you have to modify this property, the foreign key constraints
62		* should be updating and deleting on cascade.
63		* @property string $id User Identifier No. It is a 8-digit number beginning with 4 by default.
64		* @property string $pass_hash Password Hash.
65		* We strongly recommend you NOT to change this property directly!
66		* If you want to set or reset password, please use setPassword() magic property instead.
67		* @property integer $ip IP address.
68		* @property integer $ipType
69		* @property string $createdAt
70		* @property string $updatedAt
71		* @property string $auth_key
72		* @property string $access_token
73		* @property string $password_reset_token
74		* @property integer $status
75		* @property integer $type
76		* @property string $source
77		*
78		* @property-read Profile $profile Profile. This magic property is read-only.
79		* If you want to modify anyone property of Profile model, please get it first,
80		* then change and save it, like following:
81		* ```php
82		* $profile = $user->profile;
83		* $profile->nickname = 'vistart';
84		* $profile->save();
85		* ```
86		* If $profileClass is `false`, `null` returned.
87		* @version 1.0
88		* @author vistart <[email protected]>
89		*/
90		class User extends BaseUserModel
91		{
92		use UserPasswordHistoryTrait, UserLoginTrait;
93		public $searchClass = UserSearch::class;
94		public function getSearchModel()
95		{
96		$class = $this->searchClass;
97		if (empty($class) \|\| !class_exists($class)) {
98		return null;
99		}
100		return new $class;
101		}
102	1
103		/**
104		* @inheritdoc
105	1	*/
106	1	public function attributeLabels()
107	1	{
108	1	return [
109	1	$this->guidAttribute => Yii::t('user', 'GUID'),
110	1	$this->idAttribute => Yii::t('user', 'ID'),
111	1	$this->passwordHashAttribute => Yii::t('user', 'Password Hash'),
112	1	$this->ipAttribute => Yii::t('user', 'IP Address'),
113	1	$this->ipTypeAttribute => Yii::t('user', 'IP Address Type'),
114	1	$this->createdAtAttribute => Yii::t('user', 'Creation Time'),
115	1	$this->updatedAtAttribute => Yii::t('user', 'Last Updated Time'),
116	1	$this->authKeyAttribute => Yii::t('user', 'Authentication Key'),
117	1	$this->accessTokenAttribute => Yii::t('user', 'Access Token'),
118	1	$this->passwordResetTokenAttribute => Yii::t('user', 'Password Reset Token'),
119	1	$this->statusAttribute => Yii::t('user', 'Status'),
120		'type' => Yii::t('user', 'Type'),
121		$this->sourceAttribute => Yii::t('user', 'Source'),
122		'createdAt' => Yii::t('user', 'Registration Time'),
123		'updatedAt' => Yii::t('user', 'Last Updated Time'),
124		];
125		}
126
127		/**
128		* @inheritdoc
129		*/
130		public $idAttributeType = 1;
131
132		/**
133		* @inheritdoc
134		*/
135		public $idAttributeLength = 8;
136
137		/**
138		* @inheritdoc
139		*/
140		public $idAttributePrefix = '4';
141	41
142		/**
143	41	* @var bool
144		*/
145		public $idPreassigned = true;
146
147		/**
148		* @inheritdoc
149		*/
150		public static function tableName()
151		{
152	41	return '{{%user}}';
153		}
154	41
155	41	/**
156	41	* @var string\|false Profile class name. If you do not need profile model,
157	41	* please set it false.
158		*/
159		public $profileClass = false;
160
161		/**
162		* @inheritdoc
163		*/
164		public function init()
165		{
166	19	$this->on(static::$eventAfterRegister, [$this, 'onAddPasswordToHistory']);
167		$this->on(static::$eventAfterResetPassword, [$this, 'onAddPasswordToHistory']);
168	19	$this->on(static::EVENT_AFTER_UPDATE, [$this, 'onInvalidTags']);
169	19	$this->on(static::EVENT_AFTER_DELETE, [$this,'onInvalidTags']);
170	1	parent::init();
171		}
172	18
173	18	/**
174	18	* @var string
175	18	*/
176		public $cacheTagPrefix = 'tag_user_';
177	18
178		/**
179		* @return string
180		*/
181		public function getCacheTag()
182		{
183		return $this->cacheTagPrefix . $this->getID();
184	4	}
185
186	4	/**
187	2	* @param Event $event
188		*/
189	2	public function onInvalidTags($event)
190		{
191		$sender = $event->sender;
192		/@var $sender static /
193		TagDependency::invalidate(Yii::$app->cache, $sender->getCacheTag());
194		}
195
196		/**
197		* Create profile.
198		* If profile of this user exists, it will be returned instead of creating it.
199		* Meanwhile, the $config parameter will be skipped.
200		* @param array $config Profile configuration. Skipped if it exists.
201		* @return Profile
202		*/
203	4	public function createProfile($config = [])
204		{
205	4	$profileClass = $this->profileClass;
206	2	if (empty($profileClass) \|\| !is_string($this->profileClass)) {
207		return null;
208	2	}
209	2	$profile = $profileClass::findOne($this->getGUID());
210	2	if (!$profile) {
211	2	$profile = $this->create($profileClass, $config);
212		$profile->setGUID($this->getGUID());
213		}
214		return $profile;
215		}
216
217		/**
218		*
219		* @return boolean
220		*/
221		public function hasProfile()
222		{
223		if ($this->profileClass === false \|\| !is_string($this->profileClass) \|\| !class_exists($this->profileClass)) {
224		return false;
225		}
226		return true;
227		}
228
229		/**
230		* Get Profile query.
231		* If you want to get profile model, please access this method in magic property way,
232		* like following:
233		*
234		* ```php
235		* $user->profile;
236		* ```
237		*
238		* @return BaseBlameableQuery
239		*/
240		public function getProfile()
241		{
242		if (!$this->hasProfile()) {
243		return null;
244		}
245		$profileClass = $this->profileClass;
246		$profileModel = $profileClass::buildNoInitModel();
247		return $this->hasOne($profileClass,
248		[$profileModel->createdByAttribute => $this->guidAttribute])->inverseOf('user');
249		}
250
251		public function onGenerateId($event)
252		{
253		$sender = $event->sender;
254		/* @var $sender static */
255		return $sender->generateId();
256		}
257
258		/**
259		* @return array
260		*/
261		public function generateIdBehavior()
262		{
263		return [
264		'class' => AttributeBehavior::class,
265		'attributes' => [
266		ActiveRecord::EVENT_BEFORE_INSERT => $this->idAttribute,
267		],
268		'value' => [$this, 'onGenerateId'],
269		];
270		}
271
272		/**
273		* @return array
274		*/
275		public function behaviors()
276		{
277		$behaviors = parent::behaviors();
278		$behavior = $this->generateIdBehavior();
279		if (!empty($behavior)) {
280		$behaviors[] = $behavior;
281		}
282		return $behaviors;
283		}
284
285		/**
286		* @return array
287		*/
288		public function getIdRules()
289		{
290		return [
291		[$this->idAttribute, 'safe'],
292		];
293		}
294		}
295

rhosocial / yii2-user

Push — master ( 49f7b7...3b2b8f )

User::getCacheTag() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like