Stellar PHP SDK API Documentation

ClaimantPredicateResponse

Represents conditions that must be satisfied to claim a claimable balance

Predicates can be unconditional, time-based (absolute or relative), or logical combinations (AND, OR, NOT) of multiple predicates. This allows for complex claim authorization logic.

Tags
see
ClaimantResponse

For the parent claimant details

since
1.0.0

Table of Contents

Methods

fromJson()  : ClaimantPredicateResponse
getAnd()  : ClaimantPredicatesResponse|null
Gets the AND logical combination of predicates
getBeforeAbsoluteTime()  : string|null
Gets the absolute time before which the balance can be claimed
getBeforeRelativeTime()  : string|null
Gets the relative time before which the balance can be claimed
getNot()  : ClaimantPredicateResponse|null
Gets the NOT logical negation of a predicate
getOr()  : ClaimantPredicatesResponse|null
Gets the OR logical combination of predicates
getUnconditional()  : bool|null
Gets whether this is an unconditional predicate
loadFromJson()  : void

Methods

getBeforeAbsoluteTime()

Gets the absolute time before which the balance can be claimed

public getBeforeAbsoluteTime() : string|null

Uses Unix timestamp format.

Return values
string|null

The absolute time threshold, or null if not applicable

getBeforeRelativeTime()

Gets the relative time before which the balance can be claimed

public getBeforeRelativeTime() : string|null

Specified as seconds relative to the close time of the ledger where the balance was created.

Return values
string|null

The relative time threshold in seconds, or null if not applicable

getUnconditional()

Gets whether this is an unconditional predicate

public getUnconditional() : bool|null

When true, the balance can be claimed without any conditions.

Return values
bool|null

True if unconditional, null if not applicable

loadFromJson()

protected loadFromJson(array<string|int, mixed> $json) : void
Parameters
$json : array<string|int, mixed>

        
On this page

Search results