DateTime
Edit this pageWarning: You are browsing the documentation for Symfony 4.1, which is no longer maintained.
Read the updated version of this page for Symfony 6.1 (the current stable version).
DateTime
Validates that a value is a valid "datetime", meaning either a DateTime
object or a string (or an object that can be cast into a string) that follows
a specific format.
| Applies to | property or method |
| Options | |
| Class | DateTime |
| Validator | DateTimeValidator |
Basic Usage
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\DateTime
*/
protected $createdAt;
}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
format
type: string default: Y-m-d H:i:s
This option allows to validate a custom date format. See DateTime::createFromFormat() for formatting options.
message
type: string default: This value is not a valid datetime.
This message is shown if the underlying data is not a valid datetime.
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.
