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]); |
|
|
|
|
64
|
|
|
} |
65
|
|
|
|
66
|
|
|
/** |
67
|
|
|
* @param Event $event |
68
|
|
|
* @return null|string |
69
|
|
|
*/ |
70
|
|
|
public function onAssignOperator($event) |
|
|
|
|
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[] = [ |
|
|
|
|
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
|
|
|
|
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
The trait
Idable
provides a methodequalsId
that in turn relies on the methodgetId()
. 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.