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

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

DateTime

4.1 version

Maintained

4.4 5.3 current 5.4 dev 6.0

Unmaintained

2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1 5.2

DateTime
- Basic Usage
- Options
  - format
  - message
  - payload

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	format message payload
Class	`Symfony\Component\Validator\Constraints\DateTime`
Validator	`Symfony\Component\Validator\Constraints\DateTimeValidator`

Basic Usage¶

Annotations

// src/Entity/Author.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    /**
     * @Assert\DateTime
     */
     protected $createdAt;
}

YAML

# config/validator/validation.yaml
App\Entity\Author:
    properties:
        createdAt:
            - DateTime: ~

XML

<!-- config/validator/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="App\Entity\Author">
        <property name="createdAt">
            <constraint name="DateTime" />
        </property>
    </class>
</constraint-mapping>

PHP

// src/Entity/Author.php
namespace App\Entity;

use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('createdAt', new Assert\DateTime());
    }
}

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.

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