EntityQueryTrait::orderByUpdatedAt() - Code Metrics - Inspection of "add methods, improve tests." - rhosocial/yii2-base-models - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 616673...9aa93d )

by vistart

created 2017-01-27 06:35 UTC

EntityQueryTrait::orderByUpdatedAt() A

↳ Parent: EntityQueryTrait

Complexity

Conditions	3
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

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

<?php

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

namespace rhosocial\base\models\traits;

/**
 * This trait is used for building entity query class for entity model.
 *
 * @version 1.0
 * @author vistart <[email protected]>
 */
trait EntityQueryTrait
{
    use QueryTrait;
    
    public $noInitModel;

    /**
     * Build model without any initializations.
     */
    public function buildNoInitModel()
    {
        if (empty($this->noInitModel) && is_string($this->modelClass)) {
            $modelClass = $this->modelClass;
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->noInitModel = $modelClass::buildNoInitModel();
        }
    }
    
    /**
     * Specify guid attribute.
     * @param string|array $guid
     * @param false|string $like false, 'like', 'or like', 'not like', 'or not like'.
     * @return $this
     */
    public function guid($guid, $like = false)
    {
        $model = $this->noInitModel;
        return $this->likeCondition((string)$guid, $model->guidAttribute, $like);
    }
    
    /**
     * Specify id attribute.
     * @param string|integer|array $id
     * @param false|string $like false, 'like', 'or like', 'not like', 'or not like'.
     * @return $this
     */
    public function id($id, $like = false)
    {
        $model = $this->noInitModel;
        return $this->likeCondition($id, $model->idAttribute, $like);
    }
    
