Between Validator

This validator can be used to ensure that a given value falls within a specified range. For example, we can use this to validate that a number must be between 10 and 100.

Back to Validators List

Supported Options

The Between validator supports the below options:

min: determines the minimum value of the range. It is a required parameter and failing to provide this will result in an InvalidValidatorArguments exception.
max: determines the maximum value of the range. It is a required parameter and failing to provide this will result in an InvalidValidatorArguments exception.
inclusive: determines if both min and max parameters will be included in the range or not. This is optional and the default value is true.

Usage

There are two different ways in which all Sparta validators can be used. See below examples for more explanations:

Example #1

Let us assume that you want to ensure that only users between the age of 18-100 can proceed with the registration process in your web application. To achieve this, you can instantiate the Between validator as shown below:

<?php
use Sparta\Validators\Between;

$validator = Between(['min' => 18, 'max' => 100]);

//Assuming you have a variable named $age
if(!$validator->isValid($age)){ 
    //handle errors
}

You can also set the value of both min and max using validator setter methods setMin and setMax:

<?php
use Sparta\Validators\Between;

$validator = Between();

$validator->setMin(18);
$validator->setMax(100);

//$age variable can be from $_POST
if(!$validator->isValid($age)){ 
    //handle errors
}

By default, both min and max values will be included in the specified range. If both should be excluded, then you need to set the inclusive parameter to false. This can be done either via the validator constructor:

$validator = Between(['min' => 18, 'max' => 100, 'inclusive' => true]);

Or it can be configured via the validator setter method setInclusive:

$validator->setInclusive(true);

Example #2

You can build your validation rules and pass it to the Validation object to handle as shown below:

<?php
use Sparta\Validation;

$rules = [
    'age' => 'between:min=18,max=100,inclusive=true',
];
//Assuming that your $data has an element with the key "age"

$validation = new Validation($data, $rules);
if(!$validation->isValid()){
    //handle errors
}

In case of validation failure, error messages can be retrieved using the getErrors method.

Note: you can write the rule in a shorter format by dropping the arguments keys as follows:
<?php
use Sparta\Validation;

$rules = [
  'age' => 'between:18,100,true',
];
However, keep in mind that when you do so, options should be passed in the above specified order (i.e., min, max, and then inclusive). Failing to do so will result in undesirable behaviors.

Back to Validators List