1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. Date
WARNING: You are browsing the documentation for Symfony 2.3 which is not maintained anymore. Consider upgrading your projects to Symfony 5.0.

Date

2.3 version
Maintained
3.4 4.3 4.4 5.0 current 5.1 master
Unmaintained
2.0 2.1 2.2 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 4.0 4.1 4.2

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 Date
Validator 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());
    }
}

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.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.