RenderedDocumentInterface
extends
JsonSerializable
in
Interfaz para la clase que representa un archivo generado por un renderizador (ej. el PDF o el HTML de un DTE, de un libro tributario, o de cualquier otro contenido renderizado).
Table of Contents
Methods
- getContent() : string
- Obtiene los datos binarios (o de texto) del archivo renderizado.
- getCopies() : int
- Obtiene la cantidad de copias que representa este archivo renderizado.
- getFilename() : string|null
- Obtiene el nombre sugerido para el archivo renderizado.
- getLabel() : string|null
- Obtiene el identificador de la presentación con la que se generó este archivo (ej. `tributaria`, `cedible`).
- getMimeType() : string
- Obtiene el tipo MIME del archivo renderizado (ej. `application/pdf`).
- toArray() : array<string|int, mixed>
- Obtiene un arreglo con todos los atributos del archivo renderizado.
Methods
getContent()
Obtiene los datos binarios (o de texto) del archivo renderizado.
public
getContent() : string
Return values
stringgetCopies()
Obtiene la cantidad de copias que representa este archivo renderizado.
public
getCopies() : int
El contenido no se duplica en memoria por tener más de una copia: es
el mismo archivo, pensado para usarse (ej. imprimirse) esa cantidad de
veces. Ver RenderResultInterface::toArray()/jsonSerialize() para
la única expansión real a múltiples entradas.
Return values
intgetFilename()
Obtiene el nombre sugerido para el archivo renderizado.
public
getFilename() : string|null
Return values
string|nullgetLabel()
Obtiene el identificador de la presentación con la que se generó este archivo (ej. `tributaria`, `cedible`).
public
getLabel() : string|null
Es un identificador de texto libre, no atado a un enum específico: lo asigna quien construye el resultado del renderizado (ej. el worker), para que esta clase se pueda reutilizar fuera del contexto de documentos tributarios.
Return values
string|nullgetMimeType()
Obtiene el tipo MIME del archivo renderizado (ej. `application/pdf`).
public
getMimeType() : string
Return values
stringtoArray()
Obtiene un arreglo con todos los atributos del archivo renderizado.
public
toArray() : array<string|int, mixed>
El contenido se entrega tal cual (crudo, sin codificar), consistente
con el resto de la biblioteca: la codificación a base64 para
serialización JSON ocurre solo en jsonSerialize().