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 ``HH:MM:SS`` format. ========== =================================================================== Applies to :ref:`property or method ` Options - `groups`_ - `message`_ - `payload`_ 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-annotations // src/Entity/Event.php namespace App\Entity; use Symfony\Component\Validator\Constraints as Assert; class Event { /** * @Assert\Time * @var string A "H:i:s" formatted value */ protected $startsAt; } .. code-block:: yaml # config/validator/validation.yaml App\Entity\Event: properties: startsAt: - Time: ~ .. code-block:: xml .. 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 $startsAt; public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addPropertyConstraint('startsAt', new Assert\Time()); } } .. include:: /reference/constraints/_empty-values-are-valid.rst.inc Options ------- .. include:: /reference/constraints/_groups-option.rst.inc ``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 =============== ============================================================== .. include:: /reference/constraints/_payload-option.rst.inc