LibreDTE

RenderResult
in package
implements RenderResultInterface

Clase para representar el resultado de un renderizado.

Table of Contents

Interfaces

RenderResultInterface
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).

Properties

$renderings  : array<string|int, RenderedDocumentInterface>
Archivos generados por el renderizado.
$renderingsByLabel  : array<string, RenderedDocumentInterface>
Archivos generados por el renderizado, indexados por su `label`.

Methods

__construct()  : mixed
Constructor del resultado del renderizado.
__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.
jsonSerialize()  : array<string|int, mixed>
{@inheritDoc}
toArray()  : array<string|int, mixed>
Obtiene un arreglo con todos los archivos generados por el renderizado.
appendCopyNumber()  : string
Agrega el número de copia al nombre de un archivo, antes de su extensión (ej. `factura.pdf` => `factura_2.pdf`).
expand()  : array<string|int, mixed>
Expande cada archivo renderizado en tantas entradas como copias represente, agregando el número de copia y, si hay más de una copia, ajustando el nombre del archivo para no colisionar entre copias.

Properties

$renderingsByLabel read-only

Archivos generados por el renderizado, indexados por su `label`.

private array<string, RenderedDocumentInterface> $renderingsByLabel

Solo incluye los que tienen label asignado (no es el caso de uso normal, pero un RenderedDocumentInterface sin label sigue siendo válido, solo no queda indexado para hasRendering()/getRendering()).

Methods

__toString()

Entrega el contenido del renderizado como string.

public __toString() : string
Return values
string

hasRendering()

Indica si el renderizado generó un archivo con el `label` indicado.

public hasRendering(string $label) : bool
Parameters
$label : string
Return values
bool

jsonSerialize()

{@inheritDoc}

public jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>

toArray()

Obtiene un arreglo con todos los archivos generados por el renderizado.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

appendCopyNumber()

Agrega el número de copia al nombre de un archivo, antes de su extensión (ej. `factura.pdf` => `factura_2.pdf`).

private appendCopyNumber(string $filename, int $copyNumber) : string
Parameters
$filename : string
$copyNumber : int
Return values
string

expand()

Expande cada archivo renderizado en tantas entradas como copias represente, agregando el número de copia y, si hay más de una copia, ajustando el nombre del archivo para no colisionar entre copias.

private expand(callable(RenderedDocumentInterface): array<string|int, mixed> $serializer) : array<string|int, mixed>

El content/mimeType de cada entrada se calculan una sola vez (vía $serializer), no una vez por copia: expandir es solo repetir el mismo arreglo ya calculado.

Parameters
$serializer : callable(RenderedDocumentInterface): array<string|int, mixed>
Return values
array<string|int, mixed>
On this page

Search results