|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* _ __ __ _____ _____ ___ ____ _____ |
|
5
|
|
|
* | | / // // ___//_ _// || __||_ _| |
|
6
|
|
|
* | |/ // /(__ ) / / / /| || | | | |
|
7
|
|
|
* |___//_//____/ /_/ /_/ |_||_| |_| |
|
8
|
|
|
* @link http://vistart.name/ |
|
9
|
|
|
* @copyright Copyright (c) 2016 vistart |
|
10
|
|
|
* @license http://vistart.name/license/ |
|
11
|
|
|
*/ |
|
12
|
|
|
|
|
13
|
|
|
namespace vistart\Models\traits; |
|
14
|
|
|
|
|
15
|
|
|
use vistart\helpers\Number; |
|
16
|
|
|
use yii\base\ModelEvent; |
|
17
|
|
|
|
|
18
|
|
|
/** |
|
19
|
|
|
* Entity features concerning GUID. |
|
20
|
|
|
* @property-read array $guidRules |
|
21
|
|
|
* @property string $guid |
|
22
|
|
|
* @version 2.0 |
|
23
|
|
|
* @author vistart <[email protected]> |
|
24
|
|
|
*/ |
|
25
|
|
|
trait GUIDTrait |
|
26
|
|
|
{ |
|
27
|
|
|
|
|
28
|
|
|
/** |
|
29
|
|
|
* @var string REQUIRED. The attribute that will receive the GUID value. |
|
30
|
|
|
*/ |
|
31
|
|
|
public $guidAttribute = 'guid'; |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* Attach `onInitGuidAttribute` event. |
|
35
|
|
|
* @param string $eventName |
|
36
|
|
|
*/ |
|
37
|
62 |
|
protected function attachInitGuidEvent($eventName) |
|
38
|
|
|
{ |
|
39
|
62 |
|
$this->on($eventName, [$this, 'onInitGuidAttribute']); |
|
|
|
|
|
|
40
|
62 |
|
} |
|
41
|
|
|
|
|
42
|
|
|
/** |
|
43
|
|
|
* Initialize the GUID attribute with new generated GUID. |
|
44
|
|
|
* This method is ONLY used for being triggered by event. DO NOT call, |
|
45
|
|
|
* override or modify it directly, unless you know the consequences. |
|
46
|
|
|
* @param Event $event |
|
47
|
|
|
* @since 1.1 |
|
48
|
|
|
*/ |
|
49
|
62 |
|
public function onInitGuidAttribute($event) |
|
50
|
|
|
{ |
|
51
|
62 |
|
$sender = $event->sender; |
|
52
|
62 |
|
$guidAttribute = $sender->guidAttribute; |
|
53
|
62 |
|
if (is_string($guidAttribute)) { |
|
54
|
61 |
|
$sender->$guidAttribute = static::generateGuid(); |
|
55
|
61 |
|
} |
|
56
|
62 |
|
} |
|
57
|
|
|
|
|
58
|
|
|
/** |
|
59
|
|
|
* Generate GUID. It will check if the generated GUID existed in database |
|
60
|
|
|
* table, if existed, it will regenerate one. |
|
61
|
|
|
* @return string the generated GUID. |
|
62
|
|
|
*/ |
|
63
|
61 |
|
public static function generateGuid() |
|
64
|
|
|
{ |
|
65
|
61 |
|
return Number::guid(); |
|
66
|
|
|
} |
|
67
|
|
|
|
|
68
|
|
|
/** |
|
69
|
|
|
* Check if the $uuid existed in current database table. |
|
70
|
|
|
* @param string $guid the GUID to be checked. |
|
71
|
|
|
* @return boolean Whether the $guid exists or not. |
|
72
|
|
|
*/ |
|
73
|
|
|
public static function checkGuidExists($guid) |
|
74
|
|
|
{ |
|
75
|
|
|
return (self::findOne($guid) !== null); |
|
76
|
|
|
} |
|
77
|
|
|
|
|
78
|
|
|
/** |
|
79
|
|
|
* Get the rules associated with guid attribute. |
|
80
|
|
|
* @return array rules. |
|
81
|
|
|
*/ |
|
82
|
17 |
|
public function getGuidRules() |
|
83
|
|
|
{ |
|
84
|
17 |
|
$rules = []; |
|
85
|
17 |
|
if (is_string($this->guidAttribute)) { |
|
86
|
|
|
$rules = [ |
|
87
|
12 |
|
[[$this->guidAttribute], 'required',], |
|
88
|
12 |
|
[[$this->guidAttribute], 'unique',], |
|
89
|
12 |
|
[[$this->guidAttribute], 'string', 'max' => 36], |
|
90
|
12 |
|
]; |
|
91
|
12 |
|
} |
|
92
|
17 |
|
return $rules; |
|
93
|
|
|
} |
|
94
|
|
|
|
|
95
|
|
|
/** |
|
96
|
|
|
* Get guid, in spite of guid attribute name. |
|
97
|
|
|
* @return string |
|
98
|
|
|
*/ |
|
99
|
2 |
|
public function getGuid() |
|
100
|
|
|
{ |
|
101
|
2 |
|
$guidAttribute = $this->guidAttribute; |
|
102
|
2 |
|
return is_string($guidAttribute) ? $this->$guidAttribute : null; |
|
103
|
|
|
} |
|
104
|
|
|
|
|
105
|
|
|
/** |
|
106
|
|
|
* Set guid, in spite of guid attribute name. |
|
107
|
|
|
* @param string $guid |
|
108
|
|
|
* @return string |
|
109
|
|
|
*/ |
|
110
|
|
|
public function setGuid($guid) |
|
111
|
|
|
{ |
|
112
|
|
|
$guidAttribute = $this->guidAttribute; |
|
113
|
|
|
return is_string($guidAttribute) ? $this->$guidAttribute = $guid : null; |
|
114
|
|
|
} |
|
115
|
|
|
} |
|
116
|
|
|
|
vistart /
yii2-models
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
Idableprovides a methodequalsIdthat 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.