yiisoft / validator
Yii Validator
Fund package maintenance!
Opencollective
yiisoft
Installs: 215 751
Dependents: 35
Suggesters: 0
Security: 0
Stars: 108
Watchers: 24
Forks: 36
Open Issues: 42
Requires
- php: ^8.0
- ext-mbstring: *
- psr/container: ^1.0|^2.0
- psr/http-message: ^1.0|^2.0
- yiisoft/arrays: ^2.1|^3.0
- yiisoft/friendly-exception: ^1.0
- yiisoft/network-utilities: ^1.0
- yiisoft/strings: ^2.1
- yiisoft/translator: ^2.1|^3.0
Requires (Dev)
- jetbrains/phpstorm-attributes: ^1.0
- maglnet/composer-require-checker: ^4.3
- phpbench/phpbench: ^1.2
- phpunit/phpunit: ^9.5
- rector/rector: ^1.0
- roave/infection-static-analysis-plugin: ^1.25
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.30|^5.22
- yiisoft/di: ^1.2
- yiisoft/test-support: ^3.0
- yiisoft/translator-message-php: ^1.1
- yiisoft/yii-debug: dev-master|dev-php80
Suggests
- ext-fileinfo: To use image rule
- ext-intl: Allows using date rules and IDN validation for emails
- yiisoft/di: To create rule handlers via Yii DI
This package is auto-updated.
Last update: 2024-04-26 09:15:31 UTC
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 attribute.
- 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\AtLeast; use Yiisoft\Validator\Rule\Email; use Yiisoft\Validator\Rule\Length; use Yiisoft\Validator\Rule\Number; use Yiisoft\Validator\Rule\Required; use Yiisoft\Validator\Validator; #[AtLeast(['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
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.