rhosocial\user\UserProfileSearchTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	rules()	0	9	1
A	gmdate()	0	7	2
A	scenarios()	0	5	1
B	search()	0	35	3
A	attributeLabels()	0	7	1

<?php

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

namespace rhosocial\user;

use Yii;
use yii\base\Model;
use yii\data\ActiveDataProvider;

/**
 * @version 1.0
 * @author vistart <i@vistart.me>
 */
trait UserProfileSearchTrait
{
    /**
     * @var string 
     */
    public $createdFrom;
    protected $createdFromInUtc;

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

    /**
     * 
     * @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'],
        ];
    }

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

The parameter $params is not used and could be removed.

The parameter $validator is not used and could be removed.

    {
        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();
        $dataProvider = new ActiveDataProvider([
            'query' => $query,
            'pagination' => [
                'pageParam' => 'user-page',
                'defaultPageSize' => 20,
                'pageSizeParam' => 'user-per-page',
            ],
            'sort' => [
                'sortParam' => 'user-sort',
            ],
        ]);

        if (!($this->load($params) && $this->validate())) {

It seems like load() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like validate() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return $dataProvider;
        }

        $query = $query->andFilterWhere([
            'LIKE', 'id', $this->id,

The property id does not exist. Did you maybe forget to declare it?

        ])->andFilterWhere([
            'LIKE', 'nickname', $this->nickname,

The property nickname does not exist. Did you maybe forget to declare it?

        ])->andFilterWhere([
            '>=', 'created_at', $this->createdFromInUtc,
        ])->andFilterWhere([
            '<=', 'created_at', $this->createdToInUtc,
        ])->andFilterWhere([
            'LIKE', 'first_name', $this->first_name,

The property first_name does not exist. Did you maybe forget to declare it?

        ])->andFilterWhere([
            'LIKE', 'last_name', $this->last_name,

The property last_name does not exist. Did you maybe forget to declare it?

        ]);
        $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;
    }
}