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

Open in your IDE?
  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\Argument\ServiceLocatorArgument;
  21. use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
  22. use Symfony\Component\DependencyInjection\ChildDefinition;
  23. use Symfony\Component\DependencyInjection\ContainerBuilder;
  24. use Symfony\Component\DependencyInjection\ContainerInterface;
  25. use Symfony\Component\DependencyInjection\Exception\LogicException;
  26. use Symfony\Component\DependencyInjection\Extension\Extension;
  27. use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
  28. use Symfony\Component\DependencyInjection\Parameter;
  29. use Symfony\Component\DependencyInjection\Reference;
  30. use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
  31. use Symfony\UX\TwigComponent\CacheWarmer\TwigComponentCacheWarmer;
  32. use Symfony\UX\TwigComponent\Command\TwigComponentDebugCommand;
  33. use Symfony\UX\TwigComponent\ComponentFactory;
  34. use Symfony\UX\TwigComponent\ComponentProperties;
  35. use Symfony\UX\TwigComponent\ComponentRenderer;
  36. use Symfony\UX\TwigComponent\ComponentRendererInterface;
  37. use Symfony\UX\TwigComponent\ComponentStack;
  38. use Symfony\UX\TwigComponent\ComponentTemplateFinder;
  39. use Symfony\UX\TwigComponent\DependencyInjection\Compiler\TwigComponentPass;
  40. use Symfony\UX\TwigComponent\Twig\ComponentExtension;
  41. use Symfony\UX\TwigComponent\Twig\ComponentLexer;
  42. use Symfony\UX\TwigComponent\Twig\ComponentRuntime;
  43. use Symfony\UX\TwigComponent\Twig\TwigEnvironmentConfigurator;
  45. /**
  46. * @author Kevin Bond <kevinbond@gmail.com>
  47. *
  48. * @internal
  49. */
  50. final class TwigComponentExtension extends Extension implements ConfigurationInterface
  51. {
  52. private const DEPRECATED_DEFAULT_KEY = '__deprecated__use_old_naming_behavior';
  54. public function load(array $configs, ContainerBuilder $container): void
  55. {
  56. $loader = new PhpFileLoader($container, new FileLocator(__DIR__.'/../../config'));
  58. if (!isset($container->getParameter('kernel.bundles')['TwigBundle'])) {
  59. throw new LogicException('The TwigBundle is not registered in your application. Try running "composer require symfony/twig-bundle".');
  60. }
  62. $configuration = $this->getConfiguration($configs, $container);
  63. $config = $this->processConfiguration($configuration, $configs);
  64. $defaults = $config['defaults'];
  65. if ($defaults === [self::DEPRECATED_DEFAULT_KEY]) {
  66. 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.');
  67. $container->setParameter('ux.twig_component.legacy_autonaming', true);
  69. $defaults = [];
  70. }
  71. $container->setParameter('ux.twig_component.component_defaults', $defaults);
  73. $container->register('ux.twig_component.component_template_finder', ComponentTemplateFinder::class)
  74. ->setArguments([
  75. new Reference('twig.loader'),
  76. $config['anonymous_template_directory'],
  77. ]);
  78. $container->setAlias(ComponentRendererInterface::class, 'ux.twig_component.component_renderer');
  80. $container->registerAttributeForAutoconfiguration(
  81. AsTwigComponent::class,
  82. static function (ChildDefinition $definition, AsTwigComponent $attribute) {
  83. $definition->addTag('twig.component', array_filter($attribute->serviceConfig()));
  84. }
  85. );
  87. $container->register('ux.twig_component.component_factory', ComponentFactory::class)
  88. ->setArguments([
  89. new Reference('ux.twig_component.component_template_finder'),
  90. new AbstractArgument(\sprintf('Added in %s.', TwigComponentPass::class)),
  91. new Reference('property_accessor'),
  92. new Reference('event_dispatcher'),
  93. new AbstractArgument(\sprintf('Added in %s.', TwigComponentPass::class)),
  94. ])
  95. ->addTag('kernel.reset', ['method' => 'reset'])
  96. ;
  98. $container->register('ux.twig_component.component_stack', ComponentStack::class);
  100. $container->register('ux.twig_component.component_properties', ComponentProperties::class)
  101. ->setArguments([
  102. new Reference('property_accessor'),
  103. new AbstractArgument(\sprintf('Added in %s.', TwigComponentPass::class)),
  104. new Reference('cache.ux.twig_component', ContainerInterface::IGNORE_ON_INVALID_REFERENCE),
  105. ])
  106. ;
  108. $container->register('ux.twig_component.component_renderer', ComponentRenderer::class)
  109. ->setArguments([
  110. new Reference('twig'),
  111. new Reference('event_dispatcher'),
  112. new Reference('ux.twig_component.component_factory'),
  113. new Reference('ux.twig_component.component_properties'),
  114. new Reference('ux.twig_component.component_stack'),
  115. ])
  116. ->addTag('kernel.reset', ['method' => 'reset'])
  117. ;
  119. $container->register('ux.twig_component.twig.component_extension', ComponentExtension::class)
  120. ->addTag('twig.extension')
  121. ;
  123. $container->register('ux.twig_component.twig.component_runtime', ComponentRuntime::class)
  124. ->setArguments([
  125. new Reference('ux.twig_component.component_renderer'),
  126. new ServiceLocatorArgument(new TaggedIteratorArgument('ux.twig_component.twig_renderer', indexAttribute: 'key', needsIndexes: true)),
  127. ])
  128. ->addTag('twig.runtime')
  129. ;
  131. $container->register('ux.twig_component.twig.lexer', ComponentLexer::class);
  133. $container->register('ux.twig_component.twig.environment_configurator', TwigEnvironmentConfigurator::class)
  134. ->setDecoratedService(new Reference('twig.configurator.environment'))
  135. ->setArguments([new Reference('ux.twig_component.twig.environment_configurator.inner')]);
  137. $container->register('ux.twig_component.command.debug', TwigComponentDebugCommand::class)
  138. ->setArguments([
  139. new Parameter('twig.default_path'),
  140. new Reference('ux.twig_component.component_factory'),
  141. new Reference('twig'),
  142. new AbstractArgument(\sprintf('Added in %s.', TwigComponentPass::class)),
  143. $config['anonymous_template_directory'],
  144. ])
  145. ->addTag('console.command')
  146. ;
  148. $container->setAlias('console.command.stimulus_component_debug', 'ux.twig_component.command.debug')
  149. ->setDeprecated('symfony/ux-twig-component', '2.13', '%alias_id%');
  151. if ($container->getParameter('kernel.debug') && $config['profiler']) {
  152. $loader->load('debug.php');
  153. }
  155. $loader->load('cache.php');
  157. $container->register('ux.twig_component.cache_warmer', TwigComponentCacheWarmer::class)
  158. ->setArguments([new Reference(\Psr\Container\ContainerInterface::class)])
  159. ->addTag('kernel.cache_warmer')
  160. ->addTag('container.service_subscriber', ['id' => 'ux.twig_component.component_properties'])
  161. ;
  162. }
  164. public function getConfigTreeBuilder(): TreeBuilder
  165. {
  166. $treeBuilder = new TreeBuilder('twig_component');
  167. $rootNode = $treeBuilder->getRootNode();
  168. \assert($rootNode instanceof ArrayNodeDefinition);
  170. $rootNode
  171. ->validate()
  172. ->always(function ($v) {
  173. if (!isset($v['anonymous_template_directory'])) {
  174. 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.');
  175. $v['anonymous_template_directory'] = null;
  176. }
  178. return $v;
  179. })
  180. ->end()
  181. ->children()
  182. ->arrayNode('defaults')
  183. ->defaultValue([self::DEPRECATED_DEFAULT_KEY])
  184. ->useAttributeAsKey('namespace')
  185. ->validate()
  186. ->always(function ($v) {
  187. foreach ($v as $namespace => $defaults) {
  188. if (!str_ends_with($namespace, '\\')) {
  189. throw new InvalidConfigurationException(\sprintf('The twig_component.defaults namespace "%s" is invalid: it must end in a "\".', $namespace));
  190. }
  191. }
  193. return $v;
  194. })
  195. ->end()
  196. ->arrayPrototype()
  197. ->beforeNormalization()
  198. ->ifString()
  199. ->then(function (string $v) {
  200. return ['template_directory' => $v];
  201. })
  202. ->end()
  203. ->children()
  204. ->scalarNode('template_directory')
  205. ->defaultValue('components')
  206. ->end()
  207. ->scalarNode('name_prefix')
  208. ->defaultValue('')
  209. ->end()
  210. ->end()
  211. ->end()
  212. ->end()
  213. ->scalarNode('anonymous_template_directory')
  214. ->info('Defaults to `components`')
  215. ->end()
  216. ->booleanNode('profiler')
  217. ->info('Enables the profiler for Twig Component (in debug mode)')
  218. ->defaultValue('%kernel.debug%')
  219. ->end()
  220. ->scalarNode('controllers_json')
  221. ->setDeprecated('symfony/ux-twig-component', '2.18', 'The "twig_component.controllers_json" config option is deprecated, and will be removed in 3.0.')
  222. ->defaultNull()
  223. ->end()
  224. ->end();
  226. return $treeBuilder;
  227. }
  229. public function getConfiguration(array $config, ContainerBuilder $container): ConfigurationInterface
  230. {
  231. return $this;
  232. }
  233. }