1 | <?php |
||
11 | trait AuditableTrait |
||
12 | { |
||
13 | /** |
||
14 | * Boot the audit trait for a model. |
||
15 | * |
||
16 | * @return void |
||
17 | */ |
||
18 | public static function bootAuditableTrait() |
||
19 | { |
||
20 | static::observe(new AuditableTraitObserver); |
||
21 | } |
||
22 | |||
23 | /** |
||
24 | * Get user model who created the record. |
||
25 | * |
||
26 | * @return \Illuminate\Database\Eloquent\Relations\BelongsTo |
||
27 | */ |
||
28 | public function creator() |
||
29 | { |
||
30 | return $this->belongsTo($this->getUserClass(), $this->getCreatedByColumn()) |
||
|
|||
31 | ->withDefault(config('auditable.defaults.creator')); |
||
32 | } |
||
33 | |||
34 | /** |
||
35 | * Get user class. |
||
36 | * |
||
37 | * @return string |
||
38 | */ |
||
39 | protected function getUserClass() |
||
47 | |||
48 | /** |
||
49 | * Get column name for created by. |
||
50 | * |
||
51 | * @return string |
||
52 | */ |
||
53 | public function getCreatedByColumn() |
||
57 | |||
58 | /** |
||
59 | * Get user model who updated the record. |
||
60 | * |
||
61 | * @return \Illuminate\Database\Eloquent\Relations\BelongsTo |
||
62 | */ |
||
63 | public function updater() |
||
68 | |||
69 | /** |
||
70 | * Get column name for updated by. |
||
71 | * |
||
72 | * @return string |
||
73 | */ |
||
74 | public function getUpdatedByColumn() |
||
78 | |||
79 | /** |
||
80 | * Get created by user full name. |
||
81 | * |
||
82 | * @return string |
||
83 | */ |
||
84 | public function getCreatedByNameAttribute() |
||
88 | |||
89 | /** |
||
90 | * Get updated by user full name. |
||
91 | * |
||
92 | * @return string |
||
93 | */ |
||
94 | public function getUpdatedByNameAttribute() |
||
98 | |||
99 | /** |
||
100 | * Query scope to limit results to own records. |
||
101 | * |
||
102 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
103 | * @return \Illuminate\Database\Eloquent\Builder |
||
104 | */ |
||
105 | public function scopeOwned(Builder $query) |
||
109 | |||
110 | /** |
||
111 | * Get qualified column name for user id. |
||
112 | * |
||
113 | * @return string |
||
114 | */ |
||
115 | public function getQualifiedUserIdColumn() |
||
119 | |||
120 | /** |
||
121 | * Get Laravel's user class instance. |
||
122 | * |
||
123 | * @return \Illuminate\Database\Eloquent\Model |
||
124 | */ |
||
125 | public function getUserInstance() |
||
131 | } |
||
132 |
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.