Added a way to set and get form in form adapter.

Author: Daniel Berthereau

src/Api/Representation/SearchConfigRepresentation.php

@@ -34,11 +34,21 @@
 
 class SearchConfigRepresentation extends AbstractEntityRepresentation
 {
+    /**
+     * @var bool
+     */
+    private $isFormInit = false;
+
     /**
      * @var \AdvancedSearch\FormAdapter\FormAdapterInterface
      */
     protected $formAdapter;
 
+    /**
+     * @var \Laminas\Form\Form|null
+     */
+    protected $form;
+
     public function getJsonLdType()
     {
         return 'o:SearchConfig';
@@ -123,35 +133,18 @@ public function formAdapterName(): ?string
 
     public function formAdapter(): ?\AdvancedSearch\FormAdapter\FormAdapterInterface
     {
-        if (!$this->formAdapter) {
-            $formAdapterManager = $this->getServiceLocator()->get('Search\FormAdapterManager');
-            $formAdapterName = $this->formAdapterName();
-            if ($formAdapterManager->has($formAdapterName)) {
-                $this->formAdapter = $formAdapterManager->get($formAdapterName);
-            }
+        if (!$this->isFormInit) {
+            $this->formInit();
         }
-
         return $this->formAdapter;
     }
 
     public function form(): ?\Laminas\Form\Form
     {
-        $formAdapter = $this->formAdapter();
-        if (empty($formAdapter)) {
-            return null;
-        }
-
-        $formClass = $formAdapter->getFormClass();
-        if (empty($formClass)) {
-            return null;
+        if (!$this->isFormInit) {
+            $this->formInit();
         }
-
-        return $this->getServiceLocator()
-            ->get('FormElementManager')
-            ->get($formClass, [
-                'search_config' => $this,
-            ])
-            ->setAttribute('method', 'GET');
+        return $this->form;
     }
 
     public function settings(): array
@@ -183,4 +176,32 @@ public function getEntity(): \AdvancedSearch\Entity\SearchConfig
     {
         return $this->resource;
     }
+
+    private function formInit(): self
+    {
+        $this->isFormInit = true;
+
+        $formAdapterManager = $this->getServiceLocator()->get('Search\FormAdapterManager');
+        $formAdapterName = $this->formAdapterName();
+        if (!$formAdapterManager->has($formAdapterName)) {
+            return $this;
+        }
+
+        $this->formAdapter = $formAdapterManager->get($formAdapterName);
+        $formClass = $this->formAdapter->getFormClass();
+        if (empty($formClass)) {
+            return $this;
+        }
+
+        $this->form = $this->getServiceLocator()
+            ->get('FormElementManager')
+            ->get($formClass, [
+                'search_config' => $this,
+            ])
+            ->setAttribute('method', 'GET');
+
+        $this->formAdapter->setForm($this->form);
+
+        return $this;
+    }
 }

src/FormAdapter/AbstractFormAdapter.php

@@ -33,8 +33,21 @@
 
 abstract class AbstractFormAdapter implements FormAdapterInterface
 {
+    protected $form;
+
     abstract public function getLabel(): string;
 
+    public function setForm(?\Laminas\Form\Form $form): \AdvancedSearch\FormAdapter\FormAdapterInterface
+    {
+        $this->form = $form;
+        return $this;
+    }
+
+    public function getForm(): ?\Laminas\Form\Form
+    {
+        return $this->form;
+    }
+
     public function getFormPartialHeaders(): ?string
     {
         return null;

src/FormAdapter/ApiFormAdapter.php

@@ -30,6 +30,16 @@ public function getLabel(): string
         return 'Api'; // @translate
     }
 
+    public function setForm(?\Laminas\Form\Form $form): \AdvancedSearch\FormAdapter\FormAdapterInterface
+    {
+        return $this;
+    }
+
+    public function getForm(): ?\Laminas\Form\Form
+    {
+        return null;
+    }
+
     public function getFormClass(): ?string
     {
         return null;

src/FormAdapter/FormAdapterInterface.php

@@ -34,6 +34,13 @@ interface FormAdapterInterface
 {
     public function getLabel(): string;
 
+    public function setForm(?\Laminas\Form\Form $form): \AdvancedSearch\FormAdapter\FormAdapterInterface;
+
+    public function getForm(): ?\Laminas\Form\Form;
+
+    /**
+     * The form class to use to build the search form, if any.
+     */
     public function getFormClass(): ?string;
 
     /**

src/View/Helper/SearchForm.php

@@ -6,6 +6,9 @@
 use Laminas\Form\Form;
 use Laminas\View\Helper\AbstractHelper;
 
+/**
+ * @todo Remove this view helper and use SearchConfigRepresentation::form() only.
+ */
 class SearchForm extends AbstractHelper
 {
     /**