Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/illuminatech/validation-composite
Allows uniting of several validation rules into single one for easy re-usage
https://github.com/illuminatech/validation-composite
combine composite laravel rule validation validator
Last synced: 3 months ago
JSON representation
Allows uniting of several validation rules into single one for easy re-usage
- Host: GitHub
- URL: https://github.com/illuminatech/validation-composite
- Owner: illuminatech
- License: other
- Created: 2019-06-14T11:27:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T10:46:42.000Z (11 months ago)
- Last Synced: 2024-04-25T11:22:33.167Z (10 months ago)
- Topics: combine, composite, laravel, rule, validation, validator
- Language: PHP
- Homepage:
- Size: 26.4 KB
- Stars: 173
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
Laravel Composite Validation
This extension allows uniting several Laravel validation rules into a single one for easy re-usage.
For license information check the [LICENSE](LICENSE.md)-file.
[](https://packagist.org/packages/illuminatech/validation-composite)
[](https://packagist.org/packages/illuminatech/validation-composite)
[](https://github.com/illuminatech/validation-composite/actions)
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist illuminatech/validation-composite
```
or add
```json
"illuminatech/validation-composite": "*"
```
to the require section of your composer.json.
Usage
-----
The same sequence of the validation rules may repeat over the application many times. For example: you may have a set of
restrictions related to the user's password, like it should be at least 8 symbols long, but shorter then 200 to fit the
database field reserved for its storage. Your program may also allow user to upload an image to be his avatar, but in order
to make it safe, you should validate uploaded file mime type and size.
Thus validation for the user profile form may looks like following:
```php
validate([
'password' => ['required', 'string', 'min:8', 'max:200'],
'avatar' => ['required', 'file', 'mimes:png,jpg,jpeg', 'max:1024'],
// ...
]);
// ...
}
}
```
The problem is: validation for user's password or avatar may appear in several different places. For example: password
can be setup at sign-up process, during password reset and so on. You may also have a separated administration panel,
which allows system administrator to adjust existing user's record or create a new one. Thus you will have to duplicate
all these validation rules many times throughout your project source code. In case requirements change, for example:
we decide that password length should be at least 10 symbols instead of 8, or disallow '*.png' files from avatar - you'll
have to manually changes validation rules at all those places.
This extension allows uniting several validation rules into a single one for easy re-usage. For the example above you
should create 2 separated validation rule classes extending `Illuminatech\Validation\Composite\CompositeRule`:
```php
validate([
'password' => ['required', new PasswordRule],
'avatar' => ['required', new AvatarRule],
// ...
]);
// ...
}
}
```
With such approach you can change validation for the 'password' and 'avatar' at the single place.
In case composite validation rule fails, validator instance will pick up an error message from the particular sub-rule.
For example:
```php
'short'],
[
'password' => ['required', new PasswordRule],
]
);
if ($validator->fails()) {
echo $validator->errors()->first('password'); // outputs 'The password must be at least 8 characters.'
}
```
> Note: do not use rules like 'sometimes', 'required', 'required_with', 'required_without' and so on in the composite rule.
These are processed at the different validation level and thus will have no effect or may behave unexpectedly.
You may define composite validation rules using [validation factory extensions](https://laravel.com/docs/validation#using-extensions) feature.
For such case you may use `Illuminatech\Validation\Composite\DynamicCompositeRule`. For example:
```php
app->extend('validator', function (Factory $validatorFactory) {
$validatorFactory->extend('password', function ($attribute, $value) {
return (new DynamicCompositeRule(['string', 'min:8', 'max:200']))->passes($attribute, $value);
});
$validatorFactory->extend('avatar', function ($attribute, $value) {
return (new DynamicCompositeRule(['file', 'mimes:png,jpg,jpeg', 'max:1024']))->passes($attribute, $value);
});
return $validatorFactory;
});
// ...
}
}
```
Note that with such approach automatic pick up of the validation error message becomes impossible, and you will have to setup
it explicitly in language files.
You may specify [custom error messages](https://laravel.com/docs/validation#custom-error-messages) per each validation rule used in the composite one,
overriding `messages()` method. For example:
```php
'Only string is allowed.',
'min' => ':attribute is too short.',
'max' => ':attribute is too long.',
];
}
}
```