Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
8c9251b3 | 6 | | Copyright CiviCRM LLC (c) 2004-2018 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
8c9251b3 | 31 | * @copyright CiviCRM LLC (c) 2004-2018 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
ce064e4f | 35 | * This class generates form components for Scheduling Reminders. |
6a488035 TO |
36 | */ |
37 | class CRM_Admin_Form_ScheduleReminders extends CRM_Admin_Form { | |
38 | ||
39 | /** | |
eceb18cc | 40 | * Scheduled Reminder ID. |
6a488035 TO |
41 | */ |
42 | protected $_id = NULL; | |
43 | ||
44 | public $_freqUnits; | |
45 | ||
46 | /** | |
eceb18cc | 47 | * Build the form object. |
6a488035 TO |
48 | */ |
49 | public function buildQuickForm() { | |
50 | parent::buildQuickForm(); | |
51 | $this->_mappingID = $mappingID = NULL; | |
a3e3eea1 | 52 | $providersCount = CRM_SMS_BAO_Provider::activeProviderCount(); |
4d3e4dbe | 53 | $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this); |
6a488035 | 54 | |
9c74fabc WA |
55 | //CRM-16777: Don't provide access to administer schedule reminder page, with user that does not have 'administer CiviCRM' permission |
56 | if (empty($this->_context) && !CRM_Core_Permission::check('administer CiviCRM')) { | |
57 | CRM_Core_Error::fatal(ts('You do not have permission to access this page.')); | |
58 | } | |
121eba46 WA |
59 | //CRM-16777: When user have ACLs 'edit' permission for specific event, do not give access to add, delete & updtae |
60 | //schedule reminder for other events. | |
61 | else { | |
62 | $this->_compId = CRM_Utils_Request::retrieve('compId', 'Integer', $this); | |
63 | if (!CRM_Event_BAO_Event::checkPermission($this->_compId, CRM_Core_Permission::EDIT)) { | |
64 | CRM_Core_Error::fatal(ts('You do not have permission to access this page.')); | |
65 | } | |
66 | } | |
9c74fabc | 67 | |
6a488035 | 68 | if ($this->_action & (CRM_Core_Action::DELETE)) { |
4d3e4dbe | 69 | $reminderName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_ActionSchedule', $this->_id, 'title'); |
6a488035 | 70 | if ($this->_context == 'event') { |
4d3e4dbe | 71 | $this->_compId = CRM_Utils_Request::retrieve('compId', 'Integer', $this); |
6a488035 TO |
72 | } |
73 | $this->assign('reminderName', $reminderName); | |
74 | return; | |
75 | } | |
76 | elseif ($this->_action & (CRM_Core_Action::UPDATE)) { | |
c301f76e | 77 | $this->_mappingID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_ActionSchedule', $this->_id, 'mapping_id'); |
6a488035 | 78 | if ($this->_context == 'event') { |
4d3e4dbe | 79 | $this->_compId = CRM_Utils_Request::retrieve('compId', 'Integer', $this); |
6a488035 TO |
80 | } |
81 | } | |
4d3e4dbe | 82 | elseif (!empty($this->_context)) { |
83 | if ($this->_context == 'event') { | |
84 | $this->_compId = CRM_Utils_Request::retrieve('compId', 'Integer', $this); | |
4d3e4dbe | 85 | $isTemplate = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $this->_compId, 'is_template'); |
50a23755 | 86 | $mapping = CRM_Utils_Array::first(CRM_Core_BAO_ActionSchedule::getMappings(array( |
46f5566c | 87 | 'id' => $isTemplate ? CRM_Event_ActionMapping::EVENT_TPL_MAPPING_ID : CRM_Event_ActionMapping::EVENT_NAME_MAPPING_ID, |
50a23755 TO |
88 | ))); |
89 | if ($mapping) { | |
9e1bf145 | 90 | $this->_mappingID = $mapping->getId(); |
50a23755 TO |
91 | } |
92 | else { | |
4d3e4dbe | 93 | CRM_Core_Error::fatal('Could not find mapping for event scheduled reminders.'); |
94 | } | |
95 | } | |
264ebe5d | 96 | } |
97 | ||
02fc859b TO |
98 | if (!empty($_POST) && !empty($_POST['entity']) && empty($this->_context)) { |
99 | $mappingID = $_POST['entity'][0]; | |
100 | } | |
101 | elseif ($this->_mappingID) { | |
102 | $mappingID = $this->_mappingID; | |
93fdcf55 | 103 | if ($this->_context == 'event') { |
104 | $this->add('hidden', 'mappingID', $mappingID); | |
105 | } | |
02fc859b | 106 | } |
4d3e4dbe | 107 | |
6a488035 TO |
108 | $this->add( |
109 | 'text', | |
110 | 'title', | |
111 | ts('Title'), | |
0c843583 | 112 | CRM_Core_DAO::getAttribute('CRM_Core_DAO_ActionSchedule', 'title'), |
6a488035 TO |
113 | TRUE |
114 | ); | |
115 | ||
0905ee5d TO |
116 | $mappings = CRM_Core_BAO_ActionSchedule::getMappings(); |
117 | $selectedMapping = $mappings[$mappingID ? $mappingID : 1]; | |
118 | $entityRecipientLabels = $selectedMapping->getRecipientTypes() + CRM_Core_BAO_ActionSchedule::getAdditionalRecipients(); | |
119 | $this->assign('entityMapping', json_encode( | |
120 | CRM_Utils_Array::collectMethod('getEntity', $mappings) | |
121 | )); | |
122 | $this->assign('recipientMapping', json_encode( | |
123 | array_combine(array_keys($entityRecipientLabels), array_keys($entityRecipientLabels)) | |
124 | )); | |
6a488035 | 125 | |
4d3e4dbe | 126 | if (empty($this->_context)) { |
353ffa53 | 127 | $sel = &$this->add( |
4d3e4dbe | 128 | 'hierselect', |
353ffa53 TO |
129 | 'entity', |
130 | ts('Entity'), | |
131 | array( | |
132 | 'name' => 'entity[0]', | |
133 | 'style' => 'vertical-align: top;', | |
21c744ca | 134 | ) |
4d3e4dbe | 135 | ); |
0905ee5d TO |
136 | $sel->setOptions(array( |
137 | CRM_Utils_Array::collectMethod('getLabel', $mappings), | |
138 | CRM_Core_BAO_ActionSchedule::getAllEntityValueLabels(), | |
139 | CRM_Core_BAO_ActionSchedule::getAllEntityStatusLabels(), | |
140 | )); | |
6a488035 | 141 | |
4d3e4dbe | 142 | if (is_a($sel->_elements[1], 'HTML_QuickForm_select')) { |
143 | // make second selector a multi-select - | |
144 | $sel->_elements[1]->setMultiple(TRUE); | |
145 | $sel->_elements[1]->setSize(5); | |
146 | } | |
147 | ||
148 | if (is_a($sel->_elements[2], 'HTML_QuickForm_select')) { | |
149 | // make third selector a multi-select - | |
150 | $sel->_elements[2]->setMultiple(TRUE); | |
151 | $sel->_elements[2]->setSize(5); | |
152 | } | |
153 | } | |
154 | else { | |
0905ee5d TO |
155 | // Dig deeper - this code is sublimely stupid. |
156 | $allEntityStatusLabels = CRM_Core_BAO_ActionSchedule::getAllEntityStatusLabels(); | |
157 | $options = $allEntityStatusLabels[$this->_mappingID][0]; | |
4d3e4dbe | 158 | $attributes = array('multiple' => 'multiple', 'class' => 'crm-select2 huge', 'placeholder' => $options[0]); |
159 | unset($options[0]); | |
160 | $this->add('select', 'entity', ts('Recipient(s)'), $options, TRUE, $attributes); | |
161 | $this->assign('context', $this->_context); | |
6a488035 TO |
162 | } |
163 | ||
164 | //get the frequency units. | |
8fe4b69f | 165 | $this->_freqUnits = CRM_Core_SelectValues::getRecurringFrequencyUnits(); |
6a488035 | 166 | |
6a488035 | 167 | //reminder_interval |
dc5689ec | 168 | $this->add('number', 'start_action_offset', ts('When'), array('class' => 'six', 'min' => 0)); |
4054a23f DRJ |
169 | $this->addRule('start_action_offset', ts('Value should be a positive number'), 'positiveInteger'); |
170 | ||
a3e3eea1 | 171 | $isActive = ts('Send email'); |
172 | $recordActivity = ts('Record activity for automated email'); | |
173 | if ($providersCount) { | |
7b007e61 | 174 | $this->assign('sms', $providersCount); |
a3e3eea1 | 175 | $isActive = ts('Send email or SMS'); |
176 | $recordActivity = ts('Record activity for automated email or SMS'); | |
177 | $options = CRM_Core_OptionGroup::values('msg_mode'); | |
178 | $this->add('select', 'mode', ts('Send as'), $options); | |
179 | ||
180 | $providers = CRM_SMS_BAO_Provider::getProviders(NULL, NULL, TRUE, 'is_default desc'); | |
181 | ||
182 | $providerSelect = array(); | |
183 | foreach ($providers as $provider) { | |
184 | $providerSelect[$provider['id']] = $provider['title']; | |
185 | } | |
1e035d58 | 186 | $this->add('select', 'sms_provider_id', ts('SMS Provider'), $providerSelect, TRUE); |
a3e3eea1 | 187 | } |
6a488035 TO |
188 | |
189 | foreach ($this->_freqUnits as $val => $label) { | |
190 | $freqUnitsDisplay[$val] = ts('%1(s)', array(1 => $label)); | |
191 | } | |
192 | ||
193 | $this->addDate('absolute_date', ts('Start Date'), FALSE, array('formatType' => 'mailing')); | |
194 | ||
195 | //reminder_frequency | |
196 | $this->add('select', 'start_action_unit', ts('Frequency'), $freqUnitsDisplay, TRUE); | |
197 | ||
02fc859b | 198 | $condition = array( |
353ffa53 | 199 | 'before' => ts('before'), |
6a488035 TO |
200 | 'after' => ts('after'), |
201 | ); | |
202 | //reminder_action | |
203 | $this->add('select', 'start_action_condition', ts('Action Condition'), $condition); | |
204 | ||
0905ee5d | 205 | $this->add('select', 'start_action_date', ts('Date Field'), $selectedMapping->getDateFields(), TRUE); |
6a488035 | 206 | |
a3e3eea1 | 207 | $this->addElement('checkbox', 'record_activity', $recordActivity); |
6a488035 TO |
208 | |
209 | $this->addElement('checkbox', 'is_repeat', ts('Repeat'), | |
581c7be2 | 210 | NULL, array('onchange' => "return showHideByValue('is_repeat',true,'repeatFields','table-row','radio',false);") |
6a488035 TO |
211 | ); |
212 | ||
213 | $this->add('select', 'repetition_frequency_unit', ts('every'), $freqUnitsDisplay); | |
dc5689ec | 214 | $this->add('number', 'repetition_frequency_interval', ts('every'), array('class' => 'six', 'min' => 0)); |
4054a23f DRJ |
215 | $this->addRule('repetition_frequency_interval', ts('Value should be a positive number'), 'positiveInteger'); |
216 | ||
6a488035 | 217 | $this->add('select', 'end_frequency_unit', ts('until'), $freqUnitsDisplay); |
dc5689ec | 218 | $this->add('number', 'end_frequency_interval', ts('until'), array('class' => 'six', 'min' => 0)); |
4054a23f DRJ |
219 | $this->addRule('end_frequency_interval', ts('Value should be a positive number'), 'positiveInteger'); |
220 | ||
6a488035 | 221 | $this->add('select', 'end_action', ts('Repetition Condition'), $condition, TRUE); |
0905ee5d | 222 | $this->add('select', 'end_date', ts('Date Field'), $selectedMapping->getDateFields(), TRUE); |
6a488035 | 223 | |
1991bba1 | 224 | $this->add('text', 'from_name', ts('From Name')); |
1e035d58 | 225 | $this->add('text', 'from_email', ts('From Email')); |
1991bba1 | 226 | |
6a488035 TO |
227 | $recipientListingOptions = array(); |
228 | ||
229 | if ($mappingID) { | |
50a23755 TO |
230 | $mapping = CRM_Utils_Array::first(CRM_Core_BAO_ActionSchedule::getMappings(array( |
231 | 'id' => $mappingID, | |
232 | ))); | |
6a488035 TO |
233 | } |
234 | ||
84a3e359 | 235 | $limitOptions = array('' => '-neither-', 1 => ts('Limit to'), 0 => ts('Also include')); |
8ef12e64 | 236 | |
84a3e359 | 237 | $recipientLabels = array('activity' => ts('Recipients'), 'other' => ts('Limit or Add Recipients')); |
238 | $this->assign('recipientLabels', $recipientLabels); | |
239 | ||
240 | $this->add('select', 'limit_to', ts('Limit Options'), $limitOptions, FALSE, array('onChange' => "showHideByValue('limit_to','','recipient', 'select','select',true);")); | |
241 | ||
0905ee5d | 242 | $this->add('select', 'recipient', $recipientLabels['other'], $entityRecipientLabels, |
581c7be2 | 243 | FALSE, array('onchange' => "showHideByValue('recipient','manual','recipientManual','table-row','select',false); showHideByValue('recipient','group','recipientGroup','table-row','select',false);") |
6a488035 TO |
244 | ); |
245 | ||
49d61c3a | 246 | if (!empty($this->_submitValues['recipient_listing'])) { |
4d3e4dbe | 247 | if (!empty($this->_context)) { |
248 | $recipientListingOptions = CRM_Core_BAO_ActionSchedule::getRecipientListing($this->_mappingID, $this->_submitValues['recipient']); | |
249 | } | |
250 | else { | |
251 | $recipientListingOptions = CRM_Core_BAO_ActionSchedule::getRecipientListing($_POST['entity'][0], $_POST['recipient']); | |
252 | } | |
6a488035 | 253 | } |
a7488080 | 254 | elseif (!empty($this->_values['recipient_listing'])) { |
6a488035 TO |
255 | $recipientListingOptions = CRM_Core_BAO_ActionSchedule::getRecipientListing($this->_values['mapping_id'], $this->_values['recipient']); |
256 | } | |
4d3e4dbe | 257 | |
581c7be2 CW |
258 | $this->add('select', 'recipient_listing', ts('Recipient Roles'), $recipientListingOptions, FALSE, |
259 | array('multiple' => TRUE, 'class' => 'crm-select2 huge', 'placeholder' => TRUE)); | |
6a488035 | 260 | |
92f4a0b1 | 261 | $this->addEntityRef('recipient_manual_id', ts('Manual Recipients'), array('multiple' => TRUE, 'create' => TRUE)); |
6a488035 | 262 | |
581c7be2 | 263 | $this->add('select', 'group_id', ts('Group'), |
af5d5802 | 264 | CRM_Core_PseudoConstant::nestedGroup('Mailing'), FALSE, array('class' => 'crm-select2 huge') |
6a488035 TO |
265 | ); |
266 | ||
776a4216 | 267 | // multilingual only options |
273f9849 | 268 | $multilingual = CRM_Core_I18n::isMultilingual(); |
776a4216 SV |
269 | if ($multilingual) { |
270 | $smarty = CRM_Core_Smarty::singleton(); | |
271 | $smarty->assign('multilingual', $multilingual); | |
272 | ||
273f9849 SV |
273 | $languages = CRM_Core_I18n::languages(TRUE); |
274 | $languageFilter = $languages + array(CRM_Core_I18n::NONE => ts('Contacts with no preferred language')); | |
776a4216 SV |
275 | $element = $this->add('select', 'filter_contact_language', ts('Recipients language'), $languageFilter, FALSE, |
276 | array('multiple' => TRUE, 'class' => 'crm-select2', 'placeholder' => TRUE)); | |
277 | ||
b3518210 | 278 | $communicationLanguage = array( |
273f9849 | 279 | '' => ts('System default language'), |
aeb3ba30 | 280 | CRM_Core_I18n::AUTO => ts('Follow recipient preferred language'), |
273f9849 | 281 | ); |
b3518210 | 282 | $communicationLanguage = $communicationLanguage + $languages; |
776a4216 SV |
283 | $this->add('select', 'communication_language', ts('Communication language'), $communicationLanguage); |
284 | } | |
285 | ||
6a488035 TO |
286 | CRM_Mailing_BAO_Mailing::commonCompose($this); |
287 | ||
288 | $this->add('text', 'subject', ts('Subject'), | |
289 | CRM_Core_DAO::getAttribute('CRM_Core_DAO_ActionSchedule', 'subject') | |
290 | ); | |
291 | ||
a3e3eea1 | 292 | $this->add('checkbox', 'is_active', $isActive); |
6a488035 | 293 | |
4d3e4dbe | 294 | $this->addFormRule(array('CRM_Admin_Form_ScheduleReminders', 'formRule'), $this); |
581c7be2 CW |
295 | |
296 | $this->setPageTitle(ts('Scheduled Reminder')); | |
6a488035 | 297 | } |
353ffa53 | 298 | |
6a488035 | 299 | /** |
eceb18cc | 300 | * Global form rule. |
6a488035 | 301 | * |
5173bd95 TO |
302 | * @param array $fields |
303 | * The input form values. | |
ea3ddccf | 304 | * @param array $files |
7f0141d8 | 305 | * @param CRM_Admin_Form_ScheduleReminders $self |
6a488035 | 306 | * |
ea3ddccf | 307 | * @return array|bool |
308 | * True if no errors, else array of errors | |
6a488035 | 309 | */ |
00be9182 | 310 | public static function formRule($fields, $files, $self) { |
6a488035 | 311 | $errors = array(); |
8d657dde | 312 | if ((array_key_exists(1, $fields['entity']) && $fields['entity'][1][0] === 0) || |
6a488035 TO |
313 | (array_key_exists(2, $fields['entity']) && $fields['entity'][2][0] == 0) |
314 | ) { | |
315 | $errors['entity'] = ts('Please select appropriate value'); | |
316 | } | |
317 | ||
fb90d6bb | 318 | if (!empty($fields['is_active']) && |
6a488035 TO |
319 | CRM_Utils_System::isNull($fields['subject']) |
320 | ) { | |
321 | $errors['subject'] = ts('Subject is a required field.'); | |
322 | } | |
02fdbd86 | 323 | if (!empty($fields['is_active']) && |
324 | CRM_Utils_System::isNull(trim(strip_tags($fields['html_message']))) | |
325 | ) { | |
326 | $errors['html_message'] = ts('The HTML message is a required field.'); | |
327 | } | |
6a488035 | 328 | |
4d3e4dbe | 329 | if (empty($self->_context) && CRM_Utils_System::isNull(CRM_Utils_Array::value(1, $fields['entity']))) { |
6a488035 TO |
330 | $errors['entity'] = ts('Please select entity value'); |
331 | } | |
332 | ||
333 | if (!CRM_Utils_System::isNull($fields['absolute_date'])) { | |
2ea4f315 | 334 | if (CRM_Utils_Date::format(CRM_Utils_Date::processDate($fields['absolute_date'], NULL)) < CRM_Utils_Date::format(date('Ymd'))) { |
6a488035 TO |
335 | $errors['absolute_date'] = ts('Absolute date cannot be earlier than the current time.'); |
336 | } | |
337 | } | |
338 | ||
84a3e359 | 339 | $recipientKind = array( |
340 | 'participant_role' => array( | |
341 | 'name' => 'participant role', | |
21dfd5f5 | 342 | 'target_id' => 'recipient_listing', |
84a3e359 | 343 | ), |
344 | 'manual' => array( | |
345 | 'name' => 'recipient', | |
21dfd5f5 TO |
346 | 'target_id' => 'recipient_manual_id', |
347 | ), | |
84a3e359 | 348 | ); |
fb90d6bb | 349 | if ($fields['limit_to'] != '' && array_key_exists($fields['recipient'], $recipientKind) && empty($fields[$recipientKind[$fields['recipient']]['target_id']])) { |
49d61c3a | 350 | $errors[$recipientKind[$fields['recipient']]['target_id']] = ts('If "Also include" or "Limit to" are selected, you must specify at least one %1', array(1 => $recipientKind[$fields['recipient']]['name'])); |
84a3e359 | 351 | } |
352 | ||
7f0141d8 TO |
353 | $actionSchedule = $self->parseActionSchedule($fields); |
354 | if ($actionSchedule->mapping_id) { | |
355 | $mapping = CRM_Core_BAO_ActionSchedule::getMapping($actionSchedule->mapping_id); | |
356 | CRM_Utils_Array::extend($errors, $mapping->validateSchedule($actionSchedule)); | |
357 | } | |
358 | ||
6a488035 TO |
359 | if (!empty($errors)) { |
360 | return $errors; | |
361 | } | |
362 | ||
363 | return empty($errors) ? TRUE : $errors; | |
364 | } | |
365 | ||
e0ef6999 EM |
366 | /** |
367 | * @return int | |
368 | */ | |
00be9182 | 369 | public function setDefaultValues() { |
6a488035 TO |
370 | if ($this->_action & CRM_Core_Action::ADD) { |
371 | $defaults['is_active'] = 1; | |
a3e3eea1 | 372 | $defaults['mode'] = 'Email'; |
6a488035 TO |
373 | $defaults['record_activity'] = 1; |
374 | } | |
375 | else { | |
376 | $defaults = $this->_values; | |
4d3e4dbe | 377 | $entityValue = explode(CRM_Core_DAO::VALUE_SEPARATOR, CRM_Utils_Array::value('entity_value', $defaults)); |
378 | $entityStatus = explode(CRM_Core_DAO::VALUE_SEPARATOR, CRM_Utils_Array::value('entity_status', $defaults)); | |
379 | if (empty($this->_context)) { | |
380 | $defaults['entity'][0] = CRM_Utils_Array::value('mapping_id', $defaults); | |
381 | $defaults['entity'][1] = $entityValue; | |
382 | $defaults['entity'][2] = $entityStatus; | |
383 | } | |
384 | else { | |
385 | $defaults['entity'] = $entityStatus; | |
386 | } | |
6a488035 TO |
387 | if ($absoluteDate = CRM_Utils_Array::value('absolute_date', $defaults)) { |
388 | list($date, $time) = CRM_Utils_Date::setDateDefaults($absoluteDate); | |
389 | $defaults['absolute_date'] = $date; | |
390 | } | |
391 | ||
392 | if ($recipientListing = CRM_Utils_Array::value('recipient_listing', $defaults)) { | |
393 | $defaults['recipient_listing'] = explode(CRM_Core_DAO::VALUE_SEPARATOR, | |
394 | $recipientListing | |
395 | ); | |
396 | } | |
397 | $defaults['text_message'] = CRM_Utils_Array::value('body_text', $defaults); | |
398 | $defaults['html_message'] = CRM_Utils_Array::value('body_html', $defaults); | |
1e035d58 | 399 | $defaults['sms_text_message'] = CRM_Utils_Array::value('sms_body_text', $defaults); |
6a488035 | 400 | $defaults['template'] = CRM_Utils_Array::value('msg_template_id', $defaults); |
1e035d58 | 401 | $defaults['SMStemplate'] = CRM_Utils_Array::value('sms_template_id', $defaults); |
a7488080 | 402 | if (!empty($defaults['group_id'])) { |
6a488035 TO |
403 | $defaults['recipient'] = 'group'; |
404 | } | |
a7488080 | 405 | elseif (!empty($defaults['recipient_manual'])) { |
6a488035 | 406 | $defaults['recipient'] = 'manual'; |
92f4a0b1 | 407 | $defaults['recipient_manual_id'] = $defaults['recipient_manual']; |
6a488035 | 408 | } |
776a4216 | 409 | if ($contactLanguage = CRM_Utils_Array::value('filter_contact_language', $defaults)) { |
fadd4d37 | 410 | $defaults['filter_contact_language'] = explode(CRM_Core_DAO::VALUE_SEPARATOR, $contactLanguage); |
776a4216 | 411 | } |
6a488035 TO |
412 | } |
413 | ||
414 | return $defaults; | |
415 | } | |
416 | ||
417 | /** | |
eceb18cc | 418 | * Process the form submission. |
6a488035 TO |
419 | */ |
420 | public function postProcess() { | |
421 | if ($this->_action & CRM_Core_Action::DELETE) { | |
422 | // delete reminder | |
423 | CRM_Core_BAO_ActionSchedule::del($this->_id); | |
424 | CRM_Core_Session::setStatus(ts('Selected Reminder has been deleted.'), ts('Record Deleted'), 'success'); | |
4d3e4dbe | 425 | if ($this->_context == 'event' && $this->_compId) { |
6a488035 | 426 | $url = CRM_Utils_System::url('civicrm/event/manage/reminder', |
4d3e4dbe | 427 | "reset=1&action=browse&id={$this->_compId}&component={$this->_context}&setTab=1" |
6a488035 TO |
428 | ); |
429 | $session = CRM_Core_Session::singleton(); | |
430 | $session->pushUserContext($url); | |
431 | } | |
432 | return; | |
433 | } | |
434 | $values = $this->controller->exportValues($this->getName()); | |
7f0141d8 TO |
435 | $bao = $this->parseActionSchedule($values)->save(); |
436 | ||
437 | // we need to set this on the form so that hooks can identify the created entity | |
438 | $this->set('id', $bao->id); | |
439 | $bao->free(); | |
440 | ||
441 | $status = ts("Your new Reminder titled %1 has been saved.", | |
442 | array(1 => "<strong>{$values['title']}</strong>") | |
443 | ); | |
444 | ||
445 | if ($this->_action) { | |
446 | if ($this->_action & CRM_Core_Action::UPDATE) { | |
447 | $status = ts("Your Reminder titled %1 has been updated.", | |
448 | array(1 => "<strong>{$values['title']}</strong>") | |
449 | ); | |
450 | } | |
451 | ||
452 | if ($this->_context == 'event' && $this->_compId) { | |
453 | $url = CRM_Utils_System::url('civicrm/event/manage/reminder', "reset=1&action=browse&id={$this->_compId}&component={$this->_context}&setTab=1"); | |
454 | $session = CRM_Core_Session::singleton(); | |
455 | $session->pushUserContext($url); | |
456 | } | |
457 | } | |
458 | CRM_Core_Session::setStatus($status, ts('Saved'), 'success'); | |
459 | } | |
460 | ||
461 | /** | |
462 | * @param array $values | |
463 | * The submitted form values. | |
464 | * @return CRM_Core_DAO_ActionSchedule | |
465 | */ | |
466 | public function parseActionSchedule($values) { | |
467 | $params = array(); | |
6a488035 TO |
468 | |
469 | $keys = array( | |
470 | 'title', | |
471 | 'subject', | |
472 | 'absolute_date', | |
473 | 'group_id', | |
3e315abc | 474 | 'record_activity', |
a3e3eea1 | 475 | 'limit_to', |
476 | 'mode', | |
1991bba1 DG |
477 | 'sms_provider_id', |
478 | 'from_name', | |
479 | 'from_email', | |
6a488035 TO |
480 | ); |
481 | foreach ($keys as $key) { | |
482 | $params[$key] = CRM_Utils_Array::value($key, $values); | |
483 | } | |
484 | ||
2ef60934 | 485 | $params['is_repeat'] = CRM_Utils_Array::value('is_repeat', $values, 0); |
486 | ||
6a488035 | 487 | $moreKeys = array( |
3e315abc | 488 | 'start_action_offset', |
489 | 'start_action_unit', | |
490 | 'start_action_condition', | |
491 | 'start_action_date', | |
6a488035 TO |
492 | 'repetition_frequency_unit', |
493 | 'repetition_frequency_interval', | |
494 | 'end_frequency_unit', | |
495 | 'end_frequency_interval', | |
3e315abc | 496 | 'end_action', |
497 | 'end_date', | |
6a488035 TO |
498 | ); |
499 | ||
500 | if ($absoluteDate = CRM_Utils_Array::value('absolute_date', $params)) { | |
501 | $params['absolute_date'] = CRM_Utils_Date::processDate($absoluteDate); | |
6a488035 TO |
502 | } |
503 | else { | |
504 | $params['absolute_date'] = 'null'; | |
dc6c330d | 505 | } |
506 | foreach ($moreKeys as $mkey) { | |
39bf7f1e JP |
507 | if ($params['absolute_date'] != 'null' && CRM_Utils_String::startsWith($mkey, 'start_action')) { |
508 | $params[$mkey] = 'null'; | |
509 | continue; | |
6a488035 | 510 | } |
dc6c330d | 511 | $params[$mkey] = CRM_Utils_Array::value($mkey, $values); |
6a488035 TO |
512 | } |
513 | ||
514 | $params['body_text'] = CRM_Utils_Array::value('text_message', $values); | |
1e035d58 | 515 | $params['sms_body_text'] = CRM_Utils_Array::value('sms_text_message', $values); |
6a488035 TO |
516 | $params['body_html'] = CRM_Utils_Array::value('html_message', $values); |
517 | ||
518 | if (CRM_Utils_Array::value('recipient', $values) == 'manual') { | |
519 | $params['recipient_manual'] = CRM_Utils_Array::value('recipient_manual_id', $values); | |
520 | $params['group_id'] = $params['recipient'] = $params['recipient_listing'] = 'null'; | |
521 | } | |
522 | elseif (CRM_Utils_Array::value('recipient', $values) == 'group') { | |
523 | $params['group_id'] = $values['group_id']; | |
524 | $params['recipient_manual'] = $params['recipient'] = $params['recipient_listing'] = 'null'; | |
525 | } | |
7f0141d8 | 526 | elseif (isset($values['recipient_listing']) && isset($values['limit_to']) && !CRM_Utils_System::isNull($values['recipient_listing']) && !CRM_Utils_System::isNull($values['limit_to'])) { |
6a488035 TO |
527 | $params['recipient'] = CRM_Utils_Array::value('recipient', $values); |
528 | $params['recipient_listing'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, | |
529 | CRM_Utils_Array::value('recipient_listing', $values) | |
530 | ); | |
531 | $params['group_id'] = $params['recipient_manual'] = 'null'; | |
532 | } | |
533 | else { | |
534 | $params['recipient'] = CRM_Utils_Array::value('recipient', $values); | |
535 | $params['group_id'] = $params['recipient_manual'] = $params['recipient_listing'] = 'null'; | |
536 | } | |
537 | ||
4d3e4dbe | 538 | if (!empty($this->_mappingID) && !empty($this->_compId)) { |
353ffa53 | 539 | $params['mapping_id'] = $this->_mappingID; |
4d3e4dbe | 540 | $params['entity_value'] = $this->_compId; |
541 | $params['entity_status'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $values['entity']); | |
84a3e359 | 542 | } |
4d3e4dbe | 543 | else { |
544 | $params['mapping_id'] = $values['entity'][0]; | |
673cdfb4 | 545 | if ($params['mapping_id'] == 1) { |
4d3e4dbe | 546 | $params['limit_to'] = 1; |
547 | } | |
84a3e359 | 548 | |
7f0141d8 TO |
549 | $entity_value = CRM_Utils_Array::value(1, $values['entity'], array()); |
550 | $entity_status = CRM_Utils_Array::value(2, $values['entity'], array()); | |
551 | $params['entity_value'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $entity_value); | |
552 | $params['entity_status'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $entity_status); | |
6a488035 TO |
553 | } |
554 | ||
555 | $params['is_active'] = CRM_Utils_Array::value('is_active', $values, 0); | |
6a488035 TO |
556 | |
557 | if (CRM_Utils_Array::value('is_repeat', $values) == 0) { | |
558 | $params['repetition_frequency_unit'] = 'null'; | |
559 | $params['repetition_frequency_interval'] = 'null'; | |
560 | $params['end_frequency_unit'] = 'null'; | |
561 | $params['end_frequency_interval'] = 'null'; | |
562 | $params['end_action'] = 'null'; | |
563 | $params['end_date'] = 'null'; | |
564 | } | |
565 | ||
776a4216 | 566 | // multilingual options |
7f0141d8 | 567 | $params['filter_contact_language'] = CRM_Utils_Array::value('filter_contact_language', $values, array()); |
776a4216 | 568 | $params['filter_contact_language'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $params['filter_contact_language']); |
fadd4d37 | 569 | $params['communication_language'] = CRM_Utils_Array::value('communication_language', $values, NULL); |
776a4216 | 570 | |
6a488035 TO |
571 | if ($this->_action & CRM_Core_Action::UPDATE) { |
572 | $params['id'] = $this->_id; | |
573 | } | |
574 | elseif ($this->_action & CRM_Core_Action::ADD) { | |
575 | // we do this only once, so name never changes | |
576 | $params['name'] = CRM_Utils_String::munge($params['title'], '_', 64); | |
577 | } | |
578 | ||
1e035d58 | 579 | $modePrefixes = array('Mail' => NULL, 'SMS' => 'SMS'); |
580 | ||
581 | if ($params['mode'] == 'Email' || empty($params['sms_provider_id'])) { | |
582 | unset($modePrefixes['SMS']); | |
583 | } | |
584 | elseif ($params['mode'] == 'SMS') { | |
585 | unset($modePrefixes['Mail']); | |
586 | } | |
587 | ||
588 | //TODO: handle postprocessing of SMS and/or Email info based on $modePrefixes | |
589 | ||
6a488035 | 590 | $composeFields = array( |
353ffa53 TO |
591 | 'template', |
592 | 'saveTemplate', | |
593 | 'updateTemplate', | |
594 | 'saveTemplateName', | |
6a488035 TO |
595 | ); |
596 | $msgTemplate = NULL; | |
597 | //mail template is composed | |
598 | ||
1e035d58 | 599 | foreach ($modePrefixes as $prefix) { |
600 | $composeParams = array(); | |
601 | foreach ($composeFields as $key) { | |
602 | $key = $prefix . $key; | |
603 | if (!empty($values[$key])) { | |
604 | $composeParams[$key] = $values[$key]; | |
605 | } | |
6a488035 | 606 | } |
6a488035 | 607 | |
1e035d58 | 608 | if (!empty($composeParams[$prefix . 'updateTemplate'])) { |
609 | $templateParams = array('is_active' => TRUE); | |
610 | if ($prefix == 'SMS') { | |
611 | $templateParams += array( | |
612 | 'msg_text' => $params['sms_body_text'], | |
613 | 'is_sms' => TRUE, | |
02fc859b | 614 | ); |
1e035d58 | 615 | } |
616 | else { | |
617 | $templateParams += array( | |
618 | 'msg_text' => $params['body_text'], | |
619 | 'msg_html' => $params['body_html'], | |
620 | 'msg_subject' => $params['subject'], | |
621 | ); | |
622 | } | |
623 | $templateParams['id'] = $values[$prefix . 'template']; | |
624 | ||
625 | $msgTemplate = CRM_Core_BAO_MessageTemplate::add($templateParams); | |
626 | } | |
6a488035 | 627 | |
1e035d58 | 628 | if (!empty($composeParams[$prefix . 'saveTemplate'])) { |
629 | $templateParams = array('is_active' => TRUE); | |
630 | if ($prefix == 'SMS') { | |
631 | $templateParams += array( | |
632 | 'msg_text' => $params['sms_body_text'], | |
633 | 'is_sms' => TRUE, | |
634 | ); | |
635 | } | |
636 | else { | |
637 | $templateParams += array( | |
638 | 'msg_text' => $params['body_text'], | |
639 | 'msg_html' => $params['body_html'], | |
640 | 'msg_subject' => $params['subject'], | |
641 | ); | |
642 | } | |
643 | $templateParams['msg_title'] = $composeParams[$prefix . 'saveTemplateName']; | |
644 | ||
645 | $msgTemplate = CRM_Core_BAO_MessageTemplate::add($templateParams); | |
646 | } | |
6a488035 | 647 | |
1e035d58 | 648 | if ($prefix == 'SMS') { |
649 | if (isset($msgTemplate->id)) { | |
650 | $params['sms_template_id'] = $msgTemplate->id; | |
651 | } | |
652 | else { | |
653 | $params['sms_template_id'] = CRM_Utils_Array::value('SMStemplate', $values); | |
654 | } | |
655 | } | |
656 | else { | |
657 | if (isset($msgTemplate->id)) { | |
658 | $params['msg_template_id'] = $msgTemplate->id; | |
659 | } | |
660 | else { | |
661 | $params['msg_template_id'] = CRM_Utils_Array::value('template', $values); | |
662 | } | |
663 | } | |
6a488035 TO |
664 | } |
665 | ||
7f0141d8 TO |
666 | $actionSchedule = new CRM_Core_DAO_ActionSchedule(); |
667 | $actionSchedule->copyValues($params); | |
668 | return $actionSchedule; | |
6a488035 | 669 | } |
96025800 | 670 | |
5ec6b0ad TM |
671 | /** |
672 | * List available tokens for this form. | |
673 | * | |
674 | * @return array | |
675 | */ | |
676 | public function listTokens() { | |
677 | $tokens = CRM_Core_SelectValues::contactTokens(); | |
678 | $tokens = array_merge(CRM_Core_SelectValues::activityTokens(), $tokens); | |
679 | $tokens = array_merge(CRM_Core_SelectValues::eventTokens(), $tokens); | |
680 | $tokens = array_merge(CRM_Core_SelectValues::membershipTokens(), $tokens); | |
c3ab1f3d | 681 | $tokens = array_merge(CRM_Core_SelectValues::contributionTokens(), $tokens); |
5ec6b0ad TM |
682 | return $tokens; |
683 | } | |
684 | ||
6a488035 | 685 | } |