TrustlineSponsorshipUpdatedEffectResponse
extends EffectResponse
in package
Represents a trustline sponsorship updated effect from the Stellar network
This effect occurs when a trustline's sponsorship is transferred from one sponsor to another.
Tags
Table of Contents
Properties
- $httpClient : Client|null
- $rateLimitLimit : int|null
- $rateLimitRemaining : int|null
- $rateLimitReset : int|null
Methods
- fromJson() : TrustlineSponsorshipUpdatedEffectResponse
- getAccount() : string
- Gets the account address affected by this effect
- getAccountMuxed() : string|null
- Gets the muxed account address if the account is multiplexed
- getAccountMuxedId() : string|null
- Gets the muxed account ID if the account is multiplexed
- getAsset() : string|null
- Gets the asset identifier
- getAssetType() : string|null
- Gets the asset type
- getCreatedAt() : string
- Gets the timestamp when this effect was created
- getEffectId() : string
- Gets the unique identifier for this effect
- getEffectType() : int
- Gets the numeric effect type identifier
- getFormerSponsor() : string
- Gets the account ID of the former sponsor
- getHttpClient() : Client|null
- Gets the HTTP client used for pagination requests
- getHumanReadableEffectType() : string
- Gets the human-readable description of the effect type
- getLinks() : EffectLinksResponse
- Gets the links to related resources for this effect
- getLiquidityPoolId() : string|null
- Gets the liquidity pool ID
- getNewSponsor() : string
- Gets the account ID of the new sponsor
- getPagingToken() : string
- Gets the paging token for this effect in list results
- 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.
- setHeaders() : void
- Extracts and sets rate limiting information from HTTP response headers
- setHttpClient() : void
- Sets the HTTP client for making follow-up requests
- loadFromJson() : void
- Loads response data from a JSON array
Properties
$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()
public
static fromJson(array<string|int, mixed> $jsonData) : TrustlineSponsorshipUpdatedEffectResponse
Parameters
- $jsonData : array<string|int, mixed>
Return values
TrustlineSponsorshipUpdatedEffectResponsegetAccount()
Gets the account address affected by this effect
public
getAccount() : string
Return values
string —The account ID
getAccountMuxed()
Gets the muxed account address if the account is multiplexed
public
getAccountMuxed() : string|null
Return values
string|null —The muxed account address, or null if not multiplexed
getAccountMuxedId()
Gets the muxed account ID if the account is multiplexed
public
getAccountMuxedId() : string|null
Return values
string|null —The muxed account ID, or null if not multiplexed
getAsset()
Gets the asset identifier
public
getAsset() : string|null
Return values
string|null —The asset identifier, or null if not set
getAssetType()
Gets the asset type
public
getAssetType() : string|null
Return values
string|null —The asset type, or null if not set
getCreatedAt()
Gets the timestamp when this effect was created
public
getCreatedAt() : string
Return values
string —The creation time in ISO 8601 format
getEffectId()
Gets the unique identifier for this effect
public
getEffectId() : string
Return values
string —The effect ID
getEffectType()
Gets the numeric effect type identifier
public
getEffectType() : int
Return values
int —The effect type code as defined in EffectType constants
getFormerSponsor()
Gets the account ID of the former sponsor
public
getFormerSponsor() : string
Return values
string —The former sponsor's account ID
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
getHumanReadableEffectType()
Gets the human-readable description of the effect type
public
getHumanReadableEffectType() : string
Return values
string —The effect type name (e.g., "account_created", "trade")
getLinks()
Gets the links to related resources for this effect
public
getLinks() : EffectLinksResponse
Return values
EffectLinksResponse —The navigation links
getLiquidityPoolId()
Gets the liquidity pool ID
public
getLiquidityPoolId() : string|null
Return values
string|null —The liquidity pool ID, or null if not a liquidity pool trustline
getNewSponsor()
Gets the account ID of the new sponsor
public
getNewSponsor() : string
Return values
string —The new sponsor's account ID
getPagingToken()
Gets the paging token for this effect in list results
public
getPagingToken() : string
Return values
string —The paging token used for cursor-based pagination
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|nullsetHeaders()
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
loadFromJson()
Loads response data from a JSON array
protected
loadFromJson(array<string|int, mixed> $json) : void
This method is used internally to populate response objects from parsed JSON. Subclasses override this to extract their specific data fields.
Parameters
- $json : array<string|int, mixed>
-
Associative array of parsed JSON data