add @throws declarations to docs in Connection #2810
Merged
Conversation
This file contains 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
In a few cases methods in Connection may throw a DBALException which isn't declared in the docblock. As the Connection class is heavily used by third party code, this code runs the risk of ignoring those exceptions instead of handling them. While it is technically not required to declare exceptions in PHP, it is highly recommended, especially in public APIs.
|
To be honest I don't really understand the failure condition this patch is meeting in scrutinizer. Is a changed doc comment a failure condition? |
|
Oh, never mind. I see. There are other unrelated errors in doc comments. My patch doesn't fix those - as it shouldn't - which leads to the error in scrutinizer. |
Ocramius
suggested changes
Aug 3, 2017
lib/Doctrine/DBAL/Connection.php
Outdated
| @@ -410,6 +412,8 @@ private function detectDatabasePlatform() | |||
| * version without having to query it (performance reasons). | |||
| * | |||
| * @return string|null | |||
| * | |||
| * @throws \Exception | |||
|
@bestform thanks! |
|
anytime. Thanks for the merge. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
In a few cases methods in Connection may throw a DBALException which
isn't declared in the docblock. As the Connection class is heavily
used by third party code, this code runs the risk of ignoring
those exceptions instead of handling them. While it is
technically not required to declare exceptions in PHP, it is highly
recommended, especially in public APIs.
Fixes #2809