BatchMovementEngine
in package
FinalYes
Executes one flow across all items in a quantity-state batch.
Table of Contents
Properties
Methods
- __construct() : mixed
- execute() : QuantityStateBatch
- Executes a batch of quantity-state movements.
Properties
$engine
private
MovementEngine
$engine
Methods
__construct()
public
__construct(MovementEngine $engine) : mixed
Parameters
- $engine : MovementEngine
execute()
Executes a batch of quantity-state movements.
public
execute(QuantityStateBatch $batch, SlotSpace $space, string|Flow $cascade[, array<string|int, mixed> $context = [] ][, array<string, scalar|null> $params = [] ]) : QuantityStateBatch
Parameters
- $batch : QuantityStateBatch
-
the batch of quantity-state items to move
- $space : SlotSpace
-
the slot space used to resolve flow steps
- $cascade : string|Flow
-
the flow containing the movement rules
- $context : array<string|int, mixed> = []
-
execution context forwarded to the movement engine
- $params : array<string, scalar|null> = []
-
flow parameter substitutions forwarded to the movement engine
Tags
Return values
QuantityStateBatch —the batch with updated movement results for each item