CRM_Member_StatusOverrideTypes
in package
Membership status override types.
Tags
Table of Contents
Constants
- NO = 0
- The membership status is not overridden and its is subject to membership status rules.
- PERMANENT = 1
- The membership will stay at the selected status and its status is NOT subject to membership status rules.
- UNTIL_DATE = 2
- The membership status will stay at the selected status and it is NOT subject to membership status rules.
Methods
- getSelectOptions() : array<string|int, mixed>
- Gets the list of override types as a list of options to be used for select input.
- isNo() : mixed
- isOverridden() : bool
- Determines if the override type means that the membership is overridden or not.
- isPermanent() : mixed
- isUntilDate() : mixed
Constants
NO
The membership status is not overridden and its is subject to membership status rules.
public
mixed
NO
= 0
PERMANENT
The membership will stay at the selected status and its status is NOT subject to membership status rules.
public
mixed
PERMANENT
= 1
UNTIL_DATE
The membership status will stay at the selected status and it is NOT subject to membership status rules.
public
mixed
UNTIL_DATE
= 2
However, on the selected date(status_override_end_date), the status override type will automatically change to "NO" thus then the membership becomes subject to membership status rules.
Methods
getSelectOptions()
Gets the list of override types as a list of options to be used for select input.
public
static getSelectOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —In ['Type 1 Value' => 'Type 1 Label'] format
isNo()
public
static isNo(mixed $overrideType) : mixed
Parameters
- $overrideType : mixed
isOverridden()
Determines if the override type means that the membership is overridden or not.
public
static isOverridden(mixed $overrideType) : bool
For now, only "NO" type means that the membership status is not overridden.
Parameters
- $overrideType : mixed
Return values
boolisPermanent()
public
static isPermanent(mixed $overrideType) : mixed
Parameters
- $overrideType : mixed
isUntilDate()
public
static isUntilDate(mixed $overrideType) : mixed
Parameters
- $overrideType : mixed