feat: add validation_errors() in Form helper

codeigniter4 · Aug 17, 2022 · d92376b · d92376b
1 parent 282789b
commit d92376b
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/system/Helpers/form_helper.php b/system/Helpers/form_helper.php
@@ -680,12 +680,43 @@ function set_radio(string $field, string $value = '', bool $default = false): st
     }
 }
 
+if (! function_exists('validation_errors')) {
+    /**
+     * Returns the validation errors that are stored in the session.
+     * To use this, you need to use `withInput()` for `redirect()`.
+     *
+     * The returned array should be in the following format:
+     *     [
+     *         'field1' => 'error message',
+     *         'field2' => 'error message',
+     *     ]
+     *
+     * @return array<string, string>
+     */
+    function validation_errors(): array
+    {
+        session();
+
+        $errors = [];
+
+        // Check the session to see if any were
+        // passed along from a redirect withErrors() request.
+        if (isset($_SESSION['_ci_validation_errors']) && (ENVIRONMENT === 'testing' || ! is_cli())) {
+            $errors = unserialize($_SESSION['_ci_validation_errors']);
+        }
+
+        return $errors;
+    }
+}
+
 if (! function_exists('parse_form_attributes')) {
     /**
      * Parse the form attributes
      *
      * Helper function used by some of the form helpers
      *
+     * @internal
+     *
      * @param array|string $attributes List of attributes
      * @param array        $default    Default values
      */

diff --git a/tests/system/Helpers/FormHelperTest.php b/tests/system/Helpers/FormHelperTest.php
@@ -926,6 +926,15 @@ public function testSetRadioDefault()
         $this->assertSame('', set_radio('code', 'beta', false));
     }
 
+    public function testValidationErrors()
+    {
+        $_SESSION = ['_ci_validation_errors' => 'a:1:{s:3:"foo";s:3:"bar";}'];
+
+        $this->assertSame(['foo' => 'bar'], validation_errors());
+
+        $_SESSION = [];
+    }
+
     public function testFormParseFormAttributesTrue()
     {
         $expected = 'readonly ';