LibreDTE

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.
$file  : string
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.
getFile()  : string
Entrega la ruta del archivo con documentos que se debe 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.

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

$file

Ruta al archivo que contiene el lote de documentos que se deben procesar.

private string $file

Methods

__construct()

Constructor del lote.

public __construct(string $file[, array<string|int, mixed>|DataContainerInterface|null $options = [] ]) : mixed
Parameters
$file : string
$options : array<string|int, mixed>|DataContainerInterface|null = []

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|null

getFile()

Entrega la ruta del archivo con documentos que se debe procesar.

public getFile() : string
Return values
string

setCertificate()

Asigna el certificado para firmar el documento.

public setCertificate(CertificateInterface|null $certificate) : static
Parameters
$certificate : CertificateInterface|null
Return values
static

setDocumentBags()

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
static 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results