KMP PHP API Reference

BestowalNotesSupportTrait

Builds bestowal note text from linked recommendations.

Table of Contents

Methods

buildHeraldNotes()  : string|null
Build herald-oriented call text from linked recommendations.
buildNobleNotes()  : string|null
Summarize recommendation reasons for crown-facing notes.
buildReasonSummary()  : string|null
Build a persisted summary of linked recommendation reasons and submitters.
buildSpecialtySummary()  : string|null
Build the bestowal specialty from unique linked recommendation specialties.
formatAwardLabel()  : string
Format an award label with optional level for note text.
formatBestowalAwardLabel()  : string
Format the award selected on a bestowal for note and notification text.

Methods

buildHeraldNotes()

Build herald-oriented call text from linked recommendations.

protected buildHeraldNotes(array<int, Recommendation$recommendations, string $memberScaName) : string|null
Parameters
$recommendations : array<int, Recommendation>

Linked recommendations.

$memberScaName : string

Recipient SCA name.

Return values
string|null

buildNobleNotes()

Summarize recommendation reasons for crown-facing notes.

protected buildNobleNotes(array<int, Recommendation$recommendations) : string|null
Parameters
$recommendations : array<int, Recommendation>

Linked recommendations.

Return values
string|null

buildReasonSummary()

Build a persisted summary of linked recommendation reasons and submitters.

protected buildReasonSummary(array<int, Recommendation$recommendations) : string|null
Parameters
$recommendations : array<int, Recommendation>

Linked recommendations.

Return values
string|null

buildSpecialtySummary()

Build the bestowal specialty from unique linked recommendation specialties.

protected buildSpecialtySummary(array<int, Recommendation$recommendations) : string|null
Parameters
$recommendations : array<int, Recommendation>

Linked recommendations.

Return values
string|null

formatAwardLabel()

Format an award label with optional level for note text.

protected formatAwardLabel(Recommendation $recommendation) : string
Parameters
$recommendation : Recommendation

Recommendation with optional award contain.

Return values
string

formatBestowalAwardLabel()

Format the award selected on a bestowal for note and notification text.

protected formatBestowalAwardLabel(Bestowal $bestowal) : string
Parameters
$bestowal : Bestowal

Bestowal with optional award contain.

Return values
string
On this page

Search results