Stellar PHP SDK API Documentation

LedgerEntry

Part of the getLedgerEntries response.

Tags
see
https://developers.stellar.org/network/soroban-rpc/api-reference/methods/getLedgerEntries

Table of Contents

Properties

$ext  : string|null
$key  : string
$lastModifiedLedgerSeq  : int
$liveUntilLedgerSeq  : int|null
$xdr  : string

Methods

__construct()  : mixed
fromJson()  : static
Creates an instance from JSON-RPC response data
getExt()  : string|null
getKey()  : string
getKeyXdr()  : XdrSCVal
getLastModifiedLedgerSeq()  : int
getLedgerEntryDataXdr()  : XdrLedgerEntryData
getLiveUntilLedgerSeq()  : int|null
getXdr()  : string
setExt()  : void
setKey()  : void
setLastModifiedLedgerSeq()  : void
setLiveUntilLedgerSeq()  : void
setXdr()  : void

Properties

$lastModifiedLedgerSeq

public int $lastModifiedLedgerSeq

$liveUntilLedgerSeq

public int|null $liveUntilLedgerSeq = null

Methods

__construct()

public __construct(string $key, string $xdr, int $lastModifiedLedgerSeq[, int|null $liveUntilLedgerSeq = null ][, string|null $ext = null ]) : mixed
Parameters
$key : string

The key of the ledger entry (serialized in a base64 XDR string)

$xdr : string

The current value of the given ledger entry (serialized in a base64 XDR string)

$lastModifiedLedgerSeq : int

The ledger sequence number of the last time this entry was updated

$liveUntilLedgerSeq : int|null = null

Ledger sequence number until which the entry is live

$ext : string|null = null

The entry's "Ext" field (only available for protocol version >= 23)

fromJson()

Creates an instance from JSON-RPC response data

public static fromJson(array<string, mixed> $json) : static
Parameters
$json : array<string, mixed>

The JSON response data

Return values
static

The created instance

getExt()

public getExt() : string|null
Return values
string|null

getKey()

public getKey() : string
Return values
string

The key of the ledger entry (serialized in a base64 xdr string).

getKeyXdr()

public getKeyXdr() : XdrSCVal
Tags
throws
InvalidArgumentException

If XDR data is malformed

Return values
XdrSCVal

The key of the ledger entry.

getLastModifiedLedgerSeq()

public getLastModifiedLedgerSeq() : int
Return values
int

The ledger sequence number of the last time this entry was updated.

getLiveUntilLedgerSeq()

public getLiveUntilLedgerSeq() : int|null
Return values
int|null

Sequence number of the ledger.

getXdr()

public getXdr() : string
Return values
string

The current value of the given ledger entry (serialized in a base64 xdr string).

setExt()

public setExt(string|null $ext) : void
Parameters
$ext : string|null

setKey()

public setKey(string $key) : void
Parameters
$key : string

The key of the ledger entry (serialized in a base64 xdr string).

setLastModifiedLedgerSeq()

public setLastModifiedLedgerSeq(int $lastModifiedLedgerSeq) : void
Parameters
$lastModifiedLedgerSeq : int

The ledger sequence number of the last time this entry was updated.

setLiveUntilLedgerSeq()

public setLiveUntilLedgerSeq(int|null $liveUntilLedgerSeq) : void
Parameters
$liveUntilLedgerSeq : int|null

Sequence number of the ledger.

setXdr()

public setXdr(string $xdr) : void
Parameters
$xdr : string

The current value of the given ledger entry (serialized in a base64 xdr string).


        
On this page

Search results