KMP PHP API Reference

Bestowal extends BaseEntity
in package
implements ActionItemOwnerInterface

Bestowal Entity - Award presentation workflow.

Carries a minimal lifecycle_status (open|given|cancelled). Operational progress (scroll prep, court scheduling, confirmation) is tracked separately by the parallel to-do checklist subsystem.

Table of Contents

Interfaces

ActionItemOwnerInterface
Optional lifecycle contract for persisted entities that own ActionItems.

Constants

ACTION_ITEM_ENTITY_TYPE  : mixed = 'Awards.Bestowals'
Polymorphic owner type used when materializing bestowal to-dos as ActionItems.
LIFECYCLE_CANCELLED  : mixed = 'cancelled'
LIFECYCLE_GIVEN  : mixed = 'given'
LIFECYCLE_OPEN  : mixed = 'open'
Minimal lifecycle that replaces the legacy status/state machine.
LIFECYCLE_STATUSES  : mixed = [self::LIFECYCLE_OPEN, self::LIFECYCLE_GIVEN, s...
SOURCE_AD_HOC  : mixed = 'ad_hoc'
SOURCE_RECOMMENDATION  : mixed = 'recommendation'

Properties

$award  : Award|null
$award_id  : int|null
$bestowal_recommendations  : array<string|int, BestowalRecommendation>
$bestowed_at  : DateTime|null
$branch_id  : int|null
$call_into_court  : string|null
$close_reason  : string|null
$court_availability  : string|null
$created  : DateTime
$created_by  : int|null
$deleted  : DateTime|null
$gathering  : Gathering|null
$gathering_id  : int|null
$gathering_scheduled_activity  : GatheringScheduledActivity|null
$gathering_scheduled_activity_id  : int|null
$herald_notes  : string|null
$id  : int
$lifecycle_status  : string
$member  : Member
$member_id  : int|null
$member_sca_name  : string
$modified  : DateTime|null
$modified_by  : int|null
$noble_notes  : string|null
$person_to_notify  : string|null
$primary_recommendation  : Recommendation|null
$primary_recommendation_id  : int|null
$reason_summary  : string|null
$recommendations  : array<string|int, Recommendation>
$roaming_court  : bool
$source  : string
$source_approval_run_id  : int|null
$specialty  : string|null
$stack_rank  : int
$todo_template_signature  : string|null
$_accessible  : array<string, bool>

Methods

actionItemReadOnlyReason()  : string
Bestowal To-Dos are immutable after the bestowal becomes terminal.
allowsActionItemMutations()  : bool
Whether checklist transitions remain permitted.
getBranchId()  : int|null
Get the branch ID from the associated award.
isActiveBestowal()  : bool
Whether this bestowal is still active (lifecycle still open).
_setBestowedAt()  : DateTime|DateTime|null
Handle date format conversion for bestowed_at.

Constants

ACTION_ITEM_ENTITY_TYPE

Polymorphic owner type used when materializing bestowal to-dos as ActionItems.

public mixed ACTION_ITEM_ENTITY_TYPE = 'Awards.Bestowals'

LIFECYCLE_CANCELLED

public mixed LIFECYCLE_CANCELLED = 'cancelled'

LIFECYCLE_GIVEN

public mixed LIFECYCLE_GIVEN = 'given'

LIFECYCLE_OPEN

Minimal lifecycle that replaces the legacy status/state machine.

public mixed LIFECYCLE_OPEN = 'open'

LIFECYCLE_STATUSES

public mixed LIFECYCLE_STATUSES = [self::LIFECYCLE_OPEN, self::LIFECYCLE_GIVEN, self::LIFECYCLE_CANCELLED]

SOURCE_AD_HOC

public mixed SOURCE_AD_HOC = 'ad_hoc'

SOURCE_RECOMMENDATION

public mixed SOURCE_RECOMMENDATION = 'recommendation'

Properties

$bestowed_at

public DateTime|null $bestowed_at

$branch_id

public int|null $branch_id

Associated branch ID (when applicable)

$call_into_court

public string|null $call_into_court

$close_reason

public string|null $close_reason

$court_availability

public string|null $court_availability

$gathering_id

public int|null $gathering_id

$gathering_scheduled_activity_id

public int|null $gathering_scheduled_activity_id

$herald_notes

public string|null $herald_notes

$lifecycle_status

public string $lifecycle_status

$member_sca_name

public string $member_sca_name

$modified_by

public int|null $modified_by

$noble_notes

public string|null $noble_notes

$person_to_notify

public string|null $person_to_notify

$primary_recommendation_id

public int|null $primary_recommendation_id

$reason_summary

public string|null $reason_summary

$roaming_court

public bool $roaming_court

$source_approval_run_id

public int|null $source_approval_run_id

$todo_template_signature

public string|null $todo_template_signature

$_accessible

protected array<string, bool> $_accessible = ['member_id' => true, 'member_sca_name' => true, 'gathering_id' => true, 'gathering_scheduled_activity_id' => true, 'roaming_court' => true, 'primary_recommendation_id' => true, 'award_id' => true, 'specialty' => true, 'lifecycle_status' => true, 'stack_rank' => true, 'bestowed_at' => true, 'source' => true, 'source_approval_run_id' => true, 'todo_template_signature' => true, 'noble_notes' => true, 'herald_notes' => true, 'reason_summary' => true, 'call_into_court' => true, 'court_availability' => true, 'person_to_notify' => true, 'close_reason' => true, 'modified' => true, 'created' => true, 'created_by' => true, 'modified_by' => true, 'deleted' => true, 'member' => true, 'gathering' => true, 'gathering_scheduled_activity' => true, 'primary_recommendation' => true, 'award' => true, 'recommendations' => true, 'bestowal_recommendations' => true]

Methods

actionItemReadOnlyReason()

Bestowal To-Dos are immutable after the bestowal becomes terminal.

public actionItemReadOnlyReason() : string
Return values
string

allowsActionItemMutations()

Whether checklist transitions remain permitted.

public allowsActionItemMutations() : bool
Return values
bool

getBranchId()

Get the branch ID from the associated award.

public getBranchId() : int|null
Return values
int|null —

Branch ID or null if not determinable.

isActiveBestowal()

Whether this bestowal is still active (lifecycle still open).

public isActiveBestowal() : bool
Return values
bool

_setBestowedAt()

Handle date format conversion for bestowed_at.

protected _setBestowedAt(mixed $value) : DateTime|DateTime|null
Parameters
$value : mixed

Date value

Return values
DateTime|DateTime|null
On this page

Search results