Merge pull request #861 from getformwork/refactor/optional-password-updates

Refactor form initialization to enable optional password updates

Author: giuscris

formwork/fields/password.php

@@ -1,9 +1,29 @@
 <?php
 
 use Formwork\Cms\App;
+use Formwork\Fields\Field;
+use Formwork\Utils\Constraint;
 
 return function (App $app) {
     return [
         'extend' => 'text',
+
+        'methods' => [
+            /**
+             * Return whether to ignore empty values when setting the field value
+             *
+             * This is useful for password fields, where you don't want to overwrite the existing password with an empty value if the user doesn't enter a new password.
+             */
+            'ignoreEmpty' => function (Field $field): bool {
+                return $field->is('ignoreEmpty', false);
+            },
+
+            'setValue' => function (Field $field, $value) {
+                if ($field->ignoreEmpty() && Constraint::isEmpty($value)) {
+                    return $field->value();
+                }
+                return $value;
+            },
+        ],
     ];
 };

formwork/src/Panel/Controllers/FilesController.php

@@ -9,7 +9,6 @@
 use Formwork\Files\FileFactory;
 use Formwork\Forms\FormData;
 use Formwork\Http\JsonResponse;
-use Formwork\Http\RequestMethod;
 use Formwork\Http\Response;
 use Formwork\Http\ResponseStatus;
 use Formwork\Images\Image;
@@ -145,11 +144,7 @@ public function edit(RouteParams $routeParams): Response
             return $this->redirectToReferer(base: $this->panel->panelRoot());
         }
 
-        // Set initial values on GET
-        if ($this->request->method() === RequestMethod::GET) {
-            $file->fields()->setValues($file->data())
-                ->isValid(); // Pre-validate to populate validation state
-        }
+        $file->fields()->setValues($file->data());
 
         $form = $this->form('file-metadata', $file->fields())
             ->processRequest($this->request, uploadFiles: false);

formwork/src/Panel/Controllers/OptionsController.php

@@ -3,7 +3,6 @@
 namespace Formwork\Panel\Controllers;
 
 use Formwork\Config\Config;
-use Formwork\Http\RequestMethod;
 use Formwork\Http\Response;
 use Formwork\Parsers\Yaml;
 use Formwork\Schemes\Schemes;
@@ -44,11 +43,7 @@ public function systemOptions(Schemes $schemes): Response
         $scheme = $schemes->get('config.system');
         $fields = $scheme->fields();
 
-        // Set initial values on GET
-        if ($this->request->method() === RequestMethod::GET) {
-            $fields->setValues($this->config->get('system'))
-                ->isValid(); // Pre-validate to populate validation state
-        }
+        $fields->setValues($this->config->get('system'));
 
         $form = $this->form('system-options', $fields)
             ->processRequest($this->request);
@@ -97,11 +92,7 @@ public function siteOptions(Schemes $schemes): Response
         $scheme = $schemes->get('config.site');
         $fields = $scheme->fields();
 
-        // Set initial values on GET
-        if ($this->request->method() === RequestMethod::GET) {
-            $fields->setValues($this->site->data())
-                ->isValid(); // Pre-validate to populate validation state
-        }
+        $fields->setValues($this->site->data());
 
         $form = $this->form('site-options', $fields)
             ->processRequest($this->request);

formwork/src/Panel/Controllers/PagesController.php

@@ -9,7 +9,6 @@
 use Formwork\Forms\FormData;
 use Formwork\Http\JsonResponse;
 use Formwork\Http\RequestData;
-use Formwork\Http\RequestMethod;
 use Formwork\Http\Response;
 use Formwork\Http\ResponseStatus;
 use Formwork\Pages\Page;
@@ -223,10 +222,7 @@ public function edit(RouteParams $routeParams): Response
         // Clone the page fields to work with a separate copy
         $fieldCollection = $page->fields()->deepClone();
 
-        if ($this->request->method() === RequestMethod::GET) {
-            $fieldCollection->setValues($page->data())
-                ->isValid(); // Pre-validate to populate validation state
-        }
+        $fieldCollection->setValues($page->data());
 
         $form = $this->form('page-editor', $fieldCollection)
             ->setDefaultUploadsDestination($page->contentPath())

formwork/src/Panel/Controllers/PluginsController.php

@@ -4,7 +4,6 @@
 
 use Formwork\Fields\FieldCollection;
 use Formwork\Http\JsonResponse;
-use Formwork\Http\RequestMethod;
 use Formwork\Http\Response;
 use Formwork\Http\ResponseStatus;
 use Formwork\Parsers\Yaml;
@@ -72,11 +71,7 @@ public function plugin(RouteParams $routeParams, Plugins $plugins): Response
 
         $fields = $scheme->fields();
 
-        // Set initial values on GET
-        if ($this->request->method() === RequestMethod::GET) {
-            $data = $this->config->get("plugins.{$name}", []);
-            $fields->setValues($data);
-        }
+        $fields->setValues($this->config->get("plugins.{$name}", []));
 
         $form = $this->form('plugin-options', $fields)
             ->processRequest($this->request);

formwork/src/Panel/Controllers/UsersController.php

@@ -7,7 +7,6 @@
 use Formwork\Fields\Field;
 use Formwork\Forms\FormData;
 use Formwork\Http\FileResponse;
-use Formwork\Http\RequestMethod;
 use Formwork\Http\Response;
 use Formwork\Images\Image;
 use Formwork\Router\RouteParams;
@@ -173,11 +172,7 @@ public function profile(RouteParams $routeParams): Response
         // Disable role field if it cannot be changed
         $fields->get('role')->set('disabled', !$this->panel->user()->canChangeRoleOf($user));
 
-        // Set initial values on GET
-        if ($this->request->method() === RequestMethod::GET) {
-            $fields->setValues($user)
-                ->isValid(); // Pre-validate to populate validation state
-        }
+        $fields->setValues($user);
 
         $form = $this->form('user-profile', $fields)
             ->processRequest($this->request, uploadFiles: false, preserveEmpty: false);

panel/views/fields/password.php

@@ -12,7 +12,7 @@
                 'maxlength'    => $field->maxLength(),
                 'pattern'      => $field->pattern(),
                 'autocomplete' => $field->autocomplete(),
-                'required'     => $field->isRequired(),
+                'required'     => $field->isRequired() && !$field->ignoreEmpty(),
                 'disabled'     => $field->isDisabled(),
                 'hidden'       => $field->isHidden(),
             ]) ?>>