class DateTimeFormatConstraint

Validation constraint for DateTime items to ensure the format is correct.

Hierarchy

class \Symfony\Component\Validator\Constraint
- class \Drupal\datetime\Plugin\Validation\Constraint\DateTimeFormatConstraint extends \Symfony\Component\Validator\Constraint

Expanded class hierarchy of DateTimeFormatConstraint

File

core/modules/datetime/src/Plugin/Validation/Constraint/DateTimeFormatConstraint.php, line 12

Namespace

Drupal\datetime\Plugin\Validation\Constraint

View source

class DateTimeFormatConstraint extends SymfonyConstraint {
    
    /**
     * Message for when the value isn't a string.
     *
     * @var string
     */
    public $badType = "The datetime value must be a string.";
    
    /**
     * Message for when the value isn't in the proper format.
     *
     * @var string
     */
    public $badFormat = "The datetime value '@value' is invalid for the format '@format'";
    
    /**
     * Message for when the value did not parse properly.
     *
     * @var string
     */
    public $badValue = "The datetime value '@value' did not parse properly for the format '@format'";

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overrides
Constraint::$groups	public	property	The groups that the constraint belongs to.
Constraint::$payload	public	property	Domain-specific data attached to a constraint.
Constraint::addImplicitGroupName	public	function	Adds the given group if this constraint is in the Default group.	2
Constraint::CLASS_CONSTRAINT	public	constant	Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP	public	constant	The name of the group given to all constraints with no explicit group.
Constraint::ERROR_NAMES	protected	constant	Maps error codes to the names of their constants.	59
Constraint::getDefaultOption	public	function	Returns the name of the default option.	28
Constraint::getErrorName	public static	function	Returns the name of the given error code.
Constraint::getRequiredOptions	public	function	Returns the name of the required options.	22
Constraint::getTargets	public	function	Returns whether the constraint can be put onto classes, properties or both.	8
Constraint::normalizeOptions	protected	function
Constraint::PROPERTY_CONSTRAINT	public	constant	Marks a constraint that can be put onto properties.
Constraint::validatedBy	public	function	Returns the name of the class that validates this constraint.	9
Constraint::__construct	public	function	Initializes the constraint with options.	58
Constraint::__get	public	function	Returns the value of a lazily initialized option.	2
Constraint::__isset	public	function		1
Constraint::__set	public	function	Sets the value of a lazily initialized option.	1
Constraint::__sleep	public	function	Optimizes the serialized value to minimize storage space.
DateTimeFormatConstraint::$badFormat	public	property	Message for when the value isn't in the proper format.
DateTimeFormatConstraint::$badType	public	property	Message for when the value isn't a string.
DateTimeFormatConstraint::$badValue	public	property	Message for when the value did not parse properly.