add events functionality

Author: dododedodonl

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.3.0 - 2021-02-15
+- Add events on changes of the valuestore
+
 ## 0.2.0 - 2020-11-19
 
 ### Changed

README.md

@@ -13,6 +13,13 @@ You can install the package via composer:
 composer require dutchcodingcompany/cached-valuestore
 ```
 
+## Events
+
+Three events are triggered:
+- `DutchCodingCompany\CachedValuestore\Events\PutIntoValuestore`, triggered by `put`, `prepend`, `push`, `offsetSet`, `increment` and `decrement`
+- `DutchCodingCompany\CachedValuestore\Events\ForgetFromValuestore`, triggered by `forget`
+- `DutchCodingCompany\CachedValuestore\Events\FlushValuestore`, triggered by `flush` and `flushStartingWith`
+
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -8,6 +8,9 @@
     "require": {
         "php" : ">=7.2",
         "spatie/valuestore": "^1.0",
+        "illuminate/container": "^6.0|^7.0|^8.0",
+        "illuminate/events": "^6.0|^7.0|^8.0",
+        "illuminate/queue": "^6.0|^7.0|^8.0",
         "illuminate/support": "^6.0|^7.0|^8.0"
     },
     "autoload": {

src/CachedValuestore.php

@@ -3,11 +3,15 @@
 namespace DutchCodingCompany\CachedValuestore;
 
 use Spatie\Valuestore\Valuestore;
+use Illuminate\Container\Container;
+use Illuminate\Contracts\Events\Dispatcher;
 
 class CachedValuestore extends Valuestore
 {
     public static ?string $cachedFileName = null;
 
+    protected ?Dispatcher $dispatcher = null;
+
     protected ?array $cachedData = null;
 
     /**
@@ -58,4 +62,81 @@ public static function fromValuestore(Valuestore $store, array $values = null):
     {
         return static::make($store->fileName, $values);
     }
+
+    /**
+     * Gets the dispatcher from the container
+     *
+     * @return \Illuminate\Contracts\Events\Dispatcher
+     */
+    protected function dispatcher(): Dispatcher
+    {
+        if (is_null($this->dispatcher)) {
+            $this->dispatcher = Container::getInstance()->make(Dispatcher::class);
+        }
+
+        return $this->dispatcher;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function put($name, $value = null)
+    {
+        // Get arguments to event
+        $oldValue = parent::get($name);
+        $newValue = $value;
+
+        // Execute method
+        $result = parent::put($name, $value);
+
+        // Trigger event
+        $this->dispatcher()->dispatch(new Events\PutIntoValuestore($name, $oldValue, $newValue));
+
+        // Return stuff
+        return $result;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function forget(string $key)
+    {
+        // Get arguments to event
+        $oldValue = parent::get($key);
+
+        // Execute method
+        $result = parent::forget($key);
+
+        // Trigger event
+        $this->dispatcher()->dispatch(new Events\ForgetFromValuestore($key, $oldValue));
+
+        // Return stuff
+        return $result;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function flush()
+    {
+        $result = parent::flush();
+
+        // Trigger event
+        $this->dispatcher()->dispatch(new Events\FlushValuestore());
+
+        return $result;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function flushStartingWith(string $startingWith = '')
+    {
+        $result = parent::flushStartingWith($startingWith);
+
+        // Trigger event
+        $this->dispatcher()->dispatch(new Events\FlushValuestore($startingWith));
+
+        return $result;
+    }
 }

src/Events/FlushValuestore.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace DutchCodingCompany\CachedValuestore\Events;
+
+use Illuminate\Queue\SerializesModels;
+
+class FlushValuestore
+{
+    use SerializesModels;
+
+    public ?string $startingWith;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(string $startingWith = null)
+    {
+        $this->startingWith = $startingWith;
+    }
+}

src/Events/ForgetFromValuestore.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace DutchCodingCompany\CachedValuestore\Events;
+
+use Illuminate\Queue\SerializesModels;
+
+class ForgetFromValuestore
+{
+    use SerializesModels;
+
+    public string $key;
+
+    /** @var string|int|null */
+    public $oldValue;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(string $key, $oldValue)
+    {
+        $this->key = $key;
+        $this->oldValue = $oldValue;
+    }
+}

src/Events/PutIntoValuestore.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace DutchCodingCompany\CachedValuestore\Events;
+
+use Illuminate\Queue\SerializesModels;
+
+class PutIntoValuestore
+{
+    use SerializesModels;
+
+    /** @var string|array */
+    public $name;
+
+    /** @var string|int|null */
+    public $oldValue;
+
+    /** @var string|int|null */
+    public $newValue;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct($name, $oldValue, $newValue)
+    {
+        $this->name = $name;
+        $this->oldValue = $oldValue;
+        $this->newValue = $newValue;
+    }
+}