MovementEvent
in package
FinalYes
One applied movement with before-state snapshots for source and destination.
Tags
Table of Contents
Properties
- $edge : MovementEdge
- $initialFrom : int|float|null
- $initialTo : int|float|null
- $quantity : int|float
Methods
- __construct() : mixed
- deltas() : array<int, QuantityStateDelta>
- Convert this event to per-slot quantity-state deltas.
- finalFrom() : int|float|null
- Return the source quantity after this movement, or null for nil sources.
- finalTo() : int|float|null
- Return the destination quantity after this movement, or null for nil sinks.
- ledgerEntry() : LedgerEntry
- Convert this event to a ledger entry.
- mutations() : array<int, QuantityStateDelta>
Properties
$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
__construct()
public
__construct(MovementEdge $edge, int|float $quantity, int|float|null $initialFrom, int|float|null $initialTo) : mixed
Parameters
- $edge : MovementEdge
- $quantity : int|float
- $initialFrom : int|float|null
- $initialTo : int|float|null
Tags
deltas()
Convert this event to per-slot quantity-state deltas.
public
deltas() : array<int, QuantityStateDelta>
Return values
array<int, QuantityStateDelta>finalFrom()
Return the source quantity after this movement, or null for nil sources.
public
finalFrom() : int|float|null
Return values
int|float|nullfinalTo()
Return the destination quantity after this movement, or null for nil sinks.
public
finalTo() : int|float|null
Return values
int|float|nullledgerEntry()
Convert this event to a ledger entry.
public
ledgerEntry([array<string, mixed> $context = [] ]) : LedgerEntry
Parameters
- $context : array<string, mixed> = []
Return values
LedgerEntrymutations()
public
mutations() : array<int, QuantityStateDelta>
use deltas() instead