Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnnymast/redbox-validator
A validation package based on Laravel's validation package.
https://github.com/johnnymast/redbox-validator
custom-rules nodependence php psr-12 validation
Last synced: 7 days ago
JSON representation
A validation package based on Laravel's validation package.
- Host: GitHub
- URL: https://github.com/johnnymast/redbox-validator
- Owner: johnnymast
- License: mit
- Created: 2023-03-24T16:42:06.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-28T17:49:01.000Z (12 months ago)
- Last Synced: 2024-04-14T05:48:22.950Z (7 months ago)
- Topics: custom-rules, nodependence, php, psr-12, validation
- Language: PHP
- Homepage: https://johnnymast.io
- Size: 148 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Redbox-valiation
Redbox-validation is a simple to use validation class. The implementation is based on Laravel's (but no a rewrite of)
validation package but has no external when used in your project.
[](https://packagist.org/packages/redbox/validation)
[](https://github.com/johnnymast/redbox-validation/actions/workflows/Tests.yml)
[](https://github.com/johnnymast/redbox-validation/actions/workflows/Phpcs.yaml)
[](https://github.com/johnnymast/redbox-validation/actions/workflows/pest-coverage.yaml)
## Installation
```bash
$ composer require redbox/validation
```
## Usage
The package is flexible to use with an easy syntax.
## Basic Usage
```php
use Redbox\Validation\Validator;
$validator = new Validator([
'foo' => 'The quick brown fox jumps over the lazy dog'
]);
$data = $validator->validate([
'food' => 'string'
]);
/**
* Validator::passes() is also
* available.
*/
if ($validator->fails()) {
/**
* Handle errors use $validator->errors()
* to get the errors.
*/
}
```
## Using closures
You can use your own closures to add custom rules
```php
use Redbox\Validation\ValidationContext;
use Redbox\Validation\Validator;
$validator = new Validator([
'foo' => 'The quick brown fox jumps over the lazy dog'
]);
$data = $validator->validate([
/**
* This will validate field 'foo' equals 'baz' in this case it will not so
* the validation will fail and an error will be set for field 'foo'.
*/
'foo' => function (ValidationContext $context): bool {
return ($context->keyExists() && $context->getValue() === 'baz')
or $context->addError("Field {$context->getKey()} does not equal 'baz'.");
}
]);
/**
* Validator::passes() is also
* available.
*/
if ($validator->fails()) {
/**
* Handle errors use $validator->errors()
* to get the errors.
*/
print_r($validator->errors());
}
```
## Available Rules
The following validation rules are available with this package.
| Type | Alias | Description |
|---------|-------|-----------------------------------------------------|
| string | N/A | The field under validation must be of type string. |
| boolean | bool | The field under validation must be of type boolean. |
| integer | int | The field under validation must be of type integer. |
## License
The MIT License (MIT)
Copyright (c) 2023 Johnny Mast
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.