Time.rst

Time

Validates that a value is a valid time, meaning a string (or an object that can be cast into a string) that follows a valid H:i:s format (e.g. '16:27:36').

Applies to	:ref:`property or method <validation-property-target>`
Class	:class:`Symfony\\Component\\Validator\\Constraints\\Time`
Validator	:class:`Symfony\\Component\\Validator\\Constraints\\TimeValidator`

Basic Usage

Suppose you have an Event class, with a startsAt field that is the time of the day when the event starts:

.. configuration-block::

    .. code-block:: php-attributes

        // 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;
        }

    .. code-block:: yaml

        # config/validator/validation.yaml
        App\Entity\Event:
            properties:
                startsAt:
                    - Time: ~

    .. code-block:: xml

        <!-- 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\Event">
                <property name="startsAt">
                    <constraint name="Time"/>
                </property>
            </class>
        </constraint-mapping>

    .. code-block:: php

        // 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());
            }
        }

Options

message

type: string default: This value is not a valid time.

This message is shown if the underlying data is not a valid time.

You can use the following parameters in this message:

Parameter	Description
{{ value }}	The current (invalid) value
{{ label }}	Corresponding form field label

withSeconds

type: boolean default: true

This option allows you to specify whether the time should include seconds.

Option	Pattern	Correct value	Incorrect value
true	/^(\d{2}):(\d{2}):(\d{2})$/	12:00:00	12:00
false	/^(\d{2}):(\d{2})$/	12:00	12:00:00

.. versionadded:: 6.4

    The ``withSeconds`` option was introduced in Symfony 6.4.