Add support for soft deleted models, clean up code and drop support for php 7.0

Author: jacobdekeizer

Diff for: CHANGELOG.md

@@ -0,0 +1,4 @@
+# 2.0.0
+- Refactor codebase
+- Drop support for php 7.0
+- Add support for soft deleted models

Diff for: Plugin.php

@@ -1,50 +1,35 @@
-<?php namespace Jacob\Logbook;
+<?php
+
+namespace Jacob\Logbook;
 
 use Jacob\LogBook\FormWidgets\LogBook;
 use Jacob\Logbook\ReportWidgets\LogBookModelChanges;
 use System\Classes\PluginBase;
 
-/**
- * Logbook Plugin Information File
- */
 class Plugin extends PluginBase
 {
-    /**
-     * Returns information about this plugin.
-     *
-     * @return array
-     */
-    public function pluginDetails()
+    public function pluginDetails(): array
     {
         return [
-            'name'        => 'Logbook',
+            'name' => 'Logbook',
             'description' => 'Creates a logbook based on changes in a model',
-            'author'      => 'Jacob',
-            'icon'        => 'icon-leaf'
+            'author' => 'Jacob',
+            'icon' => 'icon-leaf'
         ];
     }
 
-    /**
-     * Register form widgets
-     *
-     * @return array
-     */
-    public function registerFormWidgets()
+    public function registerFormWidgets(): array
     {
         return [
             LogBook::class => 'jacob_logbook_log',
         ];
     }
 
-    /**
-     * Register report widgets
-     * @return array
-     */
-    public function registerReportWidgets()
+    public function registerReportWidgets(): array
     {
         return [
             LogBookModelChanges::class => [
-                'label'   => 'Logbook of changes in a model'
+                'label' => 'Logbook of changes in a model'
             ],
         ];
     }

Diff for: README.md

@@ -14,7 +14,7 @@ Use the LogChanges trait in your model.
 This trait will automatically save changes from the model in the database.
 
 ```php
-use \Jacob\Logbook\Traits\LogChanges;
+use Jacob\Logbook\Traits\LogChanges;
 ```
 
 If you want to ignore fields that don't need the be logged, add this to your model.
@@ -112,6 +112,7 @@ Options: <br/>
 | limitPerPage      | 20            | int       |
 | startPage         | 1             | int       |
 | showLogRelations  | null          | array or string |
+| showSoftDeletedRelations  | null  | array or string |
 | showUndoChangesButton| true       | bool      |
 | refreshFormAfterUndo | true       | bool      |
 
@@ -124,6 +125,8 @@ _logbook@update:
     showLogRelations: #optional (contains the name(s) of the relations)
         - customer
         - anotherRelationName
-    showUndoChangesButton: true
-    refreshFormAfterUndo: false
+    showSoftDeleteRelations: #optional (contains the name(s) of the relations with soft delete support)
+        - relationNameWithSoftDeletes
+    showUndoChangesButton: true #optional
+    refreshFormAfterUndo: false #optional
 ```

Diff for: classes/LoadRelation.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Jacob\LogBook\Classes;
+
+class LoadRelation
+{
+    private string $name;
+    private bool $withTrashed;
+
+    public function __construct(string $name, bool $withTrashed)
+    {
+        $this->name = $name;
+        $this->withTrashed = $withTrashed;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function isWithTrashed(): bool
+    {
+        return $this->withTrashed;
+    }
+}

Diff for: classes/entities/Attribute.php

@@ -4,9 +4,29 @@
 
 class Attribute extends BaseEntity
 {
-    protected $attributes = [
-        'column',
-        'old',
-        'new',
-    ];
-}
+    protected $column;
+    protected $old;
+    protected $new;
+
+    public function __construct(string $column, $old, $new)
+    {
+        $this->column = $column;
+        $this->old = $old;
+        $this->new = $new;
+    }
+
+    public function getColumn(): string
+    {
+        return $this->column;
+    }
+
+    public function getOld()
+    {
+        return $this->old;
+    }
+
+    public function getNew()
+    {
+        return $this->new;
+    }
+}

Diff for: classes/entities/BaseEntity.php

@@ -2,82 +2,32 @@
 
 namespace Jacob\LogBook\Classes\Entities;
 
-class BaseEntity
+abstract class BaseEntity
 {
-    /**
-     * @var array List of all the attributes of this model
-     */
-    protected $attributes = [];
-
-    /**
-     * @var array Storage of all attribute data
-     */
-    protected $attributesData = [];
-
-    public function __construct(array $attributes = [])
+    public function getData(): array
     {
-        $this->fillFromArray($attributes);
-    }
+        $data = [];
 
-    /**
-     * Fill data from array
-     * @param array $attributes
-     */
-    protected function fillFromArray(array $attributes)
-    {
-        foreach ($attributes as $key => $value) {
-            $this->__set($key, $value);
-        }
-    }
+        $properties = get_object_vars($this);
 
-    /**
-     * Get data from attribute, child entity or nested entity
-     *
-     * @param string $key
-     * @return null|string|array
-     */
-    public function __get($key)
-    {
-        if (isset( $this->attributesData[$key] )) {
-            return $this->attributesData[$key];
-        }
+        foreach ($properties as $name => $value) {
+            if (is_array($value)) {
+                $items = [];
 
-        return null;
-    }
-    /**
-     * Set data for attribute, child entity or nested entity
-     *
-     * @param $key
-     * @param $value
-     */
-    public function __set($key, $value)
-    {
-        if ($this->attributeExists($key)) {
-            $this->attributesData[$key] = $value;
-        }
-    }
+                foreach ($value as $val) {
+                    if ($val instanceof BaseEntity) {
+                        $items[] = $val->getData();
+                    }
+                }
 
-    /**
-     * Check if an attribute key exists
-     *
-     * @param $key
-     * @return bool
-     */
-    public function attributeExists($key)
-    {
-        return in_array($key, $this->attributes);
-    }
+                $value = $items;
+            } else if ($value instanceof BaseEntity) {
+                $value = $value->getData();
+            }
 
-    /**
-     * Get all current data set in this model
-     * @return array
-     */
-    public function getData()
-    {
-        $result = [];
-        foreach ($this->attributes as $attribute) {
-            $result[$attribute] = $this->$attribute;
+            $data[$name] = $value;
         }
-        return $result;
+
+        return $data;
     }
 }

Diff for: classes/entities/Changes.php

@@ -4,12 +4,47 @@
 
 class Changes extends BaseEntity
 {
-    const TYPE_CREATED = 'created';
-    const TYPE_UPDATED = 'updated';
-    const TYPE_DELETED = 'deleted';
-
-    protected $attributes = [
-        'type',
-        'changedAttributes',
-    ];
-}
+    public const TYPE_CREATED = 'created';
+    public const TYPE_UPDATED = 'updated';
+    public const TYPE_DELETED = 'deleted';
+
+    protected $type;
+    protected $changedAttributes;
+
+    /**
+     * @param Attribute[] $changedAttributes
+     */
+    public function __construct(string $type, ?array $changedAttributes = null)
+    {
+        $this->type = $type;
+        $this->changedAttributes = $changedAttributes;
+    }
+
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    public function isTypeCreated(): string
+    {
+        return $this->type === self::TYPE_CREATED;
+    }
+
+    public function isTypeUpdated(): string
+    {
+        return $this->type === self::TYPE_UPDATED;
+    }
+
+    public function isTypeDeleted(): string
+    {
+        return $this->type === self::TYPE_DELETED;
+    }
+
+    /**
+     * @return Attribute[]|null
+     */
+    public function getChangedAttributes(): ?array
+    {
+        return $this->changedAttributes;
+    }
+}