Additional SyliusTwigHook parameter (type)

phpstan.neon

@@ -9,3 +9,13 @@ parameters:
     paths:
         - 'src/TwigExtra/src'
         - 'src/TwigHooks/src'
+
+    ignoreErrors:
+        # Symfony Config component relies on magic methods in NodeBuilder.
+        # PHPStan struggles to resolve these methods on the builder class when complex generics are involved,
+        # resulting in false positive "unknown class" errors.
+        -
+            message: '#Call to method \w+Node\(\) on an unknown class .*NodeBuilder.*#'
+            paths:
+                - 'src/TwigHooks/src/DependencyInjection/Configuration.php'
+                - 'src/TwigExtra/src/Symfony/DependencyInjection/Configuration.php'

src/TwigExtra/src/Symfony/DependencyInjection/Configuration.php

@@ -14,23 +14,34 @@
 namespace Sylius\TwigExtra\Symfony\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeParentInterface;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 final class Configuration implements ConfigurationInterface
 {
+    /**
+     * @phpstan-return TreeBuilder<'array'>
+     */
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('sylius_twig_extra');
 
+        /**
+         * @var ArrayNodeDefinition $rootNode
+         * @phpstan-var ArrayNodeDefinition<NodeParentInterface|null> $rootNode
+         */
         $rootNode = $treeBuilder->getRootNode();
 
         $this->addTwigUxConfiguration($rootNode);
 
         return $treeBuilder;
     }
 
+    /**
+     * @phpstan-param ArrayNodeDefinition<NodeParentInterface|null> $rootNode
+     */
     private function addTwigUxConfiguration(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->children()

src/TwigHooks/src/DependencyInjection/Configuration.php

@@ -17,16 +17,24 @@
 use Sylius\TwigHooks\Hookable\HookableComponent;
 use Sylius\TwigHooks\Hookable\HookableTemplate;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeParentInterface;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 final class Configuration implements ConfigurationInterface
 {
+    /**
+     * @phpstan-return TreeBuilder<'array'>
+     */
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('sylius_twig_hooks');
 
+        /**
+         * @var ArrayNodeDefinition $rootNode
+         * @phpstan-var ArrayNodeDefinition<NodeParentInterface|null> $rootNode
+         */
         $rootNode = $treeBuilder->getRootNode();
 
         $rootNode
             ->children()
@@ -41,7 +49,10 @@
         return $treeBuilder;
     }
 
+    /**
+     * @phpstan-param ArrayNodeDefinition<NodeParentInterface|null> $rootNode
+     */
     private function addSupportedHookableTypesConfiguration(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->children()
@@ -58,7 +69,10 @@
         ;
     }
 
+    /**
+     * @phpstan-param ArrayNodeDefinition<NodeParentInterface|null> $rootNode
+     */
     private function addHooksConfiguration(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->children()
@@ -69,6 +83,7 @@
                         ->arrayPrototype()
                             ->beforeNormalization()
                                 ->always(function ($v) {
+                                    $isTypeDefined = isset($v['type']);
                                     $isComponentDefined = isset($v['component']);
                                     $isTemplateDefined = isset($v['template']);
                                     $isDisabled = isset($v['enabled']) && $v['enabled'] === false;
@@ -77,6 +92,10 @@
                                         return $v;
                                     }
 
+                                    if (true === $isTypeDefined && false === $isDisabled) {
+                                        return $v;
+                                    }
+
                                     $v['type'] = match (true) {
                                         $isDisabled => 'disabled',
                                         $isComponentDefined => 'component',
@@ -89,6 +108,16 @@
                             ->end()
                             ->validate()
                                 ->always(static function ($v) {
+                                    $type = $v['type'] ?? null;
+                                    if ('template' === $type) {
+                                        $v['component'] = null;
+                                        $v['props'] = [];
+                                    }
+
+                                    if ('component' === $type) {
+                                        $v['template'] = null;
+                                    }
+
                                     $component = $v['component'] ?? null;
                                     $template = $v['template'] ?? null;
                                     $enabled = $v['enabled'] ?? true;

src/TwigHooks/tests/Integration/DependencyInjection/ConfigurationTest.php

@@ -174,6 +174,7 @@ public function testItThrowsExceptionWhenBothTemplateAndComponentShortcutsAreDef
                             'some_hookable' => [
                                 'component' => 'MyAwesomeComponent',
                                 'template' => 'some_target.html.twig',
+                                'type' => 'disabled',
                             ],
                         ],
                     ],
@@ -193,6 +194,7 @@ public function testItThrowsExceptionWhenPropsAreDefinedForNonComponentHookable(
                             'some_hookable' => [
                                 'template' => 'some_target.html.twig',
                                 'props' => ['key' => 'value'],
+                                'type' => 'disabled',
                             ],
                         ],
                     ],