DateTime
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.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/AppBundle/Entity/Author.php
namespace AppBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\DateTime()
*/
protected $createdAt;
}Options
format
type: string default: Y-m-d H:i:s
3.1
The format option was introduced in Symfony 3.1.
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.
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.
