IdentityTrait::findIdentityByAccessToken() - Code Metrics - vistart/yii2-models - Measure and Improve Code Quality continuously with Scrutinizer

IdentityTrait::findIdentityByAccessToken() A
last analyzed 2016-05-02 10:57 UTC

↳ Parent: IdentityTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	5
ccs	0
cts	3
cp	0
rs	9.4285
cc	1
eloc	3
nc	1
nop	2
crap	2

<?php

/**
 *  _   __ __ _____ _____ ___  ____  _____
 * | | / // // ___//_  _//   ||  __||_   _|
 * | |/ // /(__  )  / / / /| || |     | |
 * |___//_//____/  /_/ /_/ |_||_|     |_|
 * @link http://vistart.name/
 * @copyright Copyright (c) 2016 vistart
 * @license http://vistart.name/license/
 */

namespace vistart\Models\traits;

use Yii;
use yii\base\ModelEvent;

/**
 * User features concerning identity.
 *
 * @property-read string $authKey
 * @property array $statusRules
 * @property array $authKeyRules
 * @property array $accessTokenRules
 * @version 2.0
 * @author vistart <[email protected]>
 */
trait IdentityTrait
{

    public static $statusActive = 1;
    public static $statusInactive = 0;
    public $statusAttribute = 'status';
    private $statusRules = [];
    public $authKeyAttribute = 'auth_key';
    private $authKeyRules = [];
    public $accessTokenAttribute = 'access_token';
    private $accessTokenRules = [];

    /**
     * Finds an identity by the given ID.
     * @param string|integer $id
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return type
     */
    public static function findIdentity($identity)
    {
        $self = static::buildNoInitModel();
        return static::findOne([$self->idAttribute => $identity]);
    }

    /**
     * Finds an identity by the given GUID.
     * @param string $guid
     * @return type
     */
    public static function findIdentityByGuid($guid)
    {
        return static::findOne($guid);
    }

    /**
     * Finds an identity by the given token.
     * @param string $token
     * @param type $type
     * @return type
     */
    public static function findIdentityByAccessToken($token, $type = null)

    {
        $self = static::buildNoInitModel();
        return static::findOne([$self->accessTokenAttribute => $token]);
    }

    /**
     * Get auth key.
     * @return string|null
     */
    public function getAuthKey()
    {
        $authKeyAttribute = $this->authKeyAttribute;
        return is_string($authKeyAttribute) ? $this->$authKeyAttribute : null;
    }

    /**
     * Set auth key.
     * @param string $key
     * @return string
     */
    public function setAuthKey($key)
    {
        $authKeyAttribute = $this->authKeyAttribute;
        return is_string($authKeyAttribute) ? $this->$authKeyAttribute = $key : null;
    }

    /**
     * Validate the auth key.
     * @param string $authKey
     * @return string
     */
    public function validateAuthKey($authKey)
    {
        return $this->getAuthKey() === $authKey;
    }

    /**
     * Get the rules associated with auth key attribute.
     * @return array
     */
    public function getAuthKeyRules()
    {
        if (empty($this->authKeyRules)) {
            $this->authKeyRules = [
                [[$this->authKeyAttribute], 'required'],
                [[$this->authKeyAttribute], 'string', 'max' => 40],
            ];
        }
        return $this->authKeyRules;
    }

    /**
     * Set the rules associated with auth key attribute.
     * @param array $rules
     */
    public function setAuthKeyRules($rules)
    {
        if (!empty($rules) && is_array($rules)) {
            $this->authKeyRules = $rules;
        }
    }

    /**
     * Initialize the auth key attribute.
     * This method is ONLY used for being triggered by event. DO NOT call,
     * override or modify it directly, unless you know the consequences.
     * @param ModelEvent $event
     */
    public function onInitAuthKey($event)
    {
        $sender = $event->sender;
        $authKeyAttribute = $sender->authKeyAttribute;
        $sender->$authKeyAttribute = sha1(Yii::$app->security->generateRandomString());
    }

    /**
     * Get access token.
     * @return string|null
     */
    public function getAccessToken()
    {
        $accessTokenAttribute = $this->accessTokenAttribute;
        return is_string($accessTokenAttribute) ? $this->$accessTokenAttribute : null;
    }

    /**
     * Set access token.
     * @param string $token
     * @return string|null
     */
    public function setAccessToken($token)
    {
        $accessTokenAttribute = $this->accessTokenAttribute;
        return is_string($accessTokenAttribute) ? $this->$accessTokenAttribute = $token : null;
    }

    /**
     * Get the rules associated with access token attribute.
     * @return array
     */
    public function getAccessTokenRules()
    {
        if (empty($this->accessTokenRules)) {
            $this->accessTokenRules = [
                [[$this->accessTokenAttribute], 'required'],
                [[$this->accessTokenAttribute], 'string', 'max' => 40],
            ];
        }
        return $this->accessTokenRules;
    }

    /**
     * Set the rules associated with access token attribute.
     * @param array $rules
     */
    public function setAccessTokenRules($rules)
    {
        if (!empty($rules) && is_array($rules)) {
            $this->accessTokenRules = $rules;
        }
    }

