Expressive Validator
Validation library for the zend-expressive
(http://zend-expressive.readthedocs.org/en/latest), (*1)
Installation
Using composer!, (*2)
composer require atasciuc/zend-expressive-validation
Usage
1. ----
Create a validator factory, (*3)
/**
* Instantiates the validator
* Class YourValidatorFactoryClass
*/
class YourValidatorFactoryClass
{
public function __invoke(ContainerInterface $container)
{
/** @var EntityManagerInterface $entityManager */
$entityManager = $container->get('orm.default'); // = null
return new Validator(
$container->get(OptionsExtractor::class),
$container->get(RouterInterface::class),
$entityManager
);
}
}
Note:
The entityManager is optional and required only if you want to use database validation classes such as EntityExist, (*4)
2. ----
Add the validator classes to the dependecies.php of your project, (*5)
<?php
use ExpressiveValidator\Middleware\ErrorMiddleware;
use ExpressiveValidator\Validator\OptionExtractorFactory;
use ExpressiveValidator\Validator\OptionsExtractor;
use ExpressiveValidator\Validator\ValidationMiddleware;
use ExpressiveValidator\Validator\ValidationMiddlewareFactory;
use ExpressiveValidator\Validator\Validator;
return [
'dependencies' => [
'abstract_factories' => [
],
'invokables' => [
ErrorMiddleware::class => ErrorMiddleware::class,
],
'factories' => [
Zend\Expressive\Application::class => Zend\Expressive\Container\ApplicationFactory::class,
OptionsExtractor::class => OptionExtractorFactory::class,
Validator::class => YourValidatorFactoryClass::class,
ValidationMiddleware::class => ValidationMiddlewareFactory::class,
],
'shared' => [
]
]
];
3. ----
Edit your middleware-pipeline.global and register the validation middlewares, (*6)
<?php
use ExpressiveValidator\Middleware\ErrorMiddleware;
use ExpressiveValidator\Validator\ValidationMiddleware;
return [
// This can be used to seed pre- and/or post-routing middleware
'middleware_pipeline' => [
// An array of middleware to register prior to registration of the
// routing middleware
'pre_routing' => [
[
'middleware' => ValidationMiddleware::class,
],
//[
// Required:
// 'middleware' => 'Name of middleware service, or a callable',
// Optional:
// 'path' => '/path/to/match',
// 'error' => true,
//],
],
// An array of middleware to register after registration of the
// routing middleware
'post_routing' => [
[
'middleware' => ErrorMiddleware::class,
'error' => true
],
//[
// Required:
// 'middleware' => 'Name of middleware service, or a callable',
// Optional:
// 'path' => '/path/to/match',
// 'error' => true,
//],
],
],
];
Note
Or you can add your own ErrorMiddleware and register it in you dependencies, example of the one provided:, (*7)
class ErrorMiddleware
{
/**
* @param mixed $error
* @param Request $request
* @param Response $response
* @param callable|null $out
* @return
* @throws Exception
*/
public function __invoke($error, Request $request, Response $response, callable $out = null)
{
if (!($error instanceof Exception)) {
$error = new MethodNotAllowedException();
}
switch (true) {
case $error instanceof MethodNotAllowedException || $error instanceof EntityNotFoundException:
return $out($request, new JsonExceptionResponse($error->getCode(), $error->getMessage()));
case ($error instanceof ValidationFailedException):
$messages = $error->getValidationResult()->getMessages();
return $out($request, new JsonExceptionResponse(
$error->getCode(),
count($messages) > 0 ? $messages[0] : 'Something is not right'
));
default:
throw $error;
}
}
}
4. ----
To your route add the validation to the route:, (*8)
'routes' => [
[
'name' => 'user',
'path' => '/user/{id}',
'allowed_methods' => ['GET'],
'middleware' => UserAction::class,
'options' => [
'validation' => [
'GET' => GetUserValidationRules::class
]
]
]
],
The validation might be aplyed to the http method or to all the methods:, (*9)
'options' => [
'validation' => [
'*' => GetUserValidationRules::class
]
]
The validation rules class my comply to the - ValidationRulesInterface, (*10)
Example of the validation rules:, (*11)
class GetUserValidationRules implements ValidationRulesInterface
{
use ValidationRulesConstructorTrait;
/**
* Return a class mapping
* of the validations
* @return \array[] mixed
*/
public function getValidationRules()
{
return [
'id' => [
NotEmpty::class => [
'locale' => 'en'
],
Regex::class => [
'pattern' => $this->idRegex
],
EntityExist::class => [
'entity' => User::class,
'field' => 'id'
]
]
];
}
/**
* Return the error messages
* @return array [] mixed
*/
public function getMessages()
{
return [
'id' => [
NotEmpty::class => 'Please provide the user',
Regex::class => 'user id must have the following pattern xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
EntityExist::class => 'This user does not exist'
]
];
}
}
5. ----
Now in your action you can extract the validated data:, (*12)
public function __invoke(Request $request, Response $response, callable $next = null)
{
$data = $request->getValidationResult()->getData();
return $next($request, new JsonResponse($data));
}
That it is it
ToDo
[] - add docs to the validation classes, (*13)
Wallogit.com
