Charset

7.1

The Charset constraint was introduced in Symfony 7.1.

Validates that a string (or an object implementing the Stringable PHP interface) is encoded in a given charset.

Applies to	property or method
Class	Charset
Validator	CharsetValidator

Basic Usage

If you wanted to ensure that the content property of a FileDTO class uses UTF-8, you could do the following:

        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'));
    }
}
    

Options

`encodings`

type: array | string default: []

An encoding or a set of encodings to check against. If you pass an array of encodings, the validator will check if the value is encoded in any of the encodings. This option accepts any value that can be passed to the mb_detect_encoding PHP function.

`groups`

type: array | string default: null

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

`message`

type: string default: The detected character encoding is invalid ({{ detected }}). Allowed encodings are {{ encodings }}.

This is the message that will be shown if the value does not match any of the accepted encodings.

You can use the following parameters in this message:

Parameter	Description
`{{ detected }}`	The detected encoding
`{{ encodings }}`	The accepted encodings

`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