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

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

DateTime

2.3 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
  - message

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 valid YYYY-MM-DD HH:MM:SS format.

Applies to	property or method
Options	message
Class	`Symfony\Component\Validator\Constraints\DateTime`
Validator	`Symfony\Component\Validator\Constraints\DateTimeValidator`

Basic Usage¶

Annotations

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

use Symfony\Component\Validator\Constraints as Assert;

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

YAML

# src/AppBundle/Resources/config/validation.yml
AppBundle\Entity\Author:
    properties:
        createdAt:
            - DateTime: ~

XML

<!-- 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="createdAt">
            <constraint name="DateTime" />
        </property>
    </class>
</constraint-mapping>

PHP

// 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('createdAt', new Assert\DateTime());
    }
}

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.

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