KMP PHP API Reference

BestowalFormService
in package

Prepares lookup data for bestowal edit and bulk edit forms.

Table of Contents

Properties

$courtSlotService  : BestowalCourtSlotService
$gatheringLookupService  : BestowalGatheringLookupService

Methods

__construct()  : mixed
buildFormRules()  : array<string, array<string, array<int, string>>>
Lifecycle bestowals expose no field-rule mapping.
buildStatusList()  : array<string, array<string, string>>
Lifecycle bestowals have no status/state dropdown options.
buildStatusMap()  : array<string, string>
Lifecycle bestowals expose no state-to-status mapping.
findLinkableRecommendations()  : array<int, string>
Find recommendations that may be linked to the bestowal.
prepareAdHocFormData()  : array<string, mixed>
Prepare view variables for the ad-hoc bestowal creation form.
prepareEditFormData()  : array<string, mixed>
Prepare view variables for a single bestowal edit form.

Properties

Methods

buildFormRules()

Lifecycle bestowals expose no field-rule mapping.

public buildFormRules() : array<string, array<string, array<int, string>>>
Return values
array<string, array<string, array<int, string>>>

buildStatusList()

Lifecycle bestowals have no status/state dropdown options.

public buildStatusList() : array<string, array<string, string>>
Return values
array<string, array<string, string>>

buildStatusMap()

Lifecycle bestowals expose no state-to-status mapping.

public buildStatusMap() : array<string, string>
Return values
array<string, string>

findLinkableRecommendations()

Find recommendations that may be linked to the bestowal.

public findLinkableRecommendations(Table $bestowalsTable, Bestowal $bestowal) : array<int, string>
Parameters
$bestowalsTable : Table

Bestowals table.

$bestowal : Bestowal

Loaded bestowal.

Return values
array<int, string>

Recommendation ID => label

prepareAdHocFormData()

Prepare view variables for the ad-hoc bestowal creation form.

public prepareAdHocFormData([Member|array<string|int, mixed>|null $member = null ]) : array<string, mixed>
Parameters
$member : Member|array<string|int, mixed>|null = null

Current user for timezone-aware labels.

Return values
array<string, mixed>

prepareEditFormData()

Prepare view variables for a single bestowal edit form.

public prepareEditFormData(Table $bestowalsTable, Bestowal $bestowal[, Member|array<string|int, mixed>|null $member = null ][, bool $includeRecommendationLinks = true ]) : array<string, mixed>
Parameters
$bestowalsTable : Table

Bestowals table.

$bestowal : Bestowal

Loaded bestowal entity.

$member : Member|array<string|int, mixed>|null = null

Current user for timezone-aware labels.

$includeRecommendationLinks : bool = true

Whether Crown-only recommendation link data should be loaded.

Return values
array<string, mixed>
On this page

Search results