Date

Warning: You are browsing the documentation for Symfony 2.2, which is no longer maintained.

Read the updated version of this page for Symfony 6.2 (the current stable version).

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	message
Class	Date
Validator	DateValidator

Basic Usage

YAML
Annotations
XML
PHP

        1
2
3
4
5
        # src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
    properties:
        birthday:
            - Date: ~
    

        1
2
3
4
5
6
7
8
9
10
11
12
        // src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    /**
     * @Assert\Date()
     */
     protected $birthday;
}
    

        1
2
3
4
5
6
7
8
9
10
11
12
        <!-- src/Acme/BlogBundle/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="Acme\BlogBundle\Entity\Author">
        <property name="birthday">
            <constraint name="Date" />
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
        // src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\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.

Menu

Date

Date

Basic Usage

Options

message

What is Symfony?

Learn Symfony

Screencasts

Community

Blog

Services

Deployed on