Time
Edit this pageWarning: You are browsing the documentation for Symfony 4.3, 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 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 startsAt field that is the time
of the day when the event starts:
- Annotations
- YAML
- XML
- PHP
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
{
/**
* @Assert\Time
* @var string A "H:i:s" formatted value
*/
protected $startsAt;
}Note
As with most of the other constraints, null and empty strings are
considered valid values. This is to allow them to be optional values.
If the value is mandatory, a common solution is to combine this constraint
with NotBlank.
Options
groups
type: array | string
It defines the validation group or groups this constraint belongs to. Read more about validation groups.
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 |
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.
