LedgerEntry
in package
FinalYes
A representation of one movement event, from one slot to another, with all the relevant details for ledgering and reporting.
InitialFrom quantity MUST be provided for non-nil sources. InitialTo quantity MUST be provided for non-nil sinks.
Table of Contents
Properties
- $context : array<string|int, mixed>
- $edge : MovementEdge
- $initialFrom : int|float|null
- $initialTo : int|float|null
- $quantity : int|float
Methods
- finalFrom() : int|float|null
- Return the source quantity after this ledgered movement, or null for nil sources.
- finalTo() : int|float|null
- Return the destination quantity after this ledgered movement, or null for nil sinks.
Properties
$context read-only
public
array<string|int, mixed>
$context
= []
$edge read-only
public
MovementEdge
$edge
$initialFrom read-only
public
int|float|null
$initialFrom
$initialTo read-only
public
int|float|null
$initialTo
$quantity read-only
public
int|float
$quantity
Methods
finalFrom()
Return the source quantity after this ledgered movement, or null for nil sources.
public
finalFrom() : int|float|null
APIYes
Return values
int|float|nullfinalTo()
Return the destination quantity after this ledgered movement, or null for nil sinks.
public
finalTo() : int|float|null
APIYes