Skip to content
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

phpdoc return type for ServerRequestInterface::getUploadedFiles() #85

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

XAKEPEHOK
Copy link

For better IDE autocompletion I suggest replace return type for ServerRequestInterface::getUploadedFiles() from simple array to UploadedFileInterface[]

For better IDE autocompletion I suggest replace return type for `ServerRequestInterface::getUploadedFiles()` from simple `array` to `UploadedFileInterface[]`
@jvasseur
Copy link

jvasseur commented Oct 4, 2019

This is wrong, UploadedFileInterface[] means an array of UploadedFileInterface and getUploadedFiles can return nested arrays (which can't be represented with PHPDoc because it would need a recursive type).

@@ -131,7 +131,7 @@ public function withQueryParams(array $query);
* These values MAY be prepared from $_FILES or the message body during
* instantiation, or MAY be injected via withUploadedFiles().
*
* @return array An array tree of UploadedFileInterface instances; an empty
* @return UploadedFileInterface[] An array tree of UploadedFileInterface instances; an empty

Choose a reason for hiding this comment

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

wrong type:

an empty array MUST be returned if no data is present.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants