RootRequestBuilder
extends RequestBuilder
in package
Builds requests for the root endpoint in Horizon
This class provides access to the Horizon root endpoint, which returns general information about the Horizon instance, including its version, network information, and links to other API endpoints.
The root endpoint is typically the first request made to discover the capabilities and configuration of a Horizon server. It includes the network passphrase, which identifies whether the instance serves testnet, pubnet, or a custom network.
Usage Example:
// Get Horizon root information $root = $sdk->root()->getRoot("https://horizon.stellar.org"); echo "Horizon version: " . $root->getHorizonVersion() . PHP_EOL; echo "Network passphrase: " . $root->getNetworkPassphrase() . PHP_EOL;
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 complete request URL with all segments and query parameters
- cursor() : RequestBuilder
- Sets <code>cursor</code> parameter on the request.
- execute() : Response
- 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
- getRoot() : RootResponse
- Retrieve root information from a Horizon server
- limit() : RequestBuilder
- Sets <code>limit</code> parameter on the request.
- order() : RequestBuilder
- Sets <code>order</code> parameter on the request.
- 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) : mixed
Parameters
- $httpClient : Client
-
The HTTP client used for making requests to Horizon
buildUrl()
Builds the complete request URL with all segments and query parameters
public
buildUrl() : string
Combines the URL path segments with query parameters to create the final request URL string that will be sent to Horizon.
Return values
string —The constructed URL with query parameters
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() : Response
@throws HorizonRequestException
Return values
Response —The parsed response object
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
getRoot()
Retrieve root information from a Horizon server
public
getRoot(string $url) : RootResponse
Returns general information about the Horizon instance including version, network configuration, and available endpoints.
Parameters
- $url : string
-
The full URL to the Horizon root endpoint
Tags
Return values
RootResponse —The root information
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
RequestBuildersetSegments()
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