Allow class-string argument in AsLiveComponent static methods

symfony · Oct 11, 2023 · 7266159 · 7266159
1 parent f52d7af
commit 7266159
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 5 deletions.
diff --git a/src/LiveComponent/src/Attribute/AsLiveComponent.php b/src/LiveComponent/src/Attribute/AsLiveComponent.php
@@ -48,8 +48,10 @@ public function serviceConfig(): array
 
     /**
      * @internal
+     *
+     * @param object|class-string $component
      */
-    public static function isActionAllowed(object $component, string $action): bool
+    public static function isActionAllowed(object|string $component, string $action): bool
     {
         foreach (self::attributeMethodsFor(LiveAction::class, $component) as $method) {
             if ($action === $method->getName()) {
@@ -63,34 +65,47 @@ public static function isActionAllowed(object $component, string $action): bool
     /**
      * @internal
      *
+     * @param object|class-string $component
+     *
      * @return \ReflectionMethod[]
      */
-    public static function preReRenderMethods(object $component): iterable
+    public static function preReRenderMethods(object|string $component): iterable
     {
         return self::attributeMethodsByPriorityFor($component, PreReRender::class);
     }
 
     /**
      * @internal
      *
+     * @param object|class-string $component
+     *
      * @return \ReflectionMethod[]
      */
-    public static function postHydrateMethods(object $component): iterable
+    public static function postHydrateMethods(object|string $component): iterable
     {
         return self::attributeMethodsByPriorityFor($component, PostHydrate::class);
     }
 
     /**
      * @internal
      *
+     * @param object|class-string $component
+     *
      * @return \ReflectionMethod[]
      */
-    public static function preDehydrateMethods(object $component): iterable
+    public static function preDehydrateMethods(object|string $component): iterable
     {
         return self::attributeMethodsByPriorityFor($component, PreDehydrate::class);
     }
 
-    public static function liveListeners(object $component): array
+    /**
+     * @internal
+     *
+     * @param object|class-string $component
+     *
+     * @return array<array{action: string, event: string}>
+     */
+    public static function liveListeners(object|string $component): array
     {
         $listeners = [];
         foreach (self::attributeMethodsFor(LiveListener::class, $component) as $method) {

diff --git a/src/LiveComponent/tests/Unit/Attribute/AsLiveComponentTest.php b/src/LiveComponent/tests/Unit/Attribute/AsLiveComponentTest.php
@@ -13,6 +13,8 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
+use Symfony\UX\LiveComponent\Attribute\LiveAction;
+use Symfony\UX\LiveComponent\Attribute\LiveListener;
 use Symfony\UX\LiveComponent\Attribute\PostHydrate;
 use Symfony\UX\LiveComponent\Attribute\PreDehydrate;
 use Symfony\UX\LiveComponent\Attribute\PreReRender;
@@ -104,6 +106,15 @@ public function hook3()
         $this->assertSame('hook1', $hooks[2]->name);
     }
 
+    public function testCanGetPostHydrateMethodsFromClassString(): void
+    {
+        $methods = AsLiveComponent::postHydrateMethods(DummyLiveComponent::class);
+
+        $this->assertCount(1, $methods);
+        $this->assertSame('method', $methods[0]->getName());
+        $this->assertSame(DummyLiveComponent::class, $methods[0]->getDeclaringClass()?->getName());
+    }
+
     public function testCanGetLiveListeners(): void
     {
         $liveListeners = AsLiveComponent::liveListeners(new Component5());
@@ -115,6 +126,17 @@ public function testCanGetLiveListeners(): void
         ], $liveListeners[0]);
     }
 
+    public function testCanGetLiveListenersFromClassString(): void
+    {
+        $liveListeners = AsLiveComponent::liveListeners(DummyLiveComponent::class);
+
+        $this->assertCount(1, $liveListeners);
+        $this->assertSame([
+            'action' => 'method',
+            'event' => 'event_name',
+        ], $liveListeners[0]);
+    }
+
     public function testCanCheckIfMethodIsAllowed(): void
     {
         $component = new Component5();
@@ -124,3 +146,17 @@ public function testCanCheckIfMethodIsAllowed(): void
         $this->assertTrue(AsLiveComponent::isActionAllowed($component, 'aListenerActionMethod'));
     }
 }
+
+#[AsLiveComponent]
+class DummyLiveComponent
+{
+    #[PreDehydrate]
+    #[PreReRender]
+    #[PostHydrate]
+    #[LiveListener('event_name')]
+    #[LiveAction]
+    public function method(): bool
+    {
+        return true;
+    }
+}