DocumentBatch
in package
implements
DocumentBatchInterface
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.
- $file : string
- Ruta al archivo que contiene el lote de documentos que se deben procesar.
- $options : DataContainerInterface|null
- Opciones para los workers asociados al procesamiento en lote de documentos.
Methods
- __construct() : mixed
- getFile() : string
- Entrega la ruta del archivo con documentos que se debe procesar.
- getOptions() : DataContainerInterface|null
- Obtiene las opciones del procesamiento en lote de documentos.
- setOptions() : static
- Asigna las opciones del procesamiento en lote de documentos.
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' => []]]
El formato del esquema es el utilizado por Symfony\Component\OptionsResolver\OptionsResolver.
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.
$file
Ruta al archivo que contiene el lote de documentos que se deben procesar.
private
string
$file
$options
Opciones para los workers asociados al procesamiento en lote de documentos.
private
DataContainerInterface|null
$options
Se definen los siguientes índices para las opciones:
-
batch_processor
: Opciones para el procesador en lote de documentos. -
builder
: Opciones para los constructores. -
normalizer
: Opciones para los normalizadores. -
parser
: Opciones para los analizadores sintácticos. -
renderer
: Opciones para los renderizadores. -
sanitizer
: Opciones para los sanitizadores. -
validator
: Opciones para los validadores.
Se usarán las opciones por defecto en cada worker si no se indican los índices en el arreglo $options.
Methods
__construct()
public
__construct(string $file[, array<string|int, mixed>|DataContainerInterface|null $options = null ]) : mixed
Parameters
- $file : string
- $options : array<string|int, mixed>|DataContainerInterface|null = null
getFile()
Entrega la ruta del archivo con documentos que se debe procesar.
public
getFile() : string
Return values
stringgetOptions()
Obtiene las opciones del procesamiento en lote de documentos.
public
getOptions() : DataContainerInterface|null
Return values
DataContainerInterface|nullsetOptions()
Asigna las opciones del procesamiento en lote de documentos.
public
setOptions(array<string|int, mixed>|DataContainerInterface|null $options) : static
Parameters
- $options : array<string|int, mixed>|DataContainerInterface|null