BlameableQueryTrait - Code Metrics - rhosocial/yii2-base-models - Measure and Improve Code Quality continuously with Scrutinizer

BlameableQueryTrait A
last analyzed 2017-05-15 05:37 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

91.43%

Importance

Changes

Metric	Value
wmc	17
lcom	1
cbo	2
dl	0
loc	99
ccs	32
cts	35
cp	0.9143
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Size	Complexity
A	content()	5	1
A	updatedBy()	11	3
A	confirmed()	8	2
A	createdBy()	11	4
A	parentGuid()	11	3
A	byIdentity()	10	4

<?php

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

namespace rhosocial\base\models\traits;

use rhosocial\base\models\models\BaseUserModel;
use Yii;

/**
 * This trait is used for building blameable query class for blameable model,
 * which would be attached three conditions.
 * For example:
 * ```php
 * class BlameableQuery {
 *     use BlameableQueryTrait;
 * }
 * ```
 *
 * @version 1.0
 * @author vistart <[email protected]>
 */
trait BlameableQueryTrait
{
    use QueryTrait;

    /**
     * Specify confirmation.
     * @param boolean $isConfirmed
     * @return $this
     */
    public function confirmed($isConfirmed = true)
    {
        $model = $this->noInitModel;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        if (!is_string($model->confirmationAttribute)) {
            return $this;
        }
        return $this->andWhere([$model->confirmationAttribute => $isConfirmed]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Specify content.
     * @param mixed $content
     * @param false|string $like false, 'like', 'or like', 'not like', 'or not like'.
     * @return $this
     */
    public function content($content, $like = false)
    {
        $model = $this->noInitModel;
        return $this->likeCondition($content, $model->contentAttribute, $like);
    }

    /**
     * Specify parent.
     * @param array|string $guid parent guid or array of them. non-parent if
     * empty. If you don't want to specify parent, please do not access this
     * method.
     * @return $this
     */
    public function parentGuid($guid)
    {
        $model = $this->noInitModel;
        if (!is_string($model->parentAttribute)) {
            return $this;
        }
        if ($guid instanceof $model) {
            $guid = $guid->getGUID();
        }
        return $this->andWhere([$model->parentAttribute => $guid]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Specify creator(s).
     * @param string|array $guid
     * @return $this
     */
    public function createdBy($guid)
    {
        $model = $this->noInitModel;
        if (!is_string($model->createdByAttribute) || empty($model->createdByAttribute)) {
            return $this;
        }
        if ($guid instanceof BaseUserModel) {
            $guid = $guid->getGUID();
        }
        return $this->andWhere([$model->createdByAttribute => $guid]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Specify last updater(s).
     * @param string|array $guid
     * @return $this
     */
    public function updatedBy($guid)
    {
        $model = $this->noInitModel;
        if (!is_string($model->updatedByAttribute)) {
            return $this;
        }
        if ($guid instanceof BaseUserModel) {
            $guid = $guid->getGUID();
        }
        return $this->andWhere([$model->updatedByAttribute => $guid]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Attach current identity to createdBy condition.
     * @param BaseUserModel $identity
     * @return $this
     */
    public function byIdentity($identity = null)
    {
        if (!$identity) {
            $identity = Yii::$app->user->identity;
        }
        if (method_exists($identity, 'canGetProperty') && !$identity->canGetProperty('guid')) {
            return $this;
        }
        return $this->createdBy($identity->getGUID());
    }
}


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		use rhosocial\base\models\models\BaseUserModel;
16		use Yii;
17
18		/**
19		* This trait is used for building blameable query class for blameable model,
20		* which would be attached three conditions.
21		* For example:
22		* ```php
23		* class BlameableQuery {
24		* use BlameableQueryTrait;
25		* }
26		* ```
27		*
28		* @version 1.0
29		* @author vistart <[email protected]>
30		*/
31		trait BlameableQueryTrait
32		{
33		use QueryTrait;
34
35		/**
36		* Specify confirmation.
37		* @param boolean $isConfirmed
38		* @return $this
39		*/
40	4	public function confirmed($isConfirmed = true)
41		{
42	4	$model = $this->noInitModel;
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report The property `noInitModel` 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...
43	4	if (!is_string($model->confirmationAttribute)) {
44	3	return $this;
45		}
46	1	return $this->andWhere([$model->confirmationAttribute => $isConfirmed]);
		0 ignored issues – show Bug introduced 2017-01-12 08:52 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...
47		}
48
49		/**
50		* Specify content.
51		* @param mixed $content
52		* @param false\|string $like false, 'like', 'or like', 'not like', 'or not like'.
53		* @return $this
54		*/
55	4	public function content($content, $like = false)
56		{
57	4	$model = $this->noInitModel;
58	4	return $this->likeCondition($content, $model->contentAttribute, $like);
59		}
60
61		/**
62		* Specify parent.
63		* @param array\|string $guid parent guid or array of them. non-parent if
64		* empty. If you don't want to specify parent, please do not access this
65		* method.
66		* @return $this
67		*/
68	2	public function parentGuid($guid)
69		{
70	2	$model = $this->noInitModel;
71	2	if (!is_string($model->parentAttribute)) {
72	1	return $this;
73		}
74	1	if ($guid instanceof $model) {
75	1	$guid = $guid->getGUID();
76		}
77	1	return $this->andWhere([$model->parentAttribute => $guid]);
		0 ignored issues – show Bug introduced 2017-01-12 08:52 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...
78		}
79
80		/**
81		* Specify creator(s).
82		* @param string\|array $guid
83		* @return $this
84		*/
85	24	public function createdBy($guid)
86		{
87	24	$model = $this->noInitModel;
88	24	if (!is_string($model->createdByAttribute) \|\| empty($model->createdByAttribute)) {
89		return $this;
90		}
91	24	if ($guid instanceof BaseUserModel) {
92	14	$guid = $guid->getGUID();
93		}
94	24	return $this->andWhere([$model->createdByAttribute => $guid]);
		0 ignored issues – show Bug introduced 2017-01-12 08:52 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...
95		}
96
97		/**
98		* Specify last updater(s).
99		* @param string\|array $guid
100		* @return $this
101		*/
102	2	public function updatedBy($guid)
103		{
104	2	$model = $this->noInitModel;
105	2	if (!is_string($model->updatedByAttribute)) {
106		return $this;
107		}
108	2	if ($guid instanceof BaseUserModel) {
109	2	$guid = $guid->getGUID();
110		}
111	2	return $this->andWhere([$model->updatedByAttribute => $guid]);
		0 ignored issues – show Bug introduced 2017-01-12 08:52 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...
112		}
113
114		/**
115		* Attach current identity to createdBy condition.
116		* @param BaseUserModel $identity
117		* @return $this
118		*/
119	10	public function byIdentity($identity = null)
120		{
121	10	if (!$identity) {
122	2	$identity = Yii::$app->user->identity;
123		}
124	10	if (method_exists($identity, 'canGetProperty') && !$identity->canGetProperty('guid')) {
125		return $this;
126		}
127	10	return $this->createdBy($identity->getGUID());
128		}
129		}
130

rhosocial / yii2-base-models

BlameableQueryTrait A last analyzed 2017-05-15 05:37 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Duplication Side-by-Side

Filter issues like

BlameableQueryTrait A
last analyzed 2017-05-15 05:37 UTC