Skip to content
🍤 Caridea is a miniscule PHP application library. This is a shrimpy validation library.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
src
tests
.gitignore
.scrutinizer.yml
.travis.yml
LICENSE
README.md
composer.json
phpunit.xml.dist

README.md

caridea-validate

Caridea is a miniscule PHP application library. This shrimpy fellow is what you'd use when you just want some helping hands and not a full-blown framework.

This is its validation library.

It supports LIVR rules with some exceptions. See the Compliance → LIVR section below.

Packagist Build Status Scrutinizer Code Quality Code Coverage Documentation Status

Installation

You can install this library using Composer:

$ composer require caridea/validate
  • The master branch (version 3.x) of this project requires PHP 7.1 and has no dependencies.
  • Version 2.x of this project requires PHP 7.0 and has no dependencies.
  • Version 1.x of this project requires PHP 5.5 and has no dependencies.

Documentation

Compliance

Releases of this library will conform to Semantic Versioning.

Our code is intended to comply with PSR-1, PSR-2, and PSR-4. If you find any issues related to standards compliance, please send a pull request!

LIVR

We fully support the JSON rule format as defined by the LIVR spec. However, we do not support the v0.4 style declaration for the one_of and list_of rules.

For the most part, we support all rules and their return codes as defined by version 2.0 of the specification with some notable exceptions. We did not implement the following rules:

  • trim – This is part of filtering, not validation.
  • to_lc – This is part of filtering, not validation.
  • to_uc – This is part of filtering, not validation.
  • remove – This is part of filtering, not validation.
  • leave_only – This is part of filtering, not validation.
  • default – This is part of filtering, not validation.
  • or – This is experimental.

We now support alias definitions!

We did add an extra validator: timezone! It gives the error WRONG_TIMEZONE if the string provided isn't a valid timezone identifier.

Examples

To create a validator from a rule set, you can pass the definitions to the builder, or you can use the builder procedurally.

// rules.json
{
    "name": "required",
    "email": ["required", "email"],
    "drinks": { "one_of": [["coffee", "tea"]] },
    "phone": {"max_length": 10},
}
$registry = new \Caridea\Filter\Registry();
$builder = $registry->builder();
$ruleset = json_decode(file_get_contents('rules.json'));
$validator = $builder->build($ruleset);
$registry = new \Caridea\Filter\Registry();
$builder = $registry->builder();
$validator = $builder->field('name', 'required')
    ->field('email', 'required', 'email')
    ->field('drinks', ['one_of' => [['coffee', 'tea']]])
    ->field('phone', ['max_length' => 10])
    ->build();

You can either inspect the validation results, or throw an exception containing any errors.

$input = [
    'foo' => 'bar',
    'abc' => '123',
];
$result = $validator->validate($input);
// or
$validator->assert($input);

You can register your own custom rules in the Registry.

$registry = new \Caridea\Validate\Registry();
$registry->register([
    'credit_card' => ['MyCustomRules', 'getCreditCard'], // a static method
]);
You can’t perform that action at this time.