时间

编辑此页

验证值是否为有效时间，意味着一个字符串（或可以转换为字符串的对象），它遵循有效的 H:i:s 格式（例如 '16:27:36'）。

适用于	属性或方法
类	时间
验证器	TimeValidator

基本用法

假设您有一个 Event 类，其中有一个 startsAt 字段，它是事件开始的当天时间

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

use Symfony\Component\Validator\Constraints as Assert;

class Event
{
    /**
     * @var string A "H:i:s" formatted value
     */
    #[Assert\Time]
    protected string $startsAt;
}
    

        1
2
3
4
5
        # config/validator/validation.yaml
App\Entity\Event:
    properties:
        startsAt:
            - Time: ~
    

        1
2
3
4
5
6
7
8
9
10
11
12
        <!-- 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\Event">
        <property name="startsAt">
            <constraint name="Time"/>
        </property>
    </class>
</constraint-mapping>
    

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

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

class Event
{
   /**
    * @var string A "H:i:s" formatted value
    */
    protected string $startsAt;

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('startsAt', new Assert\Time());
    }
}
    

注意

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

选项

`groups`

类型: array | string 默认值: null

它定义了此约束的验证组或组。阅读更多关于验证组的信息。

`message`

类型: string 默认值: This value is not a valid time.

如果底层数据不是有效时间，则会显示此消息。

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

参数	描述
`{{ value }}`	当前（无效）值
`{{ label }}`	对应的表单字段标签

`withSeconds`

类型: boolean 默认值: true

此选项允许您指定时间是否应包含秒。

选项	模式	正确的值	不正确的值
`true`	`/^(\d{2}):(\d{2}):(\d{2})$/`	`12:00:00`	`12:00`
`false`	`/^(\d{2}):(\d{2})$/`	`12:00`	`12:00:00`

`payload`

类型: mixed 默认值: null

此选项可用于将任意特定于域的数据附加到约束。配置的 payload 不会被 Validator 组件使用，但其处理完全取决于您。

例如，您可能想要使用几个错误级别，以便在前台以不同的方式呈现失败的约束，具体取决于错误的严重程度。

这项工作，包括代码示例，根据 Creative Commons BY-SA 3.0 许可获得许可。

版本