3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
30 * Class CRM_Contact_ActionMapping
32 * This defines the scheduled-reminder functionality for contact
33 * entities. It is useful for, e.g., sending a reminder based on
34 * birth date, modification date, or other custom dates on
37 class CRM_Contact_ActionMapping
extends \Civi\ActionSchedule\Mapping
{
40 * The value for civicrm_action_schedule.mapping_id which identifies the
43 * Note: This value is chosen to match legacy DB IDs.
45 const CONTACT_MAPPING_ID
= 6;
48 * Register Contact-related action mappings.
50 * @param \Civi\ActionSchedule\Event\MappingRegisterEvent $registrations
52 public static function onRegisterActionMappings(\Civi\ActionSchedule\Event\MappingRegisterEvent
$registrations) {
53 $registrations->register(CRM_Contact_ActionMapping
::create([
54 'id' => CRM_Contact_ActionMapping
::CONTACT_MAPPING_ID
,
55 'entity' => 'civicrm_contact',
56 'entity_label' => ts('Contact'),
57 'entity_value' => 'civicrm_contact',
58 'entity_value_label' => ts('Date Field'),
59 'entity_status' => 'contact_date_reminder_options',
60 'entity_status_label' => ts('Annual Options'),
61 'entity_date_start' => 'date_field',
65 private $contactDateFields = [
72 * Determine whether a schedule based on this mapping is sufficiently
75 * @param \CRM_Core_DAO_ActionSchedule $schedule
77 * Array (string $code => string $message).
78 * List of error messages.
80 public function validateSchedule($schedule) {
82 if (CRM_Utils_System
::isNull($schedule->entity_value
) ||
$schedule->entity_value
=== '0') {
83 $errors['entity'] = ts('Please select a specific date field.');
85 elseif (count(CRM_Utils_Array
::explodePadded($schedule->entity_value
)) > 1) {
86 $errors['entity'] = ts('You may only select one contact field per reminder');
88 elseif (CRM_Utils_System
::isNull($schedule->entity_status
) ||
$schedule->entity_status
=== '0') {
89 $errors['entity'] = ts('Please select whether the reminder is sent each year.');
96 * Generate a query to locate recipients who match the given
99 * @param \CRM_Core_DAO_ActionSchedule $schedule
100 * The schedule as configured by the administrator.
101 * @param string $phase
102 * See, e.g., RecipientBuilder::PHASE_RELATION_FIRST.
103 * @param array $defaultParams
105 * @return \CRM_Utils_SQL_Select
106 * @throws \CRM_Core_Exception
107 * @see RecipientBuilder
109 public function createQuery($schedule, $phase, $defaultParams) {
110 $selectedValues = (array) \CRM_Utils_Array
::explodePadded($schedule->entity_value
);
111 $selectedStatuses = (array) \CRM_Utils_Array
::explodePadded($schedule->entity_status
);
113 // FIXME: This assumes that $values only has one field, but UI shows multiselect.
114 // Properly supporting multiselect would require total rewrite of this function.
115 if (count($selectedValues) != 1 ||
!isset($selectedValues[0])) {
116 throw new \
CRM_Core_Exception("Error: Scheduled reminders may only have one contact field.");
118 elseif (in_array($selectedValues[0], $this->contactDateFields
)) {
119 $dateDBField = $selectedValues[0];
120 $query = \CRM_Utils_SQL_Select
::from("{$this->entity} e")->param($defaultParams);
122 'casAddlCheckFrom' => 'civicrm_contact e',
123 'casContactIdField' => 'e.id',
124 'casEntityIdField' => 'e.id',
125 'casContactTableAlias' => 'e',
127 $query->where('e.is_deleted = 0 AND e.is_deceased = 0');
131 $customFieldParams = ['id' => substr($selectedValues[0], 7)];
132 $customGroup = $customField = [];
133 \CRM_Core_BAO_CustomField
::retrieve($customFieldParams, $customField);
134 $dateDBField = $customField['column_name'];
135 $customGroupParams = ['id' => $customField['custom_group_id'], $customGroup];
136 \CRM_Core_BAO_CustomGroup
::retrieve($customGroupParams, $customGroup);
137 $query = \CRM_Utils_SQL_Select
::from("{$customGroup['table_name']} e")->param($defaultParams);
139 'casAddlCheckFrom' => "{$customGroup['table_name']} e",
140 'casContactIdField' => 'e.entity_id',
141 'casEntityIdField' => 'e.id',
142 'casContactTableAlias' => NULL,
144 // possible to have no "where" in this case
148 $query['casDateField'] = 'e.' . $dateDBField;
150 if (in_array(2, $selectedStatuses)) {
151 $query['casAnniversaryMode'] = 1;
152 $query['casDateField'] = 'DATE_ADD(' . $query['casDateField'] . ', INTERVAL ROUND(DATEDIFF(DATE(' . $query['casNow'] . '), ' . $query['casDateField'] . ') / 365) YEAR)';