3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 * This class generates form components for processing a survey.
37 class CRM_Campaign_Form_Survey_Results
extends CRM_Campaign_Form_Survey
{
41 protected $_reportTitle;
49 const NUM_OPTION
= 11;
51 public function preProcess() {
54 $this->_values
= $this->get('values');
55 if (!is_array($this->_values
)) {
56 $this->_values
= array();
57 if ($this->_surveyId
) {
58 $params = array('id' => $this->_surveyId
);
59 CRM_Campaign_BAO_Survey
::retrieve($params, $this->_values
);
61 $this->set('values', $this->_values
);
64 $query = "SELECT MAX(id) as id, title FROM civicrm_report_instance WHERE name = %1 GROUP BY id";
65 $params = array(1 => array("survey_{$this->_surveyId}", 'String'));
66 $result = CRM_Core_DAO
::executeQuery($query, $params);
67 if ($result->fetch()) {
68 $this->_reportId
= $result->id
;
69 $this->_reportTitle
= $result->title
;
74 * Set default values for the form.
76 * Note that in edit/view mode the default values are retrieved from the database.
79 * array of default values
81 public function setDefaultValues() {
82 $defaults = $this->_values
;
84 // set defaults for weight.
85 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
86 $defaults["option_weight[{$i}]"] = $i;
89 $defaults['create_report'] = 1;
90 if ($this->_reportId
) {
91 $defaults['report_title'] = $this->_reportTitle
;
97 * Build the form object.
99 public function buildQuickForm() {
100 $optionGroups = CRM_Campaign_BAO_Survey
::getResultSets();
102 if (empty($optionGroups)) {
103 $optionTypes = array('1' => ts('Create new result set'));
106 $optionTypes = array(
107 '1' => ts('Create new result set'),
108 '2' => ts('Use existing result set'),
112 ts('Select Result Set'),
114 '' => ts('- select -'),
115 ) +
$optionGroups, FALSE,
116 array('onChange' => 'loadOptionGroup( )')
120 $element = &$this->addRadio('option_type',
121 ts('Survey Responses'),
124 'onclick' => "showOptionSelect();",
128 if (empty($optionGroups) ||
empty($this->_values
['result_id'])) {
129 $this->setdefaults(array('option_type' => 1));
131 elseif (!empty($this->_values
['result_id'])) {
132 $this->setdefaults(array(
134 'option_group_id' => $this->_values
['result_id'],
138 // form fields of Custom Option rows
139 $defaultOption = array();
140 $_showHide = new CRM_Core_ShowHideBlocks('', '');
142 $optionAttributes = CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue');
143 $optionAttributes['label']['size'] = $optionAttributes['value']['size'] = 25;
145 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
146 //the show hide blocks
147 $showBlocks = 'optionField_' . $i;
149 $_showHide->addHide($showBlocks);
150 if ($i == self
::NUM_OPTION
) {
151 $_showHide->addHide('additionalOption');
155 $_showHide->addShow($showBlocks);
158 $this->add('text', 'option_label[' . $i . ']', ts('Label'),
159 $optionAttributes['label']
163 $this->add('text', 'option_value[' . $i . ']', ts('Value'),
164 $optionAttributes['value']
168 $this->add('number', "option_weight[$i]", ts('Order'),
169 $optionAttributes['weight']
172 $this->add('text', 'option_interval[' . $i .
173 ']', ts('Recontact Interval'),
174 CRM_Core_DAO
::getAttribute('CRM_Campaign_DAO_Survey', 'release_frequency')
177 $defaultOption[$i] = $this->createElement('radio', NULL, NULL, NULL, $i);
180 //default option selection
181 $this->addGroup($defaultOption, 'default_option');
183 $_showHide->addToTemplate();
185 $this->addElement('checkbox', 'create_report', ts('Create Report'));
186 $this->addElement('text', 'report_title', ts('Report Title'));
188 if ($this->_reportId
) {
189 $this->freeze('create_report');
190 $this->freeze('report_title');
193 $this->addFormRule(array(
194 'CRM_Campaign_Form_Survey_Results',
198 parent
::buildQuickForm();
202 * Global validation rules for the form.
210 public static function formRule($fields, $files, $form) {
212 if (!empty($fields['option_label']) && !empty($fields['option_value']) &&
213 (count(array_filter($fields['option_label'])) == 0) &&
214 (count(array_filter($fields['option_value'])) == 0)
216 $errors['option_label[1]'] = ts('Enter at least one result option.');
219 elseif (empty($fields['option_label']) && empty($fields['option_value'])) {
224 $fields['option_type'] == 2 && empty($fields['option_group_id'])
226 $errors['option_group_id'] = ts("Please select a Survey Result Set.");
230 $_flagOption = $_rowError = 0;
231 $_showHide = new CRM_Core_ShowHideBlocks('', '');
233 //capture duplicate Custom option values
234 if (!empty($fields['option_value'])) {
235 $countValue = count($fields['option_value']);
236 $uniqueCount = count(array_unique($fields['option_value']));
238 if ($countValue > $uniqueCount) {
240 while ($start < self
::NUM_OPTION
) {
241 $nextIndex = $start +
1;
243 while ($nextIndex <= self
::NUM_OPTION
) {
244 if ($fields['option_value'][$start] ==
245 $fields['option_value'][$nextIndex] &&
246 !empty($fields['option_value'][$nextIndex])
249 $errors['option_value[' . $start .
250 ']'] = ts('Duplicate Option values');
251 $errors['option_value[' . $nextIndex .
252 ']'] = ts('Duplicate Option values');
262 //capture duplicate Custom Option label
263 if (!empty($fields['option_label'])) {
264 $countValue = count($fields['option_label']);
265 $uniqueCount = count(array_unique($fields['option_label']));
267 if ($countValue > $uniqueCount) {
269 while ($start < self
::NUM_OPTION
) {
270 $nextIndex = $start +
1;
272 while ($nextIndex <= self
::NUM_OPTION
) {
273 if ($fields['option_label'][$start] ==
274 $fields['option_label'][$nextIndex] &&
275 !empty($fields['option_label'][$nextIndex])
277 $errors['option_label[' . $start .
278 ']'] = ts('Duplicate Option label');
279 $errors['option_label[' . $nextIndex .
280 ']'] = ts('Duplicate Option label');
290 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
291 if (!$fields['option_label'][$i]) {
292 if ($fields['option_value'][$i]) {
293 $errors['option_label[' . $i .
294 ']'] = ts('Option label cannot be empty');
301 elseif (!strlen(trim($fields['option_value'][$i]))) {
302 if (!$fields['option_value'][$i]) {
303 $errors['option_value[' . $i .
304 ']'] = ts('Option value cannot be empty');
309 if (!empty($fields['option_interval'][$i]) &&
310 !CRM_Utils_Rule
::integer($fields['option_interval'][$i])
313 $errors['option_interval[' . $i .
314 ']'] = ts('Please enter a valid integer.');
317 $showBlocks = 'optionField_' . $i;
319 $_showHide->addShow($showBlocks);
323 if (!empty($_emptyRow)) {
324 $_showHide->addHide($showBlocks);
327 $_showHide->addShow($showBlocks);
330 if ($i == self
::NUM_OPTION
) {
331 $hideBlock = 'additionalOption';
332 $_showHide->addHide($hideBlock);
335 $_flagOption = $_emptyRow = 0;
337 $_showHide->addToTemplate();
339 return empty($errors) ?
TRUE : $errors;
345 public function postProcess() {
346 // store the submitted values in an array
348 $params = $this->controller
->exportValues($this->_name
);
349 $params['id'] = $this->_surveyId
;
351 $updateResultSet = FALSE;
352 $resultSetOptGrpId = NULL;
353 if ((CRM_Utils_Array
::value('option_type', $params) == 2) &&
354 !empty($params['option_group_id'])
356 $updateResultSet = TRUE;
357 $resultSetOptGrpId = $params['option_group_id'];
360 $recontactInterval = array();
361 if ($updateResultSet) {
362 $optionValue = new CRM_Core_DAO_OptionValue();
363 $optionValue->option_group_id
= $resultSetOptGrpId;
364 $optionValue->delete();
366 $params['result_id'] = $resultSetOptGrpId;
369 $opGroupName = 'civicrm_survey_' . rand(10, 1000) . '_' . date('YmdHis');
371 $optionGroup = new CRM_Core_DAO_OptionGroup();
372 $optionGroup->name
= $opGroupName;
373 $optionGroup->title
= $this->_values
['title'] . ' Result Set';
374 $optionGroup->is_active
= 1;
375 $optionGroup->save();
377 $params['result_id'] = $optionGroup->id
;
380 foreach ($params['option_value'] as $k => $v) {
381 if (strlen(trim($v))) {
382 $optionValue = new CRM_Core_DAO_OptionValue();
383 $optionValue->option_group_id
= $params['result_id'];
384 $optionValue->label
= $params['option_label'][$k];
385 $optionValue->name
= CRM_Utils_String
::titleToVar($params['option_label'][$k]);
386 $optionValue->value
= trim($v);
387 $optionValue->weight
= $params['option_weight'][$k];
388 $optionValue->is_active
= 1;
390 if (!empty($params['default_option']) &&
391 $params['default_option'] == $k
393 $optionValue->is_default
= 1;
396 $optionValue->save();
398 // using is_numeric since 0 is a valid value for option_interval
399 if (is_numeric($params['option_interval'][$k])) {
400 $recontactInterval[$optionValue->label
] = $params['option_interval'][$k];
405 $params['recontact_interval'] = serialize($recontactInterval);
406 $survey = CRM_Campaign_BAO_Survey
::create($params);
408 // create report if required.
409 if (!$this->_reportId
&& $survey->id
&& !empty($params['create_report'])) {
410 $activityStatus = CRM_Core_PseudoConstant
::activityStatus('name');
411 $activityStatus = array_flip($activityStatus);
412 $this->_params
= array(
413 'name' => "survey_{$survey->id}",
414 'title' => $params['report_title'] ?
$params['report_title'] : $this->_values
['title'],
415 'status_id_op' => 'eq',
416 'status_id_value' => $activityStatus['Scheduled'], // reserved status
417 'survey_id_value' => array($survey->id
),
418 'description' => ts('Detailed report for canvassing, phone-banking, walk lists or other surveys.'),
420 //Default value of order by
421 $this->_params
['order_bys'] = array(
423 'column' => 'sort_name',
427 // for WalkList or default
428 $displayFields = array(
437 if (CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'WalkList') ==
438 $this->_values
['activity_type_id']
440 $this->_params
['order_bys'] = array(
442 'column' => 'street_name',
446 'column' => 'street_number_odd_even',
450 'column' => 'street_number',
454 'column' => 'sort_name',
459 elseif (CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'PhoneBank') ==
460 $this->_values
['activity_type_id']
462 array_push($displayFields, 'phone');
464 elseif ((CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Survey') ==
465 $this->_values
['activity_type_id']) ||
466 (CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Canvass') ==
467 $this->_values
['activity_type_id'])
469 array_push($displayFields, 'phone', 'city', 'state_province_id', 'postal_code', 'email');
471 foreach ($displayFields as $key) {
472 $this->_params
['fields'][$key] = 1;
474 $this->_createNew
= TRUE;
475 $this->_id
= CRM_Report_Utils_Report
::getInstanceIDForValue('survey/detail');
476 CRM_Report_Form_Instance
::postProcess($this, FALSE);
478 $query = "SELECT MAX(id) FROM civicrm_report_instance WHERE name = %1";
479 $reportID = CRM_Core_DAO
::singleValueQuery($query, array(
481 "survey_{$survey->id}",
486 $url = CRM_Utils_System
::url("civicrm/report/instance/{$reportID}", 'reset=1');
487 $status = ts("A Survey Detail Report <a href='%1'>%2</a> has been created.",
488 array(1 => $url, 2 => $this->_params
['title']));
493 // reset status as we don't want status set by Instance::postProcess
494 $session = CRM_Core_Session
::singleton();
495 $session->getStatus(TRUE);
497 CRM_Core_Session
::setStatus($status, ts('Saved'), 'success');
500 parent
::endPostProcess();