TalerMerchantResponseParser
in package
TalerMerchantResponseParser
Lightweight validators/normalisers for responses returned by the GNU Taler merchant backend.
All helpers return the payload or throw an InvalidArgumentException when required fields are missing or of the wrong type.
Table of Contents
Methods
- parseCategory() : array<string|int, mixed>
- Validate category detail payload.
- parseCategoryList() : array<string|int, mixed>
- Validate categories list payload.
- parseInventorySummary() : array<string|int, mixed>
- Validate products summary list payload.
- parseOrderHistory() : array<string|int, mixed>
- Validate OrderHistory payload.
- parseOrderStatus() : array<string|int, mixed>
- Validate MerchantOrderStatusResponse payload.
- parsePostOrderResponse() : array<string|int, mixed>
- Validate PostOrderResponse payload.
- parseProduct() : array<string|int, mixed>
- Validate product detail payload.
- parseRefundResponse() : array<string|int, mixed>
- Validate MerchantRefundResponse payload.
- parseVersion() : array<string|int, mixed>
- Validate /config payload.
- parseWebhook() : array<string|int, mixed>
- Validate webhook detail payload.
- parseWebhookList() : array<string|int, mixed>
- Validate webhook summary payload.
- requireArray() : array<string|int, mixed>
- Require a key to exist and be an array.
- requireIntLike() : int
- Require a key to exist and be an integer or numeric string.
- requireString() : string
- Require a key to exist and be a non-empty string.
Methods
parseCategory()
Validate category detail payload.
public
static parseCategory(array<string|int, mixed> $payload) : array<string|int, mixed>
Parameters
- $payload : array<string|int, mixed>
-
Category detail response body
Return values
array<string|int, mixed> —Normalised payload
parseCategoryList()
Validate categories list payload.
public
static parseCategoryList(array<string|int, mixed> $payload) : array<string|int, mixed>
Parameters
- $payload : array<string|int, mixed>
-
Categories list response body
Return values
array<string|int, mixed> —Normalised payload
parseInventorySummary()
Validate products summary list payload.
public
static parseInventorySummary(array<string|int, mixed> $payload) : array<string|int, mixed>
Parameters
- $payload : array<string|int, mixed>
-
Inventory summary response body
Return values
array<string|int, mixed> —Normalised payload
parseOrderHistory()
Validate OrderHistory payload.
public
static parseOrderHistory(array<string|int, mixed> $payload) : array<string|int, mixed>
Parameters
- $payload : array<string|int, mixed>
-
Order history response body
Return values
array<string|int, mixed> —Normalised payload
parseOrderStatus()
Validate MerchantOrderStatusResponse payload.
public
static parseOrderStatus(array<string|int, mixed> $payload) : array<string|int, mixed>
Parameters
- $payload : array<string|int, mixed>
-
Order status response body
Return values
array<string|int, mixed> —Normalised payload
parsePostOrderResponse()
Validate PostOrderResponse payload.
public
static parsePostOrderResponse(array<string|int, mixed> $payload) : array<string|int, mixed>
Parameters
- $payload : array<string|int, mixed>
-
Post order response body
Return values
array<string|int, mixed> —Normalised payload
parseProduct()
Validate product detail payload.
public
static parseProduct(array<string|int, mixed> $payload) : array<string|int, mixed>
Parameters
- $payload : array<string|int, mixed>
-
Product detail response body
Return values
array<string|int, mixed> —Normalised payload
parseRefundResponse()
Validate MerchantRefundResponse payload.
public
static parseRefundResponse(array<string|int, mixed> $payload) : array<string|int, mixed>
Parameters
- $payload : array<string|int, mixed>
-
Refund response body
Return values
array<string|int, mixed> —Normalised payload
parseVersion()
Validate /config payload.
public
static parseVersion(array<string|int, mixed> $payload) : array<string|int, mixed>
Parameters
- $payload : array<string|int, mixed>
-
Version response body
Return values
array<string|int, mixed> —Normalised payload
parseWebhook()
Validate webhook detail payload.
public
static parseWebhook(array<string|int, mixed> $payload) : array<string|int, mixed>
Parameters
- $payload : array<string|int, mixed>
-
Webhook detail response body
Return values
array<string|int, mixed> —Normalised payload
parseWebhookList()
Validate webhook summary payload.
public
static parseWebhookList(array<string|int, mixed> $payload) : array<string|int, mixed>
Parameters
- $payload : array<string|int, mixed>
-
Webhooks list response body
Return values
array<string|int, mixed> —Normalised payload
requireArray()
Require a key to exist and be an array.
private
static requireArray(array<string|int, mixed> $payload, string $key, string $context) : array<string|int, mixed>
Parameters
- $payload : array<string|int, mixed>
-
Response payload
- $key : string
-
Key to check
- $context : string
-
Human-readable context for error messages
Return values
array<string|int, mixed> —The array value
requireIntLike()
Require a key to exist and be an integer or numeric string.
private
static requireIntLike(array<string|int, mixed> $payload, string $key, string $context) : int
Parameters
- $payload : array<string|int, mixed>
-
Response payload
- $key : string
-
Key to check
- $context : string
-
Human-readable context for error messages
Return values
int —Integer value
requireString()
Require a key to exist and be a non-empty string.
private
static requireString(array<string|int, mixed> $payload, string $key, string $context) : string
Parameters
- $payload : array<string|int, mixed>
-
Response payload
- $key : string
-
Key to check
- $context : string
-
Human-readable context for error messages
Return values
string —The string value