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

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. new AbstractArgument(\sprintf('Added in %s.', TwigComponentPass::class)),
  95. new Reference('twig'),
  96. ])
  97. ->addTag('kernel.reset', ['method' => 'reset'])
  98. ;
  100. $container->register('ux.twig_component.component_stack', ComponentStack::class);
  102. $container->register('ux.twig_component.component_properties', ComponentProperties::class)
  103. ->setArguments([
  104. new Reference('property_accessor'),
  105. new AbstractArgument(\sprintf('Added in %s.', TwigComponentPass::class)),
  106. new Reference('cache.ux.twig_component', ContainerInterface::IGNORE_ON_INVALID_REFERENCE),
  107. ])
  108. ;
  110. $container->register('ux.twig_component.component_renderer', ComponentRenderer::class)
  111. ->setArguments([
  112. new Reference('twig'),
  113. new Reference('event_dispatcher'),
  114. new Reference('ux.twig_component.component_factory'),
  115. new Reference('ux.twig_component.component_properties'),
  116. new Reference('ux.twig_component.component_stack'),
  117. ])
  118. ->addTag('kernel.reset', ['method' => 'reset'])
  119. ;
  121. $container->register('ux.twig_component.twig.component_extension', ComponentExtension::class)
  122. ->addTag('twig.extension')
  123. ;
  125. $container->register('ux.twig_component.twig.component_runtime', ComponentRuntime::class)
  126. ->setArguments([
  127. new Reference('ux.twig_component.component_renderer'),
  128. new ServiceLocatorArgument(new TaggedIteratorArgument('ux.twig_component.twig_renderer', indexAttribute: 'key', needsIndexes: true)),
  129. ])
  130. ->addTag('twig.runtime')
  131. ;
  133. $container->register('ux.twig_component.twig.lexer', ComponentLexer::class);
  135. $container->register('ux.twig_component.twig.environment_configurator', TwigEnvironmentConfigurator::class)
  136. ->setDecoratedService(new Reference('twig.configurator.environment'))
  137. ->setArguments([new Reference('ux.twig_component.twig.environment_configurator.inner')]);
  139. $container->register('ux.twig_component.command.debug', TwigComponentDebugCommand::class)
  140. ->setArguments([
  141. new Parameter('twig.default_path'),
  142. new Reference('ux.twig_component.component_factory'),
  143. new Reference('twig'),
  144. new AbstractArgument(\sprintf('Added in %s.', TwigComponentPass::class)),
  145. $config['anonymous_template_directory'],
  146. ])
  147. ->addTag('console.command')
  148. ;
  150. $container->setAlias('console.command.stimulus_component_debug', 'ux.twig_component.command.debug')
  151. ->setDeprecated('symfony/ux-twig-component', '2.13', '%alias_id%');
  153. if ($container->getParameter('kernel.debug') && $config['profiler']) {
  154. $loader->load('debug.php');
  155. }
  157. $loader->load('cache.php');
  159. $container->register('ux.twig_component.cache_warmer', TwigComponentCacheWarmer::class)
  160. ->setArguments([new Reference(\Psr\Container\ContainerInterface::class)])
  161. ->addTag('kernel.cache_warmer')
  162. ->addTag('container.service_subscriber', ['id' => 'ux.twig_component.component_properties'])
  163. ;
  164. }
  166. public function getConfigTreeBuilder(): TreeBuilder
  167. {
  168. $treeBuilder = new TreeBuilder('twig_component');
  169. $rootNode = $treeBuilder->getRootNode();
  170. \assert($rootNode instanceof ArrayNodeDefinition);
  172. $rootNode
  173. ->validate()
  174. ->always(function ($v) {
  175. if (!isset($v['anonymous_template_directory'])) {
  176. 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.');
  177. $v['anonymous_template_directory'] = null;
  178. }
  180. return $v;
  181. })
  182. ->end()
  183. ->children()
  184. ->arrayNode('defaults')
  185. ->defaultValue([self::DEPRECATED_DEFAULT_KEY])
  186. ->useAttributeAsKey('namespace')
  187. ->validate()
  188. ->always(function ($v) {
  189. foreach ($v as $namespace => $defaults) {
  190. if (!str_ends_with($namespace, '\\')) {
  191. throw new InvalidConfigurationException(\sprintf('The twig_component.defaults namespace "%s" is invalid: it must end in a "\".', $namespace));
  192. }
  193. }
  195. return $v;
  196. })
  197. ->end()
  198. ->arrayPrototype()
  199. ->beforeNormalization()
  200. ->ifString()
  201. ->then(function (string $v) {
  202. return ['template_directory' => $v];
  203. })
  204. ->end()
  205. ->children()
  206. ->scalarNode('template_directory')
  207. ->defaultValue('components')
  208. ->end()
  209. ->scalarNode('name_prefix')
  210. ->defaultValue('')
  211. ->end()
  212. ->end()
  213. ->end()
  214. ->end()
  215. ->scalarNode('anonymous_template_directory')
  216. ->info('Defaults to `components`')
  217. ->end()
  218. ->booleanNode('profiler')
  219. ->info('Enables the profiler for Twig Component (in debug mode)')
  220. ->defaultValue('%kernel.debug%')
  221. ->end()
  222. ->scalarNode('controllers_json')
  223. ->setDeprecated('symfony/ux-twig-component', '2.18', 'The "twig_component.controllers_json" config option is deprecated, and will be removed in 3.0.')
  224. ->defaultNull()
  225. ->end()
  226. ->end();
  228. return $treeBuilder;
  229. }
  231. public function getConfiguration(array $config, ContainerBuilder $container): ConfigurationInterface
  232. {
  233. return $this;
  234. }
  235. }