Fix missing optional fields should not be validated

Maks3w · Maks3w · commit fc2e1e27035d · 2015-08-20T13:53:55.000+02:00
Prevent the assumption of `null` value to be a synonym of value not set. Null values are valid input values (like JSON object with null values)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,7 +18,29 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- Nothing.
+- [#25](https://github.com/zendframework/zend-inputfilter/pull/25) Fix missing optional fields to be required.
+  BC Break since 2.3.9.
+  For completely fix this you need to setup your inputs as follow.
+
+  ```php
+  $input = new Input();
+  $input->setAllowEmpty(true); // Disable BC Break logic related to treat `null` values as valid empty value instead *not set*.
+  $input->setContinueIfEmpty(true); // Disable BC Break logic related to treat `null` values as valid empty value instead *not set*.  
+  $input->getValidatorChain()->attach(new Zend\Validator\NotEmpty(), /* break chain on failure */ true);
+  ```
+
+  ```php
+  $inputSpecification = [
+    'allow_empty' => true,
+    'continue_if_empty' => true,
+    'validators' => [
+      [
+        'break_chain_on_failure' => true,
+        'name' => 'Zend\\Validator\\NotEmpty',
+      ],
+    ],
+  ];
+  ```
 
 ## 2.5.4 - 2015-08-11
 
diff --git a/src/BaseInputFilter.php b/src/BaseInputFilter.php
@@ -244,6 +244,13 @@ protected function validateInputs(array $inputs, $data = [], $context = null)
             $input       = $this->inputs[$name];
             $hasFallback = ($input instanceof Input && $input->hasFallback());
 
+            if (!array_key_exists($name, $data)
+                && $input instanceof InputInterface
+                && !$input->isRequired()
+            ) {
+                continue;
+            }
+
             // If the value is required, not present in the data set, and
             // has no fallback, validation fails.
             if (!array_key_exists($name, $data)
diff --git a/test/BaseInputFilterTest.php b/test/BaseInputFilterTest.php
@@ -10,9 +10,11 @@
 namespace ZendTest\InputFilter;
 
 use ArrayObject;
+use PHPUnit_Framework_MockObject_MockObject as MockObject;
 use PHPUnit_Framework_TestCase as TestCase;
 use stdClass;
 use Zend\InputFilter\Input;
+use Zend\InputFilter\InputInterface;
 use Zend\InputFilter\FileInput;
 use Zend\InputFilter\BaseInputFilter as InputFilter;
 use Zend\Filter;
@@ -947,6 +949,37 @@ public function testAllowEmptyTestsFilteredValueAndOverrulesValidatorChain()
         $this->assertEquals(['foo' => ''], $filter->getValues());
     }
 
+    public function testMissingOptionalInputShouldMarkInputAsValid()
+    {
+        $optionalInputName = 'fooOptionalInput';
+        /** @var InputInterface|MockObject $optionalInput */
+        $optionalInput = $this->getMock(InputInterface::class);
+        $optionalInput->method('getName')
+            ->willReturn($optionalInputName)
+        ;
+        $optionalInput->expects($this->never())
+            ->method('isValid')
+        ;
+        $data = [];
+
+        $filter = new InputFilter();
+        $filter->add($optionalInput);
+
+        $filter->setData($data);
+
+        $this->assertTrue($filter->isValid(), json_encode($filter->getMessages()));
+        $this->assertArrayNotHasKey(
+            $optionalInputName,
+            $filter->getValidInput(),
+            'Missing optional fields must not appear as valid input neither invalid input'
+        );
+        $this->assertArrayNotHasKey(
+            $optionalInputName,
+            $filter->getInvalidInput(),
+            'Missing optional fields must not appear as valid input neither invalid input'
+        );
+    }
+
     public function testAllowEmptyTestsFilteredValueAndContinuesIfEmpty()
     {
         $input = new Input('foo');
