Skip to content

[Validator] 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.

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

Conversation

saro0h
Copy link
Contributor

@saro0h saro0h commented Dec 11, 2014

Q A
Doc fix? yes
New docs? no
Applies to 2.7
Fixed tickets ~

Updated the documentation regarding the Pull Request on Symfony : symfony/symfony#12956

@timglabisch
Copy link
Contributor

👍 for checkDNS,
not sure how to handle the examples. #4632 (comment)

@@ -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.

This line is missing the final pipe character.

@xabbuh
Copy link
Member

xabbuh commented Dec 12, 2014

And I also would not use the option in the first examples, but explain it in its own section (that you already added) instead.


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

If true, then the checkdnsrr PHP function will be used to check the validity
Copy link
Member

Choose a reason for hiding this comment

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

you can do :phpfunction:checkdnsrr`` to link to the php.net page.

Updated the documentation regarding the Pull Request on Symfony : symfony/symfony#12956
@@ -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.

@xabbuh xabbuh added the On hold label Jan 2, 2015
@javiereguiluz
Copy link
Member

I agree with @xabbuh: the first examples should not use the checkDNS option because its use case is too specific. Then you can explain it thoroughly in its own section.

fabpot added a commit to symfony/symfony that referenced this pull request Jan 4, 2015
…r (saro0h)

This PR was merged into the 2.7 branch.

Discussion
----------

[2.7][Validator] Added checkDNS option on URL validator

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #10088
| License       | MIT
| Doc PR        | symfony/symfony-docs#4631

Commits
-------

ad2f906 [Validator] Added a check DNS option on URL validator
fabpot added a commit to symfony/validator that referenced this pull request Jan 4, 2015
…r (saro0h)

This PR was merged into the 2.7 branch.

Discussion
----------

[2.7][Validator] Added checkDNS option on URL validator

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #10088
| License       | MIT
| Doc PR        | symfony/symfony-docs#4631

Commits
-------

ad2f906 [Validator] Added a check DNS option on URL validator
@xabbuh xabbuh removed the On hold label Jan 4, 2015
@xabbuh
Copy link
Member

xabbuh commented Jan 4, 2015

I wish you a happy new year @saro0h. Can you update here given that the code pull request was merged?

@@ -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.

@xabbuh
Copy link
Member

xabbuh commented Mar 8, 2015

@saro0h Can you update your pull request?

fago pushed a commit to fago/Validator that referenced this pull request Apr 18, 2015
…r (saro0h)

This PR was merged into the 2.7 branch.

Discussion
----------

[2.7][Validator] Added checkDNS option on URL validator

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #10088
| License       | MIT
| Doc PR        | symfony/symfony-docs#4631

Commits
-------

ad2f906 [Validator] Added a check DNS option on URL validator
@wouterj
Copy link
Member

wouterj commented May 21, 2015

Hi @saro0h! Upcoming Saturday, we'll be hosting a doc sprint day. We would like to finish as much PRs as possible during/before that day. Maybe you can join or, if you agree, we can put it on a list so others can work on it.

@javiereguiluz
Copy link
Member

I'm finishing this PR in #5426.

@saro0h thanks for starting this pull request. In the new PR I've reused your commits to not lose the attribution of your work. Thanks!

@xabbuh
Copy link
Member

xabbuh commented Jun 23, 2015

Thank you for starting this @saro0h! Closing in favor of #5426.

@xabbuh xabbuh closed this Jun 23, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants