Merge pull request #66 from upmind-automation/65-provision-registry-u…

…pdated-event

65 - Provision Registry Cache updated event

Makefile

@@ -1,4 +1,4 @@
-.PHONY: help
+.PHONY: help setup-php81 setup-php82 setup-php83 shell static-analysis start-containers stop-containers kill-containers composer-install
 
 # List all available Makefile commands.
 help:
@@ -38,7 +38,7 @@ start-containers:
 
 # Stop the dev environment
 stop-containers:
-	docker compose down
+	if [ -f "./docker-compose.yml" ]; then docker compose down; else echo ''; fi
 
 # Stop and remove all containers
 kill-containers:

phpstan.neon.dist

@@ -2,3 +2,7 @@ parameters:
     level: 0
     paths:
         - src
+    ignoreErrors:
+        -
+            message: '#Required parameter \$parent follows optional parameter#'
+            path: src/Registry/Data/FunctionRegister.php

src/Events/RegistryEventInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Upmind\ProvisionBase\Events;
+
+interface RegistryEventInterface
+{
+    public function getEventName(): string;
+}

src/Laravel/Console/CacheRegistry.php

@@ -4,6 +4,8 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Contracts\Cache\Repository as CacheInterface;
+use Illuminate\Contracts\Events\Dispatcher as EventDispatcherInterface;
+use Upmind\ProvisionBase\Laravel\Events\RegistryUpdatedEvent;
 use Upmind\ProvisionBase\Laravel\ProvisionServiceProvider;
 use Upmind\ProvisionBase\Registry\Registry;
 
@@ -29,9 +31,14 @@ class CacheRegistry extends Command
     /**
      * Execute the console command.
      */
-    public function handle(Registry $registry, CacheInterface $cache): int
+    public function handle(Registry $registry, CacheInterface $cache, EventDispatcherInterface $eventDispatcher): int
     {
-        $this->cacheRegistry($registry, $cache);
+        $result = $this->cacheRegistry($registry, $cache);
+
+        // Dispatch event to notify listeners that the registry has been updated.
+        if ($result === true) {
+            $eventDispatcher->dispatch(new RegistryUpdatedEvent());
+        }
 
         if (!$this->option('without-summary')) {
             $this->call('upmind:provision:summary');
@@ -41,7 +48,7 @@ public function handle(Registry $registry, CacheInterface $cache): int
     }
 
     /**
-     * @return bool Whether or not new registry data was written to cache
+     * Whether, or not, new registry data was written to cache.
      */
     protected function cacheRegistry(Registry $registry, CacheInterface $cache): bool
     {

src/Laravel/Events/RegistryUpdatedEvent.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Upmind\ProvisionBase\Laravel\Events;
+
+use Upmind\ProvisionBase\Events\RegistryEventInterface;
+
+class RegistryUpdatedEvent implements RegistryEventInterface
+{
+    public function getEventName(): string
+    {
+        return 'ProvisionRegistryUpdated';
+    }
+}