Use @template generics on resource-typed interface members instead of the generic resource type
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
调研方向
Locate DriverInterface, StatementInterface, and the concrete platform implementations; start by reading their existing resource docblocks and the related mago analyzer fixes. Apply the proposed generic contract consistently, then verify that concrete mysqli types no longer require downstream suppressions and that the static analyzers accept the implementations.
由索引模型根据 Issue 内容生成。
描述
Context
Found while working phpdb-mysql#60 (mago analyze fixes).
Problem
DriverInterface::createResult($resource), DriverInterface::createStatement($sqlOrResource), and StatementInterface::getResource() are documented with a generic resource docblock type, intended to stay valid across every supported RDBMS platform. Concrete per-platform implementations (e.g. phpdb-mysql) pass/return real objects (mysqli, mysqli_result, mysqli_stmt), not resource handles, since mysqli has been object-oriented since its introduction in PHP 5.0 and was never part of PHP's resource-to-object migration. Static analyzers (mago, phpstan, psalm) flag every concrete usage as a type mismatch against the generic resource docblock, requiring local suppressions in every downstream platform package.
Proposed direction
Use PHP docblock generics (@template) on the interfaces instead of a fixed resource type, so the interface stays a single, platform-agnostic contract, and each concrete implementation narrows the generic to its own real type via @implements:
/** @template TResource */
interface DriverInterface
{
/** @param TResource $resource */
public function createResult($resource): ResultInterface;
}
/** @implements DriverInterface<mysqli|mysqli_result|mysqli_stmt> */
final class Driver implements DriverInterface { /* ... */ }
This avoids introducing per-RDBMS interfaces (a platform still free to use literal resource handles, e.g. a hypothetical oci8 implementation, can declare DriverInterface<resource>), while letting static analyzers correctly understand each concrete implementation's real type without suppressions. Same pattern applies to StatementInterface::getResource() and DriverInterface::createStatement()'s $sqlOrResource parameter.
- 主要语言
- PHP
- 星标
- 18
- 派生
- 8
- 平均合并
- 6 天 11 小时
- 30 天内合并 PR
- 14
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
php-db/phpdb 的其他 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
RFC
难度 3/5 1-2 天 新手友好度 66/100
维护者通常 1 天内回复
-
RFC
难度 5/5 一周以上 新手友好度 38/100
维护者通常 1 天内回复
-
RFC
难度 3/5 1-2 天 新手友好度 68/100
维护者通常 1 天内回复
-
RFC
难度 4/5 3-5 天 新手友好度 45/100
维护者通常 1 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
-
extension/Commercial needs-triage
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 2 天内回复
-
难度 1/5 1 小时以内 新手友好度 90/100
crazy-goat/rabbit-stream#753 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
opensourcepos/opensourcepos#4743 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
OpenConext/OpenConext-engineblock#2129 ·
维护者通常 3 天内回复