You are browsing the documentation for Symfony 3.4 which is not maintained anymore.
Consider upgrading your projects to Symfony 5.2.
URL
URL¶
Validates that a value is a valid URL string.
Applies to | property or method |
Options | |
Class | Symfony\Component\Validator\Constraints\Url |
Validator | Symfony\Component\Validator\Constraints\UrlValidator |
Basic Usage¶
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12
// src/AppBundle/Entity/Author.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Author { /** * @Assert\Url */ protected $bioUrl; }
- YAML
1 2 3 4 5
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Author: properties: bioUrl: - Url: ~
- XML
1 2 3 4 5 6 7 8 9 10 11 12
<!-- src/AppBundle/Resources/config/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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd"> <class name="AppBundle\Entity\Author"> <property name="bioUrl"> <constraint name="Url"/> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13
// src/AppBundle/Entity/Author.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; use Symfony\Component\Validator\Mapping\ClassMetadata; 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¶
groups
¶
type: array
| string
It defines the validation group or groups this constraint belongs to. Read more about validation groups.
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 |
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/AppBundle/Entity/Author.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Author { /** * @Assert\Url( * message = "The url '{{ value }}' is not a valid url", * ) */ protected $bioUrl; }
- YAML
1 2 3 4 5 6
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Author: properties: bioUrl: - Url: message: The url "{{ value }}" is not a valid url.
- XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<!-- src/AppBundle/Resources/config/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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd"> <class name="AppBundle\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>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// src/AppBundle/Entity/Author.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; use Symfony\Component\Validator\Mapping\ClassMetadata; 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
.
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/AppBundle/Entity/Author.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Author { /** * @Assert\Url( * protocols = {"http", "https", "ftp"} * ) */ protected $bioUrl; }
- YAML
1 2 3 4 5
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Author: properties: bioUrl: - Url: { protocols: [http, https, ftp] }
- XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
<!-- src/AppBundle/Resources/config/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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd"> <class name="AppBundle\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>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// src/AppBundle/Entity/Author.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; use Symfony\Component\Validator\Mapping\ClassMetadata; 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
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
Symfony\Component\Validator\Constraints\Url
class:
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/AppBundle/Entity/Author.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Author { /** * @Assert\Url( * checkDNS = "ANY" * ) */ protected $bioUrl; }
- YAML
1 2 3 4 5
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Author: properties: bioUrl: - Url: { checkDNS: 'ANY' }
- XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<!-- src/AppBundle/Resources/config/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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd"> <class name="AppBundle\Entity\Author"> <property name="bioUrl"> <constraint name="Url"> <option name="checkDNS">ANY</option> </constraint> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// src/AppBundle/Entity/Author.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; use Symfony\Component\Validator\Mapping\ClassMetadata; 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.
This message is shown when the checkDNS
option is set to true
and the
DNS check failed.
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/AppBundle/Entity/Author.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Author { /** * @Assert\Url( * dnsMessage = "The host '{{ value }}' could not be resolved." * ) */ protected $bioUrl; }
- YAML
1 2 3 4 5
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Author: properties: bioUrl: - Url: { dnsMessage: 'The host "{{ value }}" could not be resolved.' }
- XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<!-- src/AppBundle/Resources/config/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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd"> <class name="AppBundle\Entity\Author"> <property name="bioUrl"> <constraint name="Url"> <option name="dnsMessage">The host "{{ value }}" could not be resolved.</option> </constraint> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// src/AppBundle/Entity/Author.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; use Symfony\Component\Validator\Mapping\ClassMetadata; class Author { public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addPropertyConstraint('bioUrl', new Assert\Url([ 'dnsMessage' => 'The host "{{ value }}" could not be resolved.', ])); } }
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.