Boolean field validation in Laravel
In Laravel, we can write validation rules in custom classes to validate form fields. These classes are extends from FormRequest.
Sometimes, you can get a Boolean field value as string like ‘true’ or ‘false’ or ‘on’, as value can be as string and got error as following.
The {fieldname} field must be true or false
Laravel Documentation
It’s mentioned that Boolean field will accept input as true, false, 1, 0, “1”, and “0”.
Following is the Request class example with Boolean field.
<?php
namespace App\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class ProductRequest extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return true;
}
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules()
{
return [
'is_active'=>'boolean|required',
];
}
}
For instance, I am using just one input fields is_active, which is Boolean and also required.
Now with the above class, when you will get request with is_active as ‘true’ or ‘false’, you will get error “The is_active field must be true or false”.
You can get this situation when you are sending values to API from Postman or Swagger UI or sending values from form in double or single quotes or some browsers used to send ‘on’ for radio buttons or checkboxes.
To handle this we have two solutions, one with prepareForValidation method and other one is with writing custom rule. Right now I am giving you example with prepareForValidation method.
You will need to add method prepareForValidation in your Request class as following.
/**
* Prepare inputs for validation.
*
* @return void
*/
protected function prepareForValidation()
{
$this->merge([
'is_active' => $this->toBoolean($this->is_active),
]);
}
/**
* Convert to boolean
*
* @param $booleable
* @return boolean
*/
private function toBoolean($booleable)
{
return filter_var($booleable, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
}
FILTER_VALIDATE_BOOLEAN will identify value like ‘true’, ‘false’, ‘yes’, ‘no’, ‘on’, ‘off’ and it’s not case-sensitive while validating input value.
FILTER_VALIDATE_BOOLEAN will return true if input value is ‘true’, ‘on’, ‘yes’, or ‘1’.
When FILTER_NULL_ON_FAILURE flag is set then it will return false for ‘false’, ‘off’, ‘0’, or ‘no’ and null for non-boolean values.
Final code for request class will be as following.
<?php
namespace App\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class ProductRequest extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return true;
}
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules()
{
return [
'is_active'=>'boolean|required',
];
}
/**
* Prepare inputs for validation.
*
* @return void
*/
protected function prepareForValidation()
{
$this->merge([
'is_active' => $this->toBoolean($this->is_active),
]);
}
/**
* Convert to boolean
*
* @param $booleable
* @return boolean
*/
private function toBoolean($booleable)
{
return filter_var($booleable, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
}
}
Hope this will help someone.
