LedgerInfo
in package
Represents a single ledger in the getLedgers response.
Tags
Table of Contents
Properties
- $hash : string
- $headerXdr : string|null
- $ledgerCloseTime : string
- $metadataXdr : string|null
- $sequence : int
Methods
- __construct() : mixed
- fromJson() : static
- Creates an instance from JSON-RPC response data
- getHash() : string
- getHeaderXdr() : string|null
- getLedgerCloseTime() : string
- getMetadataXdr() : string|null
- getSequence() : int
- setHash() : void
- setHeaderXdr() : void
- setLedgerCloseTime() : void
- setMetadataXdr() : void
- setSequence() : void
Properties
$hash
public
string
$hash
$headerXdr
public
string|null
$headerXdr
= null
$ledgerCloseTime
public
string
$ledgerCloseTime
$metadataXdr
public
string|null
$metadataXdr
= null
$sequence
public
int
$sequence
Methods
__construct()
public
__construct(string $hash, int $sequence, string $ledgerCloseTime[, string|null $headerXdr = null ][, string|null $metadataXdr = null ]) : mixed
Parameters
- $hash : string
-
Hash of the ledger as a hex-encoded string
- $sequence : int
-
Sequence number of the ledger
- $ledgerCloseTime : string
-
Unix timestamp of the ledger close time as a string
- $headerXdr : string|null = null
-
Base64-encoded ledger header XDR
- $metadataXdr : string|null = null
-
Base64-encoded ledger metadata XDR
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
getHash()
public
getHash() : string
Return values
string —Hash of the ledger as a hex-encoded string.
getHeaderXdr()
public
getHeaderXdr() : string|null
Return values
string|null —Base64-encoded ledger header XDR (optional).
getLedgerCloseTime()
public
getLedgerCloseTime() : string
Return values
string —The unix timestamp of the close time of the ledger as a string.
getMetadataXdr()
public
getMetadataXdr() : string|null
Return values
string|null —Base64-encoded ledger metadata XDR (optional).
getSequence()
public
getSequence() : int
Return values
int —Sequence number of the ledger.
setHash()
public
setHash(string $hash) : void
Parameters
- $hash : string
-
Hash of the ledger as a hex-encoded string.
setHeaderXdr()
public
setHeaderXdr(string|null $headerXdr) : void
Parameters
- $headerXdr : string|null
-
Base64-encoded ledger header XDR (optional).
setLedgerCloseTime()
public
setLedgerCloseTime(string $ledgerCloseTime) : void
Parameters
- $ledgerCloseTime : string
-
The unix timestamp of the close time of the ledger as a string.
setMetadataXdr()
public
setMetadataXdr(string|null $metadataXdr) : void
Parameters
- $metadataXdr : string|null
-
Base64-encoded ledger metadata XDR (optional).
setSequence()
public
setSequence(int $sequence) : void
Parameters
- $sequence : int
-
Sequence number of the ledger.