IsTrue

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

IsTrue

Валидирует, что значение является true. А именно проверяет, чтобы значениче точно было true, число точно было 1, или строка точно была "1".

Также смотрите IsFalse.

??????????? ?	???????? ??? ??????
?????	IsTrue
?????????	IsTrueValidator

Базовое применение

Это ограничение может быть применено к свойствам (например, к свойству termsAccepted в модели регистрации) или к геттер-методу. Наиболее мощным оно является во втором случае, где вы можете удостовериться, чтоб метод возвращает настоящее значение. Например, представьте, что у вас есть следующий метод:

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

class Author
{
    protected string $token;

    public function isTokenValid(): bool
    {
        return $this->token === $this->generateToken();
    }
}
    

Тогда вы можете ограничить этот метод с IsTrue:

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

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    protected string $token;

    #[Assert\IsTrue(message: 'The token is invalid.')]
    public function isTokenValid(): bool
    {
        return $this->token === $this->generateToken();
    }

    // ...
}
    

        1
2
3
4
5
6
        # config/validator/validation.yaml
App\Entity\Author:
    getters:
        tokenValid:
            - 'IsTrue':
                message: The token is invalid.
    

        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\Author">
        <getter property="tokenValid">
            <constraint name="IsTrue">
                <option name="message">The token is invalid.</option>
            </constraint>
        </getter>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
        // src/Entity/Author.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints\IsTrue;
use Symfony\Component\Validator\Mapping\ClassMetadata;

class Author
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addGetterConstraint('tokenValid', new IsTrue([
            'message' => 'The token is invalid.',
        ]));
    }

    public function isTokenValid(): bool
    {
        return $this->token === $this->generateToken();
    }

    // ...
}
    

Если isTokenValid() вернёт "false", то валидация будет неудачной.

Note

As with most of the other constraints, null is considered a valid value. This is to allow the use of optional values. If the value is mandatory, a common solution is to combine this constraint with NotNull.

Опции

`groups`

type: array | string default: null

It defines the validation group or groups of this constraint. Read more about validation groups.

`message`

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

Это сообщение отображается, если основоположные данные не "true".

Вы можете использовать следующие параметры в этом сообщении:

????????	????????
`{{ value }}`	??????? (??????????) ????????
`{{ label }}`	??????????????? ????? ???? ?????

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

payload

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

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

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