KMP PHP API Reference

GatheringActivityService
in package

Gathering Activity Service

Manages business logic for gathering activities and their relationship to waiver requirements. Handles associating waiver types with activities.

Tags
see
https://github.com/Ansteorra/KMP/blob/main/docs/5.7-waivers-plugin.md

Table of Contents

Properties

$GatheringActivities  : GatheringActivitiesTable
GatheringActivities table instance
$GatheringActivityWaivers  : GatheringActivityWaiversTable
GatheringActivityWaivers table instance
$WaiverTypes  : WaiverTypesTable
WaiverTypes table instance

Methods

__construct()  : mixed
Constructor - initializes table instances
addWaiverRequirement()  : ServiceResult
Add waiver requirement to an activity
getRequiredWaiverTypes()  : ServiceResult
Get required waiver types for an activity
removeWaiverRequirement()  : ServiceResult
Remove waiver requirement from an activity

Properties

Methods

addWaiverRequirement()

Add waiver requirement to an activity

public addWaiverRequirement(int $activityId, int $waiverTypeId) : ServiceResult
Parameters
$activityId : int

Gathering activity ID

$waiverTypeId : int

Waiver type ID

Return values
ServiceResult

Success or failure

getRequiredWaiverTypes()

Get required waiver types for an activity

public getRequiredWaiverTypes(int $activityId) : ServiceResult
Parameters
$activityId : int

Gathering activity ID

Return values
ServiceResult

Success with array of WaiverType entities

removeWaiverRequirement()

Remove waiver requirement from an activity

public removeWaiverRequirement(int $activityId, int $waiverTypeId) : ServiceResult
Parameters
$activityId : int

Gathering activity ID

$waiverTypeId : int

Waiver type ID

Return values
ServiceResult

Success or failure

On this page

Search results