DocumentBatchInterface
extends
OptionsAwareInterface, JsonSerializable
in
Interfaz para el contenedor de varios documentos que se procesarán en lote.
Table of Contents
Methods
- getBatchProcessorOptions() : array<string|int, mixed>
- Obtiene las opciones del procesamiento en lote.
- getCertificate() : CertificateInterface|null
- Obtiene el certificado para firmar el documento.
- getDocumentBags() : array<string|int, DocumentBagInterface>
- Obtiene el listado de bolsas con documentos procesados en lote.
- getEmisor() : EmisorInterface|null
- Obtiene el emisor del documento.
- getInputData() : string
- Entrega el contenido con los documentos que se deben procesar.
- getInputFile() : string|null
- Entrega la ruta del archivo con los documentos que se deben procesar.
- setCertificate() : static
- Asigna el certificado para firmar el documento.
- setDocumentBags() : static
- Asigna el listado de bolsas con documentos procesados en lote.
- setEmisor() : static
- Asigna el emisor del documento.
- toArray() : array<string|int, mixed>
- Convierte el lote a un array.
Methods
getBatchProcessorOptions()
Obtiene las opciones del procesamiento en lote.
public
getBatchProcessorOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —Opciones del batch processor.
getCertificate()
Obtiene el certificado para firmar el documento.
public
getCertificate() : CertificateInterface|null
Return values
CertificateInterface|nullgetDocumentBags()
Obtiene el listado de bolsas con documentos procesados en lote.
public
getDocumentBags() : array<string|int, DocumentBagInterface>
Return values
array<string|int, DocumentBagInterface>getEmisor()
Obtiene el emisor del documento.
public
getEmisor() : EmisorInterface|null
Return values
EmisorInterface|nullgetInputData()
Entrega el contenido con los documentos que se deben procesar.
public
getInputData() : string
Si el lote se creó a partir de un archivo, el contenido se lee la primera vez que se solicita.
Tags
Return values
stringgetInputFile()
Entrega la ruta del archivo con los documentos que se deben procesar.
public
getInputFile() : string|null
Return values
string|null —Ruta del archivo, o null si el lote se creó a
partir del contenido.
setCertificate()
Asigna el certificado para firmar el documento.
public
setCertificate(CertificateInterface|null $certificate) : static
Parameters
- $certificate : CertificateInterface|null
Return values
staticsetDocumentBags()
Asigna el listado de bolsas con documentos procesados en lote.
public
setDocumentBags(array<string|int, DocumentBagInterface> $bags) : static
Parameters
- $bags : array<string|int, DocumentBagInterface>
Return values
staticsetEmisor()
Asigna el emisor del documento.
public
setEmisor(EmisorInterface|null $emisor) : static
Parameters
- $emisor : EmisorInterface|null
Return values
statictoArray()
Convierte el lote a un array.
public
toArray() : array<string|int, mixed>