Admin::getStatusList() - Code Metrics - Inspection of "build" - zacksleo/yii2-backend - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 149579...032082 )

by zacksleo

created 2017-12-22 02:52 UTC

Admin::getStatusList() A

↳ Parent: Admin

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace zacksleo\yii2\backend\models;

use yii;
use yii\base\NotSupportedException;
use yii\db\ActiveRecord;
use yii\web\IdentityInterface;
use yii\web\UploadedFile;
use yii\helpers\Url;
use yii\behaviors\TimestampBehavior;
use zacksleo\yii2\backend\models\queries\AdminQuery;
use zacksleo\yii2\backend\Module;

/**
 * User model
 *
 * @property integer $id
 * @property string $username
 * @property string $email
 * @property integer $role
 * @property integer $status
 * @property string $created_at
 * @property string $updated_at
 * @property string $password_hash write-only password
 * @property string $avatar
 * @property string $auth_key
 * @property string $name
 * @property string $password_rest_token
 * @property string $email_confirmation_token
 * @property UploadedFile $imageFile
 */
class Admin extends ActiveRecord implements IdentityInterface
{
    const STATUS_INACTIVE = 0;
    const STATUS_ACTIVE = 10;

    public $imageFile;

    public $isAdmin = true;

    /**
     * @var string|null the current password value from form input
     */
    protected $_password;

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

    /**
     * @return AdminQuery custom query class with user scopes
     */
    public static function find()
    {
        return new AdminQuery(get_called_class());
    }

    /**
     * @inheritdoc
     */
    public function scenarios()
    {
        return array_merge(parent::scenarios(), [
            'reset' => ['username', 'email', 'password_hash'],
        ]);
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['username', 'email', 'mobilephone', 'password_hash'], 'required', 'on' => 'reset'],
            ['username', 'match', 'pattern' => '/^[a-z]\w*$/i', 'on' => 'reset'],
            ['password_hash', 'match', 'pattern' => '/\d/', 'message' => '密码至少包含一位数字', 'on' => 'reset'],
            ['password_hash', 'match', 'pattern' => '/[a-zA-Z]/', 'message' => '密码至少包含一个字母', 'on' => 'reset'],

            ['status', 'default', 'value' => self::STATUS_ACTIVE],
            ['status', 'in', 'range' => [self::STATUS_ACTIVE, self::STATUS_INACTIVE]],

            ['username', 'filter', 'filter' => 'trim'],
            ['username', 'unique', 'on' => 'reset'],
            ['username', 'string', 'min' => 2, 'max' => 255],
            ['name', 'string', 'max' => '20'],

