8000 [Validator] Updated documentation of URL validator by saro0h · Pull Request #4631 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

[Va 8000 lidator] Updated documentation of URL validator #4631

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 1 commit into from
Closed

[Validator] Updated documentation of URL validator #4631

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
[Validator] Updated documentation of URL validator 
Updated the documentation regarding the Pull Request on Symfony : symfony/symfony#12956
  • Loading branch information
@saro0h
saro0h committed Dec 16, 2014
commit 4ef9034cd1a1a5ff1b084b8da8eca7f7cb11b7b5
33 changes: 30 additions & 3 deletions reference/constraints/Url.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Validates that a value is a valid URL string.
+----------------+---------------------------------------------------------------------+
| Options | - `message`_ |
| | - `protocols`_ |
| | _ `checkDNS`_ |
Copy link
Member

Choose a reason for hiding this comment

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

The underscore before "checkDNS" should be a dash.

+----------------+---------------------------------------------------------------------+
| Class | :class:`Symfony\\Component\\Validator\\Constraints\\Url` |
+----------------+---------------------------------------------------------------------+
Expand All @@ -26,6 +27,9 @@ Basic Usage
properties:
bioUrl:
- Url: ~
message: The url "{{ value }}" is not a valid url.
protocols: [http, https]
checkDNS: true
Copy link
Contributor

Choose a reason for hiding this comment

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

would prefer if we set this to false because this is the default value.


.. code-block:: php-annotations

Expand All @@ -37,7 +41,11 @@ Basic Usage
class Author
{
/**
* @Assert\Url()
* @Assert\Url(
* message = "The url '{{ value }}' is not a valid url",
* protocols = {"http", "https"}
* checkDNS = true
* )
*/
protected $bioUrl;
}
Expand All @@ -52,7 +60,14 @@ Basic Usage

<class name="Acme\BlogBundle\Entity\Author">
<property name="bioUrl">
<constraint name="Url" />
<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>
Expand All @@ -69,7 +84,11 @@ Basic Usage
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('bioUrl', new Assert\Url());
$metadata->addPropertyConstraint('bioUrl', new Assert\Url(array(
'message' => 'The url "{{ value }}" is not a valid url.',
'protocols' => array('http', 'https'),
'checkDNS' => true,
)));
}
}

Expand All @@ -91,3 +110,11 @@ protocols
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``.

checkDNS
~~~~~~~~

**type**: ``Boolean`` **default**: ``false``

If true, then the :phpfunction:`checkdnsrr` PHP function will be used to check
the validity of ANY record of the host of the given url.
0