Fix the bug that duplicate records are added to audit_logs table when…

… multiple records are updated using saveMany().

README.md

@@ -4,7 +4,7 @@ This plugin is forked from [lorenzo/audit-stash](https://github.com/lorenzo/audi
 
 The above plugin has the following issues or does not have the features I wanted.
 - Original data is not recorded at the delete event.
-    - This is useful if you add the plugin after some data has already been added.
+    - This is useful if you add the plugin after some data was added.
 
 - Associated table records were not saved properly (In this case I considered two models with ‘hasMany’ relationship)
     - Currently, in the CakePHP (4.x) ORM when there is a ‘hasMany’ relationship (for example; think about 2 DB tables: items and item_attributes), `EntityTrait::extractOriginal(array $fields)` doesn't return the original value of the associated table’s (item_attributes) original data instead they return the modified values.
@@ -14,7 +14,7 @@ The above plugin has the following issues or does not have the features I wanted
 - Unable to record audit logs when saveMany() is called to save multiple entities. 
 - Unable to set some common configurations for the AuditLog behaviour and/or Table Persister via the app.php
 - Doesn't record a human-friendly data field from foreign keys
-- Create event adds the same data into the 'original' and 'changed' columns
+- The Create event adds the same data into the 'original' and 'changed' columns
 - The 'id' (primary key) filed is added to the 'original' and 'changed' data, unless you blacklist it in each model class. (The primary key is recorded as a separate field as well)
 
 
@@ -30,20 +30,10 @@ composer require kdesilva/audit-trail
 bin/cake plugin load AuditStash
 ```
 
-For using the default storage engine (ElasticSearch) you need to install the official `elastic-search` plugin, by executing
-the following lines:
-
-```
-composer require cakephp/elastic-search
-bin/cake plugin load Cake/ElasticSearch
-```
+If you plan to use ElasticSearch as the storage engine, please refer to [lorenzo/audit-stash](https://github.com/lorenzo/audit-stash)
 
 ## Configuration
 
-### Elastic Search
-
-If you decided to use ElasticSearch as the storage engine, please refer to [lorenzo/audit-stash](https://github.com/lorenzo/audit-stash)
-
 ### Tables / Regular Databases
 
 If you want to use a regular database, respectively an engine that can be used via the CakePHP ORM API, then you can use
@@ -62,8 +52,10 @@ The plugin will then by default try to store the logs in a table named `audit_lo
 `AuditLogs`, which you could create/overwrite in your application if you need.
 
 You can find a migration in the `config/migration` folder of this plugin which you can apply to your database, this will
-add a table named `audit_logs` with all the default columns - alternatively create the table manually. After that you
-can bake the corresponding table class.
+add a table named `audit_logs` with all the default columns. Alternatively you can bake your own migration to create the table. After that you
+can migrate the corresponding table class.
+
+If you use the plugin's default migration, you can create the table and model class using the commands below.
 
 ```
 bin/cake migrations migrate -p AuditStash -t 20171018185609

src/Model/Behavior/AuditLogBehavior.php

@@ -216,7 +216,7 @@ public function afterSave(Event $event, EntityInterface $entity, $options)
      */
     public function afterCommit(Event $event, EntityInterface $entity, $options)
     {
-        if (!isset($options['_auditQueue'])) {
+        if (!isset($options['_auditQueue']) || $options['_auditQueue']->count() == 0) {
             return;
         }
 
@@ -234,7 +234,15 @@ public function afterCommit(Event $event, EntityInterface $entity, $options)
         $this->persister()->logEvents($data->getData('logs'));
 
         // stop duplicate records adding to audit_logs table, when saveMany() is called
-        unset($options['_auditQueue']);
+        /**
+         * @var SplObjectStorage $attachedAuditQueueEntities
+         */
+        $options['_auditQueue']->rewind();
+        while ($options['_auditQueue']->valid()) {
+            $obj = $options['_auditQueue']->current();
+            $options['_auditQueue']->next();
+            $options['_auditQueue']->detach($obj);
+        }
     }
 
     /**