Move events group name to component params (#61) (#62)

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## 2.0.1 under development
 
-- no changes in this release.
+- Enh #61: Move `events` configuration group name to parameters (@olegbaturin)
 
 ## 2.0.0 February 16, 2023
 

README.md

@@ -35,12 +35,28 @@ composer require yiisoft/yii-event
 
 ### DI configuration
 
-You can see a config example in the [config directory](config):
+You can find default configuration in the [config directory](config):
 
-- [common.php](config/common.php) contains the configuration for the [PSR-14](https://www.php-fig.org/psr/psr-14/) interfaces.
-- [console.php](config/console.php) and [web.php](config/web.php) contains the configuration for the `ListenerCollectionFactory`.
+- [di.php](config/di.php) contains the configuration for the [PSR-14](https://www.php-fig.org/psr/psr-14/) interfaces.
+- [di-web.php](config/di-web.php) and [di-console.php](config/di-consle.php) contains the configuration for the `Yiisoft\EventDispatcher\Provider\ListenerCollection`.
+- [params-web.php](config/params-web.php) and [params-console.php](config/params-consle.php) contains parameters for `web` and `console` configurations.
 
-All these configs will be used automatically in projects with the [yiisoft/config](https://github.com/yiisoft/config).
+All these settings will be used automatically in projects with the [yiisoft/config](https://github.com/yiisoft/config).
+
+If you have custom `events` configuration group name, for example `events-api`, redefine it in the `eventsConfigGroup` params key.
+
+params.php
+```php
+<?php
+
+declare(strict_types=1);
+
+return [
+    'yiisoft/yii-event' => [
+        'eventsConfigGroup' => 'events-api',
+    ],
+]
+```
 
 ### Event configuration example
 

composer.json

@@ -50,6 +50,8 @@
             "merge-plan-file": "../tests/environment/.merge-plan.php"
         },
         "config-plugin": {
+            "params-web": "params-web.php",
+            "params-console": "params-console.php",
             "di": "di.php",
             "di-web": "di-web.php",
             "di-console": "di-console.php",

config/di-console.php

@@ -6,7 +6,8 @@
 use Yiisoft\Yii\Event\ListenerCollectionFactory as Factory;
 
 /** @var \Yiisoft\Config\Config $config */
+/** @var array $params */
 
 return [
-    ListenerCollection::class => static fn (Factory $factory) => $factory->create($config->get('events-console')),
+    ListenerCollection::class => static fn (Factory $factory) => $factory->create($config->get($params['yiisoft/yii-event']['eventsConfigGroup'])),
 ];

config/di-web.php

@@ -6,7 +6,8 @@
 use Yiisoft\Yii\Event\ListenerCollectionFactory as Factory;
 
 /** @var \Yiisoft\Config\Config $config */
+/** @var array $params */
 
 return [
-    ListenerCollection::class => static fn (Factory $factory) => $factory->create($config->get('events-web')),
+    ListenerCollection::class => static fn (Factory $factory) => $factory->create($config->get($params['yiisoft/yii-event']['eventsConfigGroup'])),
 ];

config/params-console.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'yiisoft/yii-event' => [
+        'eventsConfigGroup' => 'events-console',
+    ],
+];

config/params-web.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'yiisoft/yii-event' => [
+        'eventsConfigGroup' => 'events-web',
+    ],
+];

tests/ConfigTest.php

@@ -51,7 +51,7 @@ private function createContainer(?string $postfix = null): Container
     {
         return new Container(
             ContainerConfig::create()->withDefinitions(
-                $this->createConfig()->get('di' . ($postfix !== null ? '-' . $postfix : ''))
+                $this->createConfig($postfix)->get('di' . ($postfix !== null ? '-' . $postfix : ''))
                 +
                 [
                     EventDispatcherInterface::class => new SimpleEventDispatcher(),
@@ -60,13 +60,13 @@ private function createContainer(?string $postfix = null): Container
         );
     }
 
-    private function createConfig(): Config
+    private function createConfig(?string $postfix = null): Config
     {
         return new Config(
             new ConfigPaths(dirname(__DIR__), 'config'),
             null,
             [],
-            null,
+            $postfix !== null ? 'params' . '-' . $postfix : null,
             '../tests/environment/.merge-plan.php'
         );
     }