-
-
Notifications
You must be signed in to change notification settings - Fork 25
/
Revisionable.php
220 lines (182 loc) · 5.85 KB
/
Revisionable.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<?php namespace Winter\Storm\Database\Traits;
use DateTime;
use Exception;
use Illuminate\Database\Eloquent\Model as EloquentModel;
use Winter\Storm\Support\Facades\DB;
trait Revisionable
{
/**
* @var array List of attributes to monitor for changes and store revisions for.
*
* protected $revisionable = [];
*/
/**
* @var int Maximum number of revision records to keep.
*
* public $revisionableLimit = 500;
*/
/**
* @var bool Flag for ignoring revision records with the same old and new values.
*
* public $revisionIgnoreSameValue = false;
*/
/*
* You can change the relation name used to store revisions:
*
* const REVISION_HISTORY = 'revision_history';
*/
/**
* @var bool Flag for arbitrarily disabling revision history.
*/
public $revisionsEnabled = true;
/**
* Boot the revisionable trait for a model.
* @return void
*/
public static function bootRevisionable()
{
if (!property_exists(get_called_class(), 'revisionable')) {
throw new Exception(sprintf(
'You must define a $revisionable property in %s to use the Revisionable trait.',
get_called_class()
));
}
static::extend(function ($model) {
$model->bindEvent('model.afterUpdate', function () use ($model) {
$model->revisionableAfterUpdate();
});
$model->bindEvent('model.afterDelete', function () use ($model) {
$model->revisionableAfterDelete();
});
});
}
public function revisionableAfterUpdate()
{
if (!$this->revisionsEnabled) {
return;
}
$relation = $this->getRevisionHistoryName();
$relationObject = $this->{$relation}();
$revisionModel = $relationObject->getRelated();
$toSave = [];
$dirty = $this->getDirty();
foreach ($dirty as $attribute => $value) {
if (!in_array($attribute, $this->revisionable)) {
continue;
}
$oldValue = array_get($this->original, $attribute);
if($this->ignoreRevisionSameValue($oldValue, $value)){
continue;
}
$toSave[] = [
'field' => $attribute,
'old_value' => $oldValue,
'new_value' => $value,
'revisionable_type' => $relationObject->getMorphClass(),
'revisionable_id' => $this->getKey(),
'user_id' => $this->revisionableGetUser(),
'cast' => $this->revisionableGetCastType($attribute),
'created_at' => new DateTime,
'updated_at' => new DateTime
];
}
// Nothing to do
if (!count($toSave)) {
return;
}
DB::table($revisionModel->getTable())->insert($toSave);
$this->revisionableCleanUp();
}
public function revisionableAfterDelete()
{
if (!$this->revisionsEnabled) {
return;
}
$softDeletes = in_array(
'Winter\Storm\Database\Traits\SoftDelete',
class_uses_recursive(get_class($this))
);
if (!$softDeletes) {
return;
}
if (!in_array('deleted_at', $this->revisionable)) {
return;
}
$relation = $this->getRevisionHistoryName();
$relationObject = $this->{$relation}();
$revisionModel = $relationObject->getRelated();
$toSave = [
'field' => 'deleted_at',
'old_value' => null,
'new_value' => $this->deleted_at,
'revisionable_type' => $relationObject->getMorphClass(),
'revisionable_id' => $this->getKey(),
'user_id' => $this->revisionableGetUser(),
'created_at' => new DateTime,
'updated_at' => new DateTime
];
Db::table($revisionModel->getTable())->insert($toSave);
$this->revisionableCleanUp();
}
/**
* Identify if the revision should be ignored if the old and new values are the same.
*
* @param mixed $oldValue
* @param mixed $newValue
* @return bool
*/
public function ignoreRevisionSameValue($oldValue, $newValue)
{
$revisionIgnoreSameValue = property_exists($this, 'revisionIgnoreSameValue')
? $this->revisionIgnoreSameValue
: false;
if(!$revisionIgnoreSameValue){
return false;
}
return $oldValue == $newValue;
}
/*
* Deletes revision records exceeding the limit.
*/
protected function revisionableCleanUp()
{
$relation = $this->getRevisionHistoryName();
$relationObject = $this->{$relation}();
$revisionLimit = property_exists($this, 'revisionableLimit')
? (int) $this->revisionableLimit
: 500;
$toDelete = $relationObject
->orderBy('id', 'desc')
->skip($revisionLimit)
->limit(64)
->get();
foreach ($toDelete as $record) {
$record->delete();
}
}
protected function revisionableGetCastType($attribute)
{
if (in_array($attribute, $this->getDates())) {
return 'date';
}
return null;
}
protected function revisionableGetUser()
{
if (method_exists($this, 'getRevisionableUser')) {
$user = $this->getRevisionableUser();
return $user instanceof EloquentModel
? $user->getKey()
: $user;
}
return null;
}
/**
* Get revision history relation name name.
* @return string
*/
public function getRevisionHistoryName()
{
return defined('static::REVISION_HISTORY') ? static::REVISION_HISTORY : 'revision_history';
}
}