README

Prevent unwanted data in your project with Heimdall Validator.

Heimdall Validator was inspired by Laravel and Symfony validators. It receives an associative array with data and another associative array with the desired validation rules.

This package does not throw exceptions or block any request. Instead, it returns a Heimdall object that lets you check validation results using $validate->passes() or $validate->fails(), and access detailed error messages with $validate->errors(). Examples are provided below.

Index

• Requirements
• Installation
• How to Use
• Available Methods
• Available Rules

Requirements

• PHP 7.0+ (not tested on older versions)
• No external dependencies. Built with pure PHP to avoid dependency issues and to be compatible with older PHP versions.

Installation

You can install using Composer by running the command below:

NOT AVAILABLE YET

composer install bacarin/heimdall-validator

How to Use

After installation, import the Bacarin\Heimdall class and call the static validate method, passing the validation rules and the data to validate, like this:

use Bacarin\Heimdall;

function yourFunc(){
    $data = [
		'name' => 'John Doe',
		'age' => 18
	];
    $rules = [
		'name' => 'required|string|min:3',
		'age' => 'required|integer|max:80'
	];
    $validation = Heimdall::validate($rules, $data);
	if ($validation->passes()){
		... your code here
	}
}

Available Methods

$validate->passes()

Returns a boolean indicating whether the payload is valid. Returns true if valid, false otherwise.

$validate->fails()

Returns a boolean indicating whether the payload is invalid. Returns true if invalid, false otherwi

$validate->errors()

Returns an associative array containing validation error messages. If empty, the payload is valid. Exampĺe:

[
	"access_level" => [
		"The field access_level is prohibited when role is in [admin, manager]."
	]
]

Available Rules

More rules will be added in future releases or upon request.