    /**
     * Initialize the access token attribute.
     * This method is ONLY used for being triggered by event. DO NOT call,
     * override or modify it directly, unless you know the consequences.
     * @param ModelEvent $event
     */
    public function onInitAccessToken($event)
    {
        $sender = $event->sender;
        $accessTokenAttribute = $sender->accessTokenAttribute;
        $sender->$accessTokenAttribute = sha1(Yii::$app->security->generateRandomString());
    }

    /**
     * Get status.
     * @return integer
     */
    public function getStatus()
    {
        $statusAttribute = $this->statusAttribute;
        return is_string($statusAttribute) ? $this->$statusAttribute : null;
    }

    /**
     * Set status.
     * @param integer $status
     * @return integer|null
     */
    public function setStatus($status)
    {
        $statusAttribute = $this->statusAttribute;
        return is_string($statusAttribute) ? $this->$statusAttribute = $status : null;
    }

    /**
     * Get the rules associated with status attribute.
     * @return array
     */
    public function getStatusRules()
    {
        if (empty($this->statusRules)) {
            $this->statusRules = [
                [[$this->statusAttribute], 'required'],
                [[$this->statusAttribute], 'number', 'integerOnly' => true, 'min' => 0],
            ];
        }
        return $this->statusRules;
    }

    /**
     * Set the rules associated with status attribute.
     * @param array $rules
     */
    public function setStatusRules($rules)
    {
        if (!empty($rules) && is_array($rules)) {
            $this->statusRules = $rules;
        }
    }

    /**
     * Initialize the status attribute.
     * This method is ONLY used for being triggered by event. DO NOT call,
     * override or modify it directly, unless you know the consequences.
     * @param ModelEvent $event
     */
    public function onInitStatusAttribute($event)
    {
        $sender = $event->sender;
        $statusAttribute = $sender->statusAttribute;
        if (empty($sender->$statusAttribute)) {
            $sender->$statusAttribute = self::$statusActive;
        }
    }
}


