Skip to content

Latest commit

 

History

History
84 lines (62 loc) · 3.54 KB

05-validator-for-data-models.md

File metadata and controls

84 lines (62 loc) · 3.54 KB

back to README

Validator for data models

The dogado/json-api-common package allows the conversion from resource instances to data models. It's usually the case, that we need some sort of validation on the JSON API data that is coming in. The Dogado\JsonApi\Server\Validator\ModelValidator class offers the possibility to validate any model in it the current state, based on symfony/validator.

Usually, you can use any validation you like. Although this validator will throw a custom JSON API compatible Dogado\JsonApi\Exception\JsonApi\ValidationException containing error objects representing the Symfony Validator violations.

Code example

Model class definition

use Dogado\JsonApi\Attribute\Attribute;
use Dogado\JsonApi\Attribute\Type;
use Symfony\Component\Validator\Constraints as Assert;

#[Type('validation-test')]
class Model
{
    #[
        Attribute,
        Assert\Email
    ]
    private string $email = 'noValidEmail';

    #[
        Attribute('jsonApiValueObject'),
        Assert\Valid
    ]
    private ValueObjectModel $valueObject;

    public function __construct()
    {
        $this->valueObject = new ValueObjectModel();
    }
}

It is also possible to validate value objects. To do that, you need to add the Assert\Valid attribute to the object property. Within the value object, you can continue to use the regular assertions.

Execute validation

use Dogado\JsonApi\Exception\JsonApiException;
use Dogado\JsonApi\Server\Tests\Stubs\Validator\Model;
use Dogado\JsonApi\Server\Validator\ModelValidator;
use Symfony\Component\Validator\ValidatorBuilder;

$model = new Model();
$validatorBuilder = new ValidatorBuilder();
$validator = $validatorBuilder->enableAnnotationMapping(true)->getValidator();

$jsonApiValidator = new ModelValidator($validator);
/** @throws JsonApiException */
$jsonApiValidator->validate($model);

In the above example we are using the annotation mapping that Symfony Validator offers by default. Feel free to use a different way of defining your validation rules. More details and validation examples can be found in the Symfony documentation.

php 8 validation limitations and Doctrine annotation support

Symfony added the php 8 attribute support for the assertion constraints in symfony/validator:5.2.0, but the alternative Doctrine annotation support is still given, even in Symfony 6. You can activate it like this:

$validatorBuilder = new ValidatorBuilder();
$validator = $validatorBuilder->enableAnnotationMapping(true)->addDefaultDoctrineAnnotationReader()->getValidator();

The benefit of using the php 8 attributes instead is that you don't have to require doctrine packages as dependencies. Attributes are a php 8 natively implemented feature and therefore faster to use. However, there are a few Symfony Constraints that are not compatible to attributes yet, but that will probably change with php 8.1.

Custom violation converter

The Symfony validator creates violations for each failing assertion rule. The JSON API server validator will send all violations against a Dogado\JsonApi\Server\Validator\ViolationConverterInterface. There already is a default ViolationConverter which will be used, but feel free to create a custom one and pass that one as parameter to the Validator instantiation.

prev: Exception handling | back to README