You are browsing the documentation for Symfony 2.8 which is not maintained anymore.
Consider upgrading your projects to Symfony 5.2.
Date
Date¶
Validates that a value is a valid date, meaning either a DateTime
object
or a string (or an object that can be cast into a string) that follows a
valid YYYY-MM-DD format.
Applies to | property or method |
Options | |
Class | Symfony\Component\Validator\Constraints\Date |
Validator | Symfony\Component\Validator\Constraints\DateValidator |
Basic Usage¶
- Annotations
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\Date */ protected $birthday; }
- YAML
1 2 3 4 5
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Author: properties: birthday: - Date: ~
- XML
1 2 3 4 5 6 7 8 9 10 11 12
<!-- src/AppBundle/Resources/config/validation.xml --> <?xml version="1.0" encoding="UTF-8" ?> <constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd"> <class name="AppBundle\Entity\Author"> <property name="birthday"> <constraint name="Date" /> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13
// src/AppBundle/Entity/Author.php namespace AppBundle\Entity; use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Component\Validator\Constraints as Assert; class Author { public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addPropertyConstraint('birthday', new Assert\Date()); } }
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¶
message¶
type: string
default: This value is not a valid date.
This message is shown if the underlying data is not a valid date.
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.
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.