Json

Warning: You are browsing the documentation for Symfony 5.x, which is no longer maintained.

Read the updated version of this page for Symfony 7.3 (the current stable version).

Validates that a value has valid JSON syntax.

Applies to	property or method
Class	Json
Validator	JsonValidator

Basic Usage

The Json constraint can be applied to a property or a "getter" method:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        // src/Entity/Book.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Book
{
    /**
     * @Assert\Json(
     *     message = "You've entered an invalid Json."
     * )
     */
    private $chapters;
}
    

        1
2
3
4
5
6
7
8
9
10
11
12
        // src/Entity/Book.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Book
{
    #[Assert\Json(
        message: "You've entered an invalid Json."
    )]
    private $chapters;
}
    

        1
2
3
4
5
6
        # config/validator/validation.yaml
App\Entity\Book:
    properties:
        chapters:
            - Json:
                message: You've entered an invalid Json.
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        <!-- config/validator/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="App\Entity\Book">
        <property name="chapters">
            <constraint name="Json">
                <option name="message">You've entered an invalid Json.</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        // src/Entity/Book.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;

class Book
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('chapters', new Assert\Json([
            'message' => 'You\'ve entered an invalid Json.',
        ]));
    }
}
    

Options

`message`

type: string default: This value should be valid JSON.

This message is shown if the underlying data is not a valid JSON value.

`payload`

type: mixed default: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

TOC

Version