KMP PHP API Reference

WaiversWorkflowConditions
in package
uses WorkflowContextAwareTrait, LocatorAwareTrait

Workflow condition evaluators for the Waivers plugin.

Each method accepts workflow context and config, returns bool.

Table of Contents

Methods

hasUndeclinedWaivers()  : bool
Check if there are any outstanding undeclined waivers for a gathering.
isClosed()  : bool
Check if gathering waiver collection is closed.
isPastRetentionDate()  : bool
Check if waiver is past its retention date.
isReadyToClose()  : bool
Check if gathering waiver collection is marked ready to close.
resolveValue()  : mixed
Resolve a config value from context if it starts with '$.'.

Methods

hasUndeclinedWaivers()

Check if there are any outstanding undeclined waivers for a gathering.

public hasUndeclinedWaivers(array<string|int, mixed> $context, array<string|int, mixed> $config) : bool
Parameters
$context : array<string|int, mixed>

Current workflow context

$config : array<string|int, mixed>

Config with gatheringId

Return values
bool

isClosed()

Check if gathering waiver collection is closed.

public isClosed(array<string|int, mixed> $context, array<string|int, mixed> $config) : bool
Parameters
$context : array<string|int, mixed>

Current workflow context

$config : array<string|int, mixed>

Config with gatheringId

Return values
bool

isPastRetentionDate()

Check if waiver is past its retention date.

public isPastRetentionDate(array<string|int, mixed> $context, array<string|int, mixed> $config) : bool
Parameters
$context : array<string|int, mixed>

Current workflow context

$config : array<string|int, mixed>

Config with waiverId

Return values
bool

isReadyToClose()

Check if gathering waiver collection is marked ready to close.

public isReadyToClose(array<string|int, mixed> $context, array<string|int, mixed> $config) : bool
Parameters
$context : array<string|int, mixed>

Current workflow context

$config : array<string|int, mixed>

Config with gatheringId

Return values
bool

resolveValue()

Resolve a config value from context if it starts with '$.'.

protected resolveValue(mixed $value, array<string|int, mixed> $context) : mixed
Parameters
$value : mixed

Raw value or context path (e.g. '$.trigger.memberId')

$context : array<string|int, mixed>

Current workflow context

Return values
mixed

Resolved value

On this page

Search results