Url
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).
Url
Validates that a value is a valid URL string.
| Applies to | property or method |
| Options | |
| Class | Url |
| Validator | UrlValidator |
Basic Usage
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12
// src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\Url()
*/
protected $bioUrl;
}Options
message
type: string default: This value is not a valid URL.
This message is shown if the URL is invalid.
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\Url(
* message = "The url '{{ value }}' is not a valid url",
* )
*/
protected $bioUrl;
}protocols
type: array default: array('http', 'https')
The protocols considered to be valid for the URL. For example, if you also consider
the ftp:// type URLs to be valid, redefine the protocols array, listing
http, https, and also ftp.
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\Url(
* protocols = {"http", "https", "ftp"}
* )
*/
protected $bioUrl;
}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.
