WaiverType
extends BaseEntity
in package
WaiverType Entity
Defines types of waivers with retention policies.
Table of Contents
Properties
- $branch_id : int|null
- $convert_to_pdf : bool
- $created : DateTime
- $description : string|null
- $document : Document|null
- $document_id : int|null
- $exemption_reasons : string|null
- $exemption_reasons_parsed : array<string|int, mixed>|null
- $gathering_activity_waivers : array<string|int, GatheringActivityWaiver>
- $gathering_waivers : array<string|int, GatheringWaiver>
- $id : int
- $is_active : bool
- $modified : DateTime
- $name : string
- $retention_description : string
- $retention_policy : string
- $retention_policy_parsed : array<string|int, mixed>|null
- $template_path : string|null
- $_accessible : array<string, bool>
- Fields that can be mass assigned using newEntity() or patchEntity().
- $_virtual : array<string|int, string>
- Virtual fields that should be included in array/JSON representations
Methods
- getBranchId() : int|null
- Get the branch ID for authorization checks.
- _getExemptionReasonsParsed() : array<string|int, mixed>
- Virtual field for parsed exemption reasons
- _getRetentionDescription() : string
- Virtual field for human-readable retention policy description
- _getRetentionPolicyParsed() : array<string|int, mixed>|null
- Virtual field for parsed retention policy
Properties
$branch_id
public
int|null
$branch_id
Associated branch ID (when applicable)
$convert_to_pdf
public
bool
$convert_to_pdf
$created
public
DateTime
$created
$description
public
string|null
$description
$document
public
Document|null
$document
$document_id
public
int|null
$document_id
FK to documents table for uploaded templates
$exemption_reasons
public
string|null
$exemption_reasons
JSON array of reasons why waiver might not be needed
$exemption_reasons_parsed
public
array<string|int, mixed>|null
$exemption_reasons_parsed
Virtual field - parsed exemption reasons array
$gathering_activity_waivers
public
array<string|int, GatheringActivityWaiver>
$gathering_activity_waivers
$gathering_waivers
public
array<string|int, GatheringWaiver>
$gathering_waivers
$id
public
int
$id
$is_active
public
bool
$is_active
$modified
public
DateTime
$modified
$name
public
string
$name
$retention_description
public
string
$retention_description
Virtual field - human readable description
$retention_policy
public
string
$retention_policy
JSON-encoded retention policy
$retention_policy_parsed
public
array<string|int, mixed>|null
$retention_policy_parsed
Virtual field - parsed JSON
$template_path
public
string|null
$template_path
External URL to template (for SCA.org hosted files)
$_accessible
Fields that can be mass assigned using newEntity() or patchEntity().
protected
array<string, bool>
$_accessible
= ['name' => true, 'description' => true, 'document_id' => true, 'template_path' => true, 'retention_policy' => true, 'exemption_reasons' => true, 'convert_to_pdf' => true, 'is_active' => true, 'document' => true, 'gathering_activity_waivers' => true, 'gathering_waivers' => true, 'gathering_waiver_exemptions' => true]
$_virtual
Virtual fields that should be included in array/JSON representations
protected
array<string|int, string>
$_virtual
= ['retention_policy_parsed', 'retention_description', 'exemption_reasons_parsed']
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
_getExemptionReasonsParsed()
Virtual field for parsed exemption reasons
protected
_getExemptionReasonsParsed() : array<string|int, mixed>
Return values
array<string|int, mixed>_getRetentionDescription()
Virtual field for human-readable retention policy description
protected
_getRetentionDescription() : string
Return values
string_getRetentionPolicyParsed()
Virtual field for parsed retention policy
protected
_getRetentionPolicyParsed() : array<string|int, mixed>|null