Merge pull request #9057 from thinkingmedia/thinkingmedia/isArray

Adds validation rule that value isArray

src/Validation/Validation.php

@@ -1182,6 +1182,17 @@ class Validation
     }
 
     /**
+     * Check that the input value is an array.
+     *
+     * @param array $value The value to check
+     * @return bool
+     */
+    public static function isArray($value)
+    {
+        return is_array($value);
+    }
+
+    /**
      * Converts an array representing a date or datetime into a ISO string.
      * The arrays are typically sent for validation from a form generated by
      * the CakePHP FormHelper.

src/Validation/Validator.php

@@ -1302,6 +1302,23 @@ class Validator implements ArrayAccess, IteratorAggregate, Countable
     }
 
     /**
+     * Add a validation rule to ensure that a field contains an array.
+     *
+     * @param string $field The field you want to apply the rule to.
+     * @param string|null $message The error message when the rule fails.
+     * @param string|callable|null $when Either 'create' or 'update' or a callable that returns
+     *   true when the validation rule should be applied.
+     * @return $this
+     */
+    public function isArray($field, $message = null, $when = null)
+    {
+        $extra = array_filter(['on' => $when, 'message' => $message]);
+        return $this->add($field, 'isArray', $extra + [
+                'rule' => 'isArray'
+            ]);
+    }
+
+    /**
      * Add a validation rule for a multiple select. Comparison is case sensitive by default.
      *
      * @param string $field The field you want to apply the rule to.

tests/TestCase/Validation/ValidationTest.php

@@ -14,11 +14,13 @@
  */
 namespace Cake\Test\TestCase\Validation;
 
+use Cake\Collection\Collection;
 use Cake\Core\Configure;
 use Cake\Filesystem\File;
 use Cake\I18n\I18n;
 use Cake\TestSuite\TestCase;
 use Cake\Validation\Validation;
+use Cake\Validation\Validator;
 use Locale;
 
 require_once __DIR__ . '/stubs.php';
@@ -2668,6 +2670,21 @@ class ValidationTest extends TestCase
     }
 
     /**
+     * Test isArray
+     *
+     * @return void
+     */
+    public function testIsArray()
+    {
+        $this->assertTrue(Validation::isArray([]));
+        $this->assertTrue(Validation::isArray([1, 2, 3]));
+        $this->assertTrue(Validation::isArray(['key' => 'value']));
+        $this->assertFalse(Validation::isArray('[1,2,3]'));
+        $this->assertFalse(Validation::isArray(new Collection([])));
+        $this->assertFalse(Validation::isArray(10));
+    }
+
+    /**
      * Test isInteger
      *
      * @return void

tests/TestCase/Validation/ValidatorTest.php

@@ -1546,6 +1546,17 @@ class ValidatorTest extends TestCase
     }
 
     /**
+     * Tests the isArray proxy method
+     */
+    public function testIsArray()
+    {
+        $validator = new Validator();
+        $validator->isArray('username');
+        $this->assertEmpty($validator->errors(['username' => [1, 2, 3]]));
+        $this->assertNotEmpty($validator->errors(['username' => 'is not an array']));
+    }
+
+    /**
      * Tests the multiple proxy method
      *
      * @return void
@@ -1603,6 +1614,15 @@ class ValidatorTest extends TestCase
         $this->assertNotEmpty($validator->errors(['things' => ['_ids' => [1, 2, 3, 4]]]));
     }
 
+    /**
+     * Tests that a rule in the Validator class exists and was configured as expected.
+     *
+     * @param Validator $validator
+     * @param string $method
+     * @param mixed $extra
+     * @param array $pass
+     * @param string|null $name
+     */
     protected function assertProxyMethod($validator, $method, $extra = null, $pass = [], $name = null)
     {
         $name = $name ?: $method;