3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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 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('1' => ts('Create new result set'),
116 '2' => ts('Use existing result set'),
120 ts('Select Result Set'),
122 '' => ts('- select -')) +
$optionGroups, FALSE,
123 array('onChange' => 'loadOptionGroup( )')
127 $element = &$this->addRadio('option_type',
128 ts('Survey Responses'),
131 'onclick' => "showOptionSelect();"), '<br/>', TRUE
134 if (empty($optionGroups) ||
empty($this->_values
['result_id'])) {
135 $this->setdefaults(array('option_type' => 1));
137 elseif (!empty($this->_values
['result_id'])) {
138 $this->setdefaults(array(
140 'option_group_id' => $this->_values
['result_id'],
144 // form fields of Custom Option rows
145 $defaultOption = array();
146 $_showHide = new CRM_Core_ShowHideBlocks('', '');
148 $optionAttributes = CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue');
149 $optionAttributes['label']['size'] = $optionAttributes['value']['size'] = 25;
151 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
152 //the show hide blocks
153 $showBlocks = 'optionField_' . $i;
155 $_showHide->addHide($showBlocks);
156 if ($i == self
::NUM_OPTION
) {
157 $_showHide->addHide('additionalOption');
161 $_showHide->addShow($showBlocks);
164 $this->add('text', 'option_label[' . $i . ']', ts('Label'),
165 $optionAttributes['label']
169 $this->add('text', 'option_value[' . $i . ']', ts('Value'),
170 $optionAttributes['value']
174 $this->add('text', "option_weight[$i]", ts('Order'),
175 $optionAttributes['weight']
178 $this->add('text', 'option_interval[' . $i . ']', ts('Recontact Interval'),
179 CRM_Core_DAO
::getAttribute('CRM_Campaign_DAO_Survey', 'release_frequency')
182 $defaultOption[$i] = $this->createElement('radio', NULL, NULL, NULL, $i);
185 //default option selection
186 $this->addGroup($defaultOption, 'default_option');
188 $_showHide->addToTemplate();
190 $this->addElement('checkbox', 'create_report', ts('Create Report'));
191 $this->addElement('text', 'report_title', ts('Report Title'));
193 if( $this->_reportId
){
194 $this->freeze('create_report');
195 $this->freeze('report_title');
198 $this->addFormRule(array('CRM_Campaign_Form_Survey_Results', 'formRule'), $this);
200 parent
::buildQuickForm();
204 * global validation rules for the form
207 static function formRule($fields, $files, $form) {
209 if (!empty($fields['option_label']) && !empty($fields['option_value']) &&
210 (count(array_filter($fields['option_label'])) == 0) &&
211 (count(array_filter($fields['option_value'])) == 0)
213 $errors['option_label[1]'] = ts('Enter at least one result option.');
216 elseif (empty($fields['option_label']) && empty($fields['option_value'])) {
221 $fields['option_type'] == 2 && empty($fields['option_group_id'])) {
222 $errors['option_group_id'] = ts("Please select a Survey Result Set.");
226 $_flagOption = $_rowError = 0;
227 $_showHide = new CRM_Core_ShowHideBlocks('', '');
229 //capture duplicate Custom option values
230 if (!empty($fields['option_value'])) {
231 $countValue = count($fields['option_value']);
232 $uniqueCount = count(array_unique($fields['option_value']));
234 if ($countValue > $uniqueCount) {
236 while ($start < self
::NUM_OPTION
) {
237 $nextIndex = $start +
1;
239 while ($nextIndex <= self
::NUM_OPTION
) {
240 if ($fields['option_value'][$start] == $fields['option_value'][$nextIndex] &&
241 !empty($fields['option_value'][$nextIndex])
244 $errors['option_value[' . $start . ']'] = ts('Duplicate Option values');
245 $errors['option_value[' . $nextIndex . ']'] = ts('Duplicate Option values');
255 //capture duplicate Custom Option label
256 if (!empty($fields['option_label'])) {
257 $countValue = count($fields['option_label']);
258 $uniqueCount = count(array_unique($fields['option_label']));
260 if ($countValue > $uniqueCount) {
262 while ($start < self
::NUM_OPTION
) {
263 $nextIndex = $start +
1;
265 while ($nextIndex <= self
::NUM_OPTION
) {
266 if ($fields['option_label'][$start] == $fields['option_label'][$nextIndex] && !empty($fields['option_label'][$nextIndex])) {
267 $errors['option_label[' . $start . ']'] = ts('Duplicate Option label');
268 $errors['option_label[' . $nextIndex . ']'] = ts('Duplicate Option label');
278 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
279 if (!$fields['option_label'][$i]) {
280 if ($fields['option_value'][$i]) {
281 $errors['option_label[' . $i . ']'] = ts('Option label cannot be empty');
288 elseif (!strlen(trim($fields['option_value'][$i]))) {
289 if (!$fields['option_value'][$i]) {
290 $errors['option_value[' . $i . ']'] = ts('Option value cannot be empty');
295 if (!empty($fields['option_interval'][$i]) && !CRM_Utils_Rule
::integer($fields['option_interval'][$i])) {
297 $errors['option_interval[' . $i . ']'] = ts('Please enter a valid integer.');
300 $showBlocks = 'optionField_' . $i;
302 $_showHide->addShow($showBlocks);
306 if (!empty($_emptyRow)) {
307 $_showHide->addHide($showBlocks);
310 $_showHide->addShow($showBlocks);
313 if ($i == self
::NUM_OPTION
) {
314 $hideBlock = 'additionalOption';
315 $_showHide->addHide($hideBlock);
318 $_flagOption = $_emptyRow = 0;
320 $_showHide->addToTemplate();
322 return empty($errors) ?
TRUE : $errors;
333 public function postProcess() {
334 // store the submitted values in an array
336 $params = $this->controller
->exportValues($this->_name
);
337 $params['id'] = $this->_surveyId
;
339 $updateResultSet = FALSE;
340 $resultSetOptGrpId = NULL;
341 if ((CRM_Utils_Array
::value('option_type', $params) == 2) && !empty($params['option_group_id'])) {
342 $updateResultSet = TRUE;
343 $resultSetOptGrpId = $params['option_group_id'];
346 $recontactInterval = array();
347 if ($updateResultSet) {
348 $optionValue = new CRM_Core_DAO_OptionValue();
349 $optionValue->option_group_id
= $resultSetOptGrpId;
350 $optionValue->delete();
352 $params['result_id'] = $resultSetOptGrpId;
355 $opGroupName = 'civicrm_survey_' . rand(10, 1000) . '_' . date('YmdHis');
357 $optionGroup = new CRM_Core_DAO_OptionGroup();
358 $optionGroup->name
= $opGroupName;
359 $optionGroup->title
= $this->_values
['title'] . ' Result Set';
360 $optionGroup->is_active
= 1;
361 $optionGroup->save();
363 $params['result_id'] = $optionGroup->id
;
366 foreach ($params['option_value'] as $k => $v) {
367 if (strlen(trim($v))) {
368 $optionValue = new CRM_Core_DAO_OptionValue();
369 $optionValue->option_group_id
= $params['result_id'];
370 $optionValue->label
= $params['option_label'][$k];
371 $optionValue->name
= CRM_Utils_String
::titleToVar($params['option_label'][$k]);
372 $optionValue->value
= trim($v);
373 $optionValue->weight
= $params['option_weight'][$k];
374 $optionValue->is_active
= 1;
376 if (!empty($params['default_option']) &&
377 $params['default_option'] == $k
379 $optionValue->is_default
= 1;
382 $optionValue->save();
384 // using is_numeric since 0 is a valid value for option_interval
385 if ( is_numeric($params['option_interval'][$k])) {
386 $recontactInterval[$optionValue->label
] = $params['option_interval'][$k];
391 $params['recontact_interval'] = serialize($recontactInterval);
392 $survey = CRM_Campaign_BAO_Survey
::create($params);
394 // create report if required.
395 if ( !$this->_reportId
&& $survey->id
&& !empty($params['create_report'])) {
396 $activityStatus = CRM_Core_PseudoConstant
::activityStatus('name');
397 $activityStatus = array_flip($activityStatus);
399 array( 'name' => "survey_{$survey->id}",
400 'title' => $params['report_title'] ?
$params['report_title'] : $this->_values
['title'],
401 'status_id_op' => 'eq',
402 'status_id_value' => $activityStatus['Scheduled'], // reserved status
403 'survey_id_value' => array($survey->id
),
404 'description' => ts('Detailed report for canvassing, phone-banking, walk lists or other surveys.'),
406 //Default value of order by
407 $this->_params
['order_bys'] =
411 'column' => 'sort_name',
415 // for WalkList or default
416 $displayFields = array('id', 'sort_name', 'result', 'street_number','street_name','street_unit','survey_response');
417 if ( CRM_Core_OptionGroup
::getValue('activity_type','WalkList') == $this->_values
['activity_type_id'] ) {
418 $this->_params
['order_bys'] =
422 'column' => 'street_name',
427 'column' => 'street_number_odd_even',
432 'column' => 'street_number',
437 'column' => 'sort_name',
442 elseif ( CRM_Core_OptionGroup
::getValue('activity_type','PhoneBank') == $this->_values
['activity_type_id'] ) {
443 array_push($displayFields, 'phone');
445 elseif ((CRM_Core_OptionGroup
::getValue('activity_type','Survey') == $this->_values
['activity_type_id']) ||
446 (CRM_Core_OptionGroup
::getValue('activity_type','Canvass') == $this->_values
['activity_type_id']) ) {
447 array_push($displayFields, 'phone','city','state_province_id','postal_code','email');
449 foreach($displayFields as $key){
450 $this->_params
['fields'][$key] = 1;
452 $this->_createNew
= TRUE;
453 $this->_id
= CRM_Report_Utils_Report
::getInstanceIDForValue('survey/detail');
454 CRM_Report_Form_Instance
::postProcess($this, FALSE);
456 $query = "SELECT MAX(id) FROM civicrm_report_instance WHERE name = %1";
457 $reportID = CRM_Core_DAO
::singleValueQuery($query, array(1 => array("survey_{$survey->id}",'String')));
459 $url = CRM_Utils_System
::url("civicrm/report/instance/{$reportID}",'reset=1');
460 $status = ts("A Survey Detail Report <a href='%1'>%2</a> has been created.",
461 array(1 => $url, 2 => $this->_params
['title']));
466 // reset status as we don't want status set by Instance::postProcess
467 $session = CRM_Core_Session
::singleton();
468 $session->getStatus(TRUE);
470 CRM_Core_Session
::setStatus($status, ts('Saved'), 'success');
473 parent
::endPostProcess();