FlowContext
in package
Runtime context object passed to policies during one flow step.
Table of Contents
Properties
- $context : array<string|int, mixed>
- $edges : array<string|int, mixed>
- $inventory : QuantityState
- $quantity : int|float
- $space : SlotSpace
- $subject : mixed
Methods
- __construct() : mixed
- slotAttribute() : mixed
- Read one remembered slot attribute with an optional default.
- slotAttributes() : array<string, mixed>
- Return remembered attributes for one slot in the current inventory.
Properties
$context read-only
public
array<string|int, mixed>
$context
= []
$edges read-only
public
array<string|int, mixed>
$edges
$inventory read-only
public
QuantityState
$inventory
$quantity read-only
public
int|float
$quantity
$space read-only
public
SlotSpace
$space
$subject read-only
public
mixed
$subject
= null
Methods
__construct()
public
__construct(SlotSpace $space, array<int, MovementEdge> $edges, QuantityState $inventory, int|float $quantity[, mixed $subject = null ][, array<string|int, mixed> $context = [] ]) : mixed
Parameters
- $space : SlotSpace
- $edges : array<int, MovementEdge>
- $inventory : QuantityState
- $quantity : int|float
- $subject : mixed = null
- $context : array<string|int, mixed> = []
slotAttribute()
Read one remembered slot attribute with an optional default.
public
slotAttribute(Slot $slot, string $name[, mixed $default = null ]) : mixed
Parameters
- $slot : Slot
- $name : string
- $default : mixed = null
slotAttributes()
Return remembered attributes for one slot in the current inventory.
public
slotAttributes(Slot $slot) : array<string, mixed>
Parameters
- $slot : Slot