Url
Edit this pageWarning: You are browsing the documentation for Symfony 4.1, which is no longer maintained.
Read the updated version of this page for Symfony 6.3 (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
1 2 3 4 5 6 7 8 9 10 11 12
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\Url
*/
protected $bioUrl;
}
1 2 3 4 5
# config/validator/validation.yaml
App\Entity\Author:
properties:
bioUrl:
- Url: ~
1 2 3 4 5 6 7 8 9 10 11 12
<!-- 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="bioUrl">
<constraint name="Url" />
</property>
</class>
</constraint-mapping>
1 2 3 4 5 6 7 8 9 10 11 12 13
// 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('bioUrl', new Assert\Url());
}
}
Note
As with most of the other constraints, null
and empty strings are
considered valid values. This is to allow them to be optional values.
If the value is mandatory, a common solution is to combine this constraint
with NotBlank.
Options
message
type: string
default: This value is not a valid URL.
This message is shown if the URL is invalid.
You can use the following parameters in this message:
Parameter | Description |
---|---|
{{ value }} |
The current (invalid) value |
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\Url(
* message = "The url '{{ value }}' is not a valid url",
* )
*/
protected $bioUrl;
}
1 2 3 4 5 6
# config/validator/validation.yaml
App\Entity\Author:
properties:
bioUrl:
- Url:
message: The url "{{ value }}" is not a valid url.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<!-- 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="bioUrl">
<constraint name="Url">
<option name="message">The url "{{ value }}" is not a valid url.</option>
</constraint>
</property>
</class>
</constraint-mapping>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// 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('bioUrl', new Assert\Url([
'message' => 'The url "{{ value }}" is not a valid url.',
]));
}
}
protocols
type: array
default: ['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
.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\Url(
* protocols = {"http", "https", "ftp"}
* )
*/
protected $bioUrl;
}
1 2 3 4 5
# config/validator/validation.yaml
App\Entity\Author:
properties:
bioUrl:
- Url: { protocols: [http, https, ftp] }
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
<!-- 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="bioUrl">
<constraint name="Url">
<option name="protocols">
<value>http</value>
<value>https</value>
<value>ftp</value>
</option>
</constraint>
</property>
</class>
</constraint-mapping>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// 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('bioUrl', new Assert\Url([
'protocols' => ['http', 'https', 'ftp'],
]));
}
}
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.
checkDNS
type: boolean
default: false
4.1
This option was deprecated in Symfony 4.1 and will be removed in Symfony 5.0, because checking the DNS records is not reliable enough to validate the existence of the host. Use the checkdnsrr PHP function if you still want to use this kind of validation.
By default, this constraint just validates the syntax of the given URL. If you
also need to check whether the associated host exists, set the checkDNS
option to the value of any of the CHECK_DNS_TYPE_*
constants in the
Url class:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\Url(
* checkDNS = "ANY"
* )
*/
protected $bioUrl;
}
1 2 3 4 5
# config/validator/validation.yaml
App\Entity\Author:
properties:
bioUrl:
- Url: { checkDNS: 'ANY' }
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<!-- 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="bioUrl">
<constraint name="Url">
<option name="checkDNS">ANY</option>
</constraint>
</property>
</class>
</constraint-mapping>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// 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('bioUrl', new Assert\Url([
'checkDNS' => Assert\Url::CHECK_DNS_TYPE_ANY,
]));
}
}
This option uses the checkdnsrr PHP function to check the validity of the DNS record corresponding to the host associated with the given URL.
dnsMessage
type: string
default: The host could not be resolved.
4.1
This option was deprecated in Symfony 4.1 and will be removed in Symfony 5.0, because checking the DNS records is not reliable enough to validate the existence of the host. Use the checkdnsrr PHP function if you still want to use this kind of validation.
This message is shown when the checkDNS
option is set to true
and the
DNS check failed.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\Url(
* dnsMessage = "The host '{{ value }}' could not be resolved."
* )
*/
protected $bioUrl;
}
1 2 3 4 5
# config/validator/validation.yaml
App\Entity\Author:
properties:
bioUrl:
- Url: { dnsMessage: 'The host "{{ value }}" could not be resolved.' }
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<!-- 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="bioUrl">
<constraint name="Url">
<option name="dnsMessage">The host "{{ value }}" could not be resolved.</option>
</constraint>
</property>
</class>
</constraint-mapping>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// 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('bioUrl', new Assert\Url([
'dnsMessage' => 'The host "{{ value }}" could not be resolved.',
]));
}
}
relativeProtocol
type: boolean
default: false
4.1
The relativeProtocol
option was introduced in Symfony 4.1.
If true
, the protocol is considered optional when validating the syntax of
the given URL. This means that both http://
and https://
are valid but
also relative URLs that contain no protocol (e.g. //example.com
).
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\Url(
* relativeProtocol = true
* )
*/
protected $bioUrl;
}
1 2 3 4 5
# config/validator/validation.yaml
App\Entity\Author:
properties:
bioUrl:
- Url: { relativeProtocol: true }
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<!-- 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="bioUrl">
<constraint name="Url">
<option name="relativeProtocol">true</option>
</constraint>
</property>
</class>
</constraint-mapping>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// 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('bioUrl', new Assert\Url([
'relativeProtocol' => true,
]));
}
}