            ['email', 'filter', 'filter' => 'trim'],
            ['email', 'email'],
            ['email', 'unique', 'on' => 'reset'],
            ['avatar', 'safe'],
            [
                ['imageFile'],
                'file',
                'skipOnEmpty' => true,
                'extensions' => 'png, jpg',
                'maxFiles' => 1,
                'maxSize' => 300000
            ],
        ];
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            'avatar' => Module::t('backend', 'avatar'),
            'id' => Module::t('backend', 'id'),
            'username' => Module::t('backend', 'username'),
            'email' => Module::t('backend', 'email'),
            'is_email_verified' => Module::t('backend', 'is email verified'),
            'password_hash' => Module::t('backend', 'password'),
            'status' => Module::t('backend', 'status'),
            'created_at' => Module::t('backend', 'create time'),
            'updated_at' => Module::t('backend', 'update time'),
            'imageFile' => '上传头像',
            'name' => '姓名'
        ];
    }

    /**
     * @inheritdoc
     */
    public function behaviors()
    {
        return [
            'timestamp' => [
                'class' => TimestampBehavior::className(),
            ],
        ];
    }

    /**
     * @inheritdoc
     */
    public function beforeSave($insert)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if ($this->isNewRecord) {
            $this->setPassword($this->password_hash);
        }
        if (Yii::$app->request->isPost && isset($_POST['Admin']['imageFile'])) {
            $this->imageFile = UploadedFile::getInstance($this, 'imageFile');
            if (!empty($this->imageFile) && !$this->upload()) {
                $this->addError('avatar', $this->imageFile->getHasError());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                return false;
            }
        }
        return parent::beforeSave($insert);
    }

    /**
     * @inheritdoc
     */
    public static function findIdentity($id)
    {
        return static::findOne($id);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @inheritdoc
     */
    public static function findIdentityByAccessToken($token, $type = null)
    {
        throw new NotSupportedException('"findIdentityByAccessToken" is not implemented.');
    }

    /**
     * @inheritdoc
     */
    public function getId()
    {
        return $this->getPrimaryKey();
    }

    /**
     * @inheritdoc
     */
    public function getAuthKey()
    {
        return $this->auth_key;
    }

    /**
     * @inheritdoc
     */
    public function validateAuthKey($authKey)
    {
        return $this->getAuthKey() === $authKey;
    }

    /**
     * Validates password
     *
     * @param  string $password password to validate
     * @return boolean if password provided is valid for current user
     */
    public function validatePassword($password)
    {
        return Yii::$app->security->validatePassword($password, $this->password_hash);
    }

    /**
     * Generates password hash from password and sets it to the model
     *
     * @param string $password
     */
    public function setPassword($password)
    {
        $this->_password = $password;
        if (!empty($password)) {
            $this->password_hash = Yii::$app->security->generatePasswordHash($password);
        }
    }

    /**
     * @return string|null the current password value, if set from form. Null otherwise.
     */
    public function getPassword()
    {
        return $this->_password;
    }

    /**
     * Generates "remember me" authentication key
     */
    public function generateAuthKey()
    {
        $this->auth_key = Yii::$app->security->generateRandomString();
    }

    /**
     * Generates new email confirmation token
     * @param bool $save whether to save the record. Default is `false`.
     * @return bool|null whether the save was successful or null if $save was false.
     */
    public function generateEmailConfirmationToken($save = false)
    {
        $this->email_confirmation_token = Yii::$app->security->generateRandomString() . '_' . time();
        if ($save) {
            return $this->save();
        }
    }

    /**
     * Generates new password reset token
     * @param bool $save whether to save the record. Default is `false`.
     * @return bool|null whether the save was successful or null if $save was false.
     */
    public function generatePasswordResetToken($save = false)
    {
        $this->password_reset_token = Yii::$app->security->generateRandomString() . '_' . time();

        if ($save) {
            return $this->save();
        }
    }

    /**
     * Resets to a new password and deletes the password reset token.
     * @param string $password the new password for this user.
     * @return bool whether the record was updated successfully
     */
    public function resetPassword($password)
    {
        $this->setPassword($password);
        $this->password_reset_token = null;

        return $this->save();
    }

    public static function getStatusList()
    {
        return [
            self::STATUS_ACTIVE => '激活',
            self::STATUS_INACTIVE => '禁用',
        ];
    }

    /**
     * 上传头像
     * @return bool
     */
    public function upload()
    {
        if ($this->validate()) {
            $path = date('Ymd') . '/';
            $fullpath = \Yii::getAlias('@app') . '/web/uploads/' . $path;
            if (!file_exists($fullpath)) {
                mkdir($fullpath);
            }
            $filename = uniqid() . '.' . $this->imageFile->extension;
            $this->imageFile->saveAs($fullpath . $filename);
            $this->avatar = $path . $filename;
            return true;
        } else {
            return false;
        }
    }

    /**
     * 获取头像地址
     * @return string
     */
    public function getImageUrl()
    {
        if (empty($this->avatar)) {
            return Url::to('/images/avatar.jpg');
        }
        return Url::to('@web/uploads/' . $this->avatar, true);
    }
}


1		<?php
2
3		namespace zacksleo\yii2\backend\models;
4
5		use yii;
6		use yii\base\NotSupportedException;
7		use yii\db\ActiveRecord;
8		use yii\web\IdentityInterface;
9		use yii\web\UploadedFile;
10		use yii\helpers\Url;
11		use yii\behaviors\TimestampBehavior;
12		use zacksleo\yii2\backend\models\queries\AdminQuery;
13		use zacksleo\yii2\backend\Module;
14
15		/**
16		* User model
17		*
18		* @property integer $id
19		* @property string $username
20		* @property string $email
21		* @property integer $role
22		* @property integer $status
23		* @property string $created_at
24		* @property string $updated_at
25		* @property string $password_hash write-only password
26		* @property string $avatar
27		* @property string $auth_key
28		* @property string $name
29		* @property string $password_rest_token
30		* @property string $email_confirmation_token
31		* @property UploadedFile $imageFile
32		*/
33		class Admin extends ActiveRecord implements IdentityInterface
34		{
35		const STATUS_INACTIVE = 0;
36		const STATUS_ACTIVE = 10;
37
38		public $imageFile;
39
40		public $isAdmin = true;
41
42		/**
43		* @var string\|null the current password value from form input
44		*/
45		protected $_password;
46
47		/**
48		* @inheritdoc
49		*/
50	32	public static function tableName()
51		{
52	32	return '{{%admin}}';
53		}
54
55		/**
56		* @return AdminQuery custom query class with user scopes
57		*/
58	30	public static function find()
59		{
60	30	return new AdminQuery(get_called_class());
61		}
62
63		/**
64		* @inheritdoc
65		*/
66	11	public function scenarios()
67		{
68	11	return array_merge(parent::scenarios(), [
69	11	'reset' => ['username', 'email', 'password_hash'],
70		]);
71		}
72
73		/**
74		* @inheritdoc
75		*/
76	11	public function rules()
77		{
78		return [
79	11	[['username', 'email', 'mobilephone', 'password_hash'], 'required', 'on' => 'reset'],
80		['username', 'match', 'pattern' => '/^[a-z]\w*$/i', 'on' => 'reset'],
81		['password_hash', 'match', 'pattern' => '/\d/', 'message' => '密码至少包含一位数字', 'on' => 'reset'],
82		['password_hash', 'match', 'pattern' => '/[a-zA-Z]/', 'message' => '密码至少包含一个字母', 'on' => 'reset'],
83
84	11	['status', 'default', 'value' => self::STATUS_ACTIVE],
85	11	['status', 'in', 'range' => [self::STATUS_ACTIVE, self::STATUS_INACTIVE]],
86
87		['username', 'filter', 'filter' => 'trim'],
88		['username', 'unique', 'on' => 'reset'],
89		['username', 'string', 'min' => 2, 'max' => 255],
90		['name', 'string', 'max' => '20'],
91
92		['email', 'filter', 'filter' => 'trim'],
93		['email', 'email'],
94		['email', 'unique', 'on' => 'reset'],
95		['avatar', 'safe'],
96		[
97		['imageFile'],
98		'file',
99		'skipOnEmpty' => true,
100		'extensions' => 'png, jpg',
101		'maxFiles' => 1,
102		'maxSize' => 300000
103		],
104		];
105		}
106
107		/**
108		* @inheritdoc
109		*/
110	10	public function attributeLabels()
111		{
112		return [
113	10	'avatar' => Module::t('backend', 'avatar'),
114	10	'id' => Module::t('backend', 'id'),
115	10	'username' => Module::t('backend', 'username'),
116	10	'email' => Module::t('backend', 'email'),
117	10	'is_email_verified' => Module::t('backend', 'is email verified'),
118	10	'password_hash' => Module::t('backend', 'password'),
119	10	'status' => Module::t('backend', 'status'),
120	10	'created_at' => Module::t('backend', 'create time'),
121	10	'updated_at' => Module::t('backend', 'update time'),
122	10	'imageFile' => '上传头像',
123	10	'name' => '姓名'
124		];
125		}
126
127		/**
128		* @inheritdoc
129		*/
130	28	public function behaviors()
131		{
132		return [
133		'timestamp' => [
134	28	'class' => TimestampBehavior::className(),
135		],
136		];
137		}
138
139		/**
140		* @inheritdoc
141		*/
142	1	public function beforeSave($insert)
		0 ignored issues – show Coding Style introduced 2017-09-20 16:08 UTC by Report Bug Copy Issue Report `beforeSave` uses the super-global variable `$_POST` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
143		{
144	1	if ($this->isNewRecord) {
145	1	$this->setPassword($this->password_hash);
146		}
147	1	if (Yii::$app->request->isPost && isset($_POST['Admin']['imageFile'])) {
148		$this->imageFile = UploadedFile::getInstance($this, 'imageFile');
149		if (!empty($this->imageFile) && !$this->upload()) {
150		$this->addError('avatar', $this->imageFile->getHasError());
		0 ignored issues – show Documentation introduced 2017-09-20 16:08 UTC by Report Bug Copy Issue Report `$this->imageFile->getHasError()` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
151		return false;
152		}
153		}
154	1	return parent::beforeSave($insert);
155		}
156
157		/**
158		* @inheritdoc
159		*/
160	5	public static function findIdentity($id)
161		{
162	5	return static::findOne($id);
		0 ignored issues – show Bug Best Practice introduced 2017-11-23 08:19 UTC by Report Bug Copy Issue Report The return type of `return static::findOne($id);` (`yii\db\ActiveRecordInterface\|array\|null`) is incompatible with the return type declared by the interface `yii\web\IdentityInterface::findIdentity` of type `yii\web\IdentityInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
163		}
164
165		/**
166		* @inheritdoc
167		*/
168	1	public static function findIdentityByAccessToken($token, $type = null)
169		{
170	1	throw new NotSupportedException('"findIdentityByAccessToken" is not implemented.');
171		}
172
173		/**
174		* @inheritdoc
175		*/
176	15	public function getId()
177		{
178	15	return $this->getPrimaryKey();
179		}
180
181		/**
182		* @inheritdoc
183		*/
184	1	public function getAuthKey()
185		{
186	1	return $this->auth_key;
187		}
188
189		/**
190		* @inheritdoc
191		*/
192	1	public function validateAuthKey($authKey)
193		{
194	1	return $this->getAuthKey() === $authKey;
195		}
196
197		/**
198		* Validates password
199		*
200		* @param string $password password to validate
201		* @return boolean if password provided is valid for current user
202		*/
203	3	public function validatePassword($password)
204		{
205	3	return Yii::$app->security->validatePassword($password, $this->password_hash);
206		}
207
208		/**
209		* Generates password hash from password and sets it to the model
210		*
211		* @param string $password
212		*/
213	4	public function setPassword($password)
214		{
215	4	$this->_password = $password;
216	4	if (!empty($password)) {
217	3	$this->password_hash = Yii::$app->security->generatePasswordHash($password);
218		}
219	4	}
220
221		/**
222		* @return string\|null the current password value, if set from form. Null otherwise.
223		*/
224		public function getPassword()
225		{
226		return $this->_password;
227		}
228
229		/**
230		* Generates "remember me" authentication key
231		*/
232	1	public function generateAuthKey()
233		{
234	1	$this->auth_key = Yii::$app->security->generateRandomString();
235	1	}
236
237		/**
238		* Generates new email confirmation token
239		* @param bool $save whether to save the record. Default is `false`.
240		* @return bool\|null whether the save was successful or null if $save was false.
241		*/
242		public function generateEmailConfirmationToken($save = false)
243		{
244		$this->email_confirmation_token = Yii::$app->security->generateRandomString() . '_' . time();
245		if ($save) {
246		return $this->save();
247		}
248		}
249
250		/**
251		* Generates new password reset token
252		* @param bool $save whether to save the record. Default is `false`.
253		* @return bool\|null whether the save was successful or null if $save was false.
254		*/
255	2	public function generatePasswordResetToken($save = false)
256		{
257	2	$this->password_reset_token = Yii::$app->security->generateRandomString() . '_' . time();
		0 ignored issues – show Bug introduced 2017-09-20 16:08 UTC by Report Bug Copy Issue Report The property `password_reset_token` does not seem to exist. Did you mean `password_rest_token`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
258	2	if ($save) {
259	2	return $this->save();
260		}
261		}
262
263		/**
264		* Resets to a new password and deletes the password reset token.
265		* @param string $password the new password for this user.
266		* @return bool whether the record was updated successfully
267		*/
268	3	public function resetPassword($password)
269		{
270	3	$this->setPassword($password);
271	3	$this->password_reset_token = null;
		0 ignored issues – show Bug introduced 2017-09-20 16:08 UTC by Report Bug Copy Issue Report The property `password_reset_token` does not seem to exist. Did you mean `password_rest_token`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
272	3	return $this->save();
273		}
274
275		public static function getStatusList()
276		{
277		return [
278		self::STATUS_ACTIVE => '激活',
279		self::STATUS_INACTIVE => '禁用',
280		];
281		}
282
283		/**
284		* 上传头像
285		* @return bool
286		*/
287	2	public function upload()
288		{
289	2	if ($this->validate()) {
290		$path = date('Ymd') . '/';
291		$fullpath = \Yii::getAlias('@app') . '/web/uploads/' . $path;
292		if (!file_exists($fullpath)) {
293		mkdir($fullpath);
294		}
295		$filename = uniqid() . '.' . $this->imageFile->extension;
296		$this->imageFile->saveAs($fullpath . $filename);
297		$this->avatar = $path . $filename;
298		return true;
299		} else {
300	2	return false;
301		}
302		}
303
304		/**
305		* 获取头像地址
306		* @return string
307		*/
308	1	public function getImageUrl()
309		{
310	1	if (empty($this->avatar)) {
311	1	return Url::to('/images/avatar.jpg');
312		}
313		return Url::to('@web/uploads/' . $this->avatar, true);
314		}
315		}
316

zacksleo / yii2-backend

Push — master ( 149579...032082 )

Admin::getStatusList() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like