3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright (C) 2011 Marty Wright |
7 | Licensed to CiviCRM under the Academic Free License version 3.0. |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2014
38 * This class generates form components for Scheduling Reminders
41 class CRM_Admin_Form_ScheduleReminders
extends CRM_Admin_Form
{
44 * Scheduled Reminder ID
46 protected $_id = NULL;
51 * Function to build the form
56 public function buildQuickForm() {
57 parent
::buildQuickForm();
58 $this->_mappingID
= $mappingID = NULL;
59 $providersCount = CRM_SMS_BAO_Provider
::activeProviderCount();
61 if ($this->_action
& (CRM_Core_Action
::DELETE
)) {
63 CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_ActionSchedule', $this->_id
, 'title');
64 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
65 if ($this->_context
== 'event') {
66 $this->_eventId
= CRM_Utils_Request
::retrieve('eventId', 'Integer', $this);
68 $this->assign('reminderName', $reminderName);
71 elseif ($this->_action
& (CRM_Core_Action
::UPDATE
)) {
73 CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_ActionSchedule', $this->_id
, 'mapping_id');
74 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
75 if ($this->_context
== 'event') {
76 $this->_eventId
= CRM_Utils_Request
::retrieve('eventId', 'Integer', $this);
80 if (!empty($_POST) && !empty($_POST['entity'])) {
81 $mappingID = $_POST['entity'][0];
83 elseif ($this->_mappingID
) {
84 $mappingID = $this->_mappingID
;
91 array('size' => 45, 'maxlength' => 128),
95 $selectionOptions = CRM_Core_BAO_ActionSchedule
::getSelection($mappingID);
96 extract($selectionOptions);
99 CRM_Core_Error
::fatal('Could not find mapping for scheduled reminders.');
101 $this->assign('entityMapping', json_encode($entityMapping));
102 $this->assign('recipientMapping', json_encode($recipientMapping));
109 'name' => 'entity[0]',
110 'style' => 'vertical-align: top;',
114 $sel->setOptions(array($sel1, $sel2, $sel3));
116 if (is_a($sel->_elements
[1], 'HTML_QuickForm_select')) {
117 // make second selector a multi-select -
118 $sel->_elements
[1]->setMultiple(TRUE);
119 $sel->_elements
[1]->setSize(5);
122 if (is_a($sel->_elements
[2], 'HTML_QuickForm_select')) {
123 // make third selector a multi-select -
124 $sel->_elements
[2]->setMultiple(TRUE);
125 $sel->_elements
[2]->setSize(5);
128 //get the frequency units.
129 $this->_freqUnits
= CRM_Core_SelectValues
::getScheduleReminderFrequencyUnits();
131 //pass the mapping ID in UPDATE mode
132 $mappings = CRM_Core_BAO_ActionSchedule
::getMapping($mappingID);
134 $numericOptions = CRM_Core_SelectValues
::getNumericOptions(0, 30);
137 $this->add('select', 'start_action_offset', ts('When'), $numericOptions);
138 $title = ts('Email');
139 $isActive = ts('Send email');
140 $recordActivity = ts('Record activity for automated email');
141 if ($providersCount) {
142 $this->assign('sms', $providersCount);
143 $title = ts('Email or SMS');
144 $isActive = ts('Send email or SMS');
145 $recordActivity = ts('Record activity for automated email or SMS');
146 $options = CRM_Core_OptionGroup
::values('msg_mode');
147 $this->add('select', 'mode', ts('Send as'), $options);
149 $providers = CRM_SMS_BAO_Provider
::getProviders(NULL, NULL, TRUE, 'is_default desc');
151 $providerSelect = array();
152 foreach ($providers as $provider) {
153 $providerSelect[$provider['id']] = $provider['title'];
155 $this->add('select', 'sms_provider_id', ts('From'), $providerSelect, TRUE);
158 $this->assign('title', $title);
159 foreach ($this->_freqUnits
as $val => $label) {
160 $freqUnitsDisplay[$val] = ts('%1(s)', array(1 => $label));
163 $this->addDate('absolute_date', ts('Start Date'), FALSE, array('formatType' => 'mailing'));
166 $this->add('select', 'start_action_unit', ts('Frequency'), $freqUnitsDisplay, TRUE);
168 $condition = array('before' => ts('before'),
169 'after' => ts('after'),
172 $this->add('select', 'start_action_condition', ts('Action Condition'), $condition);
174 $this->add('select', 'start_action_date', ts('Date Field'), $sel4, TRUE);
176 $this->addElement('checkbox', 'record_activity', $recordActivity);
178 $this->addElement('checkbox', 'is_repeat', ts('Repeat'),
179 NULL, array('onchange' => "return showHideByValue('is_repeat',true,'repeatFields','table-row','radio',false);")
182 $this->add('select', 'repetition_frequency_unit', ts('every'), $freqUnitsDisplay);
183 $this->add('select', 'repetition_frequency_interval', ts('every'), $numericOptions);
184 $this->add('select', 'end_frequency_unit', ts('until'), $freqUnitsDisplay);
185 $this->add('select', 'end_frequency_interval', ts('until'), $numericOptions);
186 $this->add('select', 'end_action', ts('Repetition Condition'), $condition, TRUE);
187 $this->add('select', 'end_date', ts('Date Field'), $sel4, TRUE);
189 $this->add('text', 'from_name', ts('From Name'));
190 $this->add('text', 'from_email', ts('From Email'));
192 $recipient = 'activity_contacts';
193 $recipientListingOptions = array();
196 $recipient = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_ActionMapping',
202 $limitOptions = array(1 => ts('Limit to'), 0 => ts('Also include'));
203 $this->add('select', 'limit_to', ts('Limit Options'), $limitOptions);
205 $this->add('select', 'recipient', ts('Recipients'), $sel5[$recipient],
206 FALSE, array('onchange' => "showHideByValue('recipient','manual','recipientManual','table-row','select',false); showHideByValue('recipient','group','recipientGroup','table-row','select',false);")
209 if (!empty($_POST['is_recipient_listing'])) {
210 $recipientListingOptions = CRM_Core_BAO_ActionSchedule
::getRecipientListing($_POST['entity'][0], $_POST['recipient']);
212 elseif (!empty($this->_values
['recipient_listing'])) {
213 $recipientListingOptions = CRM_Core_BAO_ActionSchedule
::getRecipientListing($this->_values
['mapping_id'], $this->_values
['recipient']);
215 $this->add('select', 'recipient_listing', ts('Recipient Roles'), $recipientListingOptions, FALSE,
216 array('multiple' => TRUE, 'class' => 'crm-select2 huge', 'placeholder' => TRUE));
217 $this->add('hidden', 'is_recipient_listing', (int) !empty($recipientListingOptions));
219 $this->addEntityRef('recipient_manual_id', ts('Manual Recipients'), array('multiple' => TRUE, 'create' => TRUE));
221 $this->add('select', 'group_id', ts('Group'),
222 CRM_Core_PseudoConstant
::nestedGroup(), FALSE, array('class' => 'crm-select2 huge')
225 CRM_Mailing_BAO_Mailing
::commonCompose($this);
227 $this->add('text', 'subject', ts('Subject'),
228 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_ActionSchedule', 'subject')
231 $this->add('checkbox', 'is_active', $isActive);
233 $this->addFormRule(array('CRM_Admin_Form_ScheduleReminders', 'formRule'));
235 $this->setPageTitle(ts('Scheduled Reminder'));
240 * @param array $fields the input form values
242 * @return true if no errors, else array of errors
246 static function formRule($fields) {
248 if ((array_key_exists(1, $fields['entity']) && $fields['entity'][1][0] === 0) ||
249 (array_key_exists(2, $fields['entity']) && $fields['entity'][2][0] == 0)
251 $errors['entity'] = ts('Please select appropriate value');
254 if (array_key_exists(1, $fields['entity']) && !is_numeric($fields['entity'][1][0])) {
255 if (count($fields['entity'][1]) > 1) {
256 $errors['entity'] = ts('You may only select one contact field per reminder');
258 elseif (!(array_key_exists(2, $fields['entity']) && $fields['entity'][2][0] > 0)) {
259 $errors['entity'] = ts('Please select whether the reminder is sent each year.');
263 if (!empty($fields['is_active']) &&
264 CRM_Utils_System
::isNull($fields['subject'])
266 $errors['subject'] = ts('Subject is a required field.');
269 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value(1, $fields['entity']))) {
270 $errors['entity'] = ts('Please select entity value');
273 if (!CRM_Utils_System
::isNull($fields['absolute_date'])) {
274 if (CRM_Utils_Date
::format(CRM_Utils_Date
::processDate($fields['absolute_date'], NULL)) < CRM_Utils_Date
::format(date('Ymd'))) {
275 $errors['absolute_date'] = ts('Absolute date cannot be earlier than the current time.');
279 if (!empty($errors)) {
283 return empty($errors) ?
TRUE : $errors;
289 function setDefaultValues() {
290 if ($this->_action
& CRM_Core_Action
::ADD
) {
291 $defaults['is_active'] = 1;
292 $defaults['mode'] = 'Email';
293 $defaults['record_activity'] = 1;
296 $defaults = $this->_values
;
297 $entityValue = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
298 CRM_Utils_Array
::value('entity_value', $defaults)
300 $entityStatus = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
301 CRM_Utils_Array
::value('entity_status', $defaults)
303 $defaults['entity'][0] = CRM_Utils_Array
::value('mapping_id', $defaults);
304 $defaults['entity'][1] = $entityValue;
305 $defaults['entity'][2] = $entityStatus;
306 if ($absoluteDate = CRM_Utils_Array
::value('absolute_date', $defaults)) {
307 list($date, $time) = CRM_Utils_Date
::setDateDefaults($absoluteDate);
308 $defaults['absolute_date'] = $date;
311 if ($recipientListing = CRM_Utils_Array
::value('recipient_listing', $defaults)) {
312 $defaults['recipient_listing'] = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
316 $defaults['text_message'] = CRM_Utils_Array
::value('body_text', $defaults);
317 $defaults['html_message'] = CRM_Utils_Array
::value('body_html', $defaults);
318 $defaults['template'] = CRM_Utils_Array
::value('msg_template_id', $defaults);
319 if (!empty($defaults['group_id'])) {
320 $defaults['recipient'] = 'group';
322 elseif (!empty($defaults['recipient_manual'])) {
323 $defaults['recipient'] = 'manual';
324 $defaults['recipient_manual_id'] = $defaults['recipient_manual'];
332 * Function to process the form
338 public function postProcess() {
339 if ($this->_action
& CRM_Core_Action
::DELETE
) {
341 CRM_Core_BAO_ActionSchedule
::del($this->_id
);
342 CRM_Core_Session
::setStatus(ts('Selected Reminder has been deleted.'), ts('Record Deleted'), 'success');
343 if ($this->_context
== 'event' && $this->_eventId
) {
344 $url = CRM_Utils_System
::url('civicrm/event/manage/reminder',
345 "reset=1&action=update&id={$this->_eventId}"
347 $session = CRM_Core_Session
::singleton();
348 $session->pushUserContext($url);
352 $values = $this->controller
->exportValues($this->getName());
366 foreach ($keys as $key) {
367 $params[$key] = CRM_Utils_Array
::value($key, $values);
371 'start_action_offset',
373 'start_action_condition',
375 'repetition_frequency_unit',
376 'repetition_frequency_interval',
377 'end_frequency_unit',
378 'end_frequency_interval',
383 if ($absoluteDate = CRM_Utils_Array
::value('absolute_date', $params)) {
384 $params['absolute_date'] = CRM_Utils_Date
::processDate($absoluteDate);
385 foreach ($moreKeys as $mkey) {
386 $params[$mkey] = 'null';
390 $params['absolute_date'] = 'null';
391 foreach ($moreKeys as $mkey) {
392 $params[$mkey] = CRM_Utils_Array
::value($mkey, $values);
396 $params['body_text'] = CRM_Utils_Array
::value('text_message', $values);
397 $params['body_html'] = CRM_Utils_Array
::value('html_message', $values);
399 if (CRM_Utils_Array
::value('recipient', $values) == 'manual') {
400 $params['recipient_manual'] = CRM_Utils_Array
::value('recipient_manual_id', $values);
401 $params['group_id'] = $params['recipient'] = $params['recipient_listing'] = 'null';
403 elseif (CRM_Utils_Array
::value('recipient', $values) == 'group') {
404 $params['group_id'] = $values['group_id'];
405 $params['recipient_manual'] = $params['recipient'] = $params['recipient_listing'] = 'null';
407 elseif (!CRM_Utils_System
::isNull($values['recipient_listing'])) {
408 $params['recipient'] = CRM_Utils_Array
::value('recipient', $values);
409 $params['recipient_listing'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
410 CRM_Utils_Array
::value('recipient_listing', $values)
412 $params['group_id'] = $params['recipient_manual'] = 'null';
415 $params['recipient'] = CRM_Utils_Array
::value('recipient', $values);
416 $params['group_id'] = $params['recipient_manual'] = $params['recipient_listing'] = 'null';
419 $params['mapping_id'] = $values['entity'][0];
420 $entity_value = $values['entity'][1];
421 $entity_status = $values['entity'][2];
424 'entity_value', 'entity_status') as $key) {
425 $params[$key] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $
$key);
428 $params['is_active'] = CRM_Utils_Array
::value('is_active', $values, 0);
429 $params['is_repeat'] = CRM_Utils_Array
::value('is_repeat', $values, 0);
431 if (CRM_Utils_Array
::value('is_repeat', $values) == 0) {
432 $params['repetition_frequency_unit'] = 'null';
433 $params['repetition_frequency_interval'] = 'null';
434 $params['end_frequency_unit'] = 'null';
435 $params['end_frequency_interval'] = 'null';
436 $params['end_action'] = 'null';
437 $params['end_date'] = 'null';
440 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
441 $params['id'] = $this->_id
;
443 elseif ($this->_action
& CRM_Core_Action
::ADD
) {
444 // we do this only once, so name never changes
445 $params['name'] = CRM_Utils_String
::munge($params['title'], '_', 64);
448 $composeFields = array(
449 'template', 'saveTemplate',
450 'updateTemplate', 'saveTemplateName',
453 //mail template is composed
455 $composeParams = array();
456 foreach ($composeFields as $key) {
457 if (!empty($values[$key])) {
458 $composeParams[$key] = $values[$key];
462 if (!empty($composeParams['updateTemplate'])) {
463 $templateParams = array(
464 'msg_text' => $params['body_text'],
465 'msg_html' => $params['body_html'],
466 'msg_subject' => $params['subject'],
470 $templateParams['id'] = $values['template'];
472 $msgTemplate = CRM_Core_BAO_MessageTemplate
::add($templateParams);
475 if (!empty($composeParams['saveTemplate'])) {
476 $templateParams = array(
477 'msg_text' => $params['body_text'],
478 'msg_html' => $params['body_html'],
479 'msg_subject' => $params['subject'],
483 $templateParams['msg_title'] = $composeParams['saveTemplateName'];
485 $msgTemplate = CRM_Core_BAO_MessageTemplate
::add($templateParams);
488 if (isset($msgTemplate->id
)) {
489 $params['msg_template_id'] = $msgTemplate->id
;
492 $params['msg_template_id'] = CRM_Utils_Array
::value('template', $values);
495 $bao = CRM_Core_BAO_ActionSchedule
::add($params);
496 // we need to set this on the form so that hooks can identify the created entity
497 $this->set('id', $bao->id
);
500 $status = ts("Your new Reminder titled %1 has been saved.",
501 array(1 => "<strong>{$values['title']}</strong>")
503 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
504 $status = ts("Your Reminder titled %1 has been updated.",
505 array(1 => "<strong>{$values['title']}</strong>")
508 if ($this->_context
== 'event' && $this->_eventId
) {
509 $url = CRM_Utils_System
::url('civicrm/event/manage/reminder',
510 "reset=1&action=update&id={$this->_eventId}"
512 $session = CRM_Core_Session
::singleton();
513 $session->pushUserContext($url);
516 CRM_Core_Session
::setStatus($status, ts('Saved'), 'success');