Add undo button to logs.

Author: jacobdekeizer

README.md

@@ -87,6 +87,18 @@ public static function changeLogBookDisplayValue($column, $value)
 }
 ```
 
+If you want to hide the undo button for this model specifically, you can add $logBookUndoable to your model.
+You can also disable the undo button in the log book form widget.
+
+```php
+/**
+ * Hides or shows undo button for current field
+ *
+ * @var bool $logBookLogUndoable
+ */
+public $logBookLogUndoable = false
+```
+
 # Form Widget
 
 You can use the formwidget as follows: <br/>
@@ -100,16 +112,18 @@ Options: <br/>
 | limitPerPage      | 20            | int       |
 | startPage         | 1             | int       |
 | showLogRelations  | null          | array or string |
+| showUndoChangesButton| true       | bool      |
+| refreshFormAfterUndo | true       | bool      |
 
 Example:
 ```yaml
-#tab logbook
 _logbook@update:
     type: jacob_logbook_log
     limitPerPage: 10 #optional
     startPage: 1 #optional
     showLogRelations: #optional (contains the name(s) of the relations)
         - customer
         - anotherRelationName
-    tab: logbook
+    showUndoChangesButton: true
+    refreshFormAfterUndo: false
 ```

formwidgets/LogBook.php

@@ -1,6 +1,9 @@
 <?php namespace Jacob\LogBook\FormWidgets;
 
 use Backend\Classes\FormWidgetBase;
+use Illuminate\Routing\Redirector;
+use Jacob\LogBook\Classes\Entities\Changes;
+use Jacob\Logbook\Models\Log;
 
 /**
  * LogBook Form Widget
@@ -23,6 +26,12 @@ class LogBook extends FormWidgetBase
     /** @var array|string|null  */
     public $showLogRelations = null;
 
+    /** @var bool $showUndoChangeButton */
+    public $showUndoChangesButton = true;
+
+    /** @var bool $refreshFromAfterUndo */
+    public $refreshFormAfterUndo = true;
+
     /**
      * @inheritDoc
      */
@@ -32,6 +41,8 @@ public function init()
             'limitPerPage',
             'startPage',
             'showLogRelations',
+            'showUndoChangesButton',
+            'refreshFormAfterUndo',
         ]);
     }
 
@@ -60,6 +71,7 @@ public function prepareVars()
 
         $this->vars['name'] = $this->formField->getName();
         $this->vars['model'] = $this->model;
+        $this->vars['showUndoChangesButton'] = $this->showUndoChangesButton;
     }
 
     /**
@@ -81,7 +93,7 @@ public function prepareLogs()
      */
     public function onLogBookChangePage()
     {
-        $page = (int)post('page');
+        $page = (int)post('page', 1);
         $this->prepareVars();
         $this->vars['logs'] = $this->model->getLogsFromLogBook(
             $this->limitPerPage,
@@ -94,6 +106,45 @@ public function onLogBookChangePage()
         ];
     }
 
+    /**
+     * Undo change from logbook
+     *
+     * @return mixed
+     * @throws \Exception
+     */
+    public function onLogBookUndoChange()
+    {
+        $id = post('id', null);
+
+        /** @var Log $log */
+        $log = Log::find($id);
+
+        if (!$log || ($log->getAttribute('changes')['type'] ?? null) !== Changes::TYPE_UPDATED) {
+            return $this->onLogBookChangePage();
+        }
+
+        /** @var \Model $modelInstance */
+        $modelInstance = app($log->getAttribute('model'));
+
+        /** @var \Model $changedModel */
+        $changedModel =  $modelInstance->find($log->getAttribute('model_key'));
+
+        /** @var array $changedAttribute */
+        foreach ($log->getAttribute('changes')['changedAttributes'] ?? [] as $changedAttribute) {
+            $changedModel->setAttribute($changedAttribute['column'], $changedAttribute['old']);
+        }
+
+        $changedModel->save();
+
+        if ($this->refreshFormAfterUndo) {
+            /** @var Redirector $redirect */
+            $redirect = resolve(Redirector::class);
+            return $redirect->refresh();
+        }
+
+        return $this->onLogBookChangePage();
+    }
+
     /**
      * @param mixed $value
      * @return null|string

formwidgets/logbook/partials/_logbook.htm

@@ -5,6 +5,9 @@
             <tr>
                 <th><span><?= e(trans('jacob.logbook::lang.log')) ?></span></th>
                 <th><span><?= e(trans('jacob.logbook::lang.date')) ?></span></th>
+                <?php if ($showUndoChangesButton): ?>
+                    <th><span></span></th>
+                <?php endif; ?>
             </tr>
             </thead>
             <tbody>
@@ -21,7 +24,7 @@
                                 'model' => $modelName
                             ])) ?>
                         <?php else: ?>
-                        <?= e(trans('jacob.logbook::lang.changes.unknown', [
+                            <?= e(trans('jacob.logbook::lang.changes.unknown', [
                                 'type' => trans('jacob.logbook::lang.changes.type.' . $changes['type']),
                                 'model' => $modelName
                             ])) ?>
@@ -42,6 +45,22 @@
                     <td>
                         <?= $log->updated_at->format('l j F Y H:i:s') ?>
                     </td>
+                    <?php if ($showUndoChangesButton): ?>
+                        <td>
+                            <?php if ($currentModel->logBookLogUndoable ?? true && $changes['type'] === Jacob\LogBook\Classes\Entities\Changes::TYPE_UPDATED): ?>
+                                <button class="btn btn-primary"
+                                        data-request="onLogBookUndoChange"
+                                        data-request-data="id: <?= $log->getkey() ?>"
+                                        data-request-flash>
+                                    <?= e(trans('jacob.logbook::lang.undo')) ?>
+                                </button>
+                            <?php else: ?>
+                                <button disabled class="btn btn-primary">
+                                    <?= e(trans('jacob.logbook::lang.undo')) ?>
+                                </button>
+                            <?php endif; ?>
+                        </td>
+                    <?php endif; ?>
                 </tr>
             <?php endforeach; ?>
             </tbody>

lang/en/lang.php

@@ -3,6 +3,7 @@
 return [
     'log' => 'Log',
     'date' => 'Date',
+    'undo' => 'Undo',
     'changes' => [
         'user' => ':user has :type :model',
         'unknown' => ':model is :type',

lang/nl/lang.php

@@ -3,14 +3,15 @@
 return [
     'log' => 'Log',
     'date' => 'Datum',
+    'undo' => 'Ongedaan maken',
     'changes' => [
         'user' => ':user heeft :model :type ',
         'unknown' => ':model is :type',
         'type' => [
-            'updated' => 'aangepast',
+            'updated' => 'gewijzigd',
             'created' => 'aangemaakt',
             'deleted' => 'verwijderd',
         ],
-        'column' => ':column is veranderd van :from naar :to'
+        'column' => ':column is gewijzigd van :from naar :to'
     ],
 ];

traits/LogChanges.php

@@ -31,7 +31,7 @@ trait LogChanges
      * If true -> log items are deleted when the model is deleted
      * If false -> a new log item will be created with status deleted.
      *
-     * @var bool
+     * @var bool $deleteLogbookAfterDelete
      *
      * protected $deleteLogbookAfterDelete = false;
      */
@@ -40,9 +40,19 @@ trait LogChanges
      * Here you can override the model name that is displayed in the log files.
      * The name is going to be translated when possible.
      *
+     * string $logBookModelName
+     *
      * public $logBookModelName = 'MyModelName'
      */
 
+    /**
+     * Hides or shows undo button for current field
+     *
+     * @var bool $logBookLogUndoable
+     *
+     * public $logBookLogUndoable = false
+     */
+
     /**
      * If you override this function you can change the value that is displayed in the log book
      * This can be useful for example with a dropdown