SEP24TransactionResponse
extends Response
in package
Response containing a single SEP-24 transaction details
This class represents the response from the /transaction endpoint when querying for a specific transaction by ID. It wraps the SEP24Transaction object and provides access to all transaction details including status, amounts, and timestamps.
Tags
Table of Contents
Properties
- $transaction : SEP24Transaction
- $httpClient : Client|null
- $rateLimitLimit : int|null
- $rateLimitRemaining : int|null
- $rateLimitReset : int|null
Methods
- fromJson() : SEP24TransactionResponse
- Constructs a new instance of SEP24TransactionResponse by using the given data.
- getHttpClient() : Client|null
- Gets the HTTP client used for pagination requests
- getRateLimitLimit() : int|null
- Returns X-RateLimit-Limit header from the response.
- getRateLimitRemaining() : int|null
- Returns X-RateLimit-Remaining header from the response.
- getRateLimitReset() : int|null
- Returns X-RateLimit-Reset header from the response. Seconds until a new window starts.
- getTransaction() : SEP24Transaction
- setHeaders() : void
- Extracts and sets rate limiting information from HTTP response headers
- setHttpClient() : void
- Sets the HTTP client for making follow-up requests
- setTransaction() : void
- loadFromJson() : void
- Loads the needed data from a json array.
Properties
$transaction
public
SEP24Transaction
$transaction
The parsed transaction from the anchor response.
$httpClient
protected
Client|null
$httpClient
= null
$rateLimitLimit
protected
int|null
$rateLimitLimit
= null
$rateLimitRemaining
protected
int|null
$rateLimitRemaining
= null
$rateLimitReset
protected
int|null
$rateLimitReset
= null
Methods
fromJson()
Constructs a new instance of SEP24TransactionResponse by using the given data.
public
static fromJson(array<string|int, mixed> $json) : SEP24TransactionResponse
Parameters
- $json : array<string|int, mixed>
-
the data to construct the object from.
Return values
SEP24TransactionResponse —the object containing the parsed data.
getHttpClient()
Gets the HTTP client used for pagination requests
public
getHttpClient() : Client|null
Return values
Client|null —The HTTP client instance, or null if not set
getRateLimitLimit()
Returns X-RateLimit-Limit header from the response.
public
getRateLimitLimit() : int|null
This number represents the he maximum number of requests that the current client can make in one hour.
Tags
Return values
int|nullgetRateLimitRemaining()
Returns X-RateLimit-Remaining header from the response.
public
getRateLimitRemaining() : int|null
The number of remaining requests for the current window.
Tags
Return values
int|nullgetRateLimitReset()
Returns X-RateLimit-Reset header from the response. Seconds until a new window starts.
public
getRateLimitReset() : int|null
Tags
Return values
int|nullgetTransaction()
public
getTransaction() : SEP24Transaction
Return values
SEP24Transaction —The parsed transaction from the anchor response.
setHeaders()
Extracts and sets rate limiting information from HTTP response headers
public
setHeaders(array<string|int, mixed> $headers) : void
This method processes the X-Ratelimit-* headers from the HTTP response and stores them for client access.
Parameters
- $headers : array<string|int, mixed>
-
Associative array of HTTP headers from the response
setHttpClient()
Sets the HTTP client for making follow-up requests
public
setHttpClient([Client|null $httpClient = null ]) : void
Paginated responses contain links to next/previous pages. This HTTP client is used when following those links to fetch additional pages.
Parameters
- $httpClient : Client|null = null
-
The Guzzle HTTP client to use for pagination
setTransaction()
public
setTransaction(SEP24Transaction $transaction) : void
Parameters
- $transaction : SEP24Transaction
-
The parsed transaction from the anchor response.
loadFromJson()
Loads the needed data from a json array.
protected
loadFromJson(array<string|int, mixed> $json) : void
Parameters
- $json : array<string|int, mixed>
-
the data array to read from.