Repository navigation
Predicate fluent methods accept identifier types their predicates reject #208
Description
Package Version
0.6.x-dev @ e022af5c
Php Version
8.3, 8.4, 8.5
Database Engine
Any
Basic Information
The fluent methods on Predicate\Predicate (and so on Where and Having) accept wider identifier types than the predicate classes they build. Each method passes its identifier straight to a constructor that rejects the extra types:
| Method | Identifier accepted | Constructor accepts |
|---|---|---|
between(), notBetween() (Predicate.php#L33) |
float|int|string|array|ArgumentInterface|null, plus array for min/max |
Between: string|ArgumentInterface|null (Between.php#L27) |
equalTo() and the other comparisons (Predicate.php#L50) |
float|int|string|ArgumentInterface|null |
Operator left: string|ArgumentInterface|ExpressionInterface|SqlInterface|null (Operator.php#L50) |
in(), notIn() (Predicate.php#L128) |
float|int|string|ArgumentInterface |
In: string|ArgumentInterface|null (In.php#L25) |
isNull(), isNotNull() (Predicate.php#L160) |
float|int|string|ArgumentInterface |
IsNull: string|ArgumentInterface|null (IsNull.php#L22) |
like(), notLike() (Predicate.php#L210) |
float|int|string|ArgumentInterface|null |
Like: string|ArgumentInterface|null (Like.php#L23) |
The leaf constructors were narrowed in #87 (review: "It could simply be string|Argument $identifier = null"); the fluent methods kept the wider types. docs/book/sql/where-having.md documents the wider signatures. It also states that $leftType/$rightType were removed and that a value on the left should be passed as an Argument instance.
Steps to Reproduce
(new Where())->isNull(5)(new Where())->equalTo(1, 2)(new Where())->between(['a'], 1, 2)(new Where())->in(5, [1])
Expected Behavior
Each fluent method accepts exactly what its predicate accepts, so an invalid call fails at the method the caller wrote. A numeric value on the left is passed as new Argument\Value(5), as the docs describe. The API listing in where-having.md should match.
Narrowing does not break working code, because every call it rejects already throws. A test comparing each method's parameter types with its predicate's constructor would stop them drifting apart again.
Actual behavior?
TypeError: PhpDb\Sql\Predicate\IsNull::__construct(): Argument #1 ($identifier) must be of type PhpDb\Sql\ArgumentInterface|string|null, int given
TypeError: PhpDb\Sql\Predicate\Operator::__construct(): Argument #1 ($left) must be of type PhpDb\Sql\ArgumentInterface|PhpDb\Sql\ExpressionInterface|PhpDb\Sql\SqlInterface|string|null, int given
TypeError: PhpDb\Sql\Predicate\Between::__construct(): Argument #1 ($identifier) must be of type PhpDb\Sql\ArgumentInterface|string|null, array given
TypeError: PhpDb\Sql\Predicate\In::__construct(): Argument #1 ($identifier) must be of type PhpDb\Sql\ArgumentInterface|string|null, int given
Additional Info
The unmerged 0.5.x-benchmarking branch restores $leftType/$rightType as a deprecated compatibility layer (75987ac). If that is ever ported, the left parameter would need to accept a numeric value again, alongside a type.
Activity