Skip to content

Fix the ResultSet iterator contract and stop discarding object rows #200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
simon-mundy wants to merge 3 commits into from
Closed

Fix the ResultSet iterator contract and stop discarding object rows #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
92ce629
Bring ResultSet down to twenty baselined findings
simon-mundy Sep 29, 2026
9aa802b
Return object rows rather than discarding them
simon-mundy Sep 29, 2026
b748bd6
Cover the paths this branch introduced
simon-mundy Sep 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
266 changes: 19 additions & 247 deletions analyzer-baseline.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,18 @@ code = "incompatible-return-type"
message = 'Return type `mixed` of `PhpDb\Adapter\Driver\Pdo\Result::next()` is incompatible with parent return type `void` of `Iterator::next()`'
count = 1

[[issues]]
file = "src/Adapter/Driver/Pdo/Result.php"
code = "less-specific-nested-argument-type"
message = 'Argument type mismatch for argument #1 of `PhpDb\ResultSet\AbstractResultSet::initialize`: expected `iterable<array-key, mixed>`, but provided type `$this(PhpDb\Adapter\Driver\Pdo\Result)` is less specific.'
count = 1

[[issues]]
file = "src/Adapter/Driver/Pdo/Result.php"
code = "less-specific-nested-argument-type"
message = 'Argument type mismatch for argument #1 of `PhpDb\ResultSet\ResultSetInterface::initialize`: expected `iterable<array-key, mixed>`, but provided type `$this(PhpDb\Adapter\Driver\Pdo\Result)` is less specific.'
count = 1

[[issues]]
file = "src/Adapter/Driver/Pdo/Result.php"
code = "missing-constant-type"
Expand Down Expand Up @@ -1500,12 +1512,6 @@ code = "missing-constant-type"
message = "Class constant `DEFAULT_SCHEMA` is missing a type hint."
count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "imprecise-type"
message = "Type `array` in property `$buffer` is imprecise, equivalent to `array<array-key, mixed>`."
count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "imprecise-type"
Expand All @@ -1514,20 +1520,8 @@ count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "imprecise-type"
message = "Type `iterable` in parameter `$dataSource` is imprecise, equivalent to `iterable<mixed, mixed>`."
count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "incompatible-return-type"
message = 'Return type `int|null` of `PhpDb\ResultSet\AbstractResultSet::count()` is incompatible with parent return type `int` of `Countable::count()`'
count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "invalid-property-assignment-value"
message = 'Invalid type for property `$dataSource`: expected `Iterator<mixed, mixed>|IteratorAggregate<mixed, mixed>|PhpDb\Adapter\Driver\ResultInterface|null`, but got `iterable<mixed, mixed>`.'
code = "invalid-return-statement"
message = 'Invalid return type for function `PhpDb\ResultSet\AbstractResultSet::resolveIterator`: expected `Iterator<mixed, mixed>`, but found `DOMNodeList<mixed, mixed>|DatePeriod<mixed, mixed>|Ds\Collection<mixed, mixed>|Generator<mixed, mixed, mixed, mixed>|Iterator<mixed, mixed>|PDOStatement<mixed, mixed>`.'
count = 1

[[issues]]
Expand All @@ -1536,18 +1530,6 @@ code = "invalid-type-cast"
message = "Casting `mixed` to `array`."
count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "missing-api-or-internal"
message = 'Abstract class `PhpDb\ResultSet\AbstractResultSet` is missing an `@api` or `@internal` annotation.'
count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "mixed-argument"
message = "Invalid argument type for argument #1 of `count`: expected `Countable|array<array-key, mixed>`, but found `mixed`."
count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "mixed-assignment"
Expand All @@ -1556,110 +1538,20 @@ count = 3

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "mixed-return-statement"
message = 'Could not infer a precise return type for function `PhpDb\ResultSet\AbstractResultSet::current`. Saw type `mixed`.'
code = "mixed-property-type-coercion"
message = "A value with a less specific type `mixed` is being assigned to property `$fieldCount` (int|null)."
count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "mixed-return-statement"
message = 'Could not infer a precise return type for function `PhpDb\ResultSet\AbstractResultSet::current`. Saw type `nonnull`.'
message = 'Could not infer a precise return type for function `PhpDb\ResultSet\AbstractResultSet::current`. Saw type `mixed`.'
count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "mixed-return-statement"
message = 'Could not infer a precise return type for function `PhpDb\ResultSet\AbstractResultSet::valid`. Saw type `mixed`.'
count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "non-existent-method"
message = "Method `current` does not exist on type `IteratorAggregate`."
count = 3

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "non-existent-method"
message = "Method `key` does not exist on type `IteratorAggregate`."
count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "non-existent-method"
message = "Method `next` does not exist on type `IteratorAggregate`."
count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "non-existent-method"
message = "Method `rewind` does not exist on type `IteratorAggregate`."
count = 3

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "non-existent-method"
message = "Method `valid` does not exist on type `IteratorAggregate`."
count = 2

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "possible-method-access-on-null"
message = "Attempting to call a method on `null`."
count = 6

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "possibly-invalid-argument"
message = 'Possible argument type mismatch for argument #1 of `count`: expected `Countable|array<array-key, mixed>`, but possibly received `Iterator<mixed, mixed>|IteratorAggregate<mixed, mixed>|PhpDb\Adapter\Driver\ResultInterface`.'
count = 1

