Documentation

FormValidator extends ConstraintValidator
in package

Base class for constraint validators.

Tags
author

Bernhard Schussek bschussek@gmail.com

Table of Contents

Constants

OBJECT_TO_STRING  = 2
Whether to cast objects with a "__toString()" method to strings.
PRETTY_DATE  = 1
Whether to format {@link \DateTime} objects, either with the {@link \IntlDateFormatter} (if it is available) or as RFC-3339 dates ("Y-m-d H:i:s").

Properties

$context  : ExecutionContextInterface
$resolvedGroups  : SplObjectStorage<FormInterface, array<int, string|array<string|int, string>|GroupSequence>>

Methods

initialize()  : mixed
Initializes the constraint validator.
validate()  : mixed
{@inheritdoc}
formatTypeOf()  : string
Returns a string representation of the type of the value.
formatValue()  : string
Returns a string representation of the value.
formatValues()  : string
Returns a string representation of a list of values.
getConstraintsInGroups()  : array<string|int, mixed>
getValidationGroups()  : string|GroupSequence|array<string|int, string|GroupSequence>
Returns the validation groups of the given form.
resolveValidationGroups()  : GroupSequence|array<string|int, string|GroupSequence>
Post-processes the validation groups option for a given form.

Constants

OBJECT_TO_STRING

Whether to cast objects with a "__toString()" method to strings.

public mixed OBJECT_TO_STRING = 2

PRETTY_DATE

Whether to format {@link \DateTime} objects, either with the {@link \IntlDateFormatter} (if it is available) or as RFC-3339 dates ("Y-m-d H:i:s").

public mixed PRETTY_DATE = 1

Properties

Methods

formatTypeOf()

Returns a string representation of the type of the value.

protected formatTypeOf(mixed $value) : string

This method should be used if you pass the type of a value as message parameter to a constraint violation. Note that such parameters should usually not be included in messages aimed at non-technical people.

Parameters
$value : mixed
Return values
string

formatValue()

Returns a string representation of the value.

protected formatValue(mixed $value[, int $format = 0 ]) : string

This method returns the equivalent PHP tokens for most scalar types (i.e. "false" for false, "1" for 1 etc.). Strings are always wrapped in double quotes ("). Objects, arrays and resources are formatted as "object", "array" and "resource". If the $format bitmask contains the PRETTY_DATE bit, then objects will be formatted with the . If it is not available, they will be formatted as RFC-3339 dates ("Y-m-d H:i:s").

Be careful when passing message parameters to a constraint violation that (may) contain objects, arrays or resources. These parameters should only be displayed for technical users. Non-technical users won't know what an "object", "array" or "resource" is and will be confused by the violation message.

Parameters
$value : mixed
$format : int = 0

A bitwise combination of the format constants in this class

Return values
string

formatValues()

Returns a string representation of a list of values.

protected formatValues(array<string|int, mixed> $values[, int $format = 0 ]) : string

Each of the values is converted to a string using . The values are then concatenated with commas.

Parameters
$values : array<string|int, mixed>

A list of values

$format : int = 0

A bitwise combination of the format constants in this class

Tags
see
formatValue()
Return values
string

getConstraintsInGroups()

private static getConstraintsInGroups(array<string|int, mixed> $constraints, string|array<string|int, mixed> $group) : array<string|int, mixed>
Parameters
$constraints : array<string|int, mixed>
$group : string|array<string|int, mixed>
Return values
array<string|int, mixed>

resolveValidationGroups()

Post-processes the validation groups option for a given form.

private static resolveValidationGroups(string|GroupSequence|array<string|int, string|GroupSequence>|callable $groups, FormInterface $form) : GroupSequence|array<string|int, string|GroupSequence>
Parameters
$groups : string|GroupSequence|array<string|int, string|GroupSequence>|callable

The validation groups

$form : FormInterface
Return values
GroupSequence|array<string|int, string|GroupSequence> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results