MappingInterface
interface MappingInterface
Interface MappingInterface
Methods
No description
No description
Get a printable label for this mapping type.
Get a printable label to use as the header on the 'value' filter.
Get a printable label to use as the header on the 'status' filter.
Get a list of value options.
Get a list of status options.
Get a list of available date fields.
Get a list of recipient types.
Get a list of recipients which match the given type.
Determine whether a schedule based on this mapping is sufficiently complete.
Generate a query to locate contacts who match the given schedule.
Determine whether a schedule based on this mapping should reset the reminder state if the trigger date changes.
Details
at line 39
mixed
getId()
at line 44
string
getEntity()
at line 51
string
getLabel()
Get a printable label for this mapping type.
at line 58
string
getValueHeader()
Get a printable label to use as the header on the 'value' filter.
at line 65
string
getStatusHeader()
Get a printable label to use as the header on the 'status' filter.
at line 74
array
getValueLabels()
Get a list of value options.
at line 86
array
getStatusLabels(string|int $value)
Get a list of status options.
at line 94
array
getDateFields()
Get a list of available date fields.
at line 106
array
getRecipientTypes()
Get a list of recipient types.
Note: A single schedule may filter on zero or one recipient types. When an admin chooses a value, it's stored in $schedule->recipient.
at line 121
array
getRecipientListing(string $recipientType)
Get a list of recipients which match the given type.
Note: A single schedule may filter on multiple recipients. When an admin chooses value(s), it's stored in $schedule->recipient_listing.
at line 132
array
validateSchedule(CRM_Core_DAO_ActionSchedule $schedule)
Determine whether a schedule based on this mapping is sufficiently complete.
at line 146
CRM_Utils_SQL_Select
createQuery(CRM_Core_DAO_ActionSchedule $schedule, string $phase, array $defaultParams)
Generate a query to locate contacts who match the given schedule.
at line 156
bool
resetOnTriggerDateChange(CRM_Core_DAO_ActionSchedule $schedule)
Determine whether a schedule based on this mapping should reset the reminder state if the trigger date changes.