ExchangeBag
in package
implements
ExchangeBagInterface
uses
OptionsAwareTrait
Clase que representa una bolsa con sobres con documentos para ser intercambiada.
Una bolsa podrá contener sobres de diferentes emisores o receptores, pero los documentos dentro de cada sobre serán del mismo emisor y receptor.
Table of Contents
Interfaces
- ExchangeBagInterface
- Interfaz que almacena sobres, y sus documentos, más los datos para enviar o recibir durante el proceso de intercambio de documentos electrónicos.
Properties
- $optionsSchema : array<string|int, mixed>
- Reglas de esquema de las opciones del intercambio de documentos.
- $envelopes : array<string, EnvelopeInterface>
- Listado de sobres que se están intercambiando en este lote.
- $results : array<string, ExchangeResultInterface>
- Listado con los resultados del intercambio.
Methods
- __construct() : mixed
- Constructor de la bolsa de intercambio.
- addEnvelope() : static
- Agrega un sobre a la bolsa.
- addResult() : static
- Agrega un resultado del proceso de intercambio.
- getEnvelopes() : array<string|int, EnvelopeInterface>
- Obtiene el listado de sobres que la bolsa tiene.
- getResults() : array<string|int, ExchangeResultInterface>
- Obtiene los resultados del proceso de intercambio.
- hasEnvelopes() : bool
- Indica si la bolsa tiene o no sobres dentro.
Properties
$optionsSchema
Reglas de esquema de las opciones del intercambio de documentos.
protected
array<string|int, mixed>
$optionsSchema
= ['strategy' => ['types' => 'string'], 'transport' => ['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.
$envelopes
Listado de sobres que se están intercambiando en este lote.
private
array<string, EnvelopeInterface>
$envelopes
= []
$results
Listado con los resultados del intercambio.
private
array<string, ExchangeResultInterface>
$results
= []
Methods
__construct()
Constructor de la bolsa de intercambio.
public
__construct([array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $options : array<string|int, mixed> = []
addEnvelope()
Agrega un sobre a la bolsa.
public
addEnvelope(EnvelopeInterface $envelope) : static
Parameters
- $envelope : EnvelopeInterface
Return values
staticaddResult()
Agrega un resultado del proceso de intercambio.
public
addResult(ExchangeResultInterface $result) : static
Parameters
- $result : ExchangeResultInterface
Return values
staticgetEnvelopes()
Obtiene el listado de sobres que la bolsa tiene.
public
getEnvelopes() : array<string|int, EnvelopeInterface>
Return values
array<string|int, EnvelopeInterface>getResults()
Obtiene los resultados del proceso de intercambio.
public
getResults() : array<string|int, ExchangeResultInterface>
Return values
array<string|int, ExchangeResultInterface>hasEnvelopes()
Indica si la bolsa tiene o no sobres dentro.
public
hasEnvelopes() : bool