Update PhpDoc comment #4518

Closed
wants to merge 2 commits into
from

2 participants

@localheinz
Zend Framework member

Whilst looking at the code of Filter\Upload and Filter\UploadFile to see what they are about, PhpStorm complained.

@micheh micheh and 2 others commented on an outdated diff May 22, 2013
library/Zend/Validator/File/Upload.php
@@ -213,7 +213,7 @@ public function isValid($value, $file = null)
*
* @param string $file
* @param string $errorType
- * @return false
+ * @return bool
@micheh
micheh added a line comment May 22, 2013

false is a valid phpDoc return type (see the phpDocumentor manual). bool would be misleading, as the method will never return true.

@localheinz
Zend Framework member
localheinz added a line comment May 22, 2013

While bool is more generic, it is accurate enough, though.

@weierophinney
Zend Framework member
weierophinney added a line comment May 22, 2013

It's not "accurate enough", though. It doesn't return either boolean, only false.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@weierophinney weierophinney added a commit that referenced this pull request May 23, 2013
@weierophinney weierophinney Merge branch 'hotfix/4518' into develop
Forward port #4518
e20aab2
@weierophinney weierophinney added a commit that closed this pull request May 23, 2013
@weierophinney weierophinney Merge branch 'hotfix/4518'
Close #4518
84cded7
@ghost Unknown pushed a commit that referenced this pull request Jul 14, 2013
@weierophinney weierophinney Merge branch 'hotfix/4518'
Close #4518
395987c
@weierophinney weierophinney added a commit to zendframework/zend-validator that referenced this pull request May 15, 2015
@weierophinney weierophinney Merge pull request zendframework/zendframework#4518 from localheinz/h…
…otfix/update-php-doc-comment

Update PhpDoc comment
6d6acc0
@weierophinney weierophinney added a commit to zendframework/zend-validator that referenced this pull request May 15, 2015
@weierophinney weierophinney Merge branch 'hotfix/4518' 07613c3
@weierophinney weierophinney added a commit to zendframework/zend-validator that referenced this pull request May 15, 2015
@weierophinney weierophinney Merge branch 'hotfix/4518' into develop 2ce1627
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment