UserSearch::scenarios() - Code Metrics - Inspection of "remove UserProfileSearch." - rhosocial/yii2-user - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 765f08...4ab50b )

by vistart

created 2017-04-12 09:12 UTC

UserSearch::scenarios() A

↳ Parent: UserSearch

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
eloc	2
nc	1
nop	0

<?php

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

namespace rhosocial\user;

use rhosocial\base\models\queries\BaseUserQuery;
use Yii;
use yii\base\Model;
use yii\data\ActiveDataProvider;

/**
 * Class UserSearchTrait
 * This trait should be used in the User model inherited from [[User]].
 * @package rhosocial\user
 * @version 1.0
 * @author vistart <[email protected]>
 */
class UserSearch extends Model
{
    public $userClass = User::class;
    public static function find()
    {
        $noInit = new static;
        /* @var $noInit static */
        $class = $noInit->userClass;
        if (empty($class)) {
            return null;
        }
        return $class::find();
    }
    public $userAlias = 'u_alias';
    public $profileAlias = 'p_alias';
    public $id;
    public $nickname;
    public $first_name;
    public $last_name;
    /**
     * @var string
     */
    public $createdFrom;
    protected $createdFromInUtc;

    /**
     * @var string
     */
    public $createdTo;
    protected $createdToInUtc;

    /**
     * @var string Gender filter.
     */
    public $gf;

    /**
     *
     * @return array
     */
    public function rules()
    {
        return [
            ['id', 'integer'],
            [['nickname', 'first_name', 'last_name'], 'string'],
            [['createdFrom', 'createdTo'], 'datetime', 'format' => 'yyyy-MM-dd HH:mm'],
            [['createdFrom', 'createdTo'], 'gmdate'],
            ['gf', 'in', 'range' => array_keys(Profile::getGenderDescsWithEmpty())],
            ['gf', 'default', 'value' => ''],
        ];
    }

    /**
     * Convert time attribute to UTC time.
     * @param string $attribute
     * @param array $params
     * @param mixed $validator
     */
    public function gmdate($attribute, $params, $validator)

    {
        if (isset($this->$attribute)) {
            $timestamp = strtotime($this->$attribute);
            $this->{$attribute . 'InUtc'} = gmdate('Y-m-d H:i:s', $timestamp);
        }
    }

    /**
     *
     * @return array
     */
    public function scenarios()
    {
        // bypass scenarios() implementation in the parent class
        return Model::scenarios();
    }

    /**
     * Search
     * @param array $params
     * @return ActiveDataProvider
     */
    public function search($params)
    {
        $query = static::find();
        /* @var $query BaseUserQuery */
        $userClass = $this->userClass;
        $query = $query->from("{$userClass::tableName()} {$this->userAlias}");
        $noInitUser = new $userClass;
        /* @var $noInitUser User */
        $profileClass = $noInitUser->profileClass;
        $noInitProfile = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        if (!empty($profileClass)) {
            $query = $query->joinWith(["profile {$this->profileAlias}"]);
        }
        $dataProvider = new ActiveDataProvider([
            'query' => $query,
            'pagination' => [
                'pageParam' => 'user-page',
                'defaultPageSize' => 20,
                'pageSizeParam' => 'user-per-page',
            ],
            'sort' => [
                'sortParam' => 'user-sort',
                'attributes' => [
                    'id',
                    'nickname',
                    'name' => [
                        'asc' => [$this->profileAlias . '.first_name' => SORT_ASC, $this->profileAlias . '.last_name' => SORT_ASC],
                        'desc' => [$this->profileAlias . '.first_name' => SORT_DESC, $this->profileAlias . '.last_name' => SORT_DESC],
                        'default' => SORT_DESC,
                        'label' => Yii::t('user', 'Name'),
                    ],
                    'gender' => [
                        'asc' => [$this->profileAlias . '.gender' => SORT_ASC],
                        'desc' => [$this->profileAlias . '.gender' => SORT_DESC],
                        'default' => SORT_ASC,
                        'label' => Yii::t('user', 'Gender'),
                    ],
                    'createdAt' => [
                        'asc' => [$this->userAlias . '.created_at' => SORT_ASC],
                        'desc' => [$this->userAlias . '.created_at' => SORT_DESC],
                        'default' => SORT_ASC,
                        'label' => Yii::t('user', 'Creation Time'),
                    ],
                    'updatedAt' => [
                        'asc' => [$this->userAlias . '.updated_at' => SORT_ASC],
                        'desc' => [$this->userAlias . '.updated_at' => SORT_DESC],
                        'default' => SORT_ASC,
                        'label' => Yii::t('user', 'Last Updated Time'),
                    ],
                ],
            ],
        ]);

        if (!($this->load($params) && $this->validate())) {
            return $dataProvider;
        }

        $query = $query->andFilterWhere([
            'LIKE', $this->userAlias . '.id', $this->id,
        ])->andFilterWhere([
            'LIKE', $this->profileAlias . '.nickname', $this->nickname,
        ])->andFilterWhere([
            '>=', $this->userAlias . '.created_at', $this->createdFromInUtc,
        ])->andFilterWhere([
            '<=', $this->userAlias . '.created_at', $this->createdToInUtc,
        ])->andFilterWhere([
            'LIKE', $this->profileAlias . '.first_name', $this->first_name,
        ])->andFilterWhere([
            'LIKE', $this->profileAlias . '.last_name', $this->last_name,
        ])->andFilterWhere([
            $this->profileAlias . '.gender' => $this->gf,
        ]);
        $dataProvider->query = $query;
        return $dataProvider;
    }

    /**
     * Add `createdFrom` & `createdTo` attributes.
     * @return array
     */
    public function attributeLabels()
    {
        $attributeLabels = parent::attributeLabels();
        $attributeLabels['createdFrom'] = Yii::t('user', 'From');
        $attributeLabels['createdTo'] = Yii::t('user', 'To');
        return $attributeLabels;
    }
}


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\queries\BaseUserQuery;
16			use Yii;
17			use yii\base\Model;
18			use yii\data\ActiveDataProvider;
19
20			/**
21			* Class UserSearchTrait
22			* This trait should be used in the User model inherited from [[User]].
23			* @package rhosocial\user
24			* @version 1.0
25			* @author vistart <[email protected]>
26			*/
27			class UserSearch extends Model
28			{
29			public $userClass = User::class;
30			public static function find()
31			{
32			$noInit = new static;
33			/* @var $noInit static */
34			$class = $noInit->userClass;
35			if (empty($class)) {
36			return null;
37			}
38			return $class::find();
39			}
40			public $userAlias = 'u_alias';
41			public $profileAlias = 'p_alias';
42			public $id;
43			public $nickname;
44			public $first_name;
45			public $last_name;
46			/**
47			* @var string
48			*/
49			public $createdFrom;
50			protected $createdFromInUtc;
51
52			/**
53			* @var string
54			*/
55			public $createdTo;
56			protected $createdToInUtc;
57
58			/**
59			* @var string Gender filter.
60			*/
61			public $gf;
62
63			/**
64			*
65			* @return array
66			*/
67			public function rules()
68			{
69			return [
70			['id', 'integer'],
71			[['nickname', 'first_name', 'last_name'], 'string'],
72			[['createdFrom', 'createdTo'], 'datetime', 'format' => 'yyyy-MM-dd HH:mm'],
73			[['createdFrom', 'createdTo'], 'gmdate'],
74			['gf', 'in', 'range' => array_keys(Profile::getGenderDescsWithEmpty())],
75			['gf', 'default', 'value' => ''],
76			];
77			}
78
79			/**
80			* Convert time attribute to UTC time.
81			* @param string $attribute
82			* @param array $params
83			* @param mixed $validator
84			*/
85			public function gmdate($attribute, $params, $validator)
			0 ignored issues – show Unused Code introduced 2017-04-07 05:55 UTC by Report Bug Copy Issue Report The parameter `$params` 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... Unused Code introduced 2017-04-07 05:55 UTC by Report Bug Copy Issue Report The parameter `$validator` 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...
86			{
87			if (isset($this->$attribute)) {
88			$timestamp = strtotime($this->$attribute);
89			$this->{$attribute . 'InUtc'} = gmdate('Y-m-d H:i:s', $timestamp);
90			}
91			}
92
93			/**
94			*
95			* @return array
96			*/
97			public function scenarios()
98			{
99			// bypass scenarios() implementation in the parent class
100			return Model::scenarios();
101			}
102
103			/**
104			* Search
105			* @param array $params
106			* @return ActiveDataProvider
107			*/
108			public function search($params)
109			{
110			$query = static::find();
111			/* @var $query BaseUserQuery */
112			$userClass = $this->userClass;
113			$query = $query->from("{$userClass::tableName()} {$this->userAlias}");
114			$noInitUser = new $userClass;
115			/* @var $noInitUser User */
116			$profileClass = $noInitUser->profileClass;
117			$noInitProfile = null;
			0 ignored issues – show Unused Code introduced 2017-04-12 09:16 UTC by Report Bug Copy Issue Report `$noInitProfile` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
118			if (!empty($profileClass)) {
119			$query = $query->joinWith(["profile {$this->profileAlias}"]);
120			}
121			$dataProvider = new ActiveDataProvider([
122			'query' => $query,
123			'pagination' => [
124			'pageParam' => 'user-page',
125			'defaultPageSize' => 20,
126			'pageSizeParam' => 'user-per-page',
127			],
128			'sort' => [
129			'sortParam' => 'user-sort',
130			'attributes' => [
131			'id',
132			'nickname',
133			'name' => [
134			'asc' => [$this->profileAlias . '.first_name' => SORT_ASC, $this->profileAlias . '.last_name' => SORT_ASC],
135			'desc' => [$this->profileAlias . '.first_name' => SORT_DESC, $this->profileAlias . '.last_name' => SORT_DESC],
136			'default' => SORT_DESC,
137			'label' => Yii::t('user', 'Name'),
138			],
139			'gender' => [
140			'asc' => [$this->profileAlias . '.gender' => SORT_ASC],
141			'desc' => [$this->profileAlias . '.gender' => SORT_DESC],
142			'default' => SORT_ASC,
143			'label' => Yii::t('user', 'Gender'),
144			],
145			'createdAt' => [
146			'asc' => [$this->userAlias . '.created_at' => SORT_ASC],
147			'desc' => [$this->userAlias . '.created_at' => SORT_DESC],
148			'default' => SORT_ASC,
149			'label' => Yii::t('user', 'Creation Time'),
150			],
151			'updatedAt' => [
152			'asc' => [$this->userAlias . '.updated_at' => SORT_ASC],
153			'desc' => [$this->userAlias . '.updated_at' => SORT_DESC],
154			'default' => SORT_ASC,
155			'label' => Yii::t('user', 'Last Updated Time'),
156			],
157			],
158			],
159			]);
160
161			if (!($this->load($params) && $this->validate())) {
162			return $dataProvider;
163			}
164
165			$query = $query->andFilterWhere([
166			'LIKE', $this->userAlias . '.id', $this->id,
167			])->andFilterWhere([
168			'LIKE', $this->profileAlias . '.nickname', $this->nickname,
169			])->andFilterWhere([
170			'>=', $this->userAlias . '.created_at', $this->createdFromInUtc,
171			])->andFilterWhere([
172			'<=', $this->userAlias . '.created_at', $this->createdToInUtc,
173			])->andFilterWhere([
174			'LIKE', $this->profileAlias . '.first_name', $this->first_name,
175			])->andFilterWhere([
176			'LIKE', $this->profileAlias . '.last_name', $this->last_name,
177			])->andFilterWhere([
178			$this->profileAlias . '.gender' => $this->gf,
179			]);
180			$dataProvider->query = $query;
181			return $dataProvider;
182			}
183
184			/**
185			* Add `createdFrom` & `createdTo` attributes.
186			* @return array
187			*/
188			public function attributeLabels()
189			{
190			$attributeLabels = parent::attributeLabels();
191			$attributeLabels['createdFrom'] = Yii::t('user', 'From');
192			$attributeLabels['createdTo'] = Yii::t('user', 'To');
193			return $attributeLabels;
194			}
195			}
196

rhosocial / yii2-user

Push — master ( 765f08...4ab50b )

UserSearch::scenarios() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like