ClaimantsResponse
extends IteratorIterator
in package
Iterable collection of claimant responses
Provides iterator functionality for traversing multiple ClaimantResponse objects. Represents all eligible claimants for a claimable balance.
Tags
Table of Contents
Methods
- __construct() : mixed
- Constructs a claimants collection
- add() : void
- Adds a claimant to the collection
- count() : int
- Gets the total number of claimants in the collection
- current() : ClaimantResponse
- Gets the current claimant in the iteration
- toArray() : array<string|int, ClaimantResponse>
- Converts the collection to an array
Methods
__construct()
Constructs a claimants collection
public
__construct(ClaimantResponse ...$claimants) : mixed
Parameters
- $claimants : ClaimantResponse
-
Variable number of claimant responses
add()
Adds a claimant to the collection
public
add(ClaimantResponse $claimant) : void
Parameters
- $claimant : ClaimantResponse
-
The claimant to add
count()
Gets the total number of claimants in the collection
public
count() : int
Return values
int —The count of claimants
current()
Gets the current claimant in the iteration
public
current() : ClaimantResponse
Return values
ClaimantResponse —The current claimant
toArray()
Converts the collection to an array
public
toArray() : array<string|int, ClaimantResponse>
Return values
array<string|int, ClaimantResponse> —Array of claimant responses