estasi/validator

Validation classes for data validation, and the ability to link validators to create complex validation chains

1.2.0 2020-06-08 08:30 UTC

Requires

• php: ^7.4
• ext-intl: *
• ext-mbstring: *
• estasi/plugin-manager: ^1.0
• estasi/utility: ^1.1
• php-ds/php-ds: dev-master

Requires (Dev)

• phpunit/phpunit: ^7.0.1

Suggests

• estasi/translator: ^0 || ^1 translations of validator error messages
• laminas/laminas-validator: ^2.5 extends the data validation capabilities of the main validator using Laminas validators
• symfony/validator: ^5.0 extends the data validation capabilities of the main validator using Symfony validators

BSD-3-Clause

• Mikhail Erypalov

• validator
• psr
• PSR-4
• psr-12
• estasi

README

It is a set of necessary immutable validators. Provides a simple data validation chain mechanism that allows you to apply multiple validators in a given order.

Installation

To install with a composer:

composer require estasi/validator

Requirements

• PHP 7.4 or newer
• ext-mbstring
• ext-intl
• Data Structures: composer require php-ds/php-ds
  Polyfill is installed with the estasi/validator package.

Usage

Basic usage

<?php

declare(strict_types=1);

use Estasi\Validator\Email;

$email = '[e-mail]';
$validator = new Email(Email::ALLOW_UNICODE);
if ($validator->isValid($email)) {
    // your code is here
} else {
    // print "Email "$email" is not correct!"
    echo $validator->getLastErrorMessage();
}

Custom message

<?php

declare(strict_types=1);

use Estasi\Validator\Email;

$email = '[e-mail]';
$validator = new Email(Email::ALLOW_UNICODE, [Email::E_INVALID_EMAIL => 'Custom error message.']);
if ($validator->isValid($email)) {
    // your code is here
} else {
    // print "Custom error message."
    echo $validator->getLastErrorMessage();
}

or

<?php

declare(strict_types=1);

use Estasi\Validator\Email;

$email = '[e-mail]';
$validator = new Email(Email::ALLOW_UNICODE);
if ($validator->isValid($email)) {
    // your code is here
} else {
    if ($validator->isLastError(Email::E_INVALID_EMAIL)) {
        echo "Custom error message.";
        // or your other code depending on the error
    }
    //...
}

Identical

Only the Identical validator can accept the second parameter in the isValid(), notValid() and __invoke() methods

Simple comparison

<?php

declare(strict_types=1);

use Estasi\Validator\Identical;

$token = 'string';
$value = 'string';

$validator = new Identical($token, Identical::STRICT_IDENTITY_VERIFICATION);
if ($validator->isValid($value)) {
    // your code is here
}

or

<?php

declare(strict_types=1);

use Estasi\Validator\Identical;

$context = 'string';
$value = 'string';

$validator = new Identical(null, Identical::STRICT_IDENTITY_VERIFICATION);
if ($validator->isValid($value, $context)) {
    // your code is here
}

Comparison with the value in the array

<?php

declare(strict_types=1);

use Estasi\Validator\Identical;

$token = 'email';
$value = '[e-mail]';
$context = ['names' => ['firstname' => 'John', 'lastname' => 'Doe'], 'email' => '[e-mail]'];

$validator = new Identical($token, Identical::STRICT_IDENTITY_VERIFICATION);
if ($validator->isValid($value, $context)) {
    // your code is here
}

You can also check the value of an unrestricted nested context if the context is an array. The nesting separator will thus be the symbol ".".

<?php

declare(strict_types=1);

use Estasi\Validator\Identical;

$token = 'names.lastname';
$value = 'Doe';
$context = ['names' => ['firstname' => 'John', 'lastname' => 'Doe'], 'email' => '[e-mail]'];

$validator = new Identical($token, Identical::STRICT_IDENTITY_VERIFICATION);
if ($validator->isValid($value, $context)) {
    // your code is here
}

Chain

Here are two validator tasks in the chain: explicitly (by class declaration) and via the factory (array)

<?php

declare(strict_types=1);

use Estasi\Validator\{Chain,Identical,Regex};

$datum = [
    'password' => [
        'original' => 'password_25',
        'confirm'  => 'password_25'
    ]
];

$chain = new Chain();
$chain = $chain->attach(
                   new Regex('[A-Za-z0-9_]{8,12}', Regex::OFFSET_ZERO, [Regex::OPT_ERROR_VALUE_OBSCURED => true]),
                   Chain::WITH_BREAK_ON_FAILURE
               )
               ->attach(
                   [
                       Chain::VALIDATOR_NAME => 'identical',
                       Chain::VALIDATOR_OPTIONS => [
                           Identical::OPT_TOKEN => 'password.original',
                           Identical::OPT_ERROR_VALUE_OBSCURED => true
                       ]
                   ],
                   Chain::WITH_BREAK_ON_FAILURE
               );
if($chain->isValid($datum['password']['original'], $datum)) {
    // your code is here
}

License

All contents of this package are licensed under the BSD-3-Clause license.