Merge pull request #45 from stephen-hill/isSuccess

isSuccess

Author: Paul M. Jones

src/Aura/Input/Fieldset.php

@@ -57,6 +57,15 @@ class Fieldset extends AbstractInput
      */
     protected $options;
 
+    /**
+     * 
+     * Property for storing the result of the last filter() call.
+     * 
+     * @var bool
+     * 
+     */
+    protected $success;
+    
     /**
      * 
      * Constructor.
@@ -241,6 +250,18 @@ public function init()
     {
     }
 
+    /**
+     * 
+     * Did the input data pass the filter rules?
+     * 
+     * @return null|bool
+     * 
+     */
+    public function isSuccess()
+    {
+        return $this->success;
+    }
+    
     /**
      * 
      * Sets a new Field input.
@@ -326,7 +347,7 @@ public function get($name = null)
      */
     public function filter()
     {
-        return $this->filter->values($this);
+        return $this->success = $this->filter->values($this);
     }
 
     /**

tests/Aura/Input/FieldsetTest.php

@@ -121,6 +121,42 @@ public function testFilterAll()
         $this->assertSame($expect, $actual);
     }
 
+    public function testIsSuccessAll()
+    {
+        // new fieldset
+        $fieldset = $this->newFieldset();
+        
+        // add fields
+        $fieldset->setField('foo');
+        $fieldset->setField('bar');
+        
+        // get the filter and add a rule
+        $filter = $fieldset->getFilter();
+        $filter->setRule('foo', 'Foo should be alpha', function ($value) {
+            return ctype_alpha($value);
+        });
+        
+        // set values on the fieldset
+        $fieldset->fill(['foo' => 'foo_value', 'bar' => 'bar_value']);
+        
+        // Filter has not been called, so isSuccess must return null
+        $this->assertNull($fieldset->isSuccess());
+        
+        // apply the filter
+        $pass = $fieldset->filter();
+        
+        // After calling filter, isSuccess should return a boolean
+        // and filter() should also return a boolean
+        $this->assertFalse($fieldset->isSuccess());
+        $this->assertFalse($pass);
+        
+        // Let's fix the data and test if isSuccess returns true
+        $fieldset->fill(['foo' => 'fooValue', 'bar' => 'barValue']);
+        $pass = $fieldset->filter();
+        $this->assertTrue($fieldset->isSuccess());
+        $this->assertTrue($pass);
+    }
+    
     public function testSetFieldset()
     {
         // a map so the outer fieldset can create the inner fieldset