KMP PHP API Reference

Award extends BaseEntity
in package

Award Entity - Individual award configuration with hierarchical organization.

Awards are organized by Domain (category), Level (precedence), and Branch (scope).

Table of Contents

Properties

$abbreviation  : string|null
$approval_process  : ApprovalProcess|null
$approval_process_id  : int|null
$awards_domain  : Domain
$awards_level  : Level
$badge  : string|null
$bestowal_todo_template  : BestowalTodoTemplate|null
$bestowal_todo_template_id  : int|null
$branch  : Branch
$branch_id  : int
$charter  : string|null
$close_date  : DateTime|null
$created  : DateTime
$created_by  : int|null
$deleted  : DateTime|null
$description  : string|null
$disabled  : bool
$disabled_label  : string
$domain_id  : int
$gathering_activities  : array<string|int, GatheringActivity>
$id  : int
$insignia  : string|null
$is_active  : bool
$level_id  : int
$modified  : DateTime|null
$modified_by  : int|null
$name  : string
$open_date  : DateTime|null
$specialties  : string|null
$_accessible  : array<string, bool>

Methods

getBranchId()  : int|null
Get the branch ID for authorization checks.
_getBranchName()  : string|null
Get the branch name for grid display
_getDisabled()  : bool
Get disabled status for grid and form display.
_getDisabledLabel()  : string
Get disabled status label for grid display.
_getDomainName()  : string|null
Get the domain name for grid display
_getLevelName()  : string|null
Get the level name for grid display

Properties

$abbreviation

public string|null $abbreviation

$approval_process_id

public int|null $approval_process_id

$badge

public string|null $badge

$bestowal_todo_template_id

public int|null $bestowal_todo_template_id

$branch_id

public int $branch_id

$charter

public string|null $charter

$close_date

public DateTime|null $close_date

$created

public DateTime $created

$created_by

public int|null $created_by

$deleted

public DateTime|null $deleted

$description

public string|null $description

$disabled

public bool $disabled

$disabled_label

public string $disabled_label

$domain_id

public int $domain_id

$insignia

public string|null $insignia

$is_active

public bool $is_active

$level_id

public int $level_id

$modified

public DateTime|null $modified

$modified_by

public int|null $modified_by

$open_date

public DateTime|null $open_date

$specialties

public string|null $specialties

$_accessible

protected array<string, bool> $_accessible = ['name' => true, 'specialties' => true, 'abbreviation' => true, 'description' => true, 'insignia' => true, 'badge' => true, 'charter' => true, 'domain_id' => true, 'level_id' => true, 'branch_id' => true, 'approval_process_id' => true, 'bestowal_todo_template_id' => true, 'is_active' => true, 'modified' => true, 'created' => true, 'created_by' => true, 'modified_by' => true, 'deleted' => true, 'awards_domain' => true, 'awards_level' => true, 'branch' => true, 'approval_process' => true, 'bestowal_todo_template' => true, 'gathering_activities' => true]

Methods

getBranchId()

Get the branch ID for authorization checks.

public getBranchId() : int|null

Child classes should override for complex branch relationships.

Return values
int|null —

The branch ID, or null if no association

_getBranchName()

Get the branch name for grid display

protected _getBranchName() : string|null
Return values
string|null

_getDisabled()

Get disabled status for grid and form display.

protected _getDisabled() : bool
Return values
bool

_getDisabledLabel()

Get disabled status label for grid display.

protected _getDisabledLabel() : string
Return values
string

_getDomainName()

Get the domain name for grid display

protected _getDomainName() : string|null
Return values
string|null

_getLevelName()

Get the level name for grid display

protected _getLevelName() : string|null
Return values
string|null
On this page

Search results