KMP PHP API Reference

WaiverDashboardService
in package

Waiver Dashboard Service

Aggregates metrics and data for the waiver secretary dashboard: statistics, calendar data, gatherings needing waivers, and compliance tracking.

Table of Contents

Methods

getBranchesWithIssues()  : array<string|int, mixed>
Get branches with compliance issues.
getCalendarData()  : array<string|int, mixed>
Build calendar data for gatherings in a given month.
getClosedGatherings()  : array<string|int, mixed>
Get recently closed gatherings.
getDashboardStatistics()  : array<string|int, mixed>
Get dashboard statistics.
getGatheringsNeedingClosed()  : array<string|int, mixed>
Get gatherings that need to be closed (have waivers uploaded but not yet closed).
getGatheringsReadyToClose()  : array<string|int, mixed>
Get gatherings that have been marked ready to close by event staff.
getGatheringsWithIncompleteWaivers()  : array<string|int, mixed>
Get gatherings with incomplete waivers, separated by status.
getNeedingWaiversData()  : array<string|int, mixed>
Get needingWaivers data: gatherings that need waivers uploaded.
getRecentWaiverActivity()  : array<string|int, mixed>
Get recent waiver activity.
getWaiverTypesSummary()  : array<string|int, mixed>
Get summary of waivers by type.
searchWaivers()  : array<string|int, mixed>
Search for waivers across all accessible gatherings.

Methods

getBranchesWithIssues()

Get branches with compliance issues.

public getBranchesWithIssues(array<string|int, mixed> $branchIds) : array<string|int, mixed>
Parameters
$branchIds : array<string|int, mixed>

Branches to check

Return values
array<string|int, mixed>

Branches with issue counts

getCalendarData()

Build calendar data for gatherings in a given month.

public getCalendarData(int $year, int $month, array<string|int, mixed> $branchIds, mixed $currentUser) : array<string|int, mixed>
Parameters
$year : int

Calendar year

$month : int

Calendar month (1-12)

$branchIds : array<string|int, mixed>

Branches the user can access

$currentUser : mixed

Current user identity for timezone

Return values
array<string|int, mixed>

Calendar data with events

getClosedGatherings()

Get recently closed gatherings.

public getClosedGatherings(array<string|int, mixed> $branchIds) : array<string|int, mixed>
Parameters
$branchIds : array<string|int, mixed>

Branches to check

Return values
array<string|int, mixed>

Closed gatherings with closure details

getDashboardStatistics()

Get dashboard statistics.

public getDashboardStatistics(array<string|int, mixed> $branchIds) : array<string|int, mixed>
Parameters
$branchIds : array<string|int, mixed>

Branches to include in statistics

Return values
array<string|int, mixed>

Statistics data

getGatheringsNeedingClosed()

Get gatherings that need to be closed (have waivers uploaded but not yet closed).

public getGatheringsNeedingClosed(array<string|int, mixed> $branchIds) : array<string|int, mixed>
Parameters
$branchIds : array<string|int, mixed>

Branches to check

Return values
array<string|int, mixed>

Gatherings needing closure

getGatheringsReadyToClose()

Get gatherings that have been marked ready to close by event staff.

public getGatheringsReadyToClose(array<string|int, mixed> $branchIds) : array<string|int, mixed>
Parameters
$branchIds : array<string|int, mixed>

Branches the user can access

Return values
array<string|int, mixed>

Gatherings ready to close

getGatheringsWithIncompleteWaivers()

Get gatherings with incomplete waivers, separated by status.

public getGatheringsWithIncompleteWaivers(array<string|int, mixed> $branchIds, int $daysAhead) : array<string|int, mixed>
Parameters
$branchIds : array<string|int, mixed>

Branches to check

$daysAhead : int

How many days ahead to look for upcoming events

Return values
array<string|int, mixed>

Array with 'missing' and 'upcoming' keys

getNeedingWaiversData()

Get needingWaivers data: gatherings that need waivers uploaded.

public getNeedingWaiversData(array<string|int, mixed> $branchIds, array<string|int, mixed> $stewardGatheringIds) : array<string|int, mixed>
Parameters
$branchIds : array<string|int, mixed>

Branch IDs user can access

$stewardGatheringIds : array<string|int, mixed>

Gathering IDs where user is steward

Return values
array<string|int, mixed>

With 'gatherings' and 'incompleteCount' keys

getRecentWaiverActivity()

Get recent waiver activity.

public getRecentWaiverActivity(array<string|int, mixed> $branchIds, int $days) : array<string|int, mixed>
Parameters
$branchIds : array<string|int, mixed>

Branches to include

$days : int

Days to look back

Return values
array<string|int, mixed>

Recent waivers

getWaiverTypesSummary()

Get summary of waivers by type.

public getWaiverTypesSummary(array<string|int, mixed> $branchIds) : array<string|int, mixed>
Parameters
$branchIds : array<string|int, mixed>

Branches to include

Return values
array<string|int, mixed>

Waiver type counts

searchWaivers()

Search for waivers across all accessible gatherings.

public searchWaivers(string $searchTerm, array<string|int, mixed> $branchIds) : array<string|int, mixed>
Parameters
$searchTerm : string

Search term

$branchIds : array<string|int, mixed>

Branches the user can access

Return values
array<string|int, mixed>

Search results


        
On this page

Search results