fluoresce/validate-embedded

Constraint enabling group-based validation of embedded objects with the Symfony Validator Component.

1.3.0 2023-05-23 09:55 UTC

Requires

• php: >=5.5.9
• symfony/validator: ~2.8|~3.0|~4.0|~5.0|~6.0

MIT

• Jaik Dean

• Symfony2
• validator
• validation
• validate
• constraint
• symfony3
• symfony4

README

This library provides the Validate constraint for the Symfony Validator Component.

This constraint behaves similar to the built-in Valid constraint, but respects the groups option. Additionally, it adds an option to specify the validation groups to target on the embedded object(s).

Installation

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require fluoresce/validate-embedded

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Documentation

The following examples assume you are using the full Symfony framework, though this package can be used in any project that has the Symfony Validator Component available

Basic Usage

This example shows an Author which has a collection of Books. When validation is run for group1 on Author, it will cascade to all embedded Book instances.

The behaviour here is slightly different to the standard Valid constraint, as validation of the Book instances is run with the default group.

<?php

use Fluoresce\ValidateEmbedded\Constraints as Fluoresce;

class Author
{
    /**
     * @var Book[]
     * @Fluoresce\Validate(groups={"group1"});
     */
    private $books;
}

<?php

use Symfony\Component\Validator\Constraints as Assert;

class Book
{
    /**
     * @var string
     * @Assert\NotBlank()
     */
    private $title;
}

Specifying Embedded Validation Groups

Imagine we want to specify different validation groups to be run on the Book instances. We can target these by specifying them in the Validate annotation.

<?php

use Fluoresce\ValidateEmbedded\Constraints as Fluoresce;

class Author
{
    /**
     * @var Book[]
     * @Fluoresce\Validate(embeddedGroups={"bookgroup1"});
     */
    private $books;
}

<?php

use Symfony\Component\Validator\Constraints as Assert;

class Book
{
    /**
     * @var string
     * @Assert\NotBlank(groups={"bookgroup1"})
     */
    private $title;
}

Now whenever an Author instance is validated, the embedded Books will be validated with validation group bookgroup1.

Combining All Options

This example combines behaviour from the previous ones to show how it operates together.

<?php

use Fluoresce\ValidateEmbedded\Constraints as Fluoresce;

class Author
{
    /**
     * @var Book[]
     * @Fluoresce\Validate(groups={"group1"}, embeddedGroups={"bookgroup1"});
     */
    private $books;
}

<?php

use Symfony\Component\Validator\Constraints as Assert;

class Book
{
    /**
     * @var string
     * @Assert\NotBlank(groups={"bookgroup1"})
     */
    private $title;
}