A validation library for PHP that uses the notification pattern.
- PHP 7.2+
composer require selective/validationA Notification collects together errors
In order to use a notification, you have to create the ValidationResult object.
A ValidationResult can be really simple:
<?php
use Selective\Validation\ValidationException;
use Selective\Validation\ValidationResult;
$validationResult = new ValidationResult();
if (empty($data['username'])) {
$validationResult->addError('username', 'Input required');
}You can now test the ValidationResult and throw an exception if it contains errors.
<?php
if ($validationResult->isFailed()) {
$validationResult->setMessage('Please check your input');
throw new ValidationException($validationResult);
}Login example:
<?php
use Selective\Validation\ValidationException;
use Selective\Validation\ValidationResult;
// ...
// Get all POST values
$data = (array)$request->getParsedBody();
$validation = new ValidationResult();
// Validate username
if (empty($data['username'])) {
$validation->addError('username', 'Input required');
}
// Validate password
if (empty($data['password'])) {
$validation->addError('password', 'Input required');
}
// Check validation result
if ($validation->isFailed()) {
// Global error message
$validation->setMessage('Please check your input');
// Trigger error response (see validation middleware)
throw new ValidationException($validation);
}Validating a JSON request works like validating form data, because in PHP it's just an array from the request object.
<?php
// Fetch json data from request as array
$jsonData = (array)$request->getParsedBody();
$validation = new ValidationResult();
// ...
if ($validation->isFailed()) {
$validation->setMessage('Please check your input');
throw new ValidationException($validation);
}In vanilla PHP you can fetch the JSON request as follows:
<?php
$jsonData = (array)json_decode(file_get_contents('php://input'), true);
// ...The ValidationExceptionMiddleware PSR-15 middleware catches all exceptions and converts
it into a nice JSON response.
<?php
use Selective\Validation\Encoder\JsonEncoder;
use Selective\Validation\Middleware\ValidationExceptionMiddleware;
use Selective\Validation\Transformer\ErrorDetailsResultTransformer;
use Slim\Factory\AppFactory;
require_once __DIR__ . '/../vendor/autoload.php';
$app = AppFactory::create();
$app->add(new ValidationExceptionMiddleware(
$app->getResponseFactory(),
new ErrorDetailsResultTransformer(),
new JsonEncoder()
));
// If you are using a container, you can also use this option:
// $app->add(ValidationExceptionMiddleware::class);
// ...
$app->run();This example uses PHI-DI:
<?php
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseFactoryInterface;
use Selective\Validation\Encoder\JsonEncoder;
use Selective\Validation\Middleware\ValidationExceptionMiddleware;
use Selective\Validation\Transformer\ErrorDetailsResultTransformer;
use Slim\App;
use Slim\Factory\AppFactory;
// ...
return [
ValidationExceptionMiddleware::class => static function (ContainerInterface $container) {
$factory = $container->get(ResponseFactoryInterface::class);
return new ValidationExceptionMiddleware($factory, new ErrorDetailsResultTransformer(), new JsonEncoder());
},
ResponseFactoryInterface::class => static function (ContainerInterface $container) {
$app = $container->get(App::class);
return $app->getResponseFactory();
},
App::class => static function (ContainerInterface $container) {
AppFactory::setContainer($container);
return AppFactory::create();
},
// ...
];<?php
use Selective\Validation\ValidationException;
use Selective\Validation\ValidationResult;
$validation = new ValidationResult();
// Validate username
if (empty($data->username)) {
$validation->addError('username', 'Input required');
}
// Check validation result
if ($validation->isFailed()) {
$validation->setMessage('Please check your input');
// Trigger the validation middleware
throw new ValidationException($validation);
}If you want to implement a custom response data structure,
you can implement a custom transformer against the
\Selective\Validation\Transformer\ResultTransformerInterface interface.
Example
<?php
namespace App\Transformer;
use Selective\Validation\Transformer\ResultTransformerInterface;
use Selective\Validation\ValidationResult;
final class MyValidationTransformer implements ResultTransformerInterface
{
public function transform(ValidationResult $validationResult): array
{
// Implement your own data structure for the response
// ...
return [];
}
}You can combine this library with a validator that is doing the actual validation of your input data.
The cakephp/validation library provides features to build validators that can validate arbitrary arrays of data with ease.
The $validator->errors() method will return a non-empty array when there are validation failures.
The returned array of errors then can be converted into a ValidationResult
using the CakeValidationErrorCollector.
For example, if you wanted to validate a contact form before creating and sending an email you could do the following.
Installation
composer require cakephp/validation
Usage
<?php
use Cake\Validation\Validator;
use Selective\Validation\Exception\ValidationException;
use Selective\Validation\Collector\CakeValidationErrorCollector;
// Note: This is just an example. Don't use the $request object within the domain layer.
$formData = (array)$request->getParsedBody();
// Basic form or json validation
$validator = new Validator();
$validator
->requirePresence('email')
->email('email', 'E-mail must be valid')
->requirePresence('name')
->notEmpty('name', 'We need your name.')
->requirePresence('comment')
->notEmpty('comment', 'You need to give a comment.');
$validationResult = (new CakeValidationErrorCollector)
->addErrors($validator->validate($formData));
// Optional: Do more complex validation and append it to the validation result
if (!$this->existsEmailInDatabase($formData['email'])) {
$validationResult->addError('email', 'E-Mail already exists');
}
if ($validationResult->isFailed()) {
$validationResult->setMessage('Validation failed. Please check your input.');
throw new ValidationException($validationResult);
}The MIT License (MIT). Please see License File for more information.