DocumentBatch
in package
implements
DocumentBatchInterface
uses
OptionsAwareTrait
Contenedor de datos para procesamiento en lote de documentos tributarios.
Permite "mover" varios documentos, junto a otros datos asociados, por métodos de manera sencilla y, sobre todo, extensible.
Table of Contents
Interfaces
- DocumentBatchInterface
- Interfaz para el contenedor de varios documentos que se procesarán en lote.
Properties
- $optionsSchema : array<string|int, mixed>
- Reglas de esquema de las opciones del lote de documentos.
- $certificate : CertificateInterface|null
- Certificado digital (firma electrónica) para la firma del documento.
- $documentBags : array<string|int, DocumentBagInterface>
- Listado de bolsas con los documentos procesados.
- $emisor : EmisorInterface|null
- Emisor del documento tributario.
- $inputData : string|null
- Contenido con el lote de documentos que se deben procesar.
- $inputFile : string|null
- Ruta al archivo que contiene el lote de documentos que se deben procesar.
Methods
- __construct() : mixed
- Constructor del lote.
- 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.
- jsonSerialize() : array<string|int, mixed>
- {@inheritDoc}
- 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.
Properties
$optionsSchema
Reglas de esquema de las opciones del lote de documentos.
protected
array<string|int, mixed>
$optionsSchema
= ['batch_processor' => ['types' => 'array', 'default' => []], 'builder' => ['types' => 'array', 'default' => []], 'normalizer' => ['types' => 'array', 'default' => []], 'parser' => ['types' => 'array', 'default' => []], 'renderer' => ['types' => 'array', 'default' => []], 'sanitizer' => ['types' => 'array', 'default' => []], 'validator' => ['types' => 'array', 'default' => []]]
Acá solo se indicarán los índices que deben pueden existir en las opciones. No se define el esquema de cada opción pues cada clase que utilice estas opciones deberá resolver y validar sus propias opciones.
$certificate
Certificado digital (firma electrónica) para la firma del documento.
private
CertificateInterface|null
$certificate
= null
$documentBags
Listado de bolsas con los documentos procesados.
private
array<string|int, DocumentBagInterface>
$documentBags
= []
$emisor
Emisor del documento tributario.
private
EmisorInterface|null
$emisor
= null
$inputData
Contenido con el lote de documentos que se deben procesar.
private
string|null
$inputData
Si el lote se creó a partir de un archivo, se lee la primera vez que se solicita.
$inputFile
Ruta al archivo que contiene el lote de documentos que se deben procesar.
private
string|null
$inputFile
Methods
__construct()
Constructor del lote.
public
__construct([string|null $inputData = null ][, string|null $inputFile = null ][, array<string|int, mixed>|OptionsInterface|null $options = [] ]) : mixed
Se debe indicar el contenido del lote (inputData) o la ruta del archivo
que lo contiene (inputFile), pero no ambos.
Parameters
- $inputData : string|null = null
-
Contenido con los documentos.
- $inputFile : string|null = null
-
Ruta al archivo con los documentos.
- $options : array<string|int, mixed>|OptionsInterface|null = []
Tags
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
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.
jsonSerialize()
{@inheritDoc}
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>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, mixed> $bags) : static
Parameters
- $bags : array<string|int, mixed>
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>