Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.3 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
31 | * @copyright CiviCRM LLC (c) 2004-2013 | |
32 | * $Id$ | |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * This class generates form components for processing a survey | |
38 | * | |
39 | */ | |
40 | class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey { | |
41 | ||
42 | protected $_reportId; | |
43 | ||
44 | protected $_reportTitle; | |
45 | ||
46 | /* values | |
47 | * | |
48 | * @var array | |
49 | */ | |
50 | public $_values; | |
51 | ||
52 | CONST NUM_OPTION = 11; | |
53 | ||
54 | public function preProcess() { | |
55 | parent::preProcess(); | |
56 | ||
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); | |
63 | } | |
64 | $this->set('values', $this->_values); | |
65 | } | |
66 | ||
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; | |
73 | } | |
74 | } | |
75 | ||
76 | /** | |
77 | * This function sets the default values for the form. Note that in edit/view mode | |
78 | * the default values are retrieved from the database | |
79 | * | |
80 | * @param null | |
81 | * | |
82 | * @return array array of default values | |
83 | * @access public | |
84 | */ | |
85 | function setDefaultValues() { | |
86 | $defaults = $this->_values; | |
87 | ||
88 | // set defaults for weight. | |
89 | for ($i = 1; $i <= self::NUM_OPTION; $i++) { | |
90 | $defaults["option_weight[{$i}]"] = $i; | |
91 | } | |
92 | ||
93 | $defaults['create_report'] = 1; | |
94 | if ($this->_reportId) { | |
95 | $defaults['report_title'] = $this->_reportTitle; | |
96 | } | |
97 | return $defaults; | |
98 | } | |
99 | ||
100 | /** | |
101 | * Function to actually build the form | |
102 | * | |
103 | * @param null | |
104 | * | |
105 | * @return void | |
106 | * @access public | |
107 | */ | |
108 | public function buildQuickForm() { | |
109 | $optionGroups = CRM_Campaign_BAO_Survey::getResultSets(); | |
110 | ||
111 | if (empty($optionGroups)) { | |
112 | $optionTypes = array('1' => ts('Create new result set')); | |
113 | } | |
114 | else { | |
115 | $optionTypes = array('1' => ts('Create a new result set'), | |
116 | '2' => ts('Use existing result set'), | |
117 | ); | |
118 | $this->add('select', | |
119 | 'option_group_id', | |
120 | ts('Select Result Set'), | |
121 | array( | |
122 | '' => ts('- select -')) + $optionGroups, FALSE, | |
123 | array('onChange' => 'loadOptionGroup( )') | |
124 | ); | |
125 | } | |
126 | ||
127 | $element = &$this->addRadio('option_type', | |
128 | ts('Survey Responses'), | |
129 | $optionTypes, | |
130 | array( | |
131 | 'onclick' => "showOptionSelect();"), '<br/>', TRUE | |
132 | ); | |
133 | ||
134 | if (empty($optionGroups) || !CRM_Utils_Array::value('result_id', $this->_values)) { | |
135 | $this->setdefaults(array('option_type' => 1)); | |
136 | } | |
137 | elseif (CRM_Utils_Array::value('result_id', $this->_values)) { | |
138 | $this->setdefaults(array( | |
139 | 'option_type' => 2, | |
140 | 'option_group_id' => $this->_values['result_id'], | |
141 | )); | |
142 | } | |
143 | ||
144 | // form fields of Custom Option rows | |
145 | $defaultOption = array(); | |
146 | $_showHide = new CRM_Core_ShowHideBlocks('', ''); | |
147 | ||
148 | $optionAttributes = CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue'); | |
149 | $optionAttributes['label']['size'] = $optionAttributes['value']['size'] = 25; | |
150 | ||
151 | for ($i = 1; $i <= self::NUM_OPTION; $i++) { | |
152 | //the show hide blocks | |
153 | $showBlocks = 'optionField_' . $i; | |
154 | if ($i > 2) { | |
155 | $_showHide->addHide($showBlocks); | |
156 | if ($i == self::NUM_OPTION) { | |
157 | $_showHide->addHide('additionalOption'); | |
158 | } | |
159 | } | |
160 | else { | |
161 | $_showHide->addShow($showBlocks); | |
162 | } | |
163 | ||
164 | $this->add('text', 'option_label[' . $i . ']', ts('Label'), | |
165 | $optionAttributes['label'] | |
166 | ); | |
167 | ||
168 | // value | |
169 | $this->add('text', 'option_value[' . $i . ']', ts('Value'), | |
170 | $optionAttributes['value'] | |
171 | ); | |
172 | ||
173 | // weight | |
174 | $this->add('text', "option_weight[$i]", ts('Order'), | |
175 | $optionAttributes['weight'] | |
176 | ); | |
177 | ||
178 | $this->add('text', 'option_interval[' . $i . ']', ts('Recontact Interval'), | |
179 | CRM_Core_DAO::getAttribute('CRM_Campaign_DAO_Survey', 'release_frequency') | |
180 | ); | |
181 | ||
182 | $defaultOption[$i] = $this->createElement('radio', NULL, NULL, NULL, $i); | |
183 | } | |
184 | ||
185 | //default option selection | |
186 | $this->addGroup($defaultOption, 'default_option'); | |
187 | ||
188 | $_showHide->addToTemplate(); | |
189 | ||
190 | $this->addElement('checkbox', 'create_report', ts('Create Report')); | |
191 | $this->addElement('text', 'report_title', ts('Report Title')); | |
8ef12e64 | 192 | |
6a488035 TO |
193 | if( $this->_reportId){ |
194 | $this->freeze('create_report'); | |
195 | $this->freeze('report_title'); | |
196 | } | |
197 | ||
198 | $this->addFormRule(array('CRM_Campaign_Form_Survey_Results', 'formRule'), $this); | |
199 | ||
200 | parent::buildQuickForm(); | |
201 | } | |
202 | ||
203 | /** | |
204 | * global validation rules for the form | |
205 | * | |
206 | */ | |
207 | static function formRule($fields, $files, $form) { | |
208 | $errors = array(); | |
968c2c5f DL |
209 | if ( |
210 | CRM_Utils_Array::value('option_label', $fields) && | |
6a488035 TO |
211 | CRM_Utils_Array::value('option_value', $fields) && |
212 | (count(array_filter($fields['option_label'])) == 0) && | |
213 | (count(array_filter($fields['option_value'])) == 0) | |
214 | ) { | |
215 | $errors['option_label[1]'] = ts('Enter at least one result option.'); | |
216 | return $errors; | |
217 | } | |
968c2c5f DL |
218 | elseif ( |
219 | !CRM_Utils_Array::value('option_label', $fields) && | |
6a488035 TO |
220 | !CRM_Utils_Array::value('option_value', $fields) |
221 | ) { | |
222 | return $errors; | |
223 | } | |
224 | ||
968c2c5f DL |
225 | if ( |
226 | $fields['option_type'] == 2 && | |
6a488035 TO |
227 | !CRM_Utils_Array::value('option_group_id', $fields) |
228 | ) { | |
229 | $errors['option_group_id'] = ts("Please select a Survey Result Set."); | |
230 | return $errors; | |
231 | } | |
232 | ||
233 | $_flagOption = $_rowError = 0; | |
234 | $_showHide = new CRM_Core_ShowHideBlocks('', ''); | |
235 | ||
236 | //capture duplicate Custom option values | |
237 | if (!empty($fields['option_value'])) { | |
238 | $countValue = count($fields['option_value']); | |
239 | $uniqueCount = count(array_unique($fields['option_value'])); | |
240 | ||
241 | if ($countValue > $uniqueCount) { | |
242 | $start = 1; | |
243 | while ($start < self::NUM_OPTION) { | |
244 | $nextIndex = $start + 1; | |
245 | ||
246 | while ($nextIndex <= self::NUM_OPTION) { | |
247 | if ($fields['option_value'][$start] == $fields['option_value'][$nextIndex] && | |
248 | !empty($fields['option_value'][$nextIndex]) | |
249 | ) { | |
250 | ||
251 | $errors['option_value[' . $start . ']'] = ts('Duplicate Option values'); | |
252 | $errors['option_value[' . $nextIndex . ']'] = ts('Duplicate Option values'); | |
253 | $_flagOption = 1; | |
254 | } | |
255 | $nextIndex++; | |
256 | } | |
257 | $start++; | |
258 | } | |
259 | } | |
260 | } | |
261 | ||
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'])); | |
266 | ||
267 | if ($countValue > $uniqueCount) { | |
268 | $start = 1; | |
269 | while ($start < self::NUM_OPTION) { | |
270 | $nextIndex = $start + 1; | |
271 | ||
272 | while ($nextIndex <= self::NUM_OPTION) { | |
273 | if ($fields['option_label'][$start] == $fields['option_label'][$nextIndex] && !empty($fields['option_label'][$nextIndex])) { | |
274 | $errors['option_label[' . $start . ']'] = ts('Duplicate Option label'); | |
275 | $errors['option_label[' . $nextIndex . ']'] = ts('Duplicate Option label'); | |
276 | $_flagOption = 1; | |
277 | } | |
278 | $nextIndex++; | |
279 | } | |
280 | $start++; | |
281 | } | |
282 | } | |
283 | } | |
284 | ||
285 | for ($i = 1; $i <= self::NUM_OPTION; $i++) { | |
286 | if (!$fields['option_label'][$i]) { | |
287 | if ($fields['option_value'][$i]) { | |
288 | $errors['option_label[' . $i . ']'] = ts('Option label cannot be empty'); | |
289 | $_flagOption = 1; | |
290 | } | |
291 | else { | |
292 | $_emptyRow = 1; | |
293 | } | |
294 | } | |
295 | elseif (!strlen(trim($fields['option_value'][$i]))) { | |
296 | if (!$fields['option_value'][$i]) { | |
297 | $errors['option_value[' . $i . ']'] = ts('Option value cannot be empty'); | |
298 | $_flagOption = 1; | |
299 | } | |
300 | } | |
301 | ||
302 | if (CRM_Utils_Array::value($i, $fields['option_interval']) && !CRM_Utils_Rule::integer($fields['option_interval'][$i])) { | |
303 | $_flagOption = 1; | |
304 | $errors['option_interval[' . $i . ']'] = ts('Please enter a valid integer.'); | |
305 | } | |
306 | ||
307 | $showBlocks = 'optionField_' . $i; | |
308 | if ($_flagOption) { | |
309 | $_showHide->addShow($showBlocks); | |
310 | $_rowError = 1; | |
311 | } | |
312 | ||
313 | if (!empty($_emptyRow)) { | |
314 | $_showHide->addHide($showBlocks); | |
315 | } | |
316 | else { | |
317 | $_showHide->addShow($showBlocks); | |
318 | } | |
319 | ||
320 | if ($i == self::NUM_OPTION) { | |
321 | $hideBlock = 'additionalOption'; | |
322 | $_showHide->addHide($hideBlock); | |
323 | } | |
324 | ||
325 | $_flagOption = $_emptyRow = 0; | |
326 | } | |
327 | $_showHide->addToTemplate(); | |
328 | ||
329 | return empty($errors) ? TRUE : $errors; | |
330 | } | |
331 | ||
332 | /** | |
333 | * Process the form | |
334 | * | |
335 | * @param null | |
336 | * | |
337 | * @return void | |
338 | * @access public | |
339 | */ | |
340 | public function postProcess() { | |
341 | // store the submitted values in an array | |
342 | $status = ''; | |
343 | $params = $this->controller->exportValues($this->_name); | |
344 | $params['id'] = $this->_surveyId; | |
345 | ||
346 | $updateResultSet = FALSE; | |
347 | $resultSetOptGrpId = NULL; | |
348 | if ((CRM_Utils_Array::value('option_type', $params) == 2) && | |
349 | CRM_Utils_Array::value('option_group_id', $params) | |
350 | ) { | |
351 | $updateResultSet = TRUE; | |
352 | $resultSetOptGrpId = $params['option_group_id']; | |
353 | } | |
354 | ||
355 | $recontactInterval = array(); | |
356 | if ($updateResultSet) { | |
357 | $optionValue = new CRM_Core_DAO_OptionValue(); | |
358 | $optionValue->option_group_id = $resultSetOptGrpId; | |
359 | $optionValue->delete(); | |
360 | ||
361 | $params['result_id'] = $resultSetOptGrpId; | |
362 | } | |
363 | else { | |
364 | $opGroupName = 'civicrm_survey_' . rand(10, 1000) . '_' . date('YmdHis'); | |
365 | ||
366 | $optionGroup = new CRM_Core_DAO_OptionGroup(); | |
367 | $optionGroup->name = $opGroupName; | |
368 | $optionGroup->title = $this->_values['title'] . ' Result Set'; | |
369 | $optionGroup->is_active = 1; | |
370 | $optionGroup->save(); | |
371 | ||
372 | $params['result_id'] = $optionGroup->id; | |
373 | } | |
374 | ||
375 | foreach ($params['option_value'] as $k => $v) { | |
376 | if (strlen(trim($v))) { | |
377 | $optionValue = new CRM_Core_DAO_OptionValue(); | |
378 | $optionValue->option_group_id = $params['result_id']; | |
379 | $optionValue->label = $params['option_label'][$k]; | |
380 | $optionValue->name = CRM_Utils_String::titleToVar($params['option_label'][$k]); | |
381 | $optionValue->value = trim($v); | |
382 | $optionValue->weight = $params['option_weight'][$k]; | |
383 | $optionValue->is_active = 1; | |
384 | ||
385 | if (CRM_Utils_Array::value('default_option', $params) && | |
386 | $params['default_option'] == $k | |
387 | ) { | |
388 | $optionValue->is_default = 1; | |
389 | } | |
390 | ||
391 | $optionValue->save(); | |
392 | ||
393 | // using is_numeric since 0 is a valid value for option_interval | |
394 | if ( is_numeric($params['option_interval'][$k])) { | |
395 | $recontactInterval[$optionValue->label] = $params['option_interval'][$k]; | |
396 | } | |
397 | } | |
398 | } | |
399 | ||
400 | $params['recontact_interval'] = serialize($recontactInterval); | |
401 | $survey = CRM_Campaign_BAO_Survey::create($params); | |
402 | ||
403 | // create report if required. | |
a019ffee | 404 | if ( !$this->_reportId && $survey->id && CRM_Utils_Array::value('create_report', $params) ) { |
6a488035 TO |
405 | $activityStatus = CRM_Core_PseudoConstant::activityStatus('name'); |
406 | $activityStatus = array_flip($activityStatus); | |
8ef12e64 | 407 | $this->_params = |
6a488035 | 408 | array( 'name' => "survey_{$survey->id}", |
8ef12e64 | 409 | 'title' => $params['report_title'] ? $params['report_title'] : $this->_values['title'], |
6a488035 TO |
410 | 'status_id_op' => 'eq', |
411 | 'status_id_value' => $activityStatus['Scheduled'], // reserved status | |
8ef12e64 | 412 | 'survey_id_value' => array($survey->id), |
6a488035 TO |
413 | 'description' => ts('Detailed report for canvassing, phone-banking, walk lists or other surveys.'), |
414 | ); | |
415 | //Default value of order by | |
416 | $this->_params['order_bys'] = | |
417 | array( | |
418 | 1 => | |
419 | array( | |
420 | 'column' => 'sort_name', | |
421 | 'order' => 'ASC' | |
422 | ), | |
423 | ); | |
424 | // for WalkList or default | |
425 | $displayFields = array('id', 'sort_name', 'result', 'street_number','street_name','street_unit','survey_response'); | |
426 | if ( CRM_Core_OptionGroup::getValue('activity_type','WalkList') == $this->_values['activity_type_id'] ) { | |
427 | $this->_params['order_bys'] = | |
428 | array( | |
429 | 1 => | |
430 | array( | |
431 | 'column' => 'street_name', | |
432 | 'order' => 'ASC' | |
433 | ), | |
434 | 2 => | |
435 | array( | |
436 | 'column' => 'street_number_odd_even', | |
437 | 'order' => 'ASC' | |
438 | ), | |
439 | 3 => | |
440 | array( | |
441 | 'column' => 'street_number', | |
442 | 'order' => 'ASC' | |
443 | ), | |
444 | 4 => | |
445 | array( | |
446 | 'column' => 'sort_name', | |
447 | 'order' => 'ASC' | |
448 | ), | |
449 | ); | |
450 | } | |
451 | elseif ( CRM_Core_OptionGroup::getValue('activity_type','PhoneBank') == $this->_values['activity_type_id'] ) { | |
452 | array_push($displayFields, 'phone'); | |
453 | } | |
8ef12e64 | 454 | elseif ((CRM_Core_OptionGroup::getValue('activity_type','Survey') == $this->_values['activity_type_id']) || |
6a488035 TO |
455 | (CRM_Core_OptionGroup::getValue('activity_type','Canvass') == $this->_values['activity_type_id']) ) { |
456 | array_push($displayFields, 'phone','city','state_province_id','postal_code','email'); | |
457 | } | |
458 | foreach($displayFields as $key){ | |
459 | $this->_params['fields'][$key] = 1; | |
8ef12e64 | 460 | } |
6a488035 TO |
461 | $this->_createNew = TRUE; |
462 | $this->_id = CRM_Report_Utils_Report::getInstanceIDForValue('survey/detail'); | |
463 | CRM_Report_Form_Instance::postProcess($this, FALSE); | |
8ef12e64 | 464 | |
6a488035 TO |
465 | $query = "SELECT MAX(id) FROM civicrm_report_instance WHERE name = %1"; |
466 | $reportID = CRM_Core_DAO::singleValueQuery($query, array(1 => array("survey_{$survey->id}",'String'))); | |
467 | if ($reportID) { | |
468 | $url = CRM_Utils_System::url("civicrm/report/instance/{$reportID}",'reset=1'); | |
8ef12e64 | 469 | $status = ts("A Survey Detail Report <a href='%1'>%2</a> has been created.", |
6a488035 TO |
470 | array(1 => $url, 2 => $this->_params['title'])); |
471 | } | |
472 | } | |
473 | ||
474 | if ($status) { | |
475 | // reset status as we don't want status set by Instance::postProcess | |
476 | $session = CRM_Core_Session::singleton(); | |
477 | $session->getStatus(TRUE); | |
478 | // set new status | |
479 | CRM_Core_Session::setStatus($status, ts('Saved'), 'success'); | |
480 | } | |
481 | ||
482 | parent::endPostProcess(); | |
483 | } | |
484 | } |