Submit value of hidden field if checkbox is unchecked and matching hidden field exists

Author: SOHELAHMED7

src/Codeception/Lib/InnerBrowser.php

@@ -1063,20 +1063,36 @@ protected function getFormFor(Crawler $node)
      */
     protected function getFormValuesFor(Form $form)
     {
+        $formNodeCrawler = new Crawler($form->getFormNode());
         $values = [];
         $fields = $form->all();
         foreach ($fields as $field) {
-            if ($field instanceof FileFormField || $field->isDisabled() || !$field->hasValue()) {
+            if ($field instanceof FileFormField || $field->isDisabled()) {
                 continue;
             }
+
+            if (!$field->hasValue()) {
+                // if unchecked a checkbox and if there is hidden input with same name to submit unchecked value
+                $hiddenInput = $formNodeCrawler->filter('input[type=hidden][name="'.$field->getName().'"]:not([disabled])');
+                if (!count($hiddenInput)) {
+                    continue;
+                } else {
+                    // there might be multiple hidden input with same name, but we will only grab last one's value
+                    $fieldValue = $hiddenInput->last()->attr('value');
+                }
+            } else {
+                $fieldValue = $field->getValue();
+            }
+
+
             $fieldName = $this->getSubmissionFormFieldName($field->getName());
             if (substr($field->getName(), -2) === '[]') {
                 if (!isset($values[$fieldName])) {
                     $values[$fieldName] = [];
                 }
-                $values[$fieldName][] = $field->getValue();
+                $values[$fieldName][] = $fieldValue;
             } else {
-                $values[$fieldName] = $field->getValue();
+                $values[$fieldName] = $fieldValue;
             }
         }
         return $values;
@@ -1295,7 +1311,7 @@ public function sendAjaxGetRequest($uri, $params = [])
      *     'task' => 'lorem ipsum',
      *     'category' => 'miscellaneous',
      * ]]);
-     * ```    
+     * ```
      *
      * @param string $uri
      * @param array $params

tests/data/app/view/form/button.php

@@ -5,4 +5,4 @@
     <button type="submit" name="btn0">Submit</button>
 </form>
 </body>
-</html>
+</html>

tests/data/app/view/form/uncheck_hidden.php

@@ -0,0 +1,19 @@
+<form method="POST" action="/form/uncheck_hidden">
+
+    <input type="text" name="wireless" value="mouse">
+
+    <input type="hidden" name="coffee" value="123"> <!-- this should be discarded -->
+
+    <!-- Do you need coffee ? (label) -->
+    <input type="hidden" name="coffee" value="8569" disabled="disabled">
+    <input type="hidden" name="coffee" value="8">
+    <input type="hidden" name="coffee" value="0">
+    <input type="checkbox" name="coffee" value="1" id="coffee-id" checked>
+
+    <!-- check all other work as intended -->
+    <input type="checkbox" name="tea" value="1" id="tea-id" checked>
+    <input type="checkbox" name="vanilla" id="vanilla-id" checked>
+    <input type="checkbox" name="butter" id="butter-id" >
+
+    <button type="submit">Submit Preference</button>
+</form>

tests/unit/Codeception/Module/TestsForWeb.php

@@ -1780,4 +1780,20 @@ public function testHaveServerParameter()
         $server = $this->module->client->getRequest()->getServer();
         $this->assertArrayHasKey('my', $server);
     }
+
+    public function testUncheckHidden()
+    {
+        $this->module->amOnPage('/form/uncheck_hidden');
+        $this->module->uncheckOption('#coffee-id');
+        $this->module->click("Submit Preference");
+        $form = data::get('form');
+        $this->assertEquals('0', $form['coffee']);
+
+        // test all other inputs are submitted as intended
+        $this->assertEquals('mouse', $form['wireless']);
+        $this->assertEquals('1', $form['tea']);
+        $this->assertEquals('on', $form['vanilla']); // 'on' is set internally
+        $this->assertFalse(isset($form['butter']));
+
+    }
 }