IsTrue

Дата оновлення перекладу 2022-12-17

IsTrue

Валідує, що значення - true. А точніше, перевіряє, щоб значення було точно true, точно цілим числом 1 або точно рядком '1'.

Також див. IsFalse.

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

Базове застосування

Це обмеження може бути застосовано до властивостей (наприклад, властивості termsAccepted у моделі реєстрації) та методів. Воно найбільш потужне в останньому випадку, де ви можете ствердити, що метод повертає значення true. Наприклад, уявіть, що у вас є наступний метод:

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

class Author
{
    protected $token;

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

Потім ви можете валідувати цей метод з IsTrue наступним чином:

Attributes
YAML
XML
PHP

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

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    protected $token;

    #[Assert\IsTrue(message: 'The token is invalid.')]
    public function isTokenValid()
    {
        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
        // 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)
    {
        $metadata->addGetterConstraint('tokenValid', new IsTrue([
            'message' => 'The token is invalid.',
        ]));
    }

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

Якщо isTokenValid() поверне, валідація зазнає невдачі.

Дата оновлення перекладу 2022-12-20

Note

Як і у більшості інших обмежень, null вважається валідним значенням. Це для того, щоб дозволити використання опціональних значень. Якщо значення є обовʼязковим, розповсюдженим рішенням буде комбінація цього обмеження з
NotNull.

Опції

Дата оновлення перекладу 2022-12-20

`groups`

тип: array | string

Визначаэ групу або групи валідації обмеження. Прочитайте більше про групи валідації.

`message`

тип: string за замовчуванням: This value should be true.

Це повідомлення, відображуване, якщо вихідні дані не є true.

Ви можете використати наступні параметри у цьому повідомленні:

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

Дата оновлення перекладу 2022-12-20

`payload`

тип: mixed за замовчуванням: null

Ця опція може бути використана, щоб додати довільні дані, специфічні для домену, до обмеження. Сконфігуроване корисне навантаження не використовується компонентом Validator, але його обробка повністю залежить від вас.

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