Skip to content

Documented the checkDNS option of the Url validator #5426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

Documented the checkDNS option of the Url validator #5426

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
75da2f3
[Validator] Updated documentation of URL validator
saro0h Dec 11, 2014
bb3dd4e
Simplified the first example and added more examples
javiereguiluz Jun 23, 2015
1d3b192
Boolean -> boolean
javiereguiluz Jun 24, 2015
a2fd9ef
Fixed the order of the examples
javiereguiluz Jun 24, 2015
5bcd48d
Added the "payload" option back (was removed by mistake)
javiereguiluz Jun 24, 2015
a04b4ac
Fixed some errors and made some simplifications
javiereguiluz Jun 26, 2015
2becf60
Reordered the configuration blocks of the first example
javiereguiluz Jun 26, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
239 changes: 228 additions & 11 deletions reference/constraints/Url.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Validates that a value is a valid URL string.
| Options | - `message`_ |
| | - `protocols`_ |
| | - `payload`_ |
| | - `checkDNS`_ |
+----------------+---------------------------------------------------------------------+
| Class | :class:`Symfony\\Component\\Validator\\Constraints\\Url` |
+----------------+---------------------------------------------------------------------+
Expand All @@ -20,6 +21,14 @@ Basic Usage

.. configuration-block::

.. code-block:: yaml

# src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
properties:
bioUrl:
- Url: ~

.. code-block:: php-annotations

// src/Acme/BlogBundle/Entity/Author.php
Expand All @@ -35,14 +44,6 @@ Basic Usage
protected $bioUrl;
}

.. code-block:: yaml

# src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
properties:
bioUrl:
- Url: ~

.. code-block:: xml

<!-- src/Acme/BlogBundle/Resources/config/validation.xml -->
Expand Down Expand Up @@ -84,13 +85,229 @@ message

This message is shown if the URL is invalid.

.. configuration-block::

.. code-block:: php-annotations

// 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;
}

.. code-block:: yaml

# src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
properties:
bioUrl:
- Url: ~
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...and here :)

message: The url "{{ value }}" is not a valid url.

.. code-block:: xml

<!-- src/Acme/BlogBundle/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="Acme\BlogBundle\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>

.. code-block:: php

// src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\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 that will be considered to be valid. For example, if you also
needed ``ftp://`` type URLs to be valid, you'd redefine the ``protocols``
array, listing ``http``, ``https`` and also ``ftp``.
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``.

.. configuration-block::

.. code-block:: php-annotations

// 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;
}

.. code-block:: yaml

# src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
properties:
bioUrl:
- Url: ~
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here (and I prefer - Url: { protocols: [http, https, ftp] })

protocols: [http, https, ftp]

.. code-block:: xml

<!-- src/Acme/BlogBundle/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="Acme\BlogBundle\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>

.. code-block:: php

// src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\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'),
)));
}
}

.. include:: /reference/constraints/_payload-option.rst.inc

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 ``true``:

.. configuration-block::

.. code-block:: php-annotations

// 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",
* protocols = {"http", "https"}
* checkDNS = true
* )
*/
protected $bioUrl;
}

.. code-block:: yaml

# src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
properties:
bioUrl:
- Url: ~
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the ~ is wrong (as the options are defined below)

message: The url "{{ value }}" is not a valid url.
protocols: [http, https]
checkDNS: true

.. code-block:: xml

<!-- src/Acme/BlogBundle/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="Acme\BlogBundle\Entity\Author">
<property name="bioUrl">
<constraint name="Url">
<option name="message">The url "{{ value }}" is not a valid url.</option>
<option name="protocols">
<value>http</value>
<value>https</value>
</option>
<option name="checkDNS">true</option>
</constraint>
</property>
</class>
</constraint-mapping>

.. code-block:: php

// src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\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' => array('http', 'https'),
'checkDNS' => true,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please align =>

)));
}
}

This option uses the :phpfunction:`checkdnsrr` PHP function to check the validity
of the ``ANY`` DNS record corresponding to the host associated with the given URL.