vendor/symfony/ux-twig-component/src/ComponentFactory.php line 42

  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;
  14. use Psr\EventDispatcher\EventDispatcherInterface;
  15. use Symfony\Component\DependencyInjection\ServiceLocator;
  16. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  17. use Symfony\Contracts\Service\ResetInterface;
  18. use Symfony\UX\TwigComponent\Event\PostMountEvent;
  19. use Symfony\UX\TwigComponent\Event\PreMountEvent;
  20. use Twig\Environment;
  21. use Twig\Runtime\EscaperRuntime;
  23. /**
  24. * @author Kevin Bond <kevinbond@gmail.com>
  25. *
  26. * @internal
  27. */
  28. final class ComponentFactory implements ResetInterface
  29. {
  30. private array $mountMethods = [];
  32. /**
  33. * @param array<string, array> $config
  34. * @param array<class-string, string> $classMap
  35. */
  36. public function __construct(
  37. private ComponentTemplateFinderInterface $componentTemplateFinder,
  38. private ServiceLocator $components,
  39. private PropertyAccessorInterface $propertyAccessor,
  40. private EventDispatcherInterface $eventDispatcher,
  41. private array $config,
  42. private readonly array $classMap,
  43. private readonly Environment $twig,
  44. ) {
  45. }
  47. public function metadataFor(string $name): ComponentMetadata
  48. {
  49. if ($config = $this->config[$name] ?? null) {
  50. return new ComponentMetadata($config);
  51. }
  53. if ($template = $this->componentTemplateFinder->findAnonymousComponentTemplate($name)) {
  54. $this->config[$name] = [
  55. 'key' => $name,
  56. 'template' => $template,
  57. ];
  59. return new ComponentMetadata($this->config[$name]);
  60. }
  62. if ($mappedName = $this->classMap[$name] ?? null) {
  63. if ($config = $this->config[$mappedName] ?? null) {
  64. return new ComponentMetadata($config);
  65. }
  67. throw new \InvalidArgumentException(\sprintf('Unknown component "%s".', $name));
  68. }
  70. $this->throwUnknownComponentException($name);
  71. }
  73. /**
  74. * Creates the component and "mounts" it with the passed data.
  75. */
  76. public function create(string $name, array $data = []): MountedComponent
  77. {
  78. $metadata = $this->metadataFor($name);
  80. if ($metadata->isAnonymous()) {
  81. return $this->mountFromObject(new AnonymousComponent(), $data, $metadata);
  82. }
  84. return $this->mountFromObject($this->components->get($metadata->getName()), $data, $metadata);
  85. }
  87. /**
  88. * @internal
  89. */
  90. public function mountFromObject(object $component, array $data, ComponentMetadata $componentMetadata): MountedComponent
  91. {
  92. $originalData = $data;
  93. $event = $this->preMount($component, $data, $componentMetadata);
  94. $data = $event->getData();
  96. $this->mount($component, $data, $componentMetadata);
  98. if (!$componentMetadata->isAnonymous()) {
  99. // set data that wasn't set in mount on the component directly
  100. foreach ($data as $property => $value) {
  101. if ($this->propertyAccessor->isWritable($component, $property)) {
  102. $this->propertyAccessor->setValue($component, $property, $value);
  103. unset($data[$property]);
  104. }
  105. }
  106. }
  108. $postMount = $this->postMount($component, $data, $componentMetadata);
  109. $data = $postMount->getData();
  111. // create attributes from "attributes" key if exists
  112. $attributesVar = $componentMetadata->getAttributesVar();
  113. $attributes = $data[$attributesVar] ?? [];
  114. unset($data[$attributesVar]);
  116. foreach ($data as $key => $value) {
  117. if ($value instanceof \Stringable) {
  118. $data[$key] = (string) $value;
  119. }
  120. }
  122. return new MountedComponent(
  123. $componentMetadata->getName(),
  124. $component,
  125. new ComponentAttributes([...$attributes, ...$data], $this->twig->getRuntime(EscaperRuntime::class)),
  126. $originalData,
  127. $postMount->getExtraMetadata(),
  128. );
  129. }
  131. /**
  132. * Returns the "unmounted" component.
  133. *
  134. * @internal
  135. */
  136. public function get(string $name): object
  137. {
  138. $metadata = $this->metadataFor($name);
  140. if ($metadata->isAnonymous()) {
  141. return new AnonymousComponent();
  142. }
  144. return $this->components->get($metadata->getName());
  145. }
  147. private function mount(object $component, array &$data, ComponentMetadata $componentMetadata): void
  148. {
  149. if ($component instanceof AnonymousComponent) {
  150. $component->mount($data);
  152. return;
  153. }
  155. if (!$componentMetadata->getMounts()) {
  156. return;
  157. }
  159. $mount = $this->mountMethods[$component::class] ??= (new \ReflectionClass($component))->getMethod('mount');
  161. $parameters = [];
  162. foreach ($mount->getParameters() as $refParameter) {
  163. if (\array_key_exists($name = $refParameter->getName(), $data)) {
  164. $parameters[] = $data[$name];
  165. // remove the data element so it isn't used to set the property directly.
  166. unset($data[$name]);
  167. } elseif ($refParameter->isDefaultValueAvailable()) {
  168. $parameters[] = $refParameter->getDefaultValue();
  169. } else {
  170. throw new \LogicException(\sprintf('"%s" has a required $%s parameter. Make sure to pass it or give it a default value.', $component::class.'::mount()', $name));
  171. }
  172. }
  174. $mount->invoke($component, ...$parameters);
  175. }
  177. private function preMount(object $component, array $data, ComponentMetadata $componentMetadata): PreMountEvent
  178. {
  179. $event = new PreMountEvent($component, $data, $componentMetadata);
  180. $this->eventDispatcher->dispatch($event);
  182. $data = $event->getData();
  183. foreach ($componentMetadata->getPreMounts() as $preMount) {
  184. if (null !== $newData = $component->$preMount($data)) {
  185. $event->setData($data = $newData);
  186. }
  187. }
  189. return $event;
  190. }
  192. private function postMount(object $component, array $data, ComponentMetadata $componentMetadata): PostMountEvent
  193. {
  194. $event = new PostMountEvent($component, $data, $componentMetadata);
  195. $this->eventDispatcher->dispatch($event);
  197. $data = $event->getData();
  198. foreach ($componentMetadata->getPostMounts() as $postMount) {
  199. if (null !== $newData = $component->$postMount($data)) {
  200. $event->setData($data = $newData);
  201. }
  202. }
  204. return $event;
  205. }
  207. /**
  208. * @return never
  209. */
  210. private function throwUnknownComponentException(string $name): void
  211. {
  212. $message = \sprintf('Unknown component "%s".', $name);
  213. $lowerName = strtolower($name);
  214. $nameLength = \strlen($lowerName);
  215. $alternatives = [];
  217. foreach (array_keys($this->config) as $type) {
  218. $lowerType = strtolower($type);
  219. $lev = levenshtein($lowerName, $lowerType);
  221. if ($lev <= $nameLength / 3 || str_contains($lowerType, $lowerName)) {
  222. $alternatives[] = $type;
  223. }
  224. }
  226. if ($alternatives) {
  227. if (1 === \count($alternatives)) {
  228. $message .= ' Did you mean this: "';
  229. } else {
  230. $message .= ' Did you mean one of these: "';
  231. }
  233. $message .= implode('", "', $alternatives).'"?';
  234. } else {
  235. $message .= ' And no matching anonymous component template was found.';
  236. }
  238. throw new \InvalidArgumentException($message);
  239. }
  241. public function reset(): void
  242. {
  243. $this->mountMethods = [];
  244. }
  245. }