3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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 +--------------------------------------------------------------------+
28 use Civi\ActionSchedule\RecipientBuilder
;
31 * Class CRM_Contact_ActionMapping
33 * This defines the scheduled-reminder functionality for contact
34 * entities. It is useful for, e.g., sending a reminder based on
35 * birth date, modification date, or other custom dates on
38 class CRM_Contact_ActionMapping
extends \Civi\ActionSchedule\Mapping
{
41 * The value for civicrm_action_schedule.mapping_id which identifies the
44 * Note: This value is chosen to match legacy DB IDs.
46 const CONTACT_MAPPING_ID
= 6;
49 * Register Contact-related action mappings.
51 * @param \Civi\ActionSchedule\Event\MappingRegisterEvent $registrations
53 public static function onRegisterActionMappings(\Civi\ActionSchedule\Event\MappingRegisterEvent
$registrations) {
54 $registrations->register(CRM_Contact_ActionMapping
::create(array(
55 'id' => CRM_Contact_ActionMapping
::CONTACT_MAPPING_ID
,
56 'entity' => 'civicrm_contact',
57 'entity_label' => ts('Contact'),
58 'entity_value' => 'civicrm_contact',
59 'entity_value_label' => ts('Date Field'),
60 'entity_status' => 'contact_date_reminder_options',
61 'entity_status_label' => ts('Annual Options'),
62 'entity_date_start' => 'date_field',
66 private $contactDateFields = array(
73 * Determine whether a schedule based on this mapping is sufficiently
76 * @param \CRM_Core_DAO_ActionSchedule $schedule
78 * Array (string $code => string $message).
79 * List of error messages.
81 public function validateSchedule($schedule) {
83 if (CRM_Utils_System
::isNull($schedule->entity_value
) ||
$schedule->entity_value
=== '0') {
84 $errors['entity'] = ts('Please select a specific date field.');
86 elseif (count(CRM_Utils_Array
::explodePadded($schedule->entity_value
)) > 1) {
87 $errors['entity'] = ts('You may only select one contact field per reminder');
89 elseif (CRM_Utils_System
::isNull($schedule->entity_status
) ||
$schedule->entity_status
=== '0') {
90 $errors['entity'] = ts('Please select whether the reminder is sent each year.');
97 * Generate a query to locate recipients who match the given
100 * @param \CRM_Core_DAO_ActionSchedule $schedule
101 * The schedule as configured by the administrator.
102 * @param string $phase
103 * See, e.g., RecipientBuilder::PHASE_RELATION_FIRST.
104 * @param array $defaultParams
106 * @return \CRM_Utils_SQL_Select
107 * @throws \CRM_Core_Exception
108 * @see RecipientBuilder
110 public function createQuery($schedule, $phase, $defaultParams) {
111 $selectedValues = (array) \CRM_Utils_Array
::explodePadded($schedule->entity_value
);
112 $selectedStatuses = (array) \CRM_Utils_Array
::explodePadded($schedule->entity_status
);
114 // FIXME: This assumes that $values only has one field, but UI shows multiselect.
115 // Properly supporting multiselect would require total rewrite of this function.
116 if (count($selectedValues) != 1 ||
!isset($selectedValues[0])) {
117 throw new \
CRM_Core_Exception("Error: Scheduled reminders may only have one contact field.");
119 elseif (in_array($selectedValues[0], $this->contactDateFields
)) {
120 $dateDBField = $selectedValues[0];
121 $query = \CRM_Utils_SQL_Select
::from("{$this->entity} e")->param($defaultParams);
123 'casAddlCheckFrom' => 'civicrm_contact e',
124 'casContactIdField' => 'e.id',
125 'casEntityIdField' => 'e.id',
126 'casContactTableAlias' => 'e',
128 $query->where('e.is_deleted = 0 AND e.is_deceased = 0');
132 $customFieldParams = array('id' => substr($selectedValues[0], 7));
133 $customGroup = $customField = array();
134 \CRM_Core_BAO_CustomField
::retrieve($customFieldParams, $customField);
135 $dateDBField = $customField['column_name'];
136 $customGroupParams = array('id' => $customField['custom_group_id'], $customGroup);
137 \CRM_Core_BAO_CustomGroup
::retrieve($customGroupParams, $customGroup);
138 $query = \CRM_Utils_SQL_Select
::from("{$customGroup['table_name']} e")->param($defaultParams);
140 'casAddlCheckFrom' => "{$customGroup['table_name']} e",
141 'casContactIdField' => 'e.entity_id',
142 'casEntityIdField' => 'e.id',
143 'casContactTableAlias' => NULL,
145 $query->where('1'); // 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)';