Stellar PHP SDK API Documentation

TrustlineDeauthorizedEffectResponse extends TrustlineEffectResponse
in package

Represents a trustline deauthorized effect from the Stellar network

This effect occurs when an asset issuer revokes authorization for a trustline.

Tags
see
TrustlineEffectResponse

Base trustline effect class

see
https://developers.stellar.org

Stellar developer docs Horizon Effects API

since
1.0.0

Table of Contents

Properties

$httpClient  : Client|null
$rateLimitLimit  : int|null
$rateLimitRemaining  : int|null
$rateLimitReset  : int|null

Methods

fromJson()  : TrustlineDeauthorizedEffectResponse
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
getAssetCode()  : string|null
Gets the asset code
getAssetIssuer()  : string|null
Gets the asset issuer account ID
getAssetType()  : string
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
getHttpClient()  : Client|null
Gets the HTTP client used for pagination requests
getHumanReadableEffectType()  : string
Gets the human-readable description of the effect type
getLimit()  : string
Gets the trustline limit
getLinks()  : EffectLinksResponse
Gets the links to related resources for this effect
getLiquidityPoolId()  : string|null
Gets the liquidity pool ID
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

getAccount()

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

getAssetCode()

Gets the asset code

public getAssetCode() : string|null
Return values
string|null —

The asset code, or null for native or liquidity pool assets

getAssetIssuer()

Gets the asset issuer account ID

public getAssetIssuer() : string|null
Return values
string|null —

The issuer's account ID, or null for native or liquidity pool assets

getAssetType()

Gets the asset type

public getAssetType() : string
Return values
string —

The asset type (native, credit_alphanum4, credit_alphanum12, or liquidity_pool_shares)

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

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")

getLimit()

Gets the trustline limit

public getLimit() : string
Return values
string —

The maximum amount of the asset the account trusts

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

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
see
https://developers.stellar.org

Stellar developer docs Rate limiting documentation

Return values
int|null

getRateLimitRemaining()

Returns X-RateLimit-Remaining header from the response.

public getRateLimitRemaining() : int|null

The number of remaining requests for the current window.

Tags
see
https://developers.stellar.org

Stellar developer docs Rate limiting documentation

Return values
int|null

getRateLimitReset()

Returns X-RateLimit-Reset header from the response. Seconds until a new window starts.

public getRateLimitReset() : int|null
Tags
see
https://developers.stellar.org

Stellar developer docs Rate limiting documentation

Return values
int|null

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

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


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results