RenderResultInterface
extends
Stringable, JsonSerializable
in
Interfaz para la clase que representa el resultado de un renderizado (uno o más archivos generados, ej. el PDF y/o el HTML de un DTE, de un libro tributario, o de cualquier otro contenido renderizado).
Table of Contents
Methods
- __toString() : string
- Entrega el contenido del renderizado como string.
- getRendering() : RenderedDocumentInterface
- Obtiene el archivo generado con el `label` indicado.
- getRenderings() : array<string|int, RenderedDocumentInterface>
- Obtiene los archivos generados por el renderizado.
- hasRendering() : bool
- Indica si el renderizado generó un archivo con el `label` indicado.
- toArray() : array<string|int, mixed>
- Obtiene un arreglo con todos los archivos generados por el renderizado.
Methods
__toString()
Entrega el contenido del renderizado como string.
public
__toString() : string
Solo funciona cuando el resultado contiene exactamente un archivo renderizado. Si el resultado contiene más de uno, no hay una forma no ambigua de reducirlo a un solo string, así que se lanza una excepción en vez de entregar solo el primero en silencio.
Return values
stringgetRendering()
Obtiene el archivo generado con el `label` indicado.
public
getRendering(string $label) : RenderedDocumentInterface
Parameters
- $label : string
Tags
Return values
RenderedDocumentInterfacegetRenderings()
Obtiene los archivos generados por el renderizado.
public
getRenderings() : array<string|int, RenderedDocumentInterface>
Uno por presentación (label) distinta solicitada, nunca duplicado
por su cantidad de copias. Ver RenderedDocumentInterface::getCopies().
Return values
array<string|int, RenderedDocumentInterface>hasRendering()
Indica si el renderizado generó un archivo con el `label` indicado.
public
hasRendering(string $label) : bool
Puede ser false tanto porque nunca se solicitó esa presentación como
porque se omitió en silencio (ej. copia cedible solicitada para un
tipo de documento que no la admite).
Parameters
- $label : string
Return values
booltoArray()
Obtiene un arreglo con todos los archivos generados por el renderizado.
public
toArray() : array<string|int, mixed>
A diferencia de getRenderings(), esta representación sí se expande
por cantidad de copias: cada archivo con copies > 1 aparece como
múltiples entradas (mismo content/mimeType, calculados una sola
vez), cada una con un copyNumber (desde 1) y, si hay más de una
copia, el filename ajustado para no colisionar entre copias.