Charset

Дата оновлення перекладу 2024-05-29

Charset

7.1

Обмеження Charset було представлено в Symfony 7.1.

Валідує, що рядок (або об'єкт, що реалізує інтерфейс PHP Stringable) закодовано у заданій кодировці.

Базове використання

Якщо ви хочете гарантувати, що властивість content класу FileDTO класу використовує UTF-8, ви можете зробити наступне:

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

use Symfony\Component\Validator\Constraints as Assert;

class FileDTO
{
    #[Assert\Charset('UTF-8')]
    protected string $content;
}
    

        1
2
3
4
5
        # config/validator/validation.yaml
App\Entity\FileDTO:
    properties:
        content:
            - Charset: 'UTF-8'
    

        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\FileDTO">
        <property name="content">
            <constraint name="Charset">
                <option name="charset">UTF-8</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>
    

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

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

class FileDTO
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('content', new Assert\Charset('UTF-8'));
    }
}
    

Опції

`encodings`

тип: array | string за замовчуванням: []

Кодування або набір кодувань для перевірки. Якщо ви передасте масив кодувань кодувань, валідатор перевірить, чи значення закодовано в будь-якому з кодувань. Цей параметр приймає будь-яке значення, яке можна передати в mb_detect_encoding.

Дата оновлення перекладу 2023-09-24

`groups`

тип: array | string за замовчуванням: null

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

`message`

тип: string за замовчуванням: Виявлене кодування символів є недійсним ({{ detected }}). Допустимими кодуваннями є {{ encodings }}.

Це повідомлення буде показано, якщо значення не відповідає жодному з допустимих кодувань.

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

????????	????
`{{ detected }}`	???????? ?????????
`{{ encodings }}`	????????? ?????????

Дата оновлення перекладу 2024-05-29

`payload`

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

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

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