Documentation on DBAL\Driver\Statement::bindValue is incorrect
#4212
Conversation
This change updates the documentation on the `bindValue` function. Per the implementation this function can take a string, int, or type instance. Fixes doctrine#4210
| @@ -23,8 +23,8 @@ interface Statement extends ResultStatement | |||
| * this will be a parameter name of the form :name. For a prepared statement | |||
| * using question mark placeholders, this will be the 1-indexed position of the parameter. | |||
| * @param mixed $value The value to bind to the parameter. | |||
| * @param int $type Explicit data type for the parameter using the {@link ParameterType} | |||
| * constants. | |||
| * @param mixed $type Explicit data type for the parameter using the {@link ParameterType} | |||
There was a problem hiding this comment.
This change is invalid. All implementations of this interface must accept integers. A specific implementation (Doctrine\DBAL\Statement) accepts other types but they are not part of the interface.
There was a problem hiding this comment.
Thanks @morozov - is the documentation incorrect then on Doctrine\DBAL\Connection::prepare? FWIW changing the documentation on prepare to return a Doctrine\DBAL\Statement (and not a driver statement) fixes the issue for us.
There was a problem hiding this comment.
It looks like it's already fixed in 15d9be0 but not yet released.
There was a problem hiding this comment.
Are there plans to create a release in the near future?
There was a problem hiding this comment.
We're waiting for #3980 to be resolved in order to release 2.10.3, 2.11.0, and 3.0.0. We can release 2.10.3 earlier but there's no reason for that right now.
This change updates the documentation on the
bindValuefunction. Per the implementation ofDBAL\Statementthis function can take a string, int, orTypeinstance.Fixes #4210
Summary
This change updates the documentation on the
bindValueto fix problems with static analyzers. Since this doesn't appear to be a problem in 3.x versions of this library, I've only fixed the issue in 2.10.x.