Fix some return type annotations #33007
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
derrabus
commented
Aug 7, 2019
| @@ -179,8 +179,6 @@ protected function describeContainerParameter($parameter, array $options = []) | |||
|
|
|||
| /** | |||
| * Writes data as json. | |||
| * | |||
| * @return array|string | |||
There was a problem hiding this comment.
💡 This method does not return anything.
derrabus
commented
Aug 7, 2019
| @@ -334,7 +334,7 @@ public function addNode(\DOMNode $node) | |||
| * | |||
| * @param int $position The position | |||
| * | |||
| * @return self | |||
| * @return static | |||
There was a problem hiding this comment.
💡 Most methods in this class return the result of createSubCrawler() which is already (correctly) annotated with @return static.
derrabus
commented
Aug 7, 2019
eab81e2 to
d531326
Compare
|
I can ignore the fabbot.io error, I assume. 😎 |
xabbuh
approved these changes
Aug 7, 2019
d531326 to
0a78dc0
Compare
derrabus
commented
Aug 7, 2019
| */ | ||
| private function load($key) | ||
| { | ||
| $path = $this->getPath($key); | ||
|
|
||
| return file_exists($path) ? file_get_contents($path) : false; | ||
| return file_exists($path) ? file_get_contents($path) : null; |
There was a problem hiding this comment.
As suggested by @Tobion in #32993 (comment)
There was a problem hiding this comment.
file_get_contents can also return false that we should cast to null. this will otherwise break the type hints later
There was a problem hiding this comment.
Are we talking about the file behind $path being deleted between the file_exists() and the file_get_contents() call or are there other reasons why file_get_contents could return false in this case?
There was a problem hiding this comment.
permissions, race conditions and more probably
There was a problem hiding this comment.
So, something like that?
return file_exists($path) && false !== $contents = file_get_contents($path) ? $contents : null;|
Thank you @derrabus. |
nicolas-grekas
added a commit
that referenced
this pull request
Aug 7, 2019
This PR was merged into the 3.4 branch. Discussion ---------- Fix some return type annotations | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | N/A | License | MIT | Doc PR | N/A This PR fixed some incorrect return type declarations I discovered while working on #32993. Commits ------- 0a78dc0 Fix some return type annotations.
nicolas-grekas
added a commit
that referenced
this pull request
Aug 8, 2019
… conditions (derrabus) This PR was merged into the 3.4 branch. Discussion ---------- [HttpKernel] Resilience against file_get_contents() race conditions | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | N/A | License | MIT | Doc PR | N/A This PR addresses #33007 (comment). Commits ------- 5892837 Resilience against file_get_contents() race conditions.
symfony-splitter
pushed a commit
to symfony/http-kernel
that referenced
this pull request
Aug 8, 2019
… conditions (derrabus) This PR was merged into the 3.4 branch. Discussion ---------- [HttpKernel] Resilience against file_get_contents() race conditions | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | N/A | License | MIT | Doc PR | N/A This PR addresses symfony/symfony#33007 (comment). Commits ------- 5892837 Resilience against file_get_contents() race conditions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixed some incorrect return type declarations I discovered while working on #32993.