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

Time

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

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
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:

  • YAML
    1
2
3
4
5
    # src/Acme/EventBundle/Resources/config/validation.yml
Acme\EventBundle\Entity\Event:
    properties:
        startsAt:
            - Time: ~
  • Annotations
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    // src/Acme/EventBundle/Entity/Event.php
namespace Acme\EventBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Event
{
    /**
     * @Assert\Time()
     */
     protected $startsAt;
}
  • XML
    1
2
3
4
5
6
    <!-- src/Acme/EventBundle/Resources/config/validation.xml -->
<class name="Acme\EventBundle\Entity\Event">
    <property name="startsAt">
        <constraint name="Time" />
    </property>
</class>
  • PHP
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    // src/Acme/EventBundle/Entity/Event.php
namespace Acme\EventBundle\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.