QueryTrait - Code Metrics - Inspection of "add getApi methods." - vistart/yii2-models - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 96fdaa...0a9a0f )

by vistart

created 2016-02-23 08:54 UTC

QueryTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
wmc	6
c	5
b	0
f	0
lcom	0
cbo	1
dl	0
loc	40
ccs	14
cts	14
cp	1
rs	10

2 Methods

Rating	Name	Duplication	Size	Complexity
A	range()	0	10	3
A	likeCondition()	0	10	3

<?php

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

namespace vistart\Models\traits;

/**
 * This trait attach two base condition.
 *
 * @version 2.0
 * @author vistart <[email protected]>
 */
trait QueryTrait
{

    /**
     * Attach like condition.
     * @param mixed $value
     * @param string $attribute
     * @param string|false $like
     * @return $this
     */
    protected function likeCondition($value, $attribute, $like = false)
    {
        if (!is_string($attribute)) {
            return $this;
        }
        if ($like) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return $this->andWhere([$like, $attribute, $value]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
        return $this->andWhere([$attribute => $value]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Specify range wilth $attribute to $query.
     * @param \yii\db\ActiveQuery $query
     * @param string $attribute
     * @param string $start
     * @param string $end
     * @return $query

     */
    protected static function range($query, $attribute, $start = null, $end = null)
    {
        if (!empty($start)) {
            $query = $query->andWhere(['>=', $attribute, $start]);
        }
        if (!empty($end)) {
            $query = $query->andWhere(['<', $attribute, $end]);
        }
        return $query;
    }
}


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		/**
16		* This trait attach two base condition.
17		*
18		* @version 2.0
19		* @author vistart <[email protected]>
20		*/
21		trait QueryTrait
22		{
23
24		/**
25		* Attach like condition.
26		* @param mixed $value
27		* @param string $attribute
28		* @param string\|false $like
29		* @return $this
30		*/
31	17	protected function likeCondition($value, $attribute, $like = false)
32		{
33	17	if (!is_string($attribute)) {
34	2	return $this;
35		}
36	17	if ($like) {
		0 ignored issues – show Bug Best Practice introduced 2016-01-29 17:04 UTC by Report Bug Copy Issue Report The expression `$like` of type `false\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
37	5	return $this->andWhere([$like, $attribute, $value]);
		0 ignored issues – show Bug introduced 2016-01-29 17:04 UTC by Report Bug Copy Issue Report It seems like `andWhere()` 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...
38		}
39	16	return $this->andWhere([$attribute => $value]);
		0 ignored issues – show Bug introduced 2016-01-29 17:04 UTC by Report Bug Copy Issue Report It seems like `andWhere()` 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...
40		}
41
42		/**
43		* Specify range wilth $attribute to $query.
44		* @param \yii\db\ActiveQuery $query
45		* @param string $attribute
46		* @param string $start
47		* @param string $end
48		* @return $query
		0 ignored issues – show Documentation introduced 2016-01-29 17:04 UTC by Report Bug Copy Issue Report The doc-type `$query` could not be parsed: Unknown type name "$query" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
49		*/
50	1	protected static function range($query, $attribute, $start = null, $end = null)
51		{
52	1	if (!empty($start)) {
53	1	$query = $query->andWhere(['>=', $attribute, $start]);
54	1	}
55	1	if (!empty($end)) {
56	1	$query = $query->andWhere(['<', $attribute, $end]);
57	1	}
58	1	return $query;
59		}
60		}
61

vistart / yii2-models

Push — master ( 96fdaa...0a9a0f )

QueryTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

2 Methods

Duplication Side-by-Side

Filter issues like