Update phpdoc on Table::findOneBy(...) to include false in @return #143
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
alquerci
approved these changes
Jul 18, 2024
thePanz
reviewed
Jul 19, 2024
| @@ -1725,7 +1725,7 @@ public function findBy($fieldName, $value, $hydrationMode = null) | |||
| * @param string $column field for the WHERE clause | |||
| * @param string|array $value prepared statement parameter | |||
| * @param int $hydrationMode Doctrine_Core::HYDRATE_ARRAY or Doctrine_Core::HYDRATE_RECORD | |||
| * @return Doctrine_Record | |||
| * @return Doctrine_Record|false | |||
There was a problem hiding this comment.
According to Query::fetchOne() the return could be array|Doctrine_Record|false: those whould be added too, wdyt?
At the same time, the implementation of Query::fetchOne() has:
if (is_scalar($collection)) {
return $collection;
}Which then, could return a scalar too int|bool|float
change phpdoc on Table::findOneBy() to include 'false' If the fields specified do not match a row in the database, the underlying call on Doctrine_Query::fetchOne() will return false, so this method should as well.
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.
change phpdoc on Table::findOneBy() to include 'false'
If the fields specified do not match a row in the database, the underlying call on Doctrine_Query::fetchOne() will return false, so this method should as well.