Sep24PostRequestBuilder
extends RequestBuilder
in package
Builder for SEP-24 POST requests to interactive deposit and withdrawal endpoints
This builder constructs and executes POST requests to SEP-24 interactive endpoints, handling multipart form data submission including both field data and file uploads. It is used internally by the InteractiveService to initiate deposit and withdrawal flows that require user interaction through a web interface.
The builder handles:
- JWT authentication token injection
- Multipart form encoding for fields and files
- Response parsing into SEP24InteractiveResponse
Tags
Table of Contents
Constants
- HEADERS = ["X-Client-Name" => "stellar_php_sdk", "X-Client-Version" => \Soneso\StellarSDK\StellarSDK::VERSION_NR]
Properties
- $httpClient : Client
- $queryParameters : array<string|int, mixed>
- $segments : array<string|int, mixed>
Methods
- __construct() : mixed
- Constructor.
- buildUrl() : string
- Builds the url for the request.
- cursor() : RequestBuilder
- Sets <code>cursor</code> parameter on the request.
- execute() : SEP24InteractiveResponse
- Build and execute request.
- executeRequest() : Response
- Executes an HTTP request to Horizon and returns a parsed response object
- getAndStream() : void
- Streams Server-Sent Events from Horizon to a callback function
- limit() : RequestBuilder
- Sets <code>limit</code> parameter on the request.
- order() : RequestBuilder
- Sets <code>order</code> parameter on the request.
- request() : SEP24InteractiveResponse
- Sends the request to the given url.
- setSegments() : RequestBuilder
- Sets the URL path segments for this request
Constants
HEADERS
public
mixed
HEADERS
= ["X-Client-Name" => "stellar_php_sdk", "X-Client-Version" => \Soneso\StellarSDK\StellarSDK::VERSION_NR]
Properties
$httpClient
protected
Client
$httpClient
$queryParameters
protected
array<string|int, mixed>
$queryParameters
$segments
protected
array<string|int, mixed>
$segments
Methods
__construct()
Constructor.
public
__construct(Client $httpClient, string $serviceAddress, string $endpoint, string $jwtToken, array<string|int, mixed> $fields[, array<string|int, mixed>|null $files = null ]) : mixed
Parameters
- $httpClient : Client
-
the client to be used for the request.
- $serviceAddress : string
-
the server address of the sep-24 service (e.g. from sep-01).
- $endpoint : string
-
the endpoint to be called. e.g. 'transactions/withdraw/interactive'
- $jwtToken : string
-
the jwt token obtained from sep-10 authentication.
- $fields : array<string|int, mixed>
-
the data fields to be added to the request.
- $files : array<string|int, mixed>|null = null
-
the files to be added to the request.
buildUrl()
Builds the url for the request.
public
buildUrl() : string
Return values
string —the constructed url.
cursor()
Sets <code>cursor</code> parameter on the request.
public
cursor(string $cursor) : RequestBuilder
A cursor is a value that points to a specific location in a collection of resources. The cursor attribute itself is an opaque value meaning that users should not try to parse it.
Parameters
- $cursor : string
Tags
Return values
RequestBuilderexecute()
Build and execute request.
public
execute() : SEP24InteractiveResponse
Tags
Return values
SEP24InteractiveResponse —the parsed response.
executeRequest()
Executes an HTTP request to Horizon and returns a parsed response object
public
executeRequest(string $url, string $requestType[, string|null $requestMethod = "GET" ]) : Response
This method sends the HTTP request to the Horizon server, handles errors, and parses the JSON response into the appropriate response type.
Parameters
- $url : string
-
The complete request URL to fetch
- $requestType : string
-
The expected response type for parsing
- $requestMethod : string|null = "GET"
-
The HTTP method to use (default: "GET")
Tags
Return values
Response —The parsed response object of the specified type
getAndStream()
Streams Server-Sent Events from Horizon to a callback function
public
getAndStream(string $relativeUrl, callable $callback[, bool $retryOnServerException = true ]) : void
This method establishes a persistent connection to Horizon's streaming endpoints using Server-Sent Events (SSE). It processes each event and passes the parsed data to the provided callback function. The stream automatically reconnects on server exceptions if retryOnServerException is true.
Horizon streaming uses SSE to push real-time updates. The stream sends:
- "hello" message on connection
- "byebye" message on disconnection
- JSON data objects for actual events
Parameters
- $relativeUrl : string
-
The relative URL to stream from
- $callback : callable
-
Function to receive parsed event data
- $retryOnServerException : bool = true
-
If true, automatically retry on server errors (default: true)
Tags
Return values
void —This method runs indefinitely until interrupted
limit()
Sets <code>limit</code> parameter on the request.
public
limit(int $number) : RequestBuilder
It defines maximum number of records to return. For range and default values check documentation of the endpoint requested.
Parameters
- $number : int
-
Maximum number of records to return
Return values
RequestBuilderorder()
Sets <code>order</code> parameter on the request.
public
order([string $direction = "asc" ]) : RequestBuilder
Parameters
- $direction : string = "asc"
-
"asc" or "desc"
Return values
RequestBuilderrequest()
Sends the request to the given url.
public
request(string $url) : SEP24InteractiveResponse
Parameters
- $url : string
-
the url to send the request to
Tags
Return values
SEP24InteractiveResponse —the parsed response.
setSegments()
Sets the URL path segments for this request
protected
setSegments(string ...$segments) : RequestBuilder
This method constructs the URL path by combining multiple segments. Can only be called once per request builder instance.
Parameters
- $segments : string
-
Variable number of URL path segments
Tags
Return values
RequestBuilder —This instance for method chaining