diogocavilha / array-validation

It's a simple array validator which uses native filters and validators from PHP.

Documentação em português/Portuguese documentation

Array validation

It's a simple array validator which uses native filters and validators from PHP.

Installing

composer require array/validation

Usage

Methods:

• setFields(array $fieldsRules)

It adds optional fields to filter/validate.

• setRequiredFields(array $requiredFieldsRules)

It adds required fields to filter/validate.

• validate(array $input)

It validates an input array. It throws an exception in case the validation is not satisfied.

• isValid(array $input)

It validates an input array. It returns true in case the input array is valid, otherwise it returns false.

• removeOnly(array $fieldsToRemove)

It removes fields that are not in filter/validation rules.

• getValidArray()

It returns an array containing the filtered/validated data.

• getMessages()

It returns an array containing the validation messages. This method should be called after calling the isValid.

Validating required fields:

<?php

use Validation\SimpleArray;

$rules = [
    'name' => FILTER_SANITIZE_STRING,
    'age' => FILTER_VALIDATE_INT,
];

$arrayToValidate = [
    'name' => 'Diogo Alexsander',
    'age' => 26,
];

$validator = new SimpleArray();
$validator
    ->setRequiredFields($rules)
    ->validate($arrayToValidate);

$data = $validator->getValidArray();

Validating optional fields:

<?php

use Validation\SimpleArray;

$rules = [
    'name' => FILTER_SANITIZE_STRING,
    'age' => FILTER_VALIDATE_INT,
];

$arrayToValidate = [
    'name' => 'Diogo Alexsander',
];

$validator = new SimpleArray();
$validator
    ->setFields($rules)
    ->validate($arrayToValidate);

$data = $validator->getValidArray();

Validating both:

<?php

use Validation\SimpleArray;

$fieldsRules = [
    'name' => FILTER_SANITIZE_STRING,
    'age' => FILTER_VALIDATE_INT,
];

$requiredFieldsRules = [
    'id' => FILTER_VALIDATE_INT,
];

$arrayToValidate = [
    'id' => 1,
    'name' => 'Diogo Alexsander',
    'age' => 26,
];

$validator = new SimpleArray();
$validator
    ->setFields($fieldsRules)
    ->setRequiredFields($requiredFieldsRules)
    ->validate($arrayToValidate);

$data = $validator->getValidArray();

The removeOnly method can be used to remove a few fields from input array.

In case it's not called, all the other fields that are not present in the filter/validation rules will be removed from input array.

If you wish to remove just a few fields from input array, the method removeOnly can be called by passing an array containing the fields you wish to remove.

Ps: It's not possible to remove a field that is present in filter/validation rules, if so, it will throw a RuntimeException.

<?php

use Validation\SimpleArray;

$fieldsRules = [
    'name' => FILTER_SANITIZE_STRING,
    'age' => FILTER_VALIDATE_INT,
];

$requiredFieldsRules = [
    'id' => FILTER_VALIDATE_INT,
];

$arrayToValidate = [
    'id' => 1,
    'name' => 'Diogo Alexsander',
    'age' => 26,
    'email' => 'unwanted',
    'phone' => 'unwanted',
];

$validator = new SimpleArray();
$validator
    ->setFields($fieldsRules)
    ->setRequiredFields($requiredFieldsRules)
    ->validate($arrayToValidate);

$data = $validator->getValidArray(); // It will return only 'id', 'name' and 'age'

$validator->removeOnly(['phone']);
$data = $validator->getValidArray(); // It will return 'id', 'name', 'age' and 'email'

If you don't want validator automatically throw exceptions when the validation is not satisfied, it's possible to call the method isValid instead of validate.

After that, you can call the method getMessages to get an array containing the validation messages.

Sample:

<?php

$input = [
    'name' => '<strong>Diogo</strong>',
    'description' => "<b>This is a test</b>, to know more about it <a href='index.phtml'>click here</a>",
    'email' => '[email protected]',
    'phone' => '5555555 - test',
];

$rules = [
    'phone' => FILTER_VALIDATE_INT,
    'name' => FILTER_SANITIZE_STRING,
    'description' => FILTER_SANITIZE_STRING
];

$rulesRequired = [
    'id' => FILTER_VALIDATE_INT,
    'code' => FILTER_VALIDATE_INT,
];

$validator = new SimpleArray();
$validator
    ->setFields($rules)
    ->setRequiredFields($rulesRequired);
    
if (!$validator->isValid($input)) {
    $messages = $validator->getMessages();
    foreach ($messages as $message) {
        echo $message, '<br>';
    }
}

array-validation's Issues

Opção de ignorar chaves do array

Ignorar chaves que não foram passadas para validar...
Exemplo:

<?php
$array = [
    'chave' => 'valor',
    'chave2' => 'valor2',
    'chave3' => 'valor3',
];
$validatorArray = new SimpleArray();
$validatorArray
    ->setRequiredFields(
        [
            'chave3' => FILTER_SANITIZE_STRING,
        ]
    )
    ->validate($array);
$data = $validatorArray->getValidArray();

print_r($data);
// array(0) {
//    'chave3' => 'valor3'
// }

No caso acima, eu chamaria mais um método passando um array com ['chave', 'chave2'] ou então um asterisco para que todas as outras chaves sejam desconsideradas e apenas retorne a chave3.