Explain PluginConfigurator

See php-http/HttplugBundle#477
ruudk · Nov 23, 2024 · 0ab3269 · 0ab3269
1 parent 67c88ee
commit 0ab3269
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/integrations/symfony-bundle.rst b/integrations/symfony-bundle.rst
@@ -403,6 +403,49 @@ client:
                 plugins:
                     - 'acme_plugin'
 
+If you want to configure your plugin using the bundle configuration, you can
+create a class that implements PluginConfigurator.
+
+
+.. code-block:: php
+
+    final class CustomPluginConfigurator implements PluginConfigurator
+    {
+        public static function getConfigTreeBuilder() : TreeBuilder
+        {
+            $treeBuilder = new TreeBuilder('custom_plugin');
+            $rootNode = $treeBuilder->getRootNode();
+
+            $rootNode
+                ->children()
+                    ->scalarNode('name')
+                        ->isRequired()
+                        ->cannotBeEmpty()
+                    ->end()
+                ->end();
+
+            return $treeBuilder;
+        }
+
+        public function create(array $config) : CustomPlugin
+        {
+            return new CustomPlugin($config['name']);
+        }
+    }
+
+.. code-block:: yaml
+
+    // config.yml
+    httplug:
+        clients:
+            acme:
+                factory: 'httplug.factory.guzzle6'
+                plugins:
+                    - configurator:
+                        id: 'App\CustomPluginConfigurator'
+                        config:
+                            name: 'foo'
+
 Authentication
 --------------
 

diff --git a/integrations/symfony-full-configuration.rst b/integrations/symfony-full-configuration.rst
@@ -113,6 +113,12 @@ This page shows an example of all configuration values provided by the bundle.
                 plugins:
                     # Can reference a globally configured plugin service
                     - 'httplug.plugin.authentication.my_wsse'
+                    # Configure a plugin using a custom PluginConfigurator
+                    - configurator:
+                        id: App\Httplug\Plugin\MyPluginConfigurator
+                        config:
+                            foo: 'bar'
+                            baz: 'qux'
                     # Can configure a plugin customized for this client
                     - cache:
                         cache_pool: 'my_other_pool'