Time

Validates that a value is a valid time, meaning either a DateTime object or a string (or an object that can be cast into a string) that follows a valid "HH:MM:SS" format.

Applies to	property or method
Options	message
Class	Time
Validator	TimeValidator

Basic Usage

Suppose you have an Event class, with a startAt field that is the time of the day when the event starts:

Annotations
YAML
XML
PHP

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

use Symfony\Component\Validator\Constraints as Assert;

class Event
{
    /**
     * @Assert\Time()
     */
     protected $startsAt;
}
    

        1
2
3
4
5
        # src/AppBundle/Resources/config/validation.yml
AppBundle\Entity\Event:
    properties:
        startsAt:
            - Time: ~
    

        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\Event">
        <property name="startsAt">
            <constraint name="Time" />
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
        // src/AppBundle/Entity/Event.php
namespace AppBundle\Entity;

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

class Event
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('startsAt', new Assert\Time());
    }
}
    

Options

message

type: string default: This value is not a valid time.

This message is shown if the underlying data is not a valid time.

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