Adding refreshForm() to ComponentWithFormTrait

This also cleans up how initial form values are calculated

Author: weaverryan

src/LiveComponent/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## 2.1.0
 
+-   `ComponentWithFromTrait`: Added `refreshForm()` to rebuild form based
+    on chnaged data
+
+-   `ComponentWithFormTrait`: call `$this->initializeFormValues()` from
+    `mount()` if your component has a custom `mount()`.
+
+-   `ComponentWithFormTrait` no longer has a `setForm()` method, just call
+    `$this->formView = $form` from `mount()` if you have a custom mount.
+    Hopefully that will not be needed soon.
+
 -   The Live Component AJAX endpoints now return HTML in all situations
     instead of JSON.
 

src/LiveComponent/src/ComponentWithFormTrait.php

@@ -58,6 +58,11 @@ trait ComponentWithFormTrait
     #[LiveProp(writable: true)]
     public array $validatedFields = [];
 
+    /**
+     * Internal flag to track if the form should be submitted on render.
+     */
+    private bool $didFormSubmit = false;
+
     /**
      * Return the full, top-level, Form object that this component uses.
      */
@@ -66,14 +71,20 @@ abstract protected function instantiateForm(): FormInterface;
     /**
      * Override in your class if you need extra mounted values.
      *
-     * Call $this->setForm($form) manually in that situation
-     * if you're passing in an initial form.
+     * If you override, call $this->initializeFormValues() manually
+     * and also $this->formView = $form if you are passing in a Form.
+     *
+     * TODO: Refactor to PostMount when available.
+     * https://github.com/symfony/ux/pull/220
      */
-    public function mount(?FormView $form = null)
+    public function mount(FormView $form = null)
     {
         if ($form) {
-            $this->setForm($form);
+            $this->formView = $form;
         }
+
+        // set the formValues from the initial form view's data
+        $this->initializeFormValues();
     }
 
     /**
@@ -86,7 +97,7 @@ public function mount(?FormView $form = null)
     #[BeforeReRender]
     public function submitFormOnRender(): void
     {
-        if (!$this->getFormInstance()->isSubmitted()) {
+        if (!$this->getFormInstance()->isSubmitted() && !$this->didFormSubmit) {
             $this->submitForm(false);
         }
     }
@@ -103,18 +114,6 @@ public function getForm(): FormView
         return $this->formView;
     }
 
-    /**
-     * Call this from mount() if your component receives a FormView.
-     *
-     * If your are not passing a FormView into your component, you
-     * don't need to call this directly: the form will be set for
-     * you from your instantiateForm() method.
-     */
-    public function setForm(FormView $form): void
-    {
-        $this->formView = $form;
-    }
-
     public function getFormName(): string
     {
         if (!$this->formName) {
@@ -124,18 +123,16 @@ public function getFormName(): string
         return $this->formName;
     }
 
-    public function getFormValues(): array
+    private function initializeFormValues(): void
     {
-        if (null === $this->formValues) {
-            $this->formValues = $this->extractFormValues($this->getForm());
-        }
-
-        return $this->formValues;
+        $this->formValues = $this->extractFormValues($this->getForm());
     }
 
-    private function submitForm(bool $validateAll = true): void
+    private function submitForm(bool $validateAll = true, bool $throwOnValidationError = true): void
     {
-        $this->getFormInstance()->submit($this->formValues);
+        $form = $this->getFormInstance();
+        $form->submit($this->formValues);
+        $this->didFormSubmit = true;
 
         if ($validateAll) {
             // mark the entire component as validated
@@ -146,14 +143,29 @@ private function submitForm(bool $validateAll = true): void
             // we only want to validate fields in validatedFields
             // but really, everything is validated at this point, which
             // means we need to clear validation on non-matching fields
-            $this->clearErrorsForNonValidatedFields($this->getFormInstance(), $this->getFormName());
+            $this->clearErrorsForNonValidatedFields($form, $this->getFormName());
         }
 
-        if (!$this->getFormInstance()->isValid()) {
+        if ($throwOnValidationError && !$form->isValid()) {
             throw new UnprocessableEntityHttpException('Form validation failed in component');
         }
     }
 
+    /**
+     * Call this to rebuild the form objects.
+     *
+     * This is useful in action where you call $this->submitForm(),
+     * then, after, change some of the form's underlying data. By
+     * call this function, the form can rebuild using the new data.
+     */
+    private function refreshForm(): void
+    {
+        $this->formInstance = null;
+        $this->formView = null;
+        // re-initialize the form object and the formValues from it
+        $this->initializeFormValues();
+    }
+
     /**
      * Returns a hierarchical array of the entire form's values.
      *