ActiveWindowBaseEntity
extends BaseEntity
in package
AbstractYes
ActiveWindowBaseEntity Entity
Table of Contents
Constants
- CANCELLED_STATUS = 'Cancelled'
- CURRENT_STATUS = 'Current'
- DEACTIVATED_STATUS = 'Deactivated'
- EXPIRED_STATUS = 'Expired'
- RELEASED_STATUS = 'Released'
- REPLACED_STATUS = 'Replaced'
- UPCOMING_STATUS = 'Upcoming'
Properties
- $branch_id : int|null
- $created : DateTime|null
- $expires_on : Date|null
- $id : int
- $member_id : int
- $modified : DateTime|null
- $revoked_reason : string|null
- $revoker_id : int|null
- $start_on : Date|null
- $status : string
- $typeIdField : array<string|int, mixed>
Methods
- expire() : bool
- Stops an active window for an entity - save your entity after calling
- getBranchId() : int|null
- Get the branch ID for authorization checks.
- start() : bool
- Starts an active window for an entity - save your entity after calling
- _getExpiresOnToString() : mixed
- Get the expires on to string virtual field.
- _getStartOnToString() : mixed
- Get the start on to string virtual field.
Constants
CANCELLED_STATUS
public
mixed
CANCELLED_STATUS
= 'Cancelled'
CURRENT_STATUS
public
mixed
CURRENT_STATUS
= 'Current'
DEACTIVATED_STATUS
public
mixed
DEACTIVATED_STATUS
= 'Deactivated'
EXPIRED_STATUS
public
mixed
EXPIRED_STATUS
= 'Expired'
RELEASED_STATUS
public
mixed
RELEASED_STATUS
= 'Released'
REPLACED_STATUS
public
mixed
REPLACED_STATUS
= 'Replaced'
UPCOMING_STATUS
public
mixed
UPCOMING_STATUS
= 'Upcoming'
Properties
$branch_id
public
int|null
$branch_id
Associated branch ID (when applicable)
$created
public
DateTime|null
$created
Creation timestamp
$expires_on
public
Date|null
$expires_on
$id
public
int
$id
$member_id
public
int
$member_id
$modified
public
DateTime|null
$modified
Last modification timestamp
$revoked_reason
public
string|null
$revoked_reason
$revoker_id
public
int|null
$revoker_id
$start_on
public
Date|null
$start_on
$status
public
string
$status
$typeIdField
public
array<string|int, mixed>
$typeIdField
= []
Methods
expire()
Stops an active window for an entity - save your entity after calling
public
expire([Datetime $expiresOn = null ]) : bool
Parameters
- $expiresOn : Datetime = null
Return values
boolgetBranchId()
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
start()
Starts an active window for an entity - save your entity after calling
public
start([Datetime|null $startOn = null ][, Datetime|null $expiresOn = null ][, int|null $termYears = null ]) : bool
Parameters
- $startOn : Datetime|null = null
- $expiresOn : Datetime|null = null
- $termYears : int|null = null
Return values
bool_getExpiresOnToString()
Get the expires on to string virtual field.
protected
_getExpiresOnToString() : mixed
_getStartOnToString()
Get the start on to string virtual field.
protected
_getStartOnToString() : mixed