1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Yajra\Auditable; |
4
|
|
|
|
5
|
|
|
use Illuminate\Database\Eloquent\Builder; |
6
|
|
|
|
7
|
|
|
/** |
8
|
|
|
* @property mixed creator |
9
|
|
|
* @property mixed updater |
10
|
|
|
*/ |
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() |
40
|
|
|
{ |
41
|
|
|
if (property_exists($this, 'auditUser')) { |
42
|
|
|
return $this->auditUser; |
|
|
|
|
43
|
|
|
} |
44
|
|
|
|
45
|
|
|
return config('auth.providers.users.model', 'App\User'); |
46
|
|
|
} |
47
|
|
|
|
48
|
|
|
/** |
49
|
|
|
* Get column name for created by. |
50
|
|
|
* |
51
|
|
|
* @return string |
52
|
|
|
*/ |
53
|
|
|
public function getCreatedByColumn() |
54
|
|
|
{ |
55
|
|
|
return defined('static::CREATED_BY') ? static::CREATED_BY : 'created_by'; |
56
|
|
|
} |
57
|
|
|
|
58
|
|
|
/** |
59
|
|
|
* Get user model who updated the record. |
60
|
|
|
* |
61
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo |
62
|
|
|
*/ |
63
|
|
|
public function updater() |
64
|
|
|
{ |
65
|
|
|
return $this->belongsTo($this->getUserClass(), $this->getUpdatedByColumn()) |
66
|
|
|
->withDefault(config('auditable.defaults.updater')); |
67
|
|
|
} |
68
|
|
|
|
69
|
|
|
/** |
70
|
|
|
* Get column name for updated by. |
71
|
|
|
* |
72
|
|
|
* @return string |
73
|
|
|
*/ |
74
|
|
|
public function getUpdatedByColumn() |
75
|
|
|
{ |
76
|
|
|
return defined('static::UPDATED_BY') ? static::UPDATED_BY : 'updated_by'; |
77
|
|
|
} |
78
|
|
|
|
79
|
|
|
/** |
80
|
|
|
* Get created by user full name. |
81
|
|
|
* |
82
|
|
|
* @return string |
83
|
|
|
*/ |
84
|
|
|
public function getCreatedByNameAttribute() |
85
|
|
|
{ |
86
|
|
|
return $this->creator->name ?? ''; |
87
|
|
|
} |
88
|
|
|
|
89
|
|
|
/** |
90
|
|
|
* Get updated by user full name. |
91
|
|
|
* |
92
|
|
|
* @return string |
93
|
|
|
*/ |
94
|
|
|
public function getUpdatedByNameAttribute() |
95
|
|
|
{ |
96
|
|
|
return $this->updater->name ?? ''; |
97
|
|
|
} |
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) |
106
|
|
|
{ |
107
|
|
|
return $query->where($this->getQualifiedUserIdColumn(), auth()->id()); |
108
|
|
|
} |
109
|
|
|
|
110
|
|
|
/** |
111
|
|
|
* Get qualified column name for user id. |
112
|
|
|
* |
113
|
|
|
* @return string |
114
|
|
|
*/ |
115
|
|
|
public function getQualifiedUserIdColumn() |
116
|
|
|
{ |
117
|
|
|
return $this->getTable() . '.' . $this->getUserInstance()->getKey(); |
118
|
|
|
} |
119
|
|
|
|
120
|
|
|
/** |
121
|
|
|
* Get Laravel's user class instance. |
122
|
|
|
* |
123
|
|
|
* @return \Illuminate\Database\Eloquent\Model |
124
|
|
|
*/ |
125
|
|
|
public function getUserInstance() |
126
|
|
|
{ |
127
|
|
|
$class = $this->getUserClass(); |
128
|
|
|
|
129
|
|
|
return new $class; |
130
|
|
|
} |
131
|
|
|
} |
132
|
|
|
|
In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:
Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: