README

Yii Validator

This package provides data validation capabilities.

Features

• Validates any data: arrays, objects, scalar values, etc.
• Supports custom data sets.
• Handles nested data structures (one-to-one and one-to-many).
• Can read validation rules from PHP 8 attributes.
• Error message formatting and translation.
• Attribute names translation.
• Conditional validation:
  • Skip validation of "empty" value with possibility to configure "empty" condition.
  • Skip further validation if an error occurred for the same property.
  • Skip validation depending on a condition.
• Possibility to use context in rule handler.
• Common rules bundled.
• Supports DI container for creating custom rule handlers with extra dependencies.
• Exporting rules options for using in the frontend.

Requirements

• PHP 8.0 or higher.
• mbstring PHP extension.

Installation

The package could be installed with Composer:

composer require yiisoft/validator

General usage

Validator allows to check data in any format. For example, when data is an object:

use Yiisoft\Validator\Rule\FilledAtLeast;
use Yiisoft\Validator\Rule\Email;
use Yiisoft\Validator\Rule\Length;
use Yiisoft\Validator\Rule\Number;
use Yiisoft\Validator\Rule\Required;
use Yiisoft\Validator\Validator;

#[FilledAtLeast(['email', 'phone'])]
final class Person
{
    public function __construct(
        #[Required]
        #[Length(min: 2)]
        public ?string $name = null,

        #[Number(min: 21)]
        public ?int $age = null,

        #[Email]
        public ?string $email = null,

        public ?string $phone = null,
    ) {
    }
}

$person = new Person(
    name: 'John', 
    age: 17, 
    email: 'john@example.com',
    phone: null
);

$result = (new Validator())->validate($person);

The validation result is an object that allows to check whether validation was successful:

$result->isValid();

It also contains errors occurred during validation:

$result->getErrorMessages();

Documentation

• Guide: English, Português - Brasil
• Internals

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

License

The Yii Validator is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Follow updates