Country
Edit this pageWarning: You are browsing the documentation for Symfony 2.6, which is no longer maintained.
Read the updated version of this page for Symfony 6.1 (the current stable version).
Country
Validates that a value is a valid ISO 3166-1 alpha-2 country code.
| Applies to | property or method |
| Options | |
| Class | Country |
| Validator | CountryValidator |
Basic Usage
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12
// src/Acme/UserBundle/Entity/User.php
namespace Acme\UserBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class User
{
/**
* @Assert\Country()
*/
protected $country;
}Options
message
type: string default: This value is not a valid country.
This message is shown if the string is not a valid country code.
payload
type: mixed default: null
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.
