GatheringWaiver
extends BaseEntity
in package
GatheringWaiver Entity
Represents an uploaded waiver for a gathering OR an exemption (attestation that waiver was not needed). Waivers and exemptions are gathering-level and are not linked to specific activities.
Table of Contents
Properties
- $branch_id : int|null
- $created : DateTime
- $created_by : int
- $created_by_member : Member
- $decline_reason : string|null
- $declined_at : DateTime|null
- $declined_by : int|null
- $declined_by_member : Member
- $document : Document|null
- $document_id : int|null
- $exemption_reason : string|null
- $gathering : Gathering
- $gathering_id : int
- $id : int
- $is_exemption : bool
- $modified : DateTime
- $retention_date : Date
- $status : string
- $waiver_type : WaiverType
- $waiver_type_id : int
- $_accessible : array<string, bool>
- Fields that can be mass assigned using newEntity() or patchEntity().
Methods
- getBranchId() : int|null
- Get branch ID for authorization scoping
- _getCanBeDeclined() : bool
- Virtual field indicating if waiver can be declined
- _getIsActive() : bool
- Virtual field indicating if waiver is active
- _getIsDeclined() : bool
- Virtual field indicating if waiver is declined
- _getIsExpired() : bool
- Virtual field indicating if waiver is expired
- _getStatusBadgeClass() : string
- Virtual field for status badge class
- _getStatusDisplay() : string
- Virtual field for status display text
Properties
$branch_id
public
int|null
$branch_id
Associated branch ID (when applicable)
$created
public
DateTime
$created
$created_by
public
int
$created_by
$created_by_member
public
Member
$created_by_member
$decline_reason
public
string|null
$decline_reason
$declined_at
public
DateTime|null
$declined_at
$declined_by
public
int|null
$declined_by
$declined_by_member
public
Member
$declined_by_member
$document
public
Document|null
$document
$document_id
public
int|null
$document_id
$exemption_reason
public
string|null
$exemption_reason
$gathering
public
Gathering
$gathering
$gathering_id
public
int
$gathering_id
$id
public
int
$id
$is_exemption
public
bool
$is_exemption
$modified
public
DateTime
$modified
$retention_date
public
Date
$retention_date
$status
public
string
$status
$waiver_type
public
WaiverType
$waiver_type
$waiver_type_id
public
int
$waiver_type_id
$_accessible
Fields that can be mass assigned using newEntity() or patchEntity().
protected
array<string, bool>
$_accessible
= ['gathering_id' => true, 'waiver_type_id' => true, 'document_id' => true, 'is_exemption' => true, 'exemption_reason' => true, 'status' => true, 'retention_date' => true, 'created_by' => true, 'created' => true, 'modified' => true, 'declined_at' => true, 'declined_by' => true, 'decline_reason' => true, 'gathering' => true, 'waiver_type' => true, 'document' => true, 'created_by_member' => true, 'declined_by_member' => true]
Methods
getBranchId()
Get branch ID for authorization scoping
public
getBranchId() : int|null
Returns the branch ID of the hosting branch for this waiver's gathering. This enables proper authorization checks by allowing policies to determine which branch context the waiver belongs to.
The branch ID is obtained through the gathering relationship, which connects the waiver to its hosting branch. This supports the authorization system's requirement to check permissions based on organizational scope.
Return values
int|null —Branch ID from the gathering's hosting branch, or null if not determinable
_getCanBeDeclined()
Virtual field indicating if waiver can be declined
protected
_getCanBeDeclined() : bool
A waiver can be declined if:
- It has not already been declined
- It was created within the last 30 days
- It is not expired or deleted
Return values
bool_getIsActive()
Virtual field indicating if waiver is active
protected
_getIsActive() : bool
Return values
bool_getIsDeclined()
Virtual field indicating if waiver is declined
protected
_getIsDeclined() : bool
Return values
bool_getIsExpired()
Virtual field indicating if waiver is expired
protected
_getIsExpired() : bool
Return values
bool_getStatusBadgeClass()
Virtual field for status badge class
protected
_getStatusBadgeClass() : string
Return values
string_getStatusDisplay()
Virtual field for status display text
protected
_getStatusDisplay() : string