Warning: You are browsing the documentation for Symfony 2.7, which is no longer maintained.
Read the updated version of this page for Symfony 6.0 (the current stable version).
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 | Type |
| Validator | TypeValidator |
Basic Usage
This will check if firstName is of type string and that age is an
integer.
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
// src/AppBundle/Entity/Author.php
namespace AppBundle\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;
}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.
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.
payload
type: mixed default: null
New in version 2.6
The payload option was introduced in Symfony 2.6.
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.