Type
Type¶
Validates that a value is of a specific data type. For example, if a variable
should be an array, you can use this constraint with the array
type
option to validate this.
Applies to | property or method |
Options | |
Class | Symfony\Component\Validator\Constraints\Type |
Validator | Symfony\Component\Validator\Constraints\TypeValidator |
Basic Usage¶
This will check if firstName
is of type string
and that age
is an
integer
.
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
// src/Entity/Author.php namespace App\Entity; use Symfony\Component\Validator\Constraints as Assert; class Author { /** * @Assert\Type("string") */ protected $firstName; /** * @Assert\Type( * type="integer", * message="The value {{ value }} is not a valid {{ type }}." * ) */ protected $age; }
- YAML
1 2 3 4 5 6 7 8 9 10
# config/validator/validation.yaml App\Entity\Author: properties: firstName: - Type: string age: - Type: type: integer message: The value {{ value }} is not a valid {{ type }}.
- XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
<!-- config/validator/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="App\Entity\Author"> <property name="firstName"> <constraint name="Type"> <option name="type">string</option> </constraint> </property> <property name="age"> <constraint name="Type"> <option name="type">integer</option> <option name="message">The value {{ value }} is not a valid {{ type }}.</option> </constraint> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
// src/Entity/Author.php namespace App\Entity; use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Component\Validator\Constraints as Assert; class Author { public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addPropertyConstraint('firstName', new Assert\Type('string')); $metadata->addPropertyConstraint('age', new Assert\Type([ 'type' => 'integer', 'message' => 'The value {{ value }} is not a valid {{ type }}.', ])); } }
Options¶
type¶
type: string
[default option]
This required option is the fully qualified class name or one of the PHP
datatypes as determined by PHP’s is_()
functions.
array
bool
callable
float
double
int
integer
iterable
long
null
numeric
object
real
resource
scalar
string
Also, you can use ctype_()
functions from corresponding
built-in PHP extension. Consider a list of ctype functions:
Make sure that the proper locale
is set before
using one of these.
message¶
type: string
default: This value should be of type {{ type }}.
The message if the underlying data is not of the given type.
You can use the following parameters in this message:
Parameter | Description |
---|---|
{{ value }} |
The current (invalid) value |
{{ type }} |
The expected type |
payload¶
type: mixed
default: null
This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.
For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.