https://github.com/yiisoft/validator
Yii validator library
https://github.com/yiisoft/validator
hacktoberfest validation validator yii3
Last synced: 22 days ago
JSON representation
Yii validator library
- Host: GitHub
- URL: https://github.com/yiisoft/validator
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2019-04-12T17:05:23.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-05-07T12:04:12.000Z (30 days ago)
- Last Synced: 2025-05-11T18:33:12.181Z (26 days ago)
- Topics: hacktoberfest, validation, validator, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 2.44 MB
- Stars: 114
- Watchers: 22
- Forks: 40
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Validator
[](https://packagist.org/packages/yiisoft/validator)
[](https://packagist.org/packages/yiisoft/validator)
[](https://github.com/yiisoft/validator/actions/workflows/build.yml)
[](https://codecov.io/gh/yiisoft/validator)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/validator/master)
[](https://shepherd.dev/github/yiisoft/validator)
[](https://github.com/yiisoft/validator/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/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.1 or higher.
- `mbstring` PHP extension.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/validator
```
## General usage
Validator allows to check data in any format. For example, when data is an object:
```php
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: '[email protected]',
phone: null
);
$result = (new Validator())->validate($person);
```
The validation result is an object that allows to check whether validation was successful:
```php
$result->isValid();
```
It also contains errors occurred during validation:
```php
$result->getErrorMessages();
```
## Documentation
- Guide: [English](docs/guide/en/README.md), [Português - Brasil](docs/guide/pt-BR/README.md)
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Validator is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)