OperatorTrait::getOperator() - Code Metrics - Inspection of "add OperatorTrait." - rhosocial/yii2-base-models - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 47aa95...087102 )

by vistart

created 2017-05-09 08:38 UTC

OperatorTrait::getOperator() A

↳ Parent: OperatorTrait

Complexity

Conditions	3
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	9
rs	9.6666
cc	3
eloc	6
nc	2
nop	0

<?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 rhosocial\base\models\queries\BaseUserQuery;
use Yii;
use yii\base\Event;
use yii\behaviors\BlameableBehavior;

/**
 * OperatorTrait
 *
 * Before using model with this trait, you need attach the rules and behaviors associated with 'operatorAttribute' to
 * model if you feel it is necessary, like following:
 * ```php
 * public function rules()
 * {
 *     return array_merge(parent::rules(), $this->getOperatorRules());
 * }
 *
 * public function behaviors()
 * {
 *     return array_merge(parent::behaviors(), $this->getOperatorBehaviors());
 * }
 * ```
 *
 * @property-read BaseUserModel $operator
 * @version 1.0
 * @author vistart <[email protected]>
 */
Trait OperatorTrait
{
    /**
     * @var string|bool the attribute that stores the operator's GUID.
     * If you do not want to use this feature, please set false.
     */
    public $operatorAttribute = 'operator_guid';

    /**
     * Get operator query.
     * If you want to get operator, please access [[$operator]] magic-property.
     * Note: It may return null value! Please check whether the return value is available before accessing.
     * @return BaseUserQuery
     */
    public function getOperator()
    {
        if (empty($this->operatorAttribute) || !is_string($this->operatorAttribute)) {
            return null;
        }
        $userClass = Yii::$app->user->identityClass;
        $noInit = $userClass::buildNoInitModel();
        return $this->hasOne($userClass, [$noInit->guidAttribute => $this->operatorAttribute]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @param Event $event
     * @return null|string
     */
    public function onAssignOperator($event)

    {
        $identity = Yii::$app->user->identity;
        if (empty($identity)) {
            return null;
        }
        return $identity->getGUID();
    }

    /**
     * @return array
     */
    public function getOperatorBehaviors()
    {
        if (!empty($this->operatorAttribute) && is_string($this->operatorAttribute)) {
            $behaviors[] = [
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                'class' => BlameableBehavior::class,
                'createdByAttribute' => false,
                'updatedByAttribute' => $this->operatorAttribute,
                'value' => [$this, 'onAssignOperator'],
            ];
            return $behaviors;
        }
        return [];
    }

    /**
     * @return array
     */
    public function getOperatorRules()
    {
        if (!empty($this->operatorAttribute) && is_string($this->operatorAttribute)) {
            return [
                [$this->operatorAttribute, 'safe'],
            ];
        }
        return [];
    }
}


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 rhosocial\base\models\queries\BaseUserQuery;
17			use Yii;
18			use yii\base\Event;
19			use yii\behaviors\BlameableBehavior;
20
21			/**
22			* OperatorTrait
23			*
24			* Before using model with this trait, you need attach the rules and behaviors associated with 'operatorAttribute' to
25			* model if you feel it is necessary, like following:
26			* ```php
27			* public function rules()
28			* {
29			* return array_merge(parent::rules(), $this->getOperatorRules());
30			* }
31			*
32			* public function behaviors()
33			* {
34			* return array_merge(parent::behaviors(), $this->getOperatorBehaviors());
35			* }
36			* ```
37			*
38			* @property-read BaseUserModel $operator
39			* @version 1.0
40			* @author vistart <[email protected]>
41			*/
42			Trait OperatorTrait
43			{
44			/**
45			* @var string\|bool the attribute that stores the operator's GUID.
46			* If you do not want to use this feature, please set false.
47			*/
48			public $operatorAttribute = 'operator_guid';
49
50			/**
51			* Get operator query.
52			* If you want to get operator, please access [[$operator]] magic-property.
53			* Note: It may return null value! Please check whether the return value is available before accessing.
54			* @return BaseUserQuery
55			*/
56			public function getOperator()
57			{
58			if (empty($this->operatorAttribute) \|\| !is_string($this->operatorAttribute)) {
59			return null;
60			}
61			$userClass = Yii::$app->user->identityClass;
62			$noInit = $userClass::buildNoInitModel();
63			return $this->hasOne($userClass, [$noInit->guidAttribute => $this->operatorAttribute]);
			0 ignored issues – show Bug introduced 2017-05-09 08:55 UTC by Report Bug Copy Issue Report It seems like `hasOne()` 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...
64			}
65
66			/**
67			* @param Event $event
68			* @return null\|string
69			*/
70			public function onAssignOperator($event)
			0 ignored issues – show Unused Code introduced 2017-05-09 08:55 UTC by Report Bug Copy Issue Report The parameter `$event` 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...
71			{
72			$identity = Yii::$app->user->identity;
73			if (empty($identity)) {
74			return null;
75			}
76			return $identity->getGUID();
77			}
78
79			/**
80			* @return array
81			*/
82			public function getOperatorBehaviors()
83			{
84			if (!empty($this->operatorAttribute) && is_string($this->operatorAttribute)) {
85			$behaviors[] = [
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-05-09 08:55 UTC by Report Bug Copy Issue Report `$behaviors` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$behaviors = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
86			'class' => BlameableBehavior::class,
87			'createdByAttribute' => false,
88			'updatedByAttribute' => $this->operatorAttribute,
89			'value' => [$this, 'onAssignOperator'],
90			];
91			return $behaviors;
92			}
93			return [];
94			}
95
96			/**
97			* @return array
98			*/
99			public function getOperatorRules()
100			{
101			if (!empty($this->operatorAttribute) && is_string($this->operatorAttribute)) {
102			return [
103			[$this->operatorAttribute, 'safe'],
104			];
105			}
106			return [];
107			}
108			}
109

rhosocial / yii2-base-models

Push — master ( 47aa95...087102 )

OperatorTrait::getOperator() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like