Time
Edit this pageWarning: You are browsing the documentation for Symfony 3.1, which is no longer maintained.
Read the updated version of this page for Symfony 6.2 (the current stable version).
Time
Validates that a value is a valid time, meaning either a DateTime object
or a string (or an object that can be cast into a string) that follows
a valid "HH:MM:SS" format.
| Applies to | property or method |
| Options | |
| Class | Time |
| Validator | TimeValidator |
Basic Usage
Suppose you have an Event class, with a startAt field that is the time
of the day when the event starts:
1 2 3 4 5 6 7 8 9 10 11 12
// src/AppBundle/Entity/Event.php
namespace AppBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Event
{
/**
* @Assert\Time()
*/
protected $startsAt;
}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.
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.
