Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidepastore/slim-validation
A validation library for the Slim Framework. It internally uses Respect/Validation.
https://github.com/davidepastore/slim-validation
middleware php slim-framework validation
Last synced: about 5 hours ago
JSON representation
A validation library for the Slim Framework. It internally uses Respect/Validation.
- Host: GitHub
- URL: https://github.com/davidepastore/slim-validation
- Owner: DavidePastore
- Created: 2016-01-02T15:28:54.000Z (almost 9 years ago)
- Default Branch: 4.0
- Last Pushed: 2023-12-24T07:18:18.000Z (11 months ago)
- Last Synced: 2024-10-19T21:43:54.579Z (27 days ago)
- Topics: middleware, php, slim-framework, validation
- Language: PHP
- Homepage:
- Size: 129 KB
- Stars: 170
- Watchers: 7
- Forks: 30
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Slim Framework Validation
[![Latest version][ico-version]][link-packagist]
[![Build Status][ico-github-actions]][link-github-actions]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
[![PSR2 Conformance][ico-styleci]][link-styleci]
A validation library for the Slim Framework. It internally uses [Respect/Validation][respect-validation].
## Table of contents
- [Install](#install)
- [Usage](#usage)
- [Register per route](#register-per-route)
- [Register for all routes](#register-for-all-routes)
- [Route parameters](#route-parameters)
- [JSON requests](#json-requests)
- [XML requests](#xml-requests)
- [Translate errors](#translate-errors)
- [Testing](#testing)
- [Contributing](#contributing)
- [Credits](#credits)
## Install
Via Composer
``` bash
$ composer require davidepastore/slim-validation
```
Requires Slim 4.0.0 or newer.
## Usage
In most cases you want to register `DavidePastore\Slim\Validation` for a single route, however,
as it is middleware, you can also register it for all routes.
### Register per route
```php
use Respect\Validation\Validator as v;
use Slim\Factory\AppFactory;
require __DIR__ . '/../vendor/autoload.php';
$app = AppFactory::create();
//Create the validators
$usernameValidator = v::alnum()->noWhitespace()->length(1, 10);
$ageValidator = v::numeric()->positive()->between(1, 20);
$validators = array(
'username' => $usernameValidator,
'age' => $ageValidator
);
$app->get('/api/myEndPoint',function ($req, $res, $args) {
//Here you expect 'username' and 'age' parameters
if($req->getAttribute('has_errors')){
//There are errors, read them
$errors = $req->getAttribute('errors');
/* $errors contains:
array(
'username' => array(
'"davidepastore" must have a length between 1 and 10',
),
'age' => array(
'"89" must be lower than or equals 20',
),
);
*/
} else {
//No errors
}
})->add(new \DavidePastore\Slim\Validation\Validation($validators));
$app->run();
```
### Register for all routes
```php
use Respect\Validation\Validator as v;
use Slim\Factory\AppFactory;
require __DIR__ . '/../vendor/autoload.php';
$app = AppFactory::create();
//Create the validators
$usernameValidator = v::alnum()->noWhitespace()->length(1, 10);
$ageValidator = v::numeric()->positive()->between(1, 20);
$validators = array(
'username' => $usernameValidator,
'age' => $ageValidator
);
// Register middleware for all routes
// If you are implementing per-route checks you must not add this
$app->add(new \DavidePastore\Slim\Validation\Validation($validators));
$app->get('/foo', function ($req, $res, $args) {
//Here you expect 'username' and 'age' parameters
if($req->getAttribute('has_errors')){
//There are errors, read them
$errors = $req->getAttribute('errors');
/* $errors contains:
array(
'username' => array(
'"davidepastore" must have a length between 1 and 10',
),
'age' => array(
'"89" must be lower than or equals 20',
),
);
*/
} else {
//No errors
}
});
$app->post('/bar', function ($req, $res, $args) {
//Here you expect 'username' and 'age' parameters
if($req->getAttribute('has_errors')){
//There are errors, read them
$errors = $req->getAttribute('errors');
} else {
//No errors
}
});
$app->run();
```
### Route parameters
```php
use Respect\Validation\Validator as v;
use Slim\Factory\AppFactory;
require __DIR__ . '/../vendor/autoload.php';
$app = AppFactory::create();
//Create the validators
$routeParamValidator = v::numeric()->positive();
$validators = array(
'param' => $routeParamValidator,
);
$app->get('/foo/{param}', function ($req, $res, $args) {
//Here you expect 'param' route parameter
if($req->getAttribute('has_errors')){
//There are errors, read them
$errors = $req->getAttribute('errors');
/* $errors contains:
array(
'param' => array(
'"wrong" must be numeric',
),
);
*/
} else {
//No errors
}
})->add(new \DavidePastore\Slim\Validation\Validation($validators));
$app->run();
```
Note that requests parameters take priority over route parameters, so if you use the same name for a route and request parameter, the last will win and it will be considered for validation.
### JSON requests
You can also validate a JSON request. Let's say your body request is:
```json
{
"type": "emails",
"objectid": "1",
"email": {
"id": 1,
"enable_mapping": "1",
"name": "rq3r",
"created_at": "2016-08-23 13:36:29",
"updated_at": "2016-08-23 14:36:47"
}
}
```
and you want to validate the `email.name` key. You can do it in this way:
```php
use Respect\Validation\Validator as v;
use Slim\Factory\AppFactory;
require __DIR__ . '/../vendor/autoload.php';
$app = AppFactory::create();
//Create the validators
$typeValidator = v::alnum()->noWhitespace()->length(3, 5);
$emailNameValidator = v::alnum()->noWhitespace()->length(1, 2);
$validators = array(
'type' => $typeValidator,
'email' => array(
'name' => $emailNameValidator,
),
);
```
If you'll have an error, the result would be:
```php
//In your route
$errors = $req->getAttribute('errors');
print_r($errors);
/*
Array
(
[email.name] => Array
(
[0] => "rq3r" must have a length between 1 and 2
)
)
*/
```
### XML requests
You can also validate a XML request. Let's say your body request is:
Let's say you have a POST request with a XML in its body:
```xml
emails
1
1
1
rq3r
2016-08-23 13:36:29
2016-08-23 14:36:47
```
and you want to validate the `email.name` key. You can do it in this way:
```php
use Respect\Validation\Validator as v;
use Slim\Factory\AppFactory;
require __DIR__ . '/../vendor/autoload.php';
$app = AppFactory::create();
//Create the validators
$typeValidator = v::alnum()->noWhitespace()->length(3, 5);
$emailNameValidator = v::alnum()->noWhitespace()->length(1, 2);
$validators = array(
'type' => $typeValidator,
'email' => array(
'name' => $emailNameValidator,
),
);
```
If you'll have an error, the result would be:
```php
//In your route
$errors = $req->getAttribute('errors');
print_r($errors);
/*
Array
(
[email.name] => Array
(
[0] => "rq3r" must have a length between 1 and 2
)
)
*/
```
### Translate errors
You can provide a callable function to translate the errors.
```php
use Respect\Validation\Validator as v;
use Slim\Factory\AppFactory;
require __DIR__ . '/../vendor/autoload.php';
$app = AppFactory::create();
//Create the validators
$usernameValidator = v::alnum()->noWhitespace()->length(1, 10);
$ageValidator = v::numeric()->positive()->between(1, 20);
$validators = array(
'username' => $usernameValidator,
'age' => $ageValidator
);
$translator = function($message){
$messages = [
'These rules must pass for {{name}}' => 'Queste regole devono passare per {{name}}',
'{{name}} must be a string' => '{{name}} deve essere una stringa',
'{{name}} must have a length between {{minValue}} and {{maxValue}}' => '{{name}} deve avere una dimensione di caratteri compresa tra {{minValue}} e {{maxValue}}',
];
return $messages[$message];
};
$middleware = new \DavidePastore\Slim\Validation\Validation($validators, $translator);
// Register middleware for all routes or only for one...
$app->run();
```
## Testing
``` bash
$ vendor\bin\phpunit
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
- [Davide Pastore](https://github.com/davidepastore)
[respect-validation]: https://github.com/Respect/Validation
[custom-messages]: https://respect-validation.readthedocs.io/en/1.1/feature-guide/#custom-messages
[ico-version]: https://img.shields.io/packagist/v/DavidePastore/Slim-Validation.svg?style=flat-square
[ico-github-actions]: https://github.com/DavidePastore/Slim-Validation/workflows/Continuous%20Integration/badge.svg?branch=4.0
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/DavidePastore/Slim-Validation.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/davidepastore/Slim-Validation.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/davidepastore/slim-validation.svg?style=flat-square
[ico-styleci]: https://styleci.io/repos/48914054/shield
[link-packagist]: https://packagist.org/packages/davidepastore/slim-validation
[link-github-actions]: https://github.com/DavidePastore/Slim-Validation/actions?query=workflow%3A%22Continuous+Integration%22+branch%3A4.0
[link-scrutinizer]: https://scrutinizer-ci.com/g/DavidePastore/Slim-Validation/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/DavidePastore/Slim-Validation
[link-downloads]: https://packagist.org/packages/davidepastore/slim-validation
[link-styleci]: https://styleci.io/repos/48914054/