Merge branch 'psr-event-dispatcher'

Author: lkrms

composer.json

@@ -8,6 +8,7 @@
         "composer-runtime-api": "^2.2",
         "lkrms/dice": "^4.1.6",
         "psr/container": "^2",
+        "psr/event-dispatcher": "^1",
         "psr/log": "^1"
     },
     "suggest": {
@@ -18,7 +19,7 @@
         "clue/phar-composer": "Simplifies creation of phar archives"
     },
     "require-dev": {
-        "adodb/adodb-php": "^5.22",
+        "adodb/adodb-php": "^5",
         "analog/analog": "^1",
         "clue/phar-composer": "^1",
         "firebase/php-jwt": "^6",
@@ -29,6 +30,9 @@
         "phpunit/phpunit": "^9",
         "sebastian/diff": "^4 || ^5"
     },
+    "provide": {
+        "psr/event-dispatcher-implementation": "^1"
+    },
     "autoload": {
         "psr-4": {
             "Lkrms\\": "src/"

lk-util/Command/Generate/GenerateTests.php

@@ -135,7 +135,7 @@ protected function run(string ...$args)
                         $extendsGenerality = $generality;
                     }
                 }
-            };
+            }
         }
 
         $this->Extends[] = $classPrefix . (

src/Cli/CliCommand.php

@@ -207,7 +207,7 @@ final public function setName(array $name): void
     }
 
     /**
-     * Get the command name as a string of space-delimited subcommands
+     * @inheritDoc
      */
     final public function name(): string
     {

src/Cli/Contract/ICliCommandNode.php

@@ -4,19 +4,19 @@
 
 use Lkrms\Cli\Catalog\CliHelpSectionName;
 use Lkrms\Cli\CliCommand;
-use Lkrms\Contract\ReturnsContainer;
-use Lkrms\Contract\ReturnsDescription;
-use Lkrms\Contract\ReturnsEnvironment;
+use Lkrms\Contract\HasContainer;
+use Lkrms\Contract\HasDescription;
+use Lkrms\Contract\HasEnvironment;
 use LogicException;
 
 /**
  * A node in a CLI command tree
  *
- * @extends ReturnsContainer<ICliApplication>
+ * @extends HasContainer<ICliApplication>
  *
  * @see CliCommand
  */
-interface ICliCommandNode extends ReturnsContainer, ReturnsEnvironment, ReturnsDescription
+interface ICliCommandNode extends HasContainer, HasEnvironment, HasDescription
 {
     /**
      * Get the command name as a string of space-delimited subcommands

src/Concept/Facade.php

@@ -8,6 +8,7 @@
 use Lkrms\Contract\ReceivesFacade;
 use Lkrms\Facade\Event;
 use Lkrms\Support\EventDispatcher;
+use Lkrms\Support\ServiceEvent;
 use RuntimeException;
 
 /**
@@ -58,12 +59,14 @@ private static function _load()
             ? $instance
             : Event::getInstance();
         $id = $dispatcher->listen(
-            'container.global.set',
-            function (?IContainer $container) use ($service, $instance): void {
+            function (ServiceEvent $event) use ($service, $instance): void {
+                /** @var IContainer|null */
+                $container = $event->service();
                 if ($container) {
                     $container->instanceIf($service, $instance);
                 }
-            }
+            },
+            Container::EVENT_GLOBAL_CONTAINER_SET,
         );
         self::$ListenerIds[static::class] = $id;
 

src/Concept/Provider.php

@@ -43,9 +43,13 @@ abstract protected function getDateFormatter(): IDateFormatter;
     /**
      * @inheritDoc
      */
-    public function description(): ?string
+    public function description(): string
     {
-        return null;
+        throw new MethodNotImplementedException(
+            static::class,
+            __FUNCTION__,
+            IProvider::class
+        );
     }
 
     /**

src/Container/Container.php

@@ -14,6 +14,7 @@
 use Lkrms\Contract\ReceivesContainer;
 use Lkrms\Contract\ReceivesService;
 use Lkrms\Facade\Event;
+use Lkrms\Support\ServiceEvent;
 use Psr\Container\ContainerInterface;
 use Closure;
 use ReflectionClass;
@@ -27,6 +28,8 @@
  */
 class Container extends FluentInterface implements IContainer
 {
+    public const EVENT_GLOBAL_CONTAINER_SET = self::class . '::globalContainerSet';
+
     private static ?IContainer $GlobalContainer = null;
 
     private Dice $Dice;
@@ -149,7 +152,7 @@ final public static function requireGlobalContainer(): IContainer
      */
     final public static function setGlobalContainer(?IContainer $container): ?IContainer
     {
-        Event::dispatch('container.global.set', $container);
+        Event::dispatch(new ServiceEvent(self::EVENT_GLOBAL_CONTAINER_SET, $container));
 
         self::$GlobalContainer = $container;
 

src/Contract/HasContainer.php

@@ -0,0 +1,23 @@
+<?php declare(strict_types=1);
+
+namespace Lkrms\Contract;
+
+/**
+ * @template T of IContainer
+ */
+interface HasContainer
+{
+    /**
+     * Get the object's service container
+     *
+     * @return T
+     */
+    public function app(): IContainer;
+
+    /**
+     * Get the object's service container
+     *
+     * @return T
+     */
+    public function container(): IContainer;
+}

src/Contract/HasDescription.php

@@ -0,0 +1,11 @@
+<?php declare(strict_types=1);
+
+namespace Lkrms\Contract;
+
+interface HasDescription extends HasName
+{
+    /**
+     * Get a description of the object
+     */
+    public function description(): string;
+}

src/Contract/ReturnsEnvironment.php renamed to src/Contract/HasEnvironment.php

@@ -7,7 +7,7 @@
 /**
  * Returns a shared instance of Lkrms\Utility\Env
  */
-interface ReturnsEnvironment
+interface HasEnvironment
 {
     /**
      * Get a shared instance of Lkrms\Utility\Env