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

Already on GitHub? Sign in to your account

Method annotations of Zend\Validator\Hostname constructor #4303

Merged
merged 2 commits into from Apr 29, 2013

Conversation

Projects
None yet
4 participants
Member

localheinz commented Apr 24, 2013

Method annotations of Zend\Validator\Hostname constructor are out of sync.

Contributor

micheh commented Apr 24, 2013

The annotations may not be out of sync, as the constructor is overloaded and can be called with the indicated parameters.

Contributor

prolic commented Apr 27, 2013

agree with @micheh

Member

localheinz commented Apr 28, 2013

Then at least the names of the parameters should reflect the keys of the options array to make it more obvious what the parameters are intended for.

Updating the PR in a minute.

Update annotations
- Revert changes applied with 3389ae3
- Update names of parameters to reflect keys used in option array
- Use int instead of integer for type

@localheinz localheinz commented on the diff Apr 28, 2013

library/Zend/Validator/Hostname.php
*
- * @param integer $allow OPTIONAL Set what types of hostname to allow (default ALLOW_DNS)
- * @param bool $validateIdn OPTIONAL Set whether IDN domains are validated (default true)
- * @param bool $validateTld OPTIONAL Set whether the TLD element of a hostname is validated (default true)
- * @param Ip $ipValidator OPTIONAL
+ * @param int $allow OPTIONAL Set what types of hostname to allow (default ALLOW_DNS)
+ * @param bool $useIdnCheck OPTIONAL Set whether IDN domains are validated (default true)
+ * @param bool $useTldCheck Set whether the TLD element of a hostname is validated (default true)
+ * @param Ip $ipValidator OPTIONAL
@localheinz

localheinz Apr 28, 2013

Member

Fixed the alignment of annotations along the way.

@ghost ghost assigned weierophinney Apr 29, 2013

weierophinney added a commit that referenced this pull request Apr 29, 2013

Merge pull request #4303 from localheinz/hotfix/method-annotations
Method annotations of Zend\Validator\Hostname constructor

Conflicts:
	library/Zend/Validator/Hostname.php

weierophinney added a commit that referenced this pull request Apr 29, 2013

@weierophinney weierophinney merged commit 498efa4 into zendframework:develop Apr 29, 2013

1 check passed

default The Travis build passed
Details

weierophinney added a commit to zendframework/zend-validator that referenced this pull request May 15, 2015

Merge pull request zendframework/zendframework#4303 from localheinz/h…
…otfix/method-annotations

Method annotations of Zend\Validator\Hostname constructor

Conflicts:
	library/Zend/Validator/Hostname.php

weierophinney added a commit to zendframework/zend-validator that referenced this pull request May 15, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment