ExamplesWorkerInterface
extends
WorkerInterface
in
Interfaz para el catálogo de ejemplos de documentos tributarios.
Table of Contents
Methods
- get() : array{id: string, example: array, expected: array}
- Entrega los datos de un ejemplo específico.
- list() : array<int, array{id: string, category: string, case: string}>
- Entrega el listado de ejemplos disponibles.
Methods
get()
Entrega los datos de un ejemplo específico.
public
get(string $id) : array{id: string, example: array, expected: array}
example corresponde al YAML de entrada tal como se utilizaría con
BuilderWorker::build() (dentro de un DocumentBag). expected
entrega los valores esperados del caso (Test.ExpectedValues en el
archivo de origen), separados de example para no mezclar el dato del
documento con la aserción de la suite de tests.
Parameters
- $id : string
-
Identificador del ejemplo (ver
list()).
Tags
Return values
array{id: string, example: array, expected: array} —Datos del ejemplo.
list()
Entrega el listado de ejemplos disponibles.
public
list() : array<int, array{id: string, category: string, case: string}>
Cada elemento entrega su identificador (a usar con get()), la
categoría (nombre de la carpeta del ejemplo) y el caso (nombre del
archivo del ejemplo, sin extensión).
El orden entregado garantiza que todo ejemplo aparece después de los ejemplos de los que depende (ej. una Nota de Crédito que anula una Factura aparece después de esa Factura) — un consumidor que arme cada ejemplo secuencialmente, en el orden recibido, siempre podrá resolver esas referencias contra ejemplos ya procesados.