IsCountable Validator

  • Since 2.10.0

Zend\Validator\IsCountable allows you to validate that a value can be counted (i.e., it's an array or implements Countable), and, optionally:

  • the exact count of the value
  • the minimum count of the value
  • the maximum count of the value

Specifying either of the latter two is inconsistent with the first, and, as such, the validator does not allow setting both a count and a minimum or maximum value. You may, however specify both minimum and maximum values, in which case the validator operates similar to the Between validator.

Supported options

The following options are supported for Zend\Validator\IsCountable:

  • count: Defines if the validation should look for a specific, exact count for the value provided.
  • max: Sets the maximum value for the validation; if the count of the value is greater than the maximum, validation fails..
  • min: Sets the minimum value for the validation; if the count of the value is lower than the minimum, validation fails.

Default behaviour

Given no options, the validator simply tests to see that the value may be counted (i.e., it's an array or Countable instance):

$validator = new Zend\Validator\IsCountable();

$validator->isValid(10);                    // false; not an array or Countable
$validator->isValid([10]);                  // true; value is an array
$validator->isValid(new ArrayObject([10])); // true; value is Countable
$validator->isValid(new stdClass);          // false; value is not Countable

Specifying an exact count

You can also specify an exact count; if the value is countable, and its count matches, the the value is valid.

$validator = new Zend\Validator\IsCountable(['count' => 3]);

$validator->isValid([1, 2, 3]);                  // true; countable, and count is 3
$validator->isValid(new ArrayObject([1, 2, 3])); // true; countable, and count is 3
$validator->isValid([1]);                        // false; countable, but count is 1
$validator->isValid(new ArrayObject([1]));       // false; countable, but count is 1

Specifying a minimum count

You may specify a minimum count. When you do, the value must be countable, and greater than or equal to the minimum count you specify in order to be valid.

$validator = new Zend\Validator\IsCountable(['min' => 2]);

$validator->isValid([1, 2, 3]);                  // true; countable, and count is 3
$validator->isValid(new ArrayObject([1, 2, 3])); // true; countable, and count is 3
$validator->isValid([1, 2]);                     // true; countable, and count is 2
$validator->isValid(new ArrayObject([1, 2]));    // true; countable, and count is 2
$validator->isValid([1]);                        // false; countable, but count is 1
$validator->isValid(new ArrayObject([1]));       // false; countable, but count is 1

Specifying a maximum count

You may specify a maximum count. When you do, the value must be countable, and less than or equal to the maximum count you specify in order to be valid.

$validator = new Zend\Validator\IsCountable(['max' => 2]);

$validator->isValid([1, 2, 3]);                  // false; countable, but count is 3
$validator->isValid(new ArrayObject([1, 2, 3])); // false; countable, but count is 3
$validator->isValid([1, 2]);                     // true; countable, and count is 2
$validator->isValid(new ArrayObject([1, 2]));    // true; countable, and count is 2
$validator->isValid([1]);                        // true; countable, and count is 1
$validator->isValid(new ArrayObject([1]));       // true; countable, and count is 1

Specifying both minimum and maximum

If you specify both a minimum and maximum, the count must be between the two, inclusively (i.e., it may be the minimum or maximum, and any value between).

$validator = new Zend\Validator\IsCountable([
    'min' => 3,
    'max' => 5,
]);

$validator->isValid([1, 2, 3]);                    // true; countable, and count is 3
$validator->isValid(new ArrayObject([1, 2, 3]));   // true; countable, and count is 3
$validator->isValid(range(1, 5));                  // true; countable, and count is 5
$validator->isValid(new ArrayObject(range(1, 5))); // true; countable, and count is 5
$validator->isValid([1, 2]);                       // false; countable, and count is 2
$validator->isValid(new ArrayObject([1, 2]));      // false; countable, and count is 2
$validator->isValid(range(1, 6));                  // false; countable, and count is 6
$validator->isValid(new ArrayObject(range(1, 6))); // false; countable, and count is 6

Found a mistake or want to contribute to the documentation? Edit this page on GitHub!