KMP PHP API Reference

WaiverStateService
in package

Waiver State Service

Manages waiver collection lifecycle state transitions for gatherings: closing, reopening, marking ready-to-close, unmarking, and declining waivers.

Table of Contents

Methods

close()  : ServiceResult
Close waiver collection for a gathering.
decline()  : ServiceResult
Decline/reject an invalid waiver.
markReadyToClose()  : ServiceResult
Mark a gathering as ready for waiver secretary to close.
reopen()  : ServiceResult
Reopen waiver collection for a gathering.
unmarkReadyToClose()  : ServiceResult
Unmark a gathering as ready to close (reverts ready status).

Methods

close()

Close waiver collection for a gathering.

public close(int $gatheringId, int $closedBy) : ServiceResult
Parameters
$gatheringId : int

Gathering ID

$closedBy : int

User ID performing the close

Return values
ServiceResult

decline()

Decline/reject an invalid waiver.

public decline(int $waiverId, string $declineReason, int $declinedBy) : ServiceResult
Parameters
$waiverId : int

Waiver ID

$declineReason : string

Reason for declining

$declinedBy : int

User ID performing the decline

Return values
ServiceResult

markReadyToClose()

Mark a gathering as ready for waiver secretary to close.

public markReadyToClose(int $gatheringId, int $markedBy) : ServiceResult
Parameters
$gatheringId : int

Gathering ID

$markedBy : int

User ID performing the action

Return values
ServiceResult

unmarkReadyToClose()

Unmark a gathering as ready to close (reverts ready status).

public unmarkReadyToClose(int $gatheringId) : ServiceResult
Parameters
$gatheringId : int

Gathering ID

Return values
ServiceResult

        
On this page

Search results