vendor/symfony/ux-live-component/src/Attribute/AsLiveComponent.php line 43

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\LiveComponent\Attribute;
  14. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  15. use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
  17. /**
  18. * An attribute to register a LiveComponent.
  19. *
  20. * @see https://symfony.com/bundles/ux-live-component
  21. *
  22. * @author Kevin Bond <kevinbond@gmail.com>
  23. */
  24. #[\Attribute(\Attribute::TARGET_CLASS)]
  25. final class AsLiveComponent extends AsTwigComponent
  26. {
  27. public string $route;
  28. public string $method;
  29. public int $urlReferenceType;
  31. private ?string $defaultAction;
  33. /**
  34. * @param string|null $name The component name (ie: TodoList)
  35. * @param string|null $template The template path of the component (ie: components/TodoList.html.twig).
  36. * @param string|null $defaultAction The default action to call when the component is mounted (ie: __invoke)
  37. * @param bool $exposePublicProps Whether to expose every public property as a Twig variable
  38. * @param string $attributesVar The name of the special "attributes" variable in the template
  39. * @param string $route The route used to render the component & handle actions
  40. * @param string $method The HTTP method to use
  41. * @param UrlGeneratorInterface::* $urlReferenceType Which type of URL should be generated for the given route
  42. */
  43. public function __construct(
  44. ?string $name = null,
  45. ?string $template = null,
  46. ?string $defaultAction = null,
  47. bool $exposePublicProps = true,
  48. string $attributesVar = 'attributes',
  49. string|bool $route = 'ux_live_component',
  50. string $method = 'post',
  51. int|string $urlReferenceType = UrlGeneratorInterface::ABSOLUTE_PATH,
  52. public bool|int $csrf = true, // @deprecated
  53. ) {
  54. if (8 < \func_num_args() || \is_bool($route)) {
  55. trigger_deprecation('symfony/ux-live-component', '2.21', 'Argument "$csrf" of "#[%s]" has no effect anymore and is deprecated.', static::class);
  56. }
  57. if (\is_bool($route)) {
  58. $this->csrf = $route;
  59. $route = $method;
  60. $method = $urlReferenceType;
  61. $urlReferenceType = $csrf;
  63. switch (\func_num_args()) {
  64. case 6: $route = 'ux_live_component';
  65. // no break
  66. case 7: $method = 'post';
  67. // no break
  68. case 8: $urlReferenceType = UrlGeneratorInterface::ABSOLUTE_PATH;
  69. // no break
  70. default:
  71. }
  72. }
  74. parent::__construct($name, $template, $exposePublicProps, $attributesVar);
  76. $this->defaultAction = $defaultAction;
  77. $this->route = $route;
  78. $this->method = strtolower($method);
  79. $this->urlReferenceType = $urlReferenceType;
  81. if (!\in_array($method, ['get', 'post'])) {
  82. throw new \UnexpectedValueException('$method must be either \'get\' or \'post\'.');
  83. }
  84. }
  86. /**
  87. * @internal
  88. */
  89. public function serviceConfig(): array
  90. {
  91. return array_merge(parent::serviceConfig(), [
  92. 'default_action' => $this->defaultAction,
  93. 'live' => true,
  94. 'csrf' => $this->csrf,
  95. 'route' => $this->route,
  96. 'method' => $this->method,
  97. 'url_reference_type' => $this->urlReferenceType,
  98. ]);
  99. }
  101. /**
  102. * @internal
  103. *
  104. * @param object|class-string $component
  105. */
  106. public static function isActionAllowed(object|string $component, string $action): bool
  107. {
  108. foreach (self::attributeMethodsFor(LiveAction::class, $component) as $method) {
  109. if ($action === $method->getName()) {
  110. return true;
  111. }
  112. }
  114. return false;
  115. }
  117. /**
  118. * @internal
  119. *
  120. * @param object|class-string $component
  121. *
  122. * @return \ReflectionMethod[]
  123. */
  124. public static function preReRenderMethods(object|string $component): iterable
  125. {
  126. return self::attributeMethodsByPriorityFor($component, PreReRender::class);
  127. }
  129. /**
  130. * @internal
  131. *
  132. * @param object|class-string $component
  133. *
  134. * @return \ReflectionMethod[]
  135. */
  136. public static function postHydrateMethods(object|string $component): iterable
  137. {
  138. return self::attributeMethodsByPriorityFor($component, PostHydrate::class);
  139. }
  141. /**
  142. * @internal
  143. *
  144. * @param object|class-string $component
  145. *
  146. * @return \ReflectionMethod[]
  147. */
  148. public static function preDehydrateMethods(object|string $component): iterable
  149. {
  150. return self::attributeMethodsByPriorityFor($component, PreDehydrate::class);
  151. }
  153. /**
  154. * @internal
  155. *
  156. * @param object|class-string $component
  157. *
  158. * @return array<array{action: string, event: string}>
  159. */
  160. public static function liveListeners(object|string $component): array
  161. {
  162. $listeners = [];
  163. foreach (self::attributeMethodsFor(LiveListener::class, $component) as $method) {
  164. foreach ($method->getAttributes(LiveListener::class) as $attribute) {
  165. $listeners[] = ['action' => $method->getName(), 'event' => $attribute->newInstance()->getEventName()];
  166. }
  167. }
  169. return $listeners;
  170. }
  171. }