OperatorTrait::getOperatorRules() - Code Metrics - rhosocial/yii2-organization - Measure and Improve Code Quality continuously with Scrutinizer

OperatorTrait::getOperatorRules() A
last analyzed 2017-05-03 09:59 UTC

↳ Parent: OperatorTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

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

namespace rhosocial\organization;

use rhosocial\base\models\queries\BaseUserQuery;
use rhosocial\user\User;
use Yii;
use yii\base\Event;
use yii\behaviors\BlameableBehavior;

/**
 * OperatorTrait
 *
 * @property-read User $operator
 * @version 1.0
 * @author vistart <[email protected]>
 */
Trait OperatorTrait
{
    /**
     * @var string
     */
    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()
    {
        return [
            [$this->operatorAttribute, 'safe'],
        ];
    }

    /**
     * @return array
     */
    public function getOperatorLabels()
    {
        return [
            $this->operatorAttribute => Yii::t('organization', 'Operator GUID'),
            'operator' => Yii::t('organization', 'Operator'),
        ];
    }
}


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\organization;
14
15			use rhosocial\base\models\queries\BaseUserQuery;
16			use rhosocial\user\User;
17			use Yii;
18			use yii\base\Event;
19			use yii\behaviors\BlameableBehavior;
20
21			/**
22			* OperatorTrait
23			*
24			* @property-read User $operator
25			* @version 1.0
26			* @author vistart <[email protected]>
27			*/
28			Trait OperatorTrait
29			{
30			/**
31			* @var string
32			*/
33			public $operatorAttribute = 'operator_guid';
34
35			/**
36			* Get operator query.
37			* If you want to get operator, please access [[$operator]] magic-property.
38			* Note: It may return null value! Please check whether the return value is available before accessing.
39			* @return BaseUserQuery
40			*/
41			public function getOperator()
42			{
43			if (empty($this->operatorAttribute) \|\| !is_string($this->operatorAttribute)) {
44			return null;
45			}
46			$userClass = Yii::$app->user->identityClass;
47			$noInit = $userClass::buildNoInitModel();
48			return $this->hasOne($userClass, [$noInit->guidAttribute => $this->operatorAttribute]);
			0 ignored issues – show Bug introduced 2017-04-28 15:52 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...
49			}
50
51			/**
52			* @param Event $event
53			* @return null\|string
54			*/
55			public function onAssignOperator($event)
			0 ignored issues – show Unused Code introduced 2017-04-21 16:56 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...
56			{
57			$identity = Yii::$app->user->identity;
58			if (empty($identity)) {
59			return null;
60			}
61			return $identity->getGUID();
62			}
63
64			/**
65			* @return array
66			*/
67			public function getOperatorBehaviors()
68			{
69			if (!empty($this->operatorAttribute) && is_string($this->operatorAttribute)) {
70			$behaviors[] = [
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-04-28 15:52 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...
71			'class' => BlameableBehavior::class,
72			'createdByAttribute' => false,
73			'updatedByAttribute' => $this->operatorAttribute,
74			'value' => [$this, 'onAssignOperator'],
75			];
76			return $behaviors;
77			}
78			return [];
79			}
80
81			/**
82			* @return array
83			*/
84			public function getOperatorRules()
85			{
86			return [
87			[$this->operatorAttribute, 'safe'],
88			];
89			}
90
91			/**
92			* @return array
93			*/
94			public function getOperatorLabels()
95			{
96			return [
97			$this->operatorAttribute => Yii::t('organization', 'Operator GUID'),
98			'operator' => Yii::t('organization', 'Operator'),
99			];
100			}
101			}
102

rhosocial / yii2-organization

OperatorTrait::getOperatorRules() A last analyzed 2017-05-03 09:59 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

OperatorTrait::getOperatorRules() A
last analyzed 2017-05-03 09:59 UTC