    /**
     * Specify create time range.
     * @param string $start
     * @param string $end
     * @return $this
     */
    public function createdAt($start = null, $end = null)
    {
        $model = $this->noInitModel;
        /* @var $model static */
        if (!is_string($model->createdAtAttribute) || empty($model->createdAtAttribute)) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            return $this;
        }
        return static::range($this, $model->createdAtAttribute, $start, $end);
    }
    
    /**
     * Specify order by creation time.
     * @param string $sort only 'ASC' and 'DESC' are acceptable.
     * @return $this
     */
    public function orderByCreatedAt($sort = 'ASC')
    {
        $model = $this->noInitModel;
        /* @var $model static */
        if (!is_string($model->createdAtAttribute) || empty($model->createdAtAttribute)) {
            return $this;
        }
        return $this->addOrderBy([$model->createdAtAttribute => $sort]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
    
    /**
     * Specify update time range.
     * @param string $start 
     * @param string $end
     * @return $this
     */
    public function updatedAt($start = null, $end = null)
    {
        $model = $this->noInitModel;
        /* @var $model static */
        if (!is_string($model->updatedAtAttribute) || empty($model->updatedAtAttribute)) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            return $this;
        }
        return static::range($this, $model->updatedAtAttribute, $start, $end);
    }
    
    /**
     * Specify order by update time.
     * @param string $sort only 'ASC' and 'DESC' are acceptable.
     * @return $this
     */
    public function orderByUpdatedAt($sort = 'ASC')
    {
        $model = $this->noInitModel;
        /* @var $model static */
        if (!is_string($model->updatedAtAttribute) || empty($model->updatedAtAttribute)) {
            return $this;
        }
        return $this->addOrderBy([$model->updatedAtAttribute => $sort]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
    
    public static $pageAll = 'all';
    public static $defaultPageSize = 10;
    
    /**
     * Specify page condition.
     * @param string|int $pageSize It will return all models if it is 'all',
     * or it will be regarded as sum of models.
     * @param int $currentPage The current page number if it is integer begun with 0.
     * @return $this
     */
    public function page($pageSize = 10, $currentPage = 0)
    {
        if ($pageSize === static::$pageAll) {
            return $this;
        }
        /* normalize $currentPage and $currentPage */
        if (!is_numeric($currentPage) || $currentPage < 0) {
            $currentPage = 0;
        }
        $currentPage = (int) $currentPage;
        if (!is_numeric($pageSize) || $pageSize < 1) {
            $pageSize = static::$defaultPageSize;
        }
        $pageSize = (int) $pageSize;
        return $this->limit($pageSize)->offset($pageSize * $currentPage);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
}


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\base\models\traits;
14
15		/**
16		* This trait is used for building entity query class for entity model.
17		*
18		* @version 1.0
19		* @author vistart <[email protected]>
20		*/
21		trait EntityQueryTrait
22		{
23		use QueryTrait;
24
25		public $noInitModel;
26
27		/**
28		* Build model without any initializations.
29		*/
30	289	public function buildNoInitModel()
31		{
32	289	if (empty($this->noInitModel) && is_string($this->modelClass)) {
33		$modelClass = $this->modelClass;
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report The property `modelClass` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
34		$this->noInitModel = $modelClass::buildNoInitModel();
35		}
36	289	}
37
38		/**
39		* Specify guid attribute.
40		* @param string\|array $guid
41		* @param false\|string $like false, 'like', 'or like', 'not like', 'or not like'.
42		* @return $this
43		*/
44	12	public function guid($guid, $like = false)
45		{
46	12	$model = $this->noInitModel;
47	12	return $this->likeCondition((string)$guid, $model->guidAttribute, $like);
48		}
49
50		/**
51		* Specify id attribute.
52		* @param string\|integer\|array $id
53		* @param false\|string $like false, 'like', 'or like', 'not like', 'or not like'.
54		* @return $this
55		*/
56	9	public function id($id, $like = false)
57		{
58	9	$model = $this->noInitModel;
59	9	return $this->likeCondition($id, $model->idAttribute, $like);
60		}
61
62		/**
63		* Specify create time range.
64		* @param string $start
65		* @param string $end
66		* @return $this
67		*/
68	5	public function createdAt($start = null, $end = null)
69		{
70	5	$model = $this->noInitModel;
71		/* @var $model static */
72	5	if (!is_string($model->createdAtAttribute) \|\| empty($model->createdAtAttribute)) {
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report The property `createdAtAttribute` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
73		return $this;
74		}
75	5	return static::range($this, $model->createdAtAttribute, $start, $end);
76		}
77
78		/**
79		* Specify order by creation time.
80		* @param string $sort only 'ASC' and 'DESC' are acceptable.
81		* @return $this
82		*/
83		public function orderByCreatedAt($sort = 'ASC')
84		{
85		$model = $this->noInitModel;
86		/* @var $model static */
87		if (!is_string($model->createdAtAttribute) \|\| empty($model->createdAtAttribute)) {
88		return $this;
89		}
90		return $this->addOrderBy([$model->createdAtAttribute => $sort]);
		0 ignored issues – show Bug introduced 2017-01-27 06:50 UTC by Report Bug Copy Issue Report It seems like `addOrderBy()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
91		}
92
93		/**
94		* Specify update time range.
95		* @param string $start
96		* @param string $end
97		* @return $this
98		*/
99	7	public function updatedAt($start = null, $end = null)
100		{
101	7	$model = $this->noInitModel;
102		/* @var $model static */
103	7	if (!is_string($model->updatedAtAttribute) \|\| empty($model->updatedAtAttribute)) {
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report The property `updatedAtAttribute` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
104		return $this;
105		}
106	7	return static::range($this, $model->updatedAtAttribute, $start, $end);
107		}
108
109		/**
110		* Specify order by update time.
111		* @param string $sort only 'ASC' and 'DESC' are acceptable.
112		* @return $this
113		*/
114		public function orderByUpdatedAt($sort = 'ASC')
115		{
116		$model = $this->noInitModel;
117		/* @var $model static */
118		if (!is_string($model->updatedAtAttribute) \|\| empty($model->updatedAtAttribute)) {
119		return $this;
120		}
121		return $this->addOrderBy([$model->updatedAtAttribute => $sort]);
		0 ignored issues – show Bug introduced 2017-01-27 06:50 UTC by Report Bug Copy Issue Report It seems like `addOrderBy()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
122		}
123
124		public static $pageAll = 'all';
125		public static $defaultPageSize = 10;
126
127		/**
128		* Specify page condition.
129		* @param string\|int $pageSize It will return all models if it is 'all',
130		* or it will be regarded as sum of models.
131		* @param int $currentPage The current page number if it is integer begun with 0.
132		* @return $this
133		*/
134	3	public function page($pageSize = 10, $currentPage = 0)
135		{
136	3	if ($pageSize === static::$pageAll) {
137	2	return $this;
138		}
139		/* normalize $currentPage and $currentPage */
140	1	if (!is_numeric($currentPage) \|\| $currentPage < 0) {
141	1	$currentPage = 0;
142		}
143	1	$currentPage = (int) $currentPage;
144	1	if (!is_numeric($pageSize) \|\| $pageSize < 1) {
145	1	$pageSize = static::$defaultPageSize;
146		}
147	1	$pageSize = (int) $pageSize;
148	1	return $this->limit($pageSize)->offset($pageSize * $currentPage);
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `limit()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
149		}
150		}
151

rhosocial / yii2-base-models

Push — master ( 616673...9aa93d )

EntityQueryTrait::orderByUpdatedAt() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like