1		<?php
2
3		/**
4		* _ __ __ _____ _____ ___ ____ _____
5		* \| \| / // // ___//_ _// \|\| __\|\|_ _\|
6		* \| \|/ // /(__ ) / / / /\| \|\| \| \| \|
7		* \|___//_//____/ /_/ /_/ \|_\|\|_\| \|_\|
8		* @link http://vistart.name/
9		* @copyright Copyright (c) 2016 vistart
10		* @license http://vistart.name/license/
11		*/
12
13		namespace vistart\Models\traits;
14
15		use Yii;
16		use yii\base\ModelEvent;
17
18		/**
19		* User features concerning identity.
20		*
21		* @property-read string $authKey
22		* @property array $statusRules
23		* @property array $authKeyRules
24		* @property array $accessTokenRules
25		* @version 2.0
26		* @author vistart <[email protected]>
27		*/
28		trait IdentityTrait
29		{
30
31		public static $statusActive = 1;
32		public static $statusInactive = 0;
33		public $statusAttribute = 'status';
34		private $statusRules = [];
35		public $authKeyAttribute = 'auth_key';
36		private $authKeyRules = [];
37		public $accessTokenAttribute = 'access_token';
38		private $accessTokenRules = [];
39
40		/**
41		* Finds an identity by the given ID.
42		* @param string\|integer $id
		0 ignored issues – show Bug introduced 2016-01-29 17:04 UTC by Report Bug Copy Issue Report There is no parameter named `$id`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
43		* @return type
44		*/
45		public static function findIdentity($identity)
46		{
47		$self = static::buildNoInitModel();
48		return static::findOne([$self->idAttribute => $identity]);
49		}
50
51		/**
52		* Finds an identity by the given GUID.
53		* @param string $guid
54		* @return type
55		*/
56		public static function findIdentityByGuid($guid)
57		{
58		return static::findOne($guid);
59		}
60
61		/**
62		* Finds an identity by the given token.
63		* @param string $token
64		* @param type $type
65		* @return type
66		*/
67		public static function findIdentityByAccessToken($token, $type = null)
		0 ignored issues – show Unused Code introduced 2016-01-29 17:04 UTC by Report Bug Copy Issue Report The parameter `$type` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
68		{
69		$self = static::buildNoInitModel();
70		return static::findOne([$self->accessTokenAttribute => $token]);
71		}
72
73		/**
74		* Get auth key.
75		* @return string\|null
76		*/
77		public function getAuthKey()
78		{
79		$authKeyAttribute = $this->authKeyAttribute;
80		return is_string($authKeyAttribute) ? $this->$authKeyAttribute : null;
81		}
82
83		/**
84		* Set auth key.
85		* @param string $key
86		* @return string
87		*/
88		public function setAuthKey($key)
89		{
90		$authKeyAttribute = $this->authKeyAttribute;
91		return is_string($authKeyAttribute) ? $this->$authKeyAttribute = $key : null;
92		}
93
94		/**
95		* Validate the auth key.
96		* @param string $authKey
97		* @return string
98		*/
99		public function validateAuthKey($authKey)
100		{
101		return $this->getAuthKey() === $authKey;
102		}
103
104		/**
105		* Get the rules associated with auth key attribute.
106		* @return array
107		*/
108		public function getAuthKeyRules()
109		{
110		if (empty($this->authKeyRules)) {
111		$this->authKeyRules = [
112		[[$this->authKeyAttribute], 'required'],
113		[[$this->authKeyAttribute], 'string', 'max' => 40],
114		];
115		}
116		return $this->authKeyRules;
117		}
118
119		/**
120		* Set the rules associated with auth key attribute.
121		* @param array $rules
122		*/
123		public function setAuthKeyRules($rules)
124		{
125		if (!empty($rules) && is_array($rules)) {
126		$this->authKeyRules = $rules;
127		}
128		}
129
130		/**
131		* Initialize the auth key attribute.
132		* This method is ONLY used for being triggered by event. DO NOT call,
133		* override or modify it directly, unless you know the consequences.
134		* @param ModelEvent $event
135		*/
136	60	public function onInitAuthKey($event)
137		{
138	60	$sender = $event->sender;
139	60	$authKeyAttribute = $sender->authKeyAttribute;
140	60	$sender->$authKeyAttribute = sha1(Yii::$app->security->generateRandomString());
141	60	}
142
143		/**
144		* Get access token.
145		* @return string\|null
146		*/
147		public function getAccessToken()
148		{
149		$accessTokenAttribute = $this->accessTokenAttribute;
150		return is_string($accessTokenAttribute) ? $this->$accessTokenAttribute : null;
151		}
152
153		/**
154		* Set access token.
155		* @param string $token
156		* @return string\|null
157		*/
158		public function setAccessToken($token)
159		{
160		$accessTokenAttribute = $this->accessTokenAttribute;
161		return is_string($accessTokenAttribute) ? $this->$accessTokenAttribute = $token : null;
162		}
163
164		/**
165		* Get the rules associated with access token attribute.
166		* @return array
167		*/
168		public function getAccessTokenRules()
169		{
170		if (empty($this->accessTokenRules)) {
171		$this->accessTokenRules = [
172		[[$this->accessTokenAttribute], 'required'],
173		[[$this->accessTokenAttribute], 'string', 'max' => 40],
174		];
175		}
176		return $this->accessTokenRules;
177		}
178
179		/**
180		* Set the rules associated with access token attribute.
181		* @param array $rules
182		*/
183		public function setAccessTokenRules($rules)
184		{
185		if (!empty($rules) && is_array($rules)) {
186		$this->accessTokenRules = $rules;
187		}
188		}
189
190		/**
191		* Initialize the access token attribute.
192		* This method is ONLY used for being triggered by event. DO NOT call,
193		* override or modify it directly, unless you know the consequences.
194		* @param ModelEvent $event
195		*/
196	60	public function onInitAccessToken($event)
197		{
198	60	$sender = $event->sender;
199	60	$accessTokenAttribute = $sender->accessTokenAttribute;
200	60	$sender->$accessTokenAttribute = sha1(Yii::$app->security->generateRandomString());
201	60	}
202
203		/**
204		* Get status.
205		* @return integer
206		*/
207		public function getStatus()
208		{
209		$statusAttribute = $this->statusAttribute;
210		return is_string($statusAttribute) ? $this->$statusAttribute : null;
211		}
212
213		/**
214		* Set status.
215		* @param integer $status
216		* @return integer\|null
217		*/
218		public function setStatus($status)
219		{
220		$statusAttribute = $this->statusAttribute;
221		return is_string($statusAttribute) ? $this->$statusAttribute = $status : null;
222		}
223
224		/**
225		* Get the rules associated with status attribute.
226		* @return array
227		*/
228		public function getStatusRules()
229		{
230		if (empty($this->statusRules)) {
231		$this->statusRules = [
232		[[$this->statusAttribute], 'required'],
233		[[$this->statusAttribute], 'number', 'integerOnly' => true, 'min' => 0],
234		];
235		}
236		return $this->statusRules;
237		}
238
239		/**
240		* Set the rules associated with status attribute.
241		* @param array $rules
242		*/
243		public function setStatusRules($rules)
244		{
245		if (!empty($rules) && is_array($rules)) {
246		$this->statusRules = $rules;
247		}
248		}
249
250		/**
251		* Initialize the status attribute.
252		* This method is ONLY used for being triggered by event. DO NOT call,
253		* override or modify it directly, unless you know the consequences.
254		* @param ModelEvent $event
255		*/
256	60	public function onInitStatusAttribute($event)
257		{
258	60	$sender = $event->sender;
259	60	$statusAttribute = $sender->statusAttribute;
260	60	if (empty($sender->$statusAttribute)) {
261	60	$sender->$statusAttribute = self::$statusActive;
262	60	}
263	60	}
264		}
265

vistart / yii2-models

IdentityTrait::findIdentityByAccessToken() A last analyzed 2016-05-02 10:57 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

IdentityTrait::findIdentityByAccessToken() A
last analyzed 2016-05-02 10:57 UTC