Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vjik/yii-validator-symfony-rule
Symfony validation constraints adapter for Yii Validator
https://github.com/vjik/yii-validator-symfony-rule
constraints symfony validation validator yii3
Last synced: about 3 hours ago
JSON representation
Symfony validation constraints adapter for Yii Validator
- Host: GitHub
- URL: https://github.com/vjik/yii-validator-symfony-rule
- Owner: vjik
- License: bsd-3-clause
- Created: 2022-12-21T09:43:34.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-22T13:33:19.000Z (over 1 year ago)
- Last Synced: 2024-04-20T13:14:02.613Z (7 months ago)
- Topics: constraints, symfony, validation, validator, yii3
- Language: PHP
- Homepage:
- Size: 16.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Yii Validator Symfony Rule
[](https://packagist.org/packages/vjik/yii-validator-symfony-rule)
[](https://packagist.org/packages/vjik/yii-validator-symfony-rule)
[](https://github.com/vjik/yii-validator-symfony-rule/actions?query=workflow%3Abuild)
[](https://dashboard.stryker-mutator.io/reports/github.com/vjik/yii-validator-symfony-rule/master)
[](https://shepherd.dev/github/vjik/yii-validator-symfony-rule)
[](https://github.com/vjik/yii-validator-symfony-rule/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/vjik/yii-validator-symfony-rule)
The package provides validator rule `SymfonyRule` that allow use Symfony validation constraints in
[Yii Validator](https://github.com/yiisoft/validator).
## Requirements
- PHP 8.0 or higher.
## Installation
The package could be installed with [composer](https://getcomposer.org/download/):
```shell
composer require vjik/yii-validator-symfony-rule
```
## General usage
Wrap a symfony constraints to Yii rule `SymfonyRule` enough. For example:
```php
use Symfony\Component\Validator\Constraints\CssColor;
use Symfony\Component\Validator\Constraints\NotEqualTo;
use Symfony\Component\Validator\Constraints\Positive;
use Vjik\Yii\ValidatorSymfonyRule\SymfonyRule;
use Yiisoft\Validator\Rule\HasLength;
use Yiisoft\Validator\Rule\Required;
final class Car
{
#[Required]
#[HasLength(min: 3, skipOnEmpty: true)]
public string $name = '';
#[Required]
#[SymfonyRule(
new CssColor(CssColor::RGB), // Symfony constraint
skipOnEmpty: true,
)]
public string $cssColor = '#1123';
#[SymfonyRule([
new Positive(), // Symfony constraint
new NotEqualTo(13), // Symfony constraint
])]
public int $number = 13;
}
```
## `SymfonyRule` rule parameters
**$constraint** — Single or array of Symfony validation constraints. Required.
**$skipOnEmpty** — Whether skip rule on empty value or not, and which value consider as empty. Defaults to `null`.
**$skipOnError** — A boolean value where `true` means to skip rule when the previous one errored and `false` — do not skip.
Defaults to `false`.
**$when** — The closure that allow to apply rule under certain conditions only. Defaults to `null`.
## `SymfonyRuleHandler` parameters
**$symfonyValidator** — Symfony validator instance. Defaults to validator created by
`Symfony\Component\Validator\Validation::createValidator()`.
## Testing
### Unit testing
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
```shell
./vendor/bin/phpunit
```
### Mutation testing
The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
```shell
./vendor/bin/roave-infection-static-analysis-plugin
```
### Static analysis
The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
```shell
./vendor/bin/psalm
```
## License
The Yii Validator Symfony Rule is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.