WarrantPeriod
extends BaseEntity
in package
WarrantPeriod Entity - Warrant Period Templates
Defines temporal boundaries for warrant activation/expiration. Used as templates for consistent warrant durations and integrates with warrant roster workflows.
Table of Contents
Properties
- $branch_id : int|null
- $created : DateTime
- $created_by : int|null
- $end_date : DateTime
- $id : int
- $modified : DateTime|null
- $name : string
- $start_date : DateTime
- $_accessible : array<string, bool>
Methods
- getBranchId() : int|null
- Get the branch ID for authorization checks.
- _getName() : string
- Virtual property: formatted period display name.
Properties
$branch_id
public
int|null
$branch_id
Associated branch ID (when applicable)
$created
public
DateTime
$created
Creation timestamp
$created_by
public
int|null
$created_by
Creator member ID
$end_date
public
DateTime
$end_date
Period end date
$id
public
int
$id
Primary key
$modified
public
DateTime|null
$modified
Last modification timestamp
$name
public
string
$name
Virtual: formatted "start_date ~ end_date"
$start_date
public
DateTime
$start_date
Period start date
$_accessible
protected
array<string, bool>
$_accessible
= [
'start_date' => true,
// Warrant period start date
'end_date' => true,
// Warrant period end date
'created' => true,
// Creation timestamp
'created_by' => true,
]
Mass assignment fields
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
_getName()
Virtual property: formatted period display name.
protected
_getName() : string
Return values
string —"YYYY-MM-DD ~ YYYY-MM-DD" format