长度

编辑此页

验证给定的字符串长度是否在某个最小值和最大值之间。

适用于	属性或方法
类	长度
验证器	LengthValidator

基本用法

要验证类的 firstName 字段长度是否在 2 和 50 之间，你可以添加以下内容

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

use Symfony\Component\Validator\Constraints as Assert;

class Participant
{
    #[Assert\Length(
        min: 2,
        max: 50,
        minMessage: 'Your first name must be at least {{ limit }} characters long',
        maxMessage: 'Your first name cannot be longer than {{ limit }} characters',
    )]
    protected string $firstName;
}
    

        1
2
3
4
5
6
7
8
9
        # config/validator/validation.yaml
App\Entity\Participant:
    properties:
        firstName:
            - Length:
                min: 2
                max: 50
                minMessage: 'Your first name must be at least {{ limit }} characters long'
                maxMessage: 'Your first name cannot be longer than {{ limit }} characters'
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
        <!-- config/validator/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.ac.cn/schema/dic/constraint-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.ac.cn/schema/dic/constraint-mapping http://symfony.ac.cn/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="App\Entity\Participant">
        <property name="firstName">
            <constraint name="Length">
                <option name="min">2</option>
                <option name="max">50</option>
                <option name="minMessage">
                    Your first name must be at least {{ limit }} characters long
                </option>
                <option name="maxMessage">
                    Your first name cannot be longer than {{ limit }} characters
                </option>
            </constraint>
        </property>
    </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/Participant.php
namespace App\Entity;

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

class Participant
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('firstName', new Assert\Length([
            'min' => 2,
            'max' => 50,
            'minMessage' => 'Your first name must be at least {{ limit }} characters long',
            'maxMessage' => 'Your first name cannot be longer than {{ limit }} characters',
        ]));
    }
}
    

注意

与其他大多数约束一样，null 被认为是有效值。这是为了允许使用可选值。如果该值是强制性的，一个常见的解决方案是将此约束与 NotNull 结合使用。

选项

`charset`

类型: string 默认值: UTF-8

使用 mb_check_encoding 和 mb_strlen PHP 函数计算值长度时要使用的字符集。

`charsetMessage`

类型: string 默认值: 此值与预期的 {{ charset }} 字符集不匹配。

如果该值未使用给定的 charset，则会显示此消息。

你可以在此消息中使用以下参数

参数	描述
`{{ charset }}`	预期的字符集
`{{ value }}`	当前的（无效）值

`countUnit`

类型: string 默认值: Length::COUNT_CODEPOINTS

用于长度检查的字符计数单位。默认情况下，使用 mb_strlen，它计算 Unicode 代码点。

可以是 Length 类的以下常量之一

COUNT_BYTES: 使用 strlen 计算字符串的字节长度。
COUNT_CODEPOINTS: 使用 mb_strlen 计算字符串的 Unicode 代码点长度。这是 Symfony 6.2 之前的唯一行为，并且是 Symfony 6.3 以来的默认行为。简单（多字节）Unicode 字符算作 1 个字符，而例如由表情符号组成的 ZWJ 序列算作多个字符。
COUNT_GRAPHEMES: 使用 grapheme_strlen 计算字符串的字形长度，即，即使是表情符号和由表情符号组成的 ZWJ 序列也算作 1 个字符。