vendor/symfony/ux-twig-component/src/DependencyInjection/TwigComponentExtension.php line 60

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\UX\TwigComponent\DependencyInjection;
  14. use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
  15. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  16. use Symfony\Component\Config\Definition\ConfigurationInterface;
  17. use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
  18. use Symfony\Component\Config\FileLocator;
  19. use Symfony\Component\DependencyInjection\Argument\AbstractArgument;
  20. use Symfony\Component\DependencyInjection\ChildDefinition;
  21. use Symfony\Component\DependencyInjection\ContainerBuilder;
  22. use Symfony\Component\DependencyInjection\Exception\LogicException;
  23. use Symfony\Component\DependencyInjection\Extension\Extension;
  24. use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
  25. use Symfony\Component\DependencyInjection\Parameter;
  26. use Symfony\Component\DependencyInjection\Reference;
  27. use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
  28. use Symfony\UX\TwigComponent\Command\TwigComponentDebugCommand;
  29. use Symfony\UX\TwigComponent\ComponentFactory;
  30. use Symfony\UX\TwigComponent\ComponentRenderer;
  31. use Symfony\UX\TwigComponent\ComponentRendererInterface;
  32. use Symfony\UX\TwigComponent\ComponentStack;
  33. use Symfony\UX\TwigComponent\ComponentTemplateFinder;
  34. use Symfony\UX\TwigComponent\DependencyInjection\Compiler\TwigComponentPass;
  35. use Symfony\UX\TwigComponent\Twig\ComponentExtension;
  36. use Symfony\UX\TwigComponent\Twig\ComponentLexer;
  37. use Symfony\UX\TwigComponent\Twig\TwigEnvironmentConfigurator;
  39. /**
  40.  * @author Kevin Bond <kevinbond@gmail.com>
  41.  *
  42.  * @internal
  43.  */
  44. final class TwigComponentExtension extends Extension implements ConfigurationInterface
  45. {
  46.     private const DEPRECATED_DEFAULT_KEY = '__deprecated__use_old_naming_behavior';
  48.     public function load(array $configs, ContainerBuilder $container): void
  49.     {
  50.         $loader = new PhpFileLoader($container, new FileLocator(__DIR__.'/../../config'));
  52.         if (!isset($container->getParameter('kernel.bundles')['TwigBundle'])) {
  53.             throw new LogicException('The TwigBundle is not registered in your application. Try running "composer require symfony/twig-bundle".');
  54.         }
  56.         $configuration = $this->getConfiguration($configs, $container);
  57.         $config = $this->processConfiguration($configuration, $configs);
  58.         $defaults = $config['defaults'];
  59.         if ($defaults === [self::DEPRECATED_DEFAULT_KEY]) {
  60.             trigger_deprecation('symfony/ux-twig-component', '2.13', 'Not setting the "twig_component.defaults" config option is deprecated. Check the documentation for an example configuration.');
  61.             $container->setParameter('ux.twig_component.legacy_autonaming', true);
  63.             $defaults = [];
  64.         }
  65.         $container->setParameter('ux.twig_component.component_defaults', $defaults);
  67.         $container->register('ux.twig_component.component_template_finder', ComponentTemplateFinder::class)
  68.             ->setArguments([
  69.                 new Reference('twig.loader'),
  70.                 $config['anonymous_template_directory'],
  71.             ]);
  72.         $container->setAlias(ComponentRendererInterface::class, 'ux.twig_component.component_renderer');
  74.         $container->registerAttributeForAutoconfiguration(
  75.             AsTwigComponent::class,
  76.             static function (ChildDefinition $definition, AsTwigComponent $attribute) {
  77.                 $definition->addTag('twig.component', array_filter($attribute->serviceConfig()));
  78.             }
  79.         );
  81.         $container->register('ux.twig_component.component_factory', ComponentFactory::class)
  82.             ->setArguments([
  83.                 new Reference('ux.twig_component.component_template_finder'),
  84.                 class_exists(AbstractArgument::class) ? new AbstractArgument(sprintf('Added in %s.', TwigComponentPass::class)) : null,
  85.                 new Reference('property_accessor'),
  86.                 new Reference('event_dispatcher'),
  87.                 class_exists(AbstractArgument::class) ? new AbstractArgument(sprintf('Added in %s.', TwigComponentPass::class)) : [],
  88.             ])
  89.         ;
  91.         $container->register('ux.twig_component.component_stack', ComponentStack::class);
  93.         $container->register('ux.twig_component.component_renderer', ComponentRenderer::class)
  94.             ->setArguments([
  95.                 new Reference('twig'),
  96.                 new Reference('event_dispatcher'),
  97.                 new Reference('ux.twig_component.component_factory'),
  98.                 new Reference('property_accessor'),
  99.                 new Reference('ux.twig_component.component_stack'),
  100.             ])
  101.         ;
  103.         $container->register('ux.twig_component.twig.component_extension', ComponentExtension::class)
  104.             ->addTag('twig.extension')
  105.             ->addTag('container.service_subscriber', ['key' => ComponentRenderer::class, 'id' => 'ux.twig_component.component_renderer'])
  106.         ;
  108.         $container->register('ux.twig_component.twig.lexer', ComponentLexer::class);
  110.         $container->register('ux.twig_component.twig.environment_configurator', TwigEnvironmentConfigurator::class)
  111.             ->setDecoratedService(new Reference('twig.configurator.environment'))
  112.             ->setArguments([new Reference('ux.twig_component.twig.environment_configurator.inner')]);
  114.         $container->register('ux.twig_component.command.debug', TwigComponentDebugCommand::class)
  115.             ->setArguments([
  116.                 new Parameter('twig.default_path'),
  117.                 new Reference('ux.twig_component.component_factory'),
  118.                 new Reference('twig'),
  119.                 class_exists(AbstractArgument::class) ? new AbstractArgument(sprintf('Added in %s.', TwigComponentPass::class)) : [],
  120.                 $config['anonymous_template_directory'],
  121.             ])
  122.             ->addTag('console.command')
  123.         ;
  125.         $container->setAlias('console.command.stimulus_component_debug', 'ux.twig_component.command.debug')
  126.             ->setDeprecated('symfony/ux-twig-component', '2.13', '%alias_id%');
  128.         if ($container->getParameter('kernel.debug')) {
  129.             $loader->load('debug.php');
  130.         }
  131.     }
  133.     public function getConfigTreeBuilder(): TreeBuilder
  134.     {
  135.         $treeBuilder = new TreeBuilder('twig_component');
  136.         $rootNode = $treeBuilder->getRootNode();
  137.         \assert($rootNode instanceof ArrayNodeDefinition);
  139.         $rootNode
  140.             ->validate()
  141.             ->always(function ($v) {
  142.                 if (!isset($v['anonymous_template_directory'])) {
  143.                     trigger_deprecation('symfony/twig-component-bundle', '2.13', 'Not setting the "twig_component.anonymous_template_directory" config option is deprecated. It will default to "components" in 3.0.');
  144.                     $v['anonymous_template_directory'] = null;
  145.                 }
  147.                 return $v;
  148.             })
  149.             ->end()
  150.             ->children()
  151.                 ->arrayNode('defaults')
  152.                     ->defaultValue([self::DEPRECATED_DEFAULT_KEY])
  153.                     ->useAttributeAsKey('namespace')
  154.                     ->validate()
  155.                         ->always(function ($v) {
  156.                             foreach ($v as $namespace => $defaults) {
  157.                                 if (!str_ends_with($namespace, '\\')) {
  158.                                     throw new InvalidConfigurationException(sprintf('The twig_component.defaults namespace "%s" is invalid: it must end in a "\"', $namespace));
  159.                                 }
  160.                             }
  162.                             return $v;
  163.                         })
  164.                     ->end()
  165.                     ->arrayPrototype()
  166.                         ->beforeNormalization()
  167.                             ->ifString()
  168.                             ->then(function (string $v) {
  169.                                 return ['template_directory' => $v];
  170.                             })
  171.                         ->end()
  172.                         ->children()
  173.                             ->scalarNode('template_directory')
  174.                                 ->defaultValue('components')
  175.                             ->end()
  176.                             ->scalarNode('name_prefix')
  177.                                 ->defaultValue('')
  178.                             ->end()
  179.                         ->end()
  180.                     ->end()
  181.                 ->end()
  182.                 ->scalarNode('anonymous_template_directory')
  183.                     ->info('Defaults to `components`')
  184.                 ->end()
  185.                 ->scalarNode('controllers_json')
  186.                     ->defaultValue('%kernel.project_dir%/assets/controllers.json')
  187.                 ->end()
  188.             ->end();
  190.         return $treeBuilder;
  191.     }
  193.     public function getConfiguration(array $config, ContainerBuilder $container): ConfigurationInterface
  194.     {
  195.         return $this;
  196.     }
  197. }