logger()->info([...]) throws a TypeError although the docs show array messages

Abierto
#613 0 comentarios 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@armanist ya está trabajando en esto.

Desde el 27/10/2026.

  • #625 de @armanist — cerrado sin fusionar

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
42/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
php
Área
backend

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug

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 calls logger()->info([...]).
  • packages/logger/adapters.md and architecture.md: "If you pass an array message, the package JSON-encodes it with pretty printing before writing."
  • packages/logger/helpers.md: use logger() for "structured array messages".

Cause

  • Logger::log() and the nine level methods take string|Stringable $message, and so does ReportableInterface::report().
  • LoggerTrait::report() still contains is_array($message) ? json_encode($message, JSON_PRETTY_PRINT) : (string) $message. That branch can never run, because the parameter type rejects an array first.
  • Logger implements Psr\Log\LoggerInterface, where the message is string|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

  1. Accept arrays. Widen the message type to string|Stringable|array on Logger and ReportableInterface::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.
  2. 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 $context in 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 phpstan and composer rector:check pass on PHP 8.1 to 8.3
  • the changelog lists the change
Lenguaje dominante
PHP
Estrellas
43
Forks
22
Merge medio
54 min
PR fusionados (30 d)
57

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de quantum-php/framework

Todos los issues de quantum-php/framework

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.