1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. Url
WARNING: You are browsing the documentation for Symfony 2.3 which is not maintained anymore. Consider upgrading your projects to Symfony 4.1.

Url

2.3 version
Maintained
2.8 3.4 4.0 4.1 current 4.2 master
Unmaintained
2.0 2.1 2.2 2.4 2.5 2.6 2.7 3.0 3.1 3.2 3.3

Url

Validates that a value is a valid URL string.

Applies to property or method
Options
Class Url
Validator 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 http://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\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('bioUrl', new Assert\Url());
    }
}

Options

message

type: string default: This value is not a valid URL.

This message is shown if the URL is invalid.

  • 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 http://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\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('bioUrl', new Assert\Url(array(
            'message' => 'The url "{{ value }}" is not a valid url.',
        )));
    }
}

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
     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 http://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\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('bioUrl', new Assert\Url(array(
            'protocols' => array('http', 'https', 'ftp'),
        )));
    }
}

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.