[LiveComponent] add LiveProp name to modifier function

Author: jannes-io

src/LiveComponent/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 2.25.0
+
+- Add property name as second paramter to LiveProp modifier callback
+
 ## 2.23.0
 
 -   Allow configuring the secret used to compute fingerprints and checksums.

src/LiveComponent/doc/index.rst

@@ -2651,6 +2651,47 @@ This way you can also use the component multiple times in the same page and avoi
     <twig:SearchModule alias="q1" />
     <twig:SearchModule alias="q2" />
 
+.. versionadded:: 2.25
+
+   The property name is passed into the modifier function since LiveComponents 2.25.
+
+The ``modifier`` function can also take the name of the property as a secondary parameter.
+It can be used to perform more generic operations inside of the modifier that can be re-used for multiple props::
+
+    abstract class AbstractSearchModule
+    {
+        #[LiveProp(writable: true, url: true, modifier: 'modifyQueryProp')]
+        public string $query = '';
+
+        protected string $urlPrefix = '';
+
+        public function modifyQueryProp(LiveProp $liveProp, string $propName): LiveProp
+        {
+            if ($this->urlPrefix) {
+                return $liveProp->withUrl(new UrlMapping(as: $this->urlPrefix.'-'.$propName));
+            }
+            return $liveProp;
+        }
+    }
+
+    #[AsLiveComponent]
+    class ImportantSearchModule extends AbstractSearchModule
+    {
+    }
+
+    #[AsLiveComponent]
+    class SecondarySearchModule extends AbstractSearchModule
+    {
+        protected string $urlPrefix = 'secondary';
+    }
+
+.. code-block:: html+twig
+
+    <twig:ImportantSearchModule />
+    <twig:SecondarySearchModule />
+
+The ``query`` value will appear in the URL like ``/search?query=my+important+query&secondary-query=my+secondary+query``.
+
 Validating the Query Parameter Values
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

src/LiveComponent/src/Metadata/LivePropMetadata.php

@@ -135,7 +135,7 @@ public function withModifier(object $component): self
             throw new \LogicException(\sprintf('Method "%s::%s()" given in LiveProp "modifier" does not exist.', $component::class, $modifier));
         }
 
-        $modifiedLiveProp = $component->{$modifier}($this->liveProp);
+        $modifiedLiveProp = $component->{$modifier}($this->liveProp, $this->getName());
         if (!$modifiedLiveProp instanceof LiveProp) {
             throw new \LogicException(\sprintf('Method "%s::%s()" should return an instance of "%s" (given: "%s").', $component::class, $modifier, LiveProp::class, get_debug_type($modifiedLiveProp)));
         }

src/LiveComponent/tests/Unit/Metadata/LivePropMetadataTest.php

@@ -29,7 +29,7 @@ public function testWithModifier()
         $component
             ->expects($this->once())
             ->method('modifyProp')
-            ->with($liveProp)
+            ->with($liveProp, 'propWithModifier')
             ->willReturn($liveProp->withFieldName('customField'));
 
         $livePropMetadata = $livePropMetadata->withModifier($component);