Add new PHP Attribute JsProperty for usage in ComponentViewModels

Author: jissereitsma

Attribute/JsProperty.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace Loki\Components\Attribute;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_METHOD)]
+final class JsProperty
+{
+    public function __construct(
+        public readonly string $name,
+    ) {
+    }
+}

Component/Component.php

@@ -4,6 +4,7 @@
 namespace Loki\Components\Component;
 
 use Loki\Components\Util\Ajax;
+use Loki\Components\Util\JsPropertyResolver;
 use Magento\Framework\ObjectManagerInterface;
 use Magento\Framework\View\Element\AbstractBlock;
 use Magento\Framework\View\LayoutInterface;
@@ -26,7 +27,8 @@ public function __construct(
         protected LayoutInterface $layout,
         protected ComponentContextInterface $context,
         protected GlobalMessageRegistry $globalMessageRegistry,
-        LocalMessageRegistryFactory $localMessageRegistryFactory,
+        protected LocalMessageRegistryFactory $localMessageRegistryFactory,
+        protected JsPropertyResolver $jsPropertyResolver,
         protected Validator $validator,
         protected Filter $filter,
         protected Ajax $ajax,
@@ -37,7 +39,6 @@ public function __construct(
         protected ?string $repositoryClass = null,
         protected ?string $viewModelClass = null,
     ) {
-        $this->localMessageRegistry = $localMessageRegistryFactory->create();
     }
 
     public function getName(): string
@@ -172,6 +173,10 @@ public function getGlobalMessageRegistry(): GlobalMessageRegistry
 
     public function getLocalMessageRegistry(): LocalMessageRegistry
     {
+        if (false === $this->localMessageRegistry instanceof LocalMessageRegistry) {
+            $this->localMessageRegistry = $this->localMessageRegistryFactory->create();
+        }
+
         return $this->localMessageRegistry;
     }
 
@@ -202,4 +207,9 @@ public function getLayout(): LayoutInterface
     {
         return $this->layout;
     }
+
+    public function getJsPropertyResolver(): JsPropertyResolver
+    {
+        return $this->jsPropertyResolver;
+    }
 }

Component/ComponentViewModel.php

@@ -4,6 +4,7 @@
 namespace Loki\Components\Component;
 
 use Loki\Components\Util\Block\GetElementId;
+use Loki\Components\Util\JsPropertyResolver;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\View\Element\AbstractBlock;
 use Loki\Components\Filter\Filter;
@@ -228,9 +229,11 @@ public function isVisible(): bool
     public function getJsData(): array
     {
         $jsDataFromBlock = (array)$this->getBlock()->getJsData();
+        $jsProperties = $this->getComponent()->getJsPropertyResolver()->getJsProperties($this);
 
         return [
             ...(array)$jsDataFromBlock,
+            ...$jsProperties,
             'lazyLoad' => $this->isLazyLoad(),
             'lazyUpdate' => $this->isLazyUpdate(),
             'lazyUpdateTimeout' => $this->getLazyUpdateTimeout(),

Util/JsPropertyResolver.php

@@ -0,0 +1,26 @@
+<?php declare(strict_types=1);
+
+namespace Loki\Components\Util;
+
+use Loki\Components\Attribute\JsProperty;
+use Loki\Components\Component\ComponentViewModelInterface;
+use ReflectionClass;
+
+class JsPropertyResolver
+{
+    public function getJsProperties(ComponentViewModelInterface $componentViewModel): array
+    {
+        $reflection = new ReflectionClass($componentViewModel::class);
+        $jsProperties = [];
+
+        foreach ($reflection->getMethods() as $method) {
+            $attributes = $method->getAttributes(JsProperty::class);
+            foreach ($attributes as $attribute) {
+                $instance = $attribute->newInstance();
+                $jsProperties[$instance->name] = $method->invoke($componentViewModel);
+            }
+        }
+
+        return $jsProperties;
+    }
+}