Respuesta
in package
FinalYes
Punto único de salida de la API.
Table of Contents
Methods
- delControlador() : never
- Respuesta de un controlador, que ya trae su propio 'status'.
- error() : never
- Error controlado. Nunca expone detalles internos.
- json() : never
- Emite el cuerpo como JSON y termina.
- ok() : never
- Respuesta correcta con envoltorio uniforme.
Methods
delControlador()
Respuesta de un controlador, que ya trae su propio 'status'.
public
static delControlador(array<string|int, mixed> $resultado) : never
Parameters
- $resultado : array<string|int, mixed>
-
: array del controlador
Return values
nevererror()
Error controlado. Nunca expone detalles internos.
public
static error(string $mensaje[, int $status = 400 ][, string $codigo = 'ERROR' ][, array<string|int, mixed> $extra = [] ]) : never
El campo 'code' permite al frontend discriminar por máquina en lugar de por el texto en español.
Parameters
- $mensaje : string
-
: texto apto para el usuario
- $status : int = 400
-
: código HTTP
- $codigo : string = 'ERROR'
-
: código estable de error
- $extra : array<string|int, mixed> = []
-
: campos adicionales del cuerpo
Return values
neverjson()
Emite el cuerpo como JSON y termina.
public
static json(mixed $datos[, int $status = 200 ]) : never
Parameters
- $datos : mixed
-
: cuerpo a serializar
- $status : int = 200
-
: código HTTP
Return values
neverok()
Respuesta correcta con envoltorio uniforme.
public
static ok(mixed $datos[, int $status = 200 ]) : never
Parameters
- $datos : mixed
-
: contenido de 'data'
- $status : int = 200
-
: código HTTP