Completed
Push — master ( 17b522...72c996 )
by vistart
07:24
created

OperatorTrait::onAssignOperator()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 8
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 8
rs 9.4285
cc 2
eloc 5
nc 2
nop 1
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 Yii;
17
use yii\base\Event;
18
use yii\behaviors\BlameableBehavior;
19
20
/**
21
 * OperatorTrait
22
 * @version 1.0
23
 * @author vistart <[email protected]>
24
 */
25
Trait OperatorTrait
26
{
27
    /**
28
     * @var string
29
     */
30
    public $operatorAttribute = 'operator_guid';
31
32
    /**
33
     * Get operator query.
34
     * If you want to get operator, please access [[$operator]] magic-property.
35
     * @return BaseUserQuery
36
     */
37
    public function getOperator()
38
    {
39
        if (empty($this->operatorAttribute) || !is_string($this->operatorAttribute)) {
40
            return null;
41
        }
42
        $userClass = Yii::$app->user->identityClass;
43
        $noInit = $userClass::buildNoInitModel();
44
        return $this->hasOne($userClass, [$noInit->guidAttribute => $this->operatorAttribute]);
0 ignored issues
show
Bug introduced by
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...
45
    }
46
47
    /**
48
     * @param Event $event
49
     * @return null|string
50
     */
51
    public function onAssignOperator($event)
0 ignored issues
show
Unused Code introduced by
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...
52
    {
53
        $identity = Yii::$app->user->identity;
54
        if (empty($identity)) {
55
            return null;
56
        }
57
        return $identity->getGUID();
58
    }
59
60
    /**
61
     * @return array
62
     */
63
    public function getOperatorBehaviors()
64
    {
65
        if (!empty($this->operatorAttribute) && is_string($this->operatorAttribute)) {
66
            $behaviors[] = [
0 ignored issues
show
Coding Style Comprehensibility introduced by
$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...
67
                'class' => BlameableBehavior::class,
68
                'createdByAttribute' => false,
69
                'updatedByAttribute' => $this->operatorAttribute,
70
                'value' => [$this, 'onAssignOperator'],
71
            ];
72
            return $behaviors;
73
        }
74
        return [];
75
    }
76
77
    /**
78
     * @return array
79
     */
80
    public function getOperatorRules()
81
    {
82
        return [
83
            [$this->operatorAttribute, 'safe'],
84
        ];
85
    }
86
87
    /**
88
     * @return array
89
     */
90
    public function getOperatorLabels()
91
    {
92
        return [
93
            $this->operatorAttribute => Yii::t('organization', 'Operator'),
94
        ];
95
    }
96
}
97