[[issues]]
file = "src/ResultSet/AbstractResultSet.php"
code = "property-type-coercion"
message = 'A value of a less specific type `Traversable<mixed, mixed>` is being assigned to property `$dataSource` (Iterator<mixed, mixed>|IteratorAggregate<mixed, mixed>|PhpDb\Adapter\Driver\ResultInterface|null).'
count = 1

[[issues]]
file = "src/ResultSet/ArrayObjectResultSetInterface.php"
code = "missing-api-or-internal"
message = 'Interface `PhpDb\ResultSet\ArrayObjectResultSetInterface` is missing an `@api` or `@internal` annotation.'
count = 1

[[issues]]
file = "src/ResultSet/ArrayResultSet.php"
code = "class-must-be-final"
message = 'Class `PhpDb\ResultSet\ArrayResultSet` should be declared `final`.'
count = 1

[[issues]]
file = "src/ResultSet/ArrayResultSet.php"
code = "imprecise-type"
message = "Type `array` in return type of `toArray` is imprecise, equivalent to `array<array-key, mixed>`."
count = 1

[[issues]]
file = "src/ResultSet/Exception/InvalidArgumentException.php"
code = "class-must-be-final"
message = 'Class `PhpDb\ResultSet\Exception\InvalidArgumentException` should be declared `final`.'
count = 1

[[issues]]
file = "src/ResultSet/Exception/RuntimeException.php"
code = "class-must-be-final"
message = 'Class `PhpDb\ResultSet\Exception\RuntimeException` should be declared `final`.'
count = 1

[[issues]]
file = "src/ResultSet/HydratingResultSet.php"
code = "class-must-be-final"
message = 'Class `PhpDb\ResultSet\HydratingResultSet` should be declared `final`.'
count = 1

[[issues]]
file = "src/ResultSet/HydratingResultSet.php"
code = "imprecise-type"
message = "Type `array` in return type of `toArray` is imprecise, equivalent to `array<array-key, mixed>`."
message = 'Could not infer a precise return type for function `PhpDb\ResultSet\AbstractResultSet::current`. Saw type `nonnull`.'
count = 1

[[issues]]
Expand All @@ -1674,102 +1566,12 @@ code = "mixed-return-statement"
message = 'Could not infer a precise return type for function `PhpDb\ResultSet\HydratingResultSet::current`. Saw type `nonnull`.'
count = 1

[[issues]]
file = "src/ResultSet/HydratingResultSet.php"
code = "non-existent-method"
message = "Method `current` does not exist on type `IteratorAggregate`."
count = 1

[[issues]]
file = "src/ResultSet/HydratingResultSet.php"
code = "overly-wide-return-type"
message = "Declared return type `null|object` for `getobjectprototype` has unused branches: `null`."
count = 1

[[issues]]
file = "src/ResultSet/HydratingResultSet.php"
code = "possible-method-access-on-null"
message = "Attempting to call a method on `null`."
count = 1

[[issues]]
file = "src/ResultSet/HydratingResultSet.php"
code = "possibly-null-argument"
message = 'Argument #1 of method `Laminas\Hydrator\ExtractionInterface::extract` is possibly `null`, but parameter type `object` does not accept it.'
count = 1

[[issues]]
file = "src/ResultSet/HydratingResultSetInterface.php"
code = "missing-api-or-internal"
message = 'Interface `PhpDb\ResultSet\HydratingResultSetInterface` is missing an `@api` or `@internal` annotation.'
count = 1

[[issues]]
file = "src/ResultSet/ResultSet.php"
code = "class-must-be-final"
message = 'Class `PhpDb\ResultSet\ResultSet` should be declared `final`.'
count = 1

[[issues]]
file = "src/ResultSet/ResultSet.php"
code = "imprecise-type"
message = "Type `array` in return type of `current` is imprecise, equivalent to `array<array-key, mixed>`."
count = 1

[[issues]]
file = "src/ResultSet/ResultSet.php"
code = "imprecise-type"
message = "Type `array` in return type of `toArray` is imprecise, equivalent to `array<array-key, mixed>`."
count = 1

[[issues]]
file = "src/ResultSet/ResultSet.php"
code = "invalid-return-statement"
message = 'Invalid return type for function `PhpDb\ResultSet\ResultSet::getReturnType`: expected `enum(PhpDb\ResultSet\ResultSetReturnType)`, but found `enum(PhpDb\ResultSet\ResultSetReturnType)|string`.'
count = 1

[[issues]]
file = "src/ResultSet/ResultSet.php"
code = "less-specific-return-statement"
message = 'Returned type `array<array-key, mixed>|null|object` is less specific than the declared return type `ArrayObject<array-key, mixed>|array<array-key, mixed>|null` for function `PhpDb\ResultSet\ResultSet::current`.'
count = 1

[[issues]]
file = "src/ResultSet/ResultSet.php"
code = "missing-constant-type"
message = "Class constant `TYPE_ARRAYOBJECT` is missing a type hint."
count = 1

[[issues]]
file = "src/ResultSet/ResultSet.php"
code = "missing-constant-type"
message = "Class constant `TYPE_ARRAY` is missing a type hint."
count = 1

[[issues]]
file = "src/ResultSet/ResultSetInterface.php"
code = "imprecise-type"
message = "Type `array` in return type of `toArray` is imprecise, equivalent to `array<array-key, mixed>`."
count = 1

[[issues]]
file = "src/ResultSet/ResultSetInterface.php"
code = "imprecise-type"
message = "Type `iterable` in parameter `$dataSource` is imprecise, equivalent to `iterable<mixed, mixed>`."
count = 1

[[issues]]
file = "src/ResultSet/ResultSetInterface.php"
code = "missing-api-or-internal"
message = 'Interface `PhpDb\ResultSet\ResultSetInterface` is missing an `@api` or `@internal` annotation.'
count = 1

[[issues]]
file = "src/ResultSet/ResultSetInterface.php"
code = "missing-template-parameter"
message = "Too few template arguments for `Iterator`: expected at least 2, but found 0."
count = 1

[[issues]]
file = "src/ResultSet/RowPrototypeInterface.php"
code = "imprecise-type"
Expand All @@ -1782,42 +1584,12 @@ code = "imprecise-type"
message = "Type `array` in return type of `toArray` is imprecise, equivalent to `array<array-key, mixed>`."
count = 1

[[issues]]
file = "src/ResultSet/RowPrototypeInterface.php"
code = "missing-api-or-internal"
message = 'Interface `PhpDb\ResultSet\RowPrototypeInterface` is missing an `@api` or `@internal` annotation.'
count = 1

[[issues]]
file = "src/ResultSet/RowPrototypeResultSet.php"
code = "class-must-be-final"
message = 'Class `PhpDb\ResultSet\RowPrototypeResultSet` should be declared `final`.'
count = 1

[[issues]]
file = "src/ResultSet/RowPrototypeResultSet.php"
code = "imprecise-type"
message = "Type `array` in return type of `current` is imprecise, equivalent to `array<array-key, mixed>`."
count = 1

[[issues]]
file = "src/ResultSet/RowPrototypeResultSet.php"
code = "imprecise-type"
message = "Type `array` in return type of `toArray` is imprecise, equivalent to `array<array-key, mixed>`."
count = 1

[[issues]]
file = "src/ResultSet/RowPrototypeResultSet.php"
code = "less-specific-return-statement"
message = 'Returned type `null|object` is less specific than the declared return type `PhpDb\ResultSet\RowPrototypeInterface|array<array-key, mixed>|null` for function `PhpDb\ResultSet\RowPrototypeResultSet::current`.'
count = 1

[[issues]]
file = "src/ResultSet/RowPrototypeResultSetInterface.php"
code = "missing-api-or-internal"
message = 'Interface `PhpDb\ResultSet\RowPrototypeResultSetInterface` is missing an `@api` or `@internal` annotation.'
count = 1

[[issues]]
file = "src/RowGateway/AbstractRowGateway.php"
code = "imprecise-type"
Expand Down Expand Up @@ -5259,7 +5031,7 @@ count = 1
[[issues]]
file = "src/TableGateway/AbstractTableGateway.php"
code = "mixed-argument"
message = 'Invalid argument type for argument #1 of `PhpDb\ResultSet\ResultSetInterface::initialize`: expected `iterable<mixed, mixed>`, but found `mixed`.'
message = 'Invalid argument type for argument #1 of `PhpDb\ResultSet\ResultSetInterface::initialize`: expected `iterable<array-key, mixed>`, but found `mixed`.'
count = 1

[[issues]]
Expand Down
Loading
Loading