3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * This class generates form components for processing a survey
40 class CRM_Campaign_Form_Survey_Results
extends CRM_Campaign_Form_Survey
{
44 protected $_reportTitle;
52 const NUM_OPTION
= 11;
54 public function preProcess() {
57 $this->_values
= $this->get('values');
58 if (!is_array($this->_values
)) {
59 $this->_values
= array();
60 if ($this->_surveyId
) {
61 $params = array('id' => $this->_surveyId
);
62 CRM_Campaign_BAO_Survey
::retrieve($params, $this->_values
);
64 $this->set('values', $this->_values
);
67 $query = "SELECT MAX(id) as id, title FROM civicrm_report_instance WHERE name = %1";
68 $params = array(1 => array("survey_{$this->_surveyId}", 'String'));
69 $result = CRM_Core_DAO
::executeQuery($query, $params);
70 if ($result->fetch()) {
71 $this->_reportId
= $result->id
;
72 $this->_reportTitle
= $result->title
;
77 * Set default values for the form. Note that in edit/view mode
78 * the default values are retrieved from the database
82 * @return array array of default values
85 public function setDefaultValues() {
86 $defaults = $this->_values
;
88 // set defaults for weight.
89 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
90 $defaults["option_weight[{$i}]"] = $i;
93 $defaults['create_report'] = 1;
94 if ($this->_reportId
) {
95 $defaults['report_title'] = $this->_reportTitle
;
101 * Build the form object
108 public function buildQuickForm() {
109 $optionGroups = CRM_Campaign_BAO_Survey
::getResultSets();
111 if (empty($optionGroups)) {
112 $optionTypes = array('1' => ts('Create new result set'));
115 $optionTypes = array(
116 '1' => ts('Create new result set'),
117 '2' => ts('Use existing result set'),
121 ts('Select Result Set'),
123 '' => ts('- select -')
124 ) +
$optionGroups, FALSE,
125 array('onChange' => 'loadOptionGroup( )')
129 $element = &$this->addRadio('option_type',
130 ts('Survey Responses'),
133 'onclick' => "showOptionSelect();"
137 if (empty($optionGroups) ||
empty($this->_values
['result_id'])) {
138 $this->setdefaults(array('option_type' => 1));
140 elseif (!empty($this->_values
['result_id'])) {
141 $this->setdefaults(array(
143 'option_group_id' => $this->_values
['result_id'],
147 // form fields of Custom Option rows
148 $defaultOption = array();
149 $_showHide = new CRM_Core_ShowHideBlocks('', '');
151 $optionAttributes = CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue');
152 $optionAttributes['label']['size'] = $optionAttributes['value']['size'] = 25;
154 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
155 //the show hide blocks
156 $showBlocks = 'optionField_' . $i;
158 $_showHide->addHide($showBlocks);
159 if ($i == self
::NUM_OPTION
) {
160 $_showHide->addHide('additionalOption');
164 $_showHide->addShow($showBlocks);
167 $this->add('text', 'option_label[' . $i . ']', ts('Label'),
168 $optionAttributes['label']
172 $this->add('text', 'option_value[' . $i . ']', ts('Value'),
173 $optionAttributes['value']
177 $this->add('text', "option_weight[$i]", ts('Order'),
178 $optionAttributes['weight']
181 $this->add('text', 'option_interval[' . $i .
182 ']', ts('Recontact Interval'),
183 CRM_Core_DAO
::getAttribute('CRM_Campaign_DAO_Survey', 'release_frequency')
186 $defaultOption[$i] = $this->createElement('radio', NULL, NULL, NULL, $i);
189 //default option selection
190 $this->addGroup($defaultOption, 'default_option');
192 $_showHide->addToTemplate();
194 $this->addElement('checkbox', 'create_report', ts('Create Report'));
195 $this->addElement('text', 'report_title', ts('Report Title'));
197 if ($this->_reportId
) {
198 $this->freeze('create_report');
199 $this->freeze('report_title');
202 $this->addFormRule(array(
203 'CRM_Campaign_Form_Survey_Results',
207 parent
::buildQuickForm();
211 * Global validation rules for the form
214 public static function formRule($fields, $files, $form) {
216 if (!empty($fields['option_label']) && !empty($fields['option_value']) &&
217 (count(array_filter($fields['option_label'])) == 0) &&
218 (count(array_filter($fields['option_value'])) == 0)
220 $errors['option_label[1]'] = ts('Enter at least one result option.');
223 elseif (empty($fields['option_label']) && empty($fields['option_value'])) {
228 $fields['option_type'] == 2 && empty($fields['option_group_id'])
230 $errors['option_group_id'] = ts("Please select a Survey Result Set.");
234 $_flagOption = $_rowError = 0;
235 $_showHide = new CRM_Core_ShowHideBlocks('', '');
237 //capture duplicate Custom option values
238 if (!empty($fields['option_value'])) {
239 $countValue = count($fields['option_value']);
240 $uniqueCount = count(array_unique($fields['option_value']));
242 if ($countValue > $uniqueCount) {
244 while ($start < self
::NUM_OPTION
) {
245 $nextIndex = $start +
1;
247 while ($nextIndex <= self
::NUM_OPTION
) {
248 if ($fields['option_value'][$start] ==
249 $fields['option_value'][$nextIndex] &&
250 !empty($fields['option_value'][$nextIndex])
253 $errors['option_value[' . $start .
254 ']'] = ts('Duplicate Option values');
255 $errors['option_value[' . $nextIndex .
256 ']'] = ts('Duplicate Option values');
266 //capture duplicate Custom Option label
267 if (!empty($fields['option_label'])) {
268 $countValue = count($fields['option_label']);
269 $uniqueCount = count(array_unique($fields['option_label']));
271 if ($countValue > $uniqueCount) {
273 while ($start < self
::NUM_OPTION
) {
274 $nextIndex = $start +
1;
276 while ($nextIndex <= self
::NUM_OPTION
) {
277 if ($fields['option_label'][$start] ==
278 $fields['option_label'][$nextIndex] &&
279 !empty($fields['option_label'][$nextIndex])
281 $errors['option_label[' . $start .
282 ']'] = ts('Duplicate Option label');
283 $errors['option_label[' . $nextIndex .
284 ']'] = ts('Duplicate Option label');
294 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
295 if (!$fields['option_label'][$i]) {
296 if ($fields['option_value'][$i]) {
297 $errors['option_label[' . $i .
298 ']'] = ts('Option label cannot be empty');
305 elseif (!strlen(trim($fields['option_value'][$i]))) {
306 if (!$fields['option_value'][$i]) {
307 $errors['option_value[' . $i .
308 ']'] = ts('Option value cannot be empty');
313 if (!empty($fields['option_interval'][$i]) &&
314 !CRM_Utils_Rule
::integer($fields['option_interval'][$i])
317 $errors['option_interval[' . $i .
318 ']'] = ts('Please enter a valid integer.');
321 $showBlocks = 'optionField_' . $i;
323 $_showHide->addShow($showBlocks);
327 if (!empty($_emptyRow)) {
328 $_showHide->addHide($showBlocks);
331 $_showHide->addShow($showBlocks);
334 if ($i == self
::NUM_OPTION
) {
335 $hideBlock = 'additionalOption';
336 $_showHide->addHide($hideBlock);
339 $_flagOption = $_emptyRow = 0;
341 $_showHide->addToTemplate();
343 return empty($errors) ?
TRUE : $errors;
354 public function postProcess() {
355 // store the submitted values in an array
357 $params = $this->controller
->exportValues($this->_name
);
358 $params['id'] = $this->_surveyId
;
360 $updateResultSet = FALSE;
361 $resultSetOptGrpId = NULL;
362 if ((CRM_Utils_Array
::value('option_type', $params) == 2) &&
363 !empty($params['option_group_id'])
365 $updateResultSet = TRUE;
366 $resultSetOptGrpId = $params['option_group_id'];
369 $recontactInterval = array();
370 if ($updateResultSet) {
371 $optionValue = new CRM_Core_DAO_OptionValue();
372 $optionValue->option_group_id
= $resultSetOptGrpId;
373 $optionValue->delete();
375 $params['result_id'] = $resultSetOptGrpId;
378 $opGroupName = 'civicrm_survey_' . rand(10, 1000) . '_' . date('YmdHis');
380 $optionGroup = new CRM_Core_DAO_OptionGroup();
381 $optionGroup->name
= $opGroupName;
382 $optionGroup->title
= $this->_values
['title'] . ' Result Set';
383 $optionGroup->is_active
= 1;
384 $optionGroup->save();
386 $params['result_id'] = $optionGroup->id
;
389 foreach ($params['option_value'] as $k => $v) {
390 if (strlen(trim($v))) {
391 $optionValue = new CRM_Core_DAO_OptionValue();
392 $optionValue->option_group_id
= $params['result_id'];
393 $optionValue->label
= $params['option_label'][$k];
394 $optionValue->name
= CRM_Utils_String
::titleToVar($params['option_label'][$k]);
395 $optionValue->value
= trim($v);
396 $optionValue->weight
= $params['option_weight'][$k];
397 $optionValue->is_active
= 1;
399 if (!empty($params['default_option']) &&
400 $params['default_option'] == $k
402 $optionValue->is_default
= 1;
405 $optionValue->save();
407 // using is_numeric since 0 is a valid value for option_interval
408 if (is_numeric($params['option_interval'][$k])) {
409 $recontactInterval[$optionValue->label
] = $params['option_interval'][$k];
414 $params['recontact_interval'] = serialize($recontactInterval);
415 $survey = CRM_Campaign_BAO_Survey
::create($params);
417 // create report if required.
418 if (!$this->_reportId
&& $survey->id
&& !empty($params['create_report'])) {
419 $activityStatus = CRM_Core_PseudoConstant
::activityStatus('name');
420 $activityStatus = array_flip($activityStatus);
423 'name' => "survey_{$survey->id}",
424 'title' => $params['report_title'] ?
$params['report_title'] : $this->_values
['title'],
425 'status_id_op' => 'eq',
426 'status_id_value' => $activityStatus['Scheduled'], // reserved status
427 'survey_id_value' => array($survey->id
),
428 'description' => ts('Detailed report for canvassing, phone-banking, walk lists or other surveys.'),
430 //Default value of order by
431 $this->_params
['order_bys'] =
434 'column' => 'sort_name',
438 // for WalkList or default
439 $displayFields = array(
448 if (CRM_Core_OptionGroup
::getValue('activity_type', 'WalkList') ==
449 $this->_values
['activity_type_id']
451 $this->_params
['order_bys'] =
454 'column' => 'street_name',
458 'column' => 'street_number_odd_even',
462 'column' => 'street_number',
466 'column' => 'sort_name',
471 elseif (CRM_Core_OptionGroup
::getValue('activity_type', 'PhoneBank') ==
472 $this->_values
['activity_type_id']
474 array_push($displayFields, 'phone');
476 elseif ((CRM_Core_OptionGroup
::getValue('activity_type', 'Survey') ==
477 $this->_values
['activity_type_id']) ||
478 (CRM_Core_OptionGroup
::getValue('activity_type', 'Canvass') ==
479 $this->_values
['activity_type_id'])
481 array_push($displayFields, 'phone', 'city', 'state_province_id', 'postal_code', 'email');
483 foreach ($displayFields as $key) {
484 $this->_params
['fields'][$key] = 1;
486 $this->_createNew
= TRUE;
487 $this->_id
= CRM_Report_Utils_Report
::getInstanceIDForValue('survey/detail');
488 CRM_Report_Form_Instance
::postProcess($this, FALSE);
490 $query = "SELECT MAX(id) FROM civicrm_report_instance WHERE name = %1";
491 $reportID = CRM_Core_DAO
::singleValueQuery($query, array(
493 "survey_{$survey->id}",
498 $url = CRM_Utils_System
::url("civicrm/report/instance/{$reportID}", 'reset=1');
499 $status = ts("A Survey Detail Report <a href='%1'>%2</a> has been created.",
500 array(1 => $url, 2 => $this->_params
['title']));
505 // reset status as we don't want status set by Instance::postProcess
506 $session = CRM_Core_Session
::singleton();
507 $session->getStatus(TRUE);
509 CRM_Core_Session
::setStatus($status, ts('Saved'), 'success');
512 parent
::endPostProcess();