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;
60 if ($this->_action
& (CRM_Core_Action
::DELETE
)) {
62 CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_ActionSchedule', $this->_id
, 'title');
63 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
64 if ($this->_context
== 'event') {
65 $this->_eventId
= CRM_Utils_Request
::retrieve('eventId', 'Integer', $this);
67 $this->assign('reminderName', $reminderName);
70 elseif ($this->_action
& (CRM_Core_Action
::UPDATE
)) {
72 CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_ActionSchedule', $this->_id
, 'mapping_id');
73 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
74 if ($this->_context
== 'event') {
75 $this->_eventId
= CRM_Utils_Request
::retrieve('eventId', 'Integer', $this);
79 if (!empty($_POST) && CRM_Utils_Array
::value('entity', $_POST)) {
80 $mappingID = $_POST['entity'][0];
82 elseif ($this->_mappingID
) {
83 $mappingID = $this->_mappingID
;
90 array('size' => 45, 'maxlength' => 128),
94 $selectionOptions = CRM_Core_BAO_ActionSchedule
::getSelection($mappingID);
95 extract($selectionOptions);
98 CRM_Core_Error
::fatal('Could not find mapping for scheduled reminders.');
100 $this->assign('entityMapping', json_encode($entityMapping));
101 $this->assign('recipientMapping', json_encode($recipientMapping));
108 'name' => 'entity[0]',
109 'style' => 'vertical-align: top;',
113 $sel->setOptions(array($sel1, $sel2, $sel3));
115 if (is_a($sel->_elements
[1], 'HTML_QuickForm_select')) {
116 // make second selector a multi-select -
117 $sel->_elements
[1]->setMultiple(TRUE);
118 $sel->_elements
[1]->setSize(5);
121 if (is_a($sel->_elements
[2], 'HTML_QuickForm_select')) {
122 // make third selector a multi-select -
123 $sel->_elements
[2]->setMultiple(TRUE);
124 $sel->_elements
[2]->setSize(5);
127 //get the frequency units.
128 $this->_freqUnits
= array('hour' => 'hour') + CRM_Core_OptionGroup
::values('recur_frequency_units');
130 //pass the mapping ID in UPDATE mode
131 $mappings = CRM_Core_BAO_ActionSchedule
::getMapping($mappingID);
133 $numericOptions = CRM_Core_SelectValues
::getNumericOptions(0, 30);
136 $this->add('select', 'start_action_offset', ts('When'), $numericOptions);
138 foreach ($this->_freqUnits
as $val => $label) {
139 $freqUnitsDisplay[$val] = ts('%1(s)', array(1 => $label));
142 $this->addDate('absolute_date', ts('Start Date'), FALSE, array('formatType' => 'mailing'));
145 $this->add('select', 'start_action_unit', ts('Frequency'), $freqUnitsDisplay, TRUE);
147 $condition = array('before' => ts('before'),
148 'after' => ts('after'),
151 $this->add('select', 'start_action_condition', ts('Action Condition'), $condition);
153 $this->add('select', 'start_action_date', ts('Date Field'), $sel4, TRUE);
155 $this->addElement('checkbox', 'record_activity', ts('Record activity for automated email'));
157 $this->addElement('checkbox', 'is_repeat', ts('Repeat'),
158 NULL, array('onclick' => "return showHideByValue('is_repeat',true,'repeatFields','table-row','radio',false);")
161 $this->add('select', 'repetition_frequency_unit', ts('every'), $freqUnitsDisplay);
162 $this->add('select', 'repetition_frequency_interval', ts('every'), $numericOptions);
163 $this->add('select', 'end_frequency_unit', ts('until'), $freqUnitsDisplay);
164 $this->add('select', 'end_frequency_interval', ts('until'), $numericOptions);
165 $this->add('select', 'end_action', ts('Repetition Condition'), $condition, TRUE);
166 $this->add('select', 'end_date', ts('Date Field'), $sel4, TRUE);
168 $recipient = 'activity_contacts';
169 $recipientListingOptions = array();
172 $recipient = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_ActionMapping',
178 $limitOptions = array(1 => ts('Limit to'), 0 => ts('Addition to'));
179 $this->add('select', 'limit_to', ts('Limit Options'), $limitOptions);
181 $this->add('select', 'recipient', ts('Recipients'), $sel5[$recipient],
182 FALSE, array('onClick' => "showHideByValue('recipient','manual','recipientManual','table-row','select',false); showHideByValue('recipient','group','recipientGroup','table-row','select',false);")
185 if (CRM_Utils_Array
::value('is_recipient_listing', $_POST)) {
186 $recipientListingOptions = CRM_Core_BAO_ActionSchedule
::getRecipientListing($_POST['entity'][0], $_POST['recipient']);
188 elseif (CRM_Utils_Array
::value('recipient_listing', $this->_values
)) {
189 $recipientListingOptions = CRM_Core_BAO_ActionSchedule
::getRecipientListing($this->_values
['mapping_id'], $this->_values
['recipient']);
191 $recipientListing = $this->add('select', 'recipient_listing', ts('Recipient Listing'), $recipientListingOptions);
192 $recipientListing->setMultiple(TRUE);
193 $this->add('hidden', 'is_recipient_listing', empty($recipientListingOptions) ?
FALSE : TRUE, array('id' => 'is_recipient_listing'));
196 $dataUrl = CRM_Utils_System
::url('civicrm/ajax/rest',
197 'className=CRM_Contact_Page_AJAX&fnName=getContactList&json=1&context=activity&reset=1',
201 $this->assign('dataUrl', $dataUrl);
203 $tokenUrl = CRM_Utils_System
::url('civicrm/ajax/checkemail',
207 $this->assign('tokenUrl', $tokenUrl);
208 $this->add('text', 'recipient_manual_id', ts('Manual Recipients'));
210 $this->addElement('select', 'group_id', ts('Group'),
211 CRM_Core_PseudoConstant
::staticGroup()
214 CRM_Mailing_BAO_Mailing
::commonCompose($this);
216 $this->add('text', 'subject', ts('Subject'),
217 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_ActionSchedule', 'subject')
220 $this->add('checkbox', 'is_active', ts('Send email'));
222 $this->addFormRule(array('CRM_Admin_Form_ScheduleReminders', 'formRule'));
227 * @param array $fields the input form values
229 * @return true if no errors, else array of errors
233 static function formRule($fields) {
235 if ((array_key_exists(1, $fields['entity']) && $fields['entity'][1][0] == 0) ||
236 (array_key_exists(2, $fields['entity']) && $fields['entity'][2][0] == 0)
238 $errors['entity'] = ts('Please select appropriate value');
241 if (CRM_Utils_Array
::value('is_active', $fields) &&
242 CRM_Utils_System
::isNull($fields['subject'])
244 $errors['subject'] = ts('Subject is a required field.');
247 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value(1, $fields['entity']))) {
248 $errors['entity'] = ts('Please select entity value');
251 if (!CRM_Utils_System
::isNull($fields['absolute_date'])) {
252 if (CRM_Utils_Date
::format(CRM_Utils_Date
::processDate($fields['absolute_date'], NULL)) < CRM_Utils_Date
::format(date('YmdHi00'))) {
253 $errors['absolute_date'] = ts('Absolute date cannot be earlier than the current time.');
257 if (!empty($errors)) {
261 return empty($errors) ?
TRUE : $errors;
264 function setDefaultValues() {
265 if ($this->_action
& CRM_Core_Action
::ADD
) {
266 $defaults['is_active'] = 1;
267 $defaults['record_activity'] = 1;
270 $defaults = $this->_values
;
271 $entityValue = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
272 CRM_Utils_Array
::value('entity_value', $defaults)
274 $entityStatus = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
275 CRM_Utils_Array
::value('entity_status', $defaults)
277 $defaults['entity'][0] = CRM_Utils_Array
::value('mapping_id', $defaults);
278 $defaults['entity'][1] = $entityValue;
279 $defaults['entity'][2] = $entityStatus;
280 if ($absoluteDate = CRM_Utils_Array
::value('absolute_date', $defaults)) {
281 list($date, $time) = CRM_Utils_Date
::setDateDefaults($absoluteDate);
282 $defaults['absolute_date'] = $date;
285 if ($recipientListing = CRM_Utils_Array
::value('recipient_listing', $defaults)) {
286 $defaults['recipient_listing'] = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
290 $defaults['text_message'] = CRM_Utils_Array
::value('body_text', $defaults);
291 $defaults['html_message'] = CRM_Utils_Array
::value('body_html', $defaults);
292 $defaults['template'] = CRM_Utils_Array
::value('msg_template_id', $defaults);
293 if (CRM_Utils_Array
::value('group_id', $defaults)) {
294 $defaults['recipient'] = 'group';
296 elseif (CRM_Utils_Array
::value('recipient_manual', $defaults)) {
297 $defaults['recipient'] = 'manual';
298 $recipients = array();
299 foreach (explode(',', $defaults['recipient_manual']) as $cid) {
300 $recipients[$cid] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
305 $this->assign('recipients', $recipients);
313 * Function to process the form
319 public function postProcess() {
320 if ($this->_action
& CRM_Core_Action
::DELETE
) {
322 CRM_Core_BAO_ActionSchedule
::del($this->_id
);
323 CRM_Core_Session
::setStatus(ts('Selected Reminder has been deleted.'), ts('Record Deleted'), 'success');
324 if ($this->_context
== 'event' && $this->_eventId
) {
325 $url = CRM_Utils_System
::url('civicrm/event/manage/reminder',
326 "reset=1&action=update&id={$this->_eventId}"
328 $session = CRM_Core_Session
::singleton();
329 $session->pushUserContext($url);
333 $values = $this->controller
->exportValues($this->getName());
343 foreach ($keys as $key) {
344 $params[$key] = CRM_Utils_Array
::value($key, $values);
348 'start_action_offset',
350 'start_action_condition',
352 'repetition_frequency_unit',
353 'repetition_frequency_interval',
354 'end_frequency_unit',
355 'end_frequency_interval',
360 if ($absoluteDate = CRM_Utils_Array
::value('absolute_date', $params)) {
361 $params['absolute_date'] = CRM_Utils_Date
::processDate($absoluteDate);
362 foreach ($moreKeys as $mkey) {
363 $params[$mkey] = 'null';
367 $params['absolute_date'] = 'null';
368 foreach ($moreKeys as $mkey) {
369 $params[$mkey] = CRM_Utils_Array
::value($mkey, $values);
373 $params['body_text'] = CRM_Utils_Array
::value('text_message', $values);
374 $params['body_html'] = CRM_Utils_Array
::value('html_message', $values);
376 if (CRM_Utils_Array
::value('recipient', $values) == 'manual') {
377 $params['recipient_manual'] = CRM_Utils_Array
::value('recipient_manual_id', $values);
378 $params['group_id'] = $params['recipient'] = $params['recipient_listing'] = 'null';
380 elseif (CRM_Utils_Array
::value('recipient', $values) == 'group') {
381 $params['group_id'] = $values['group_id'];
382 $params['recipient_manual'] = $params['recipient'] = $params['recipient_listing'] = 'null';
384 elseif (!CRM_Utils_System
::isNull($values['recipient_listing'])) {
385 $params['recipient'] = CRM_Utils_Array
::value('recipient', $values);
386 $params['recipient_listing'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
387 CRM_Utils_Array
::value('recipient_listing', $values)
389 $params['group_id'] = $params['recipient_manual'] = 'null';
392 $params['recipient'] = CRM_Utils_Array
::value('recipient', $values);
393 $params['group_id'] = $params['recipient_manual'] = $params['recipient_listing'] = 'null';
396 $params['mapping_id'] = $values['entity'][0];
397 $entity_value = $values['entity'][1];
398 $entity_status = $values['entity'][2];
401 'entity_value', 'entity_status') as $key) {
402 $params[$key] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $
$key);
405 $params['is_active'] = CRM_Utils_Array
::value('is_active', $values, 0);
406 $params['is_repeat'] = CRM_Utils_Array
::value('is_repeat', $values, 0);
408 if (CRM_Utils_Array
::value('is_repeat', $values) == 0) {
409 $params['repetition_frequency_unit'] = 'null';
410 $params['repetition_frequency_interval'] = 'null';
411 $params['end_frequency_unit'] = 'null';
412 $params['end_frequency_interval'] = 'null';
413 $params['end_action'] = 'null';
414 $params['end_date'] = 'null';
417 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
418 $params['id'] = $this->_id
;
420 elseif ($this->_action
& CRM_Core_Action
::ADD
) {
421 // we do this only once, so name never changes
422 $params['name'] = CRM_Utils_String
::munge($params['title'], '_', 64);
425 $composeFields = array(
426 'template', 'saveTemplate',
427 'updateTemplate', 'saveTemplateName',
430 //mail template is composed
432 $composeParams = array();
433 foreach ($composeFields as $key) {
434 if (CRM_Utils_Array
::value($key, $values)) {
435 $composeParams[$key] = $values[$key];
439 if (CRM_Utils_Array
::value('updateTemplate', $composeParams)) {
440 $templateParams = array(
441 'msg_text' => $params['body_text'],
442 'msg_html' => $params['body_html'],
443 'msg_subject' => $params['subject'],
447 $templateParams['id'] = $values['template'];
449 $msgTemplate = CRM_Core_BAO_MessageTemplate
::add($templateParams);
452 if (CRM_Utils_Array
::value('saveTemplate', $composeParams)) {
453 $templateParams = array(
454 'msg_text' => $params['body_text'],
455 'msg_html' => $params['body_html'],
456 'msg_subject' => $params['subject'],
460 $templateParams['msg_title'] = $composeParams['saveTemplateName'];
462 $msgTemplate = CRM_Core_BAO_MessageTemplate
::add($templateParams);
465 if (isset($msgTemplate->id
)) {
466 $params['msg_template_id'] = $msgTemplate->id
;
469 $params['msg_template_id'] = CRM_Utils_Array
::value('template', $values);
472 CRM_Core_BAO_ActionSchedule
::add($params, $ids);
474 $status = ts("Your new Reminder titled %1 has been saved.",
475 array(1 => "<strong>{$values['title']}</strong>")
477 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
478 $status = ts("Your Reminder titled %1 has been updated.",
479 array(1 => "<strong>{$values['title']}</strong>")
482 if ($this->_context
== 'event' && $this->_eventId
) {
483 $url = CRM_Utils_System
::url('civicrm/event/manage/reminder',
484 "reset=1&action=update&id={$this->_eventId}"
486 $session = CRM_Core_Session
::singleton();
487 $session->pushUserContext($url);
490 CRM_Core_Session
::setStatus($status, ts('Saved'), 'success');