logger()->info([...]) throws a TypeError although the docs show array messages
维护者通常 1 天内回复
评估
调研方向
Read Logger::log(), the nine level methods, ReportableInterface::report(), and LoggerTrait::report() to trace where the array is rejected; compare that behavior with packages/logger/usage.md, packages/logger/adapters.md, architecture.md, and packages/logger/helpers.md. The issue leaves two incompatible approaches open, so first clarify which behavior should be supported. Done means the chosen behavior and docs agree, the corresponding file-adapter test passes, and the listed checks pass on PHP 8.1–8.3 with a changelog entry.
由索引模型根据 Issue 内容生成。
描述
Summary
Passing an array to a Logger method throws a TypeError, but the Logger docs describe array messages as a supported way to log structured data.
What happens
logger()->info(['order' => 1042, 'status' => 'paid']);
TypeError: Quantum\Logger\Logger::info(): Argument #1 ($message) must be of type Stringable|string, array given
I reproduced it on 3.1.0 with a stub adapter. Before 3.1 the Logger methods had no parameter type, but ReportableInterface::report() already required string|Stringable, so the same call could not have worked there either.
What the docs say
packages/logger/usage.md, "Log a structured payload": the example callslogger()->info([...]).packages/logger/adapters.mdandarchitecture.md: "If you pass an array message, the package JSON-encodes it with pretty printing before writing."packages/logger/helpers.md: uselogger()for "structured array messages".
Cause
Logger::log()and the nine level methods takestring|Stringable $message, and so doesReportableInterface::report().LoggerTrait::report()still containsis_array($message) ? json_encode($message, JSON_PRETTY_PRINT) : (string) $message. That branch can never run, because the parameter type rejects an array first.LoggerimplementsPsr\Log\LoggerInterface, where the message isstring|Stringable. PSR-3 puts structured data in$context, but the docs state that no context rendering happens ("No placeholder interpolation or structured context rendering happens").
Options
- Accept arrays. Widen the message type to
string|Stringable|arrayonLoggerandReportableInterface::report(), so the existing JSON branch works. PHP allows widening a parameter type in an override, so the PSR-3 interface still holds. This keeps the docs as they are. - Keep the PSR-3 shape. Remove the array promises from the docs and the dead branch from
LoggerTrait, and decide how structured data should be written, for example by rendering$contextin the file adapters.
Acceptance criteria
- the behavior and the docs agree, whichever option is chosen
- a test logs an array through
logger()with a file adapter and checks what is written (option 1), or a test checks that the chosen alternative works (option 2) composer test,composer cs:check,composer phpstanandcomposer rector:checkpass on PHP 8.1 to 8.3- the changelog lists the change
- 主要语言
- PHP
- 星标
- 43
- 派生
- 22
- 平均合并
- 54 分钟
- 30 天内合并 PR
- 57
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
quantum-php/framework 的其他 Issue
-
bug good first issue
难度 2/5 1-3 小时 新手友好度 78/100
quantum-php/framework#692 ·
维护者通常 1 天内回复
-
routing testing
难度 2/5 1-3 小时 新手友好度 76/100
quantum-php/framework#547 ·
维护者通常 1 天内回复
-
bug
难度 3/5 1-2 天 新手友好度 72/100
quantum-php/framework#694 ·
维护者通常 1 天内回复
-
refactoring tech debt
难度 5/5 一周以上 新手友好度 20/100
quantum-php/framework#693 ·
维护者通常 1 天内回复
-
install:debugbar reads the package folder from the working directory and uses the default storage adapter可能已有人在做 @armanist 今天认领。 未关闭bug console debugbar good first issue
quantum-php/framework#691 · 已指派 1 人 ·
维护者通常 1 天内回复
查看 quantum-php/framework 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 70/100
ajeetraina/awesome-docker-sbx#559 ·
-
dependencies enhancement
难度 2/5 1-3 小时 新手友好度 68/100
novalo-dev/Prestashop-MCP-Server#329 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 80/100
维护者通常 1 天内回复
-
bug origin:interactive status:available
难度 2/5 1-3 小时 新手友好度 62/100
Ultimate-Multisite/ultimate-multisite#2131 ·
维护者通常 1 天内回复
-
sync-en
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复