Json

Дата обновления перевода 2023-09-25

Json

Валидирует, что значение имеет валидный синтаксис JSON.

??????????? ?	???????? ??? ??????
?????	Json
?????????	JsonValidator

Базовое использование

Ограничение Json может быть применено к свойству или методу "getter":

        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 string $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): void
    {
        $metadata->addPropertyConstraint('chapters', new Assert\Json([
            'message' => 'You\'ve entered an invalid Json.',
        ]));
    }
}
    

Опции

`message`

тип: string по умолчанию: Это значение должно быть валидным JSON.

Это сообщение отображается, если низлежащие данные не являются валидным JSON значением.

Дата обновления перевода 2024-07-25

payload

тип: mixed по умолчанию: null

Эта опция может быть использована, чтобы добавить к ограничению произвольные данные, относящиеся к домену. Сконфигурированная нагрузка не используется компонентом Валидатор, но его обработка полностью зависит от вас.

Например, вы можете захотеть исользовать несколько уровней ошибок, чтобы представить неудачные ограничения в фронт-энде по-разному, в зависимости от степени сложности ошибки.