CRM_Contribute_ActionMapping_ByPage
extends CRM_Contribute_ActionMapping
in package
Class CRM_Contribute_ActionMapping_ByPage
This defines the scheduled-reminder functionality for contribution entities. It is useful for sending a reminder based on:
- The receipt-date, cancel-date, or thankyou-date.
- The page on which the contribution was made.
Table of Contents
Methods
- createQuery() : CRM_Utils_SQL_Select
- Generate a query to locate contacts who match the given schedule.
- getLabel() : string
- Get a printable label for this mapping type.
- getName() : string
- getValueLabels() : array<string|int, mixed>
- Get a list of value options.
- modifyApiSpec() : mixed
Methods
createQuery()
Generate a query to locate contacts who match the given schedule.
public
createQuery(CRM_Core_DAO_ActionSchedule $schedule, string $phase, array<string|int, mixed> $defaultParams) : CRM_Utils_SQL_Select
Parameters
- $schedule : CRM_Core_DAO_ActionSchedule
- $phase : string
-
See, e.g., RecipientBuilder::PHASE_RELATION_FIRST.
- $defaultParams : array<string|int, mixed>
-
Default parameters that should be included with query.
Tags
Return values
CRM_Utils_SQL_SelectgetLabel()
Get a printable label for this mapping type.
public
getLabel() : string
Return values
stringgetName()
public
getName() : string
Return values
stringgetValueLabels()
Get a list of value options.
public
getValueLabels() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Array(string $value => string $label). Ex: array(123 => 'Phone Call', 456 => 'Meeting').
modifyApiSpec()
public
modifyApiSpec(RequestSpec $spec) : mixed
Parameters
- $spec : RequestSpec