3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
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-2013
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
= array('hour' => 'hour') + CRM_Core_OptionGroup
::values('recur_frequency_units');
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 $title = ts('Email or SMS');
143 $isActive = ts('Send email or SMS');
144 $recordActivity = ts('Record activity for automated email or SMS');
145 $options = CRM_Core_OptionGroup
::values('msg_mode');
146 $this->add('select', 'mode', ts('Send as'), $options);
148 $providers = CRM_SMS_BAO_Provider
::getProviders(NULL, NULL, TRUE, 'is_default desc');
150 $providerSelect = array();
151 foreach ($providers as $provider) {
152 $providerSelect[$provider['id']] = $provider['title'];
154 $this->add('select', 'sms_provider_id', ts('From'), $providerSelect, TRUE);
157 $this->assign('title', $title);
158 foreach ($this->_freqUnits
as $val => $label) {
159 $freqUnitsDisplay[$val] = ts('%1(s)', array(1 => $label));
162 $this->addDate('absolute_date', ts('Start Date'), FALSE, array('formatType' => 'mailing'));
165 $this->add('select', 'start_action_unit', ts('Frequency'), $freqUnitsDisplay, TRUE);
167 $condition = array('before' => ts('before'),
168 'after' => ts('after'),
171 $this->add('select', 'start_action_condition', ts('Action Condition'), $condition);
173 $this->add('select', 'start_action_date', ts('Date Field'), $sel4, TRUE);
175 $this->addElement('checkbox', 'record_activity', $recordActivity);
177 $this->addElement('checkbox', 'is_repeat', ts('Repeat'),
178 NULL, array('onclick' => "return showHideByValue('is_repeat',true,'repeatFields','table-row','radio',false);")
181 $this->add('select', 'repetition_frequency_unit', ts('every'), $freqUnitsDisplay);
182 $this->add('select', 'repetition_frequency_interval', ts('every'), $numericOptions);
183 $this->add('select', 'end_frequency_unit', ts('until'), $freqUnitsDisplay);
184 $this->add('select', 'end_frequency_interval', ts('until'), $numericOptions);
185 $this->add('select', 'end_action', ts('Repetition Condition'), $condition, TRUE);
186 $this->add('select', 'end_date', ts('Date Field'), $sel4, TRUE);
188 $recipient = 'activity_contacts';
189 $recipientListingOptions = array();
192 $recipient = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_ActionMapping',
198 $limitOptions = array(1 => ts('Limit to'), 0 => ts('Addition to'));
199 $this->add('select', 'limit_to', ts('Limit Options'), $limitOptions);
201 $this->add('select', 'recipient', ts('Recipients'), $sel5[$recipient],
202 FALSE, array('onClick' => "showHideByValue('recipient','manual','recipientManual','table-row','select',false); showHideByValue('recipient','group','recipientGroup','table-row','select',false);")
205 if (!empty($_POST['is_recipient_listing'])) {
206 $recipientListingOptions = CRM_Core_BAO_ActionSchedule
::getRecipientListing($_POST['entity'][0], $_POST['recipient']);
208 elseif (!empty($this->_values
['recipient_listing'])) {
209 $recipientListingOptions = CRM_Core_BAO_ActionSchedule
::getRecipientListing($this->_values
['mapping_id'], $this->_values
['recipient']);
211 $recipientListing = $this->add('select', 'recipient_listing', ts('Recipient Listing'), $recipientListingOptions);
212 $recipientListing->setMultiple(TRUE);
213 $this->add('hidden', 'is_recipient_listing', empty($recipientListingOptions) ?
FALSE : TRUE, array('id' => 'is_recipient_listing'));
216 $tokenUrl = CRM_Utils_System
::url('civicrm/ajax/checkemail',
220 $this->assign('tokenUrl', $tokenUrl);
221 $this->add('text', 'recipient_manual_id', ts('Manual Recipients'));
228 CRM_Core_PseudoConstant
::group()
231 CRM_Mailing_BAO_Mailing
::commonCompose($this);
233 $this->add('text', 'subject', ts('Subject'),
234 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_ActionSchedule', 'subject')
237 $this->add('checkbox', 'is_active', $isActive);
239 $this->addFormRule(array('CRM_Admin_Form_ScheduleReminders', 'formRule'));
244 * @param array $fields the input form values
246 * @return true if no errors, else array of errors
250 static function formRule($fields) {
252 if ((array_key_exists(1, $fields['entity']) && $fields['entity'][1][0] == 0) ||
253 (array_key_exists(2, $fields['entity']) && $fields['entity'][2][0] == 0)
255 $errors['entity'] = ts('Please select appropriate value');
258 if (!empty($fields['is_active']) &&
259 CRM_Utils_System
::isNull($fields['subject'])
261 $errors['subject'] = ts('Subject is a required field.');
264 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value(1, $fields['entity']))) {
265 $errors['entity'] = ts('Please select entity value');
268 if (!CRM_Utils_System
::isNull($fields['absolute_date'])) {
269 if (CRM_Utils_Date
::format(CRM_Utils_Date
::processDate($fields['absolute_date'], NULL)) < CRM_Utils_Date
::format(date('Ymd'))) {
270 $errors['absolute_date'] = ts('Absolute date cannot be earlier than the current time.');
274 if (!empty($errors)) {
278 return empty($errors) ?
TRUE : $errors;
281 function setDefaultValues() {
282 if ($this->_action
& CRM_Core_Action
::ADD
) {
283 $defaults['is_active'] = 1;
284 $defaults['mode'] = 'Email';
285 $defaults['record_activity'] = 1;
288 $defaults = $this->_values
;
289 $entityValue = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
290 CRM_Utils_Array
::value('entity_value', $defaults)
292 $entityStatus = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
293 CRM_Utils_Array
::value('entity_status', $defaults)
295 $defaults['entity'][0] = CRM_Utils_Array
::value('mapping_id', $defaults);
296 $defaults['entity'][1] = $entityValue;
297 $defaults['entity'][2] = $entityStatus;
298 if ($absoluteDate = CRM_Utils_Array
::value('absolute_date', $defaults)) {
299 list($date, $time) = CRM_Utils_Date
::setDateDefaults($absoluteDate);
300 $defaults['absolute_date'] = $date;
303 if ($recipientListing = CRM_Utils_Array
::value('recipient_listing', $defaults)) {
304 $defaults['recipient_listing'] = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
308 $defaults['text_message'] = CRM_Utils_Array
::value('body_text', $defaults);
309 $defaults['html_message'] = CRM_Utils_Array
::value('body_html', $defaults);
310 $defaults['template'] = CRM_Utils_Array
::value('msg_template_id', $defaults);
311 if (!empty($defaults['group_id'])) {
312 $defaults['recipient'] = 'group';
314 elseif (!empty($defaults['recipient_manual'])) {
315 $defaults['recipient'] = 'manual';
316 $recipients = array();
317 foreach (explode(',', $defaults['recipient_manual']) as $cid) {
318 $recipients[$cid] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
323 $this->assign('recipients', $recipients);
331 * Function to process the form
337 public function postProcess() {
338 if ($this->_action
& CRM_Core_Action
::DELETE
) {
340 CRM_Core_BAO_ActionSchedule
::del($this->_id
);
341 CRM_Core_Session
::setStatus(ts('Selected Reminder has been deleted.'), ts('Record Deleted'), 'success');
342 if ($this->_context
== 'event' && $this->_eventId
) {
343 $url = CRM_Utils_System
::url('civicrm/event/manage/reminder',
344 "reset=1&action=update&id={$this->_eventId}"
346 $session = CRM_Core_Session
::singleton();
347 $session->pushUserContext($url);
351 $values = $this->controller
->exportValues($this->getName());
363 foreach ($keys as $key) {
364 $params[$key] = CRM_Utils_Array
::value($key, $values);
368 'start_action_offset',
370 'start_action_condition',
372 'repetition_frequency_unit',
373 'repetition_frequency_interval',
374 'end_frequency_unit',
375 'end_frequency_interval',
380 if ($absoluteDate = CRM_Utils_Array
::value('absolute_date', $params)) {
381 $params['absolute_date'] = CRM_Utils_Date
::processDate($absoluteDate);
382 foreach ($moreKeys as $mkey) {
383 $params[$mkey] = 'null';
387 $params['absolute_date'] = 'null';
388 foreach ($moreKeys as $mkey) {
389 $params[$mkey] = CRM_Utils_Array
::value($mkey, $values);
393 $params['body_text'] = CRM_Utils_Array
::value('text_message', $values);
394 $params['body_html'] = CRM_Utils_Array
::value('html_message', $values);
396 if (CRM_Utils_Array
::value('recipient', $values) == 'manual') {
397 $params['recipient_manual'] = CRM_Utils_Array
::value('recipient_manual_id', $values);
398 $params['group_id'] = $params['recipient'] = $params['recipient_listing'] = 'null';
400 elseif (CRM_Utils_Array
::value('recipient', $values) == 'group') {
401 $params['group_id'] = $values['group_id'];
402 $params['recipient_manual'] = $params['recipient'] = $params['recipient_listing'] = 'null';
404 elseif (!CRM_Utils_System
::isNull($values['recipient_listing'])) {
405 $params['recipient'] = CRM_Utils_Array
::value('recipient', $values);
406 $params['recipient_listing'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
407 CRM_Utils_Array
::value('recipient_listing', $values)
409 $params['group_id'] = $params['recipient_manual'] = 'null';
412 $params['recipient'] = CRM_Utils_Array
::value('recipient', $values);
413 $params['group_id'] = $params['recipient_manual'] = $params['recipient_listing'] = 'null';
416 $params['mapping_id'] = $values['entity'][0];
417 $entity_value = $values['entity'][1];
418 $entity_status = $values['entity'][2];
421 'entity_value', 'entity_status') as $key) {
422 $params[$key] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $
$key);
425 $params['is_active'] = CRM_Utils_Array
::value('is_active', $values, 0);
426 $params['is_repeat'] = CRM_Utils_Array
::value('is_repeat', $values, 0);
428 if (CRM_Utils_Array
::value('is_repeat', $values) == 0) {
429 $params['repetition_frequency_unit'] = 'null';
430 $params['repetition_frequency_interval'] = 'null';
431 $params['end_frequency_unit'] = 'null';
432 $params['end_frequency_interval'] = 'null';
433 $params['end_action'] = 'null';
434 $params['end_date'] = 'null';
437 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
438 $params['id'] = $this->_id
;
440 elseif ($this->_action
& CRM_Core_Action
::ADD
) {
441 // we do this only once, so name never changes
442 $params['name'] = CRM_Utils_String
::munge($params['title'], '_', 64);
445 $composeFields = array(
446 'template', 'saveTemplate',
447 'updateTemplate', 'saveTemplateName',
450 //mail template is composed
452 $composeParams = array();
453 foreach ($composeFields as $key) {
454 if (!empty($values[$key])) {
455 $composeParams[$key] = $values[$key];
459 if (!empty($composeParams['updateTemplate'])) {
460 $templateParams = array(
461 'msg_text' => $params['body_text'],
462 'msg_html' => $params['body_html'],
463 'msg_subject' => $params['subject'],
467 $templateParams['id'] = $values['template'];
469 $msgTemplate = CRM_Core_BAO_MessageTemplate
::add($templateParams);
472 if (!empty($composeParams['saveTemplate'])) {
473 $templateParams = array(
474 'msg_text' => $params['body_text'],
475 'msg_html' => $params['body_html'],
476 'msg_subject' => $params['subject'],
480 $templateParams['msg_title'] = $composeParams['saveTemplateName'];
482 $msgTemplate = CRM_Core_BAO_MessageTemplate
::add($templateParams);
485 if (isset($msgTemplate->id
)) {
486 $params['msg_template_id'] = $msgTemplate->id
;
489 $params['msg_template_id'] = CRM_Utils_Array
::value('template', $values);
492 $bao = CRM_Core_BAO_ActionSchedule
::add($params);
493 // we need to set this on the form so that hooks can identify the created entity
494 $this->set('id', $bao->id
);
497 $status = ts("Your new Reminder titled %1 has been saved.",
498 array(1 => "<strong>{$values['title']}</strong>")
500 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
501 $status = ts("Your Reminder titled %1 has been updated.",
502 array(1 => "<strong>{$values['title']}</strong>")
505 if ($this->_context
== 'event' && $this->_eventId
) {
506 $url = CRM_Utils_System
::url('civicrm/event/manage/reminder',
507 "reset=1&action=update&id={$this->_eventId}"
509 $session = CRM_Core_Session
::singleton();
510 $session->pushUserContext($url);
513 CRM_Core_Session
::setStatus($status, ts('Saved'), 'success');