ExchangeResult
in package
implements
ExchangeResultInterface
Clase que representan un resultado de intercambio de sobres.
Este resultado está asociado a un único sobre, pero puede tener como resultado múltiples estados. Loanterior ocurre porque un sobre puede haber sido procesado por más de una estrategia y cada una asigna un estado.
Table of Contents
Interfaces
- ExchangeResultInterface
- Interfaz para el resultado del proceso de intercambio de un sobre.
Properties
- $envelope : EnvelopeInterface
- Sobre al que está asociado el resultado.
- $metadata : BagInterface
- Metadatos del resultado.
- $statuses : array<string, ExchangeStatusInterface>
- Listado de resultados de las estrategias que procesaron el sobre.
Methods
- __construct() : mixed
- Constructor del resultado del intercambio de un sobre.
- addMetadata() : static
- Agrega una clave específica a los metadatos.
- addStatus() : static
- Agrega el estado de resultado de una estrategia al resultado general del intercambio del sobre.
- getEnvelope() : EnvelopeInterface
- Obtiene el sobre asociado a la operación, y resultado, de intercambio.
- getMetadata() : BagInterface
- Obtiene los metadatos del resultado.
- getStatuses() : array<string|int, ExchangeStatusInterface>
- Entrega los estados del intercambio de las estrategias que participaron en el intercambio del sobre asociado.
- getStrategies() : array<string|int, string>
- Entrega los códigos de las estrategias que procesaron el sobre.
- setMetadata() : static
- Asigna los metadatos del resultado.
Properties
$envelope
Sobre al que está asociado el resultado.
private
EnvelopeInterface
$envelope
$metadata
Metadatos del resultado.
private
BagInterface
$metadata
$statuses
Listado de resultados de las estrategias que procesaron el sobre.
private
array<string, ExchangeStatusInterface>
$statuses
Methods
__construct()
Constructor del resultado del intercambio de un sobre.
public
__construct(EnvelopeInterface $envelope[, BagInterface|array<string|int, mixed> $metadata = [] ]) : mixed
Parameters
- $envelope : EnvelopeInterface
- $metadata : BagInterface|array<string|int, mixed> = []
addMetadata()
Agrega una clave específica a los metadatos.
public
addMetadata(string $key, mixed $value) : static
Parameters
- $key : string
- $value : mixed
Return values
staticaddStatus()
Agrega el estado de resultado de una estrategia al resultado general del intercambio del sobre.
public
addStatus(ExchangeStatusInterface $status) : static
Parameters
- $status : ExchangeStatusInterface
Return values
staticgetEnvelope()
Obtiene el sobre asociado a la operación, y resultado, de intercambio.
public
getEnvelope() : EnvelopeInterface
Return values
EnvelopeInterfacegetMetadata()
Obtiene los metadatos del resultado.
public
getMetadata() : BagInterface
Return values
BagInterfacegetStatuses()
Entrega los estados del intercambio de las estrategias que participaron en el intercambio del sobre asociado.
public
getStatuses() : array<string|int, ExchangeStatusInterface>
Return values
array<string|int, ExchangeStatusInterface>getStrategies()
Entrega los códigos de las estrategias que procesaron el sobre.
public
getStrategies() : array<string|int, string>
Return values
array<string|int, string>setMetadata()
Asigna los metadatos del resultado.
public
setMetadata(BagInterface|array<string|int, mixed> $metadata) : static
Parameters
- $metadata : BagInterface|array<string|int, mixed>