CRM/Campaign/Form/Survey/Results.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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    * Set default values for the form. Note that in edit/view mode
  78    * the default values are retrieved from the database
  79    *
  80    * @return array
  81    *   array of default values
  82    */
  83   public function setDefaultValues() {
  84     $defaults = $this->_values;
  85
  86     // set defaults for weight.
  87     for ($i = 1; $i <= self::NUM_OPTION; $i++) {
  88       $defaults["option_weight[{$i}]"] = $i;
  89     }
  90
  91     $defaults['create_report'] = 1;
  92     if ($this->_reportId) {
  93       $defaults['report_title'] = $this->_reportTitle;
  94     }
  95     return $defaults;
  96   }
  97
  98   /**
  99    * Build the form object
 100    *
 101    * @return void
 102    */
 103   public function buildQuickForm() {
 104     $optionGroups = CRM_Campaign_BAO_Survey::getResultSets();
 105
 106     if (empty($optionGroups)) {
 107       $optionTypes = array('1' => ts('Create new result set'));
 108     }
 109     else {
 110       $optionTypes = array(
 111         '1' => ts('Create new result set'),
 112         '2' => ts('Use existing result set'),
 113       );
 114       $this->add('select',
 115         'option_group_id',
 116         ts('Select Result Set'),
 117         array(
 118           '' => ts('- select -'),
 119         ) + $optionGroups, FALSE,
 120         array('onChange' => 'loadOptionGroup( )')
 121       );
 122     }
 123
 124     $element = &$this->addRadio('option_type',
 125       ts('Survey Responses'),
 126       $optionTypes,
 127       array(
 128         'onclick' => "showOptionSelect();",
 129       ), '<br/>', TRUE
 130     );
 131
 132     if (empty($optionGroups) || empty($this->_values['result_id'])) {
 133       $this->setdefaults(array('option_type' => 1));
 134     }
 135     elseif (!empty($this->_values['result_id'])) {
 136       $this->setdefaults(array(
 137         'option_type' => 2,
 138         'option_group_id' => $this->_values['result_id'],
 139       ));
 140     }
 141
 142     // form fields of Custom Option rows
 143     $defaultOption = array();
 144     $_showHide = new CRM_Core_ShowHideBlocks('', '');
 145
 146     $optionAttributes = CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue');
 147     $optionAttributes['label']['size'] = $optionAttributes['value']['size'] = 25;
 148
 149     for ($i = 1; $i <= self::NUM_OPTION; $i++) {
 150       //the show hide blocks
 151       $showBlocks = 'optionField_' . $i;
 152       if ($i > 2) {
 153         $_showHide->addHide($showBlocks);
 154         if ($i == self::NUM_OPTION) {
 155           $_showHide->addHide('additionalOption');
 156         }
 157       }
 158       else {
 159         $_showHide->addShow($showBlocks);
 160       }
 161
 162       $this->add('text', 'option_label[' . $i . ']', ts('Label'),
 163         $optionAttributes['label']
 164       );
 165
 166       // value
 167       $this->add('text', 'option_value[' . $i . ']', ts('Value'),
 168         $optionAttributes['value']
 169       );
 170
 171       // weight
 172       $this->add('text', "option_weight[$i]", ts('Order'),
 173         $optionAttributes['weight']
 174       );
 175
 176       $this->add('text', 'option_interval[' . $i .
 177         ']', ts('Recontact Interval'),
 178         CRM_Core_DAO::getAttribute('CRM_Campaign_DAO_Survey', 'release_frequency')
 179       );
 180
 181       $defaultOption[$i] = $this->createElement('radio', NULL, NULL, NULL, $i);
 182     }
 183
 184     //default option selection
 185     $this->addGroup($defaultOption, 'default_option');
 186
 187     $_showHide->addToTemplate();
 188
 189     $this->addElement('checkbox', 'create_report', ts('Create Report'));
 190     $this->addElement('text', 'report_title', ts('Report Title'));
 191
 192     if ($this->_reportId) {
 193       $this->freeze('create_report');
 194       $this->freeze('report_title');
 195     }
 196
 197     $this->addFormRule(array(
 198       'CRM_Campaign_Form_Survey_Results',
 199       'formRule',
 200     ), $this);
 201
 202     parent::buildQuickForm();
 203   }
 204
 205   /**
 206    * Global validation rules for the form
 207    */
 208   public static function formRule($fields, $files, $form) {
 209     $errors = array();
 210     if (!empty($fields['option_label']) && !empty($fields['option_value']) &&
 211       (count(array_filter($fields['option_label'])) == 0) &&
 212       (count(array_filter($fields['option_value'])) == 0)
 213     ) {
 214       $errors['option_label[1]'] = ts('Enter at least one result option.');
 215       return $errors;
 216     }
 217     elseif (empty($fields['option_label']) && empty($fields['option_value'])) {
 218       return $errors;
 219     }
 220
 221     if (
 222       $fields['option_type'] == 2 && empty($fields['option_group_id'])
 223     ) {
 224       $errors['option_group_id'] = ts("Please select a Survey Result Set.");
 225       return $errors;
 226     }
 227
 228     $_flagOption = $_rowError = 0;
 229     $_showHide = new CRM_Core_ShowHideBlocks('', '');
 230
 231     //capture duplicate Custom option values
 232     if (!empty($fields['option_value'])) {
 233       $countValue = count($fields['option_value']);
 234       $uniqueCount = count(array_unique($fields['option_value']));
 235
 236       if ($countValue > $uniqueCount) {
 237         $start = 1;
 238         while ($start < self::NUM_OPTION) {
 239           $nextIndex = $start + 1;
 240
 241           while ($nextIndex <= self::NUM_OPTION) {
 242             if ($fields['option_value'][$start] ==
 243               $fields['option_value'][$nextIndex] &&
 244               !empty($fields['option_value'][$nextIndex])
 245             ) {
 246
 247               $errors['option_value[' . $start .
 248               ']'] = ts('Duplicate Option values');
 249               $errors['option_value[' . $nextIndex .
 250               ']'] = ts('Duplicate Option values');
 251               $_flagOption = 1;
 252             }
 253             $nextIndex++;
 254           }
 255           $start++;
 256         }
 257       }
 258     }
 259
 260     //capture duplicate Custom Option label
 261     if (!empty($fields['option_label'])) {
 262       $countValue = count($fields['option_label']);
 263       $uniqueCount = count(array_unique($fields['option_label']));
 264
 265       if ($countValue > $uniqueCount) {
 266         $start = 1;
 267         while ($start < self::NUM_OPTION) {
 268           $nextIndex = $start + 1;
 269
 270           while ($nextIndex <= self::NUM_OPTION) {
 271             if ($fields['option_label'][$start] ==
 272               $fields['option_label'][$nextIndex] &&
 273               !empty($fields['option_label'][$nextIndex])
 274             ) {
 275               $errors['option_label[' . $start .
 276               ']'] = ts('Duplicate Option label');
 277               $errors['option_label[' . $nextIndex .
 278               ']'] = ts('Duplicate Option label');
 279               $_flagOption = 1;
 280             }
 281             $nextIndex++;
 282           }
 283           $start++;
 284         }
 285       }
 286     }
 287
 288     for ($i = 1; $i <= self::NUM_OPTION; $i++) {
 289       if (!$fields['option_label'][$i]) {
 290         if ($fields['option_value'][$i]) {
 291           $errors['option_label[' . $i .
 292           ']'] = ts('Option label cannot be empty');
 293           $_flagOption = 1;
 294         }
 295         else {
 296           $_emptyRow = 1;
 297         }
 298       }
 299       elseif (!strlen(trim($fields['option_value'][$i]))) {
 300         if (!$fields['option_value'][$i]) {
 301           $errors['option_value[' . $i .
 302           ']'] = ts('Option value cannot be empty');
 303           $_flagOption = 1;
 304         }
 305       }
 306
 307       if (!empty($fields['option_interval'][$i]) &&
 308         !CRM_Utils_Rule::integer($fields['option_interval'][$i])
 309       ) {
 310         $_flagOption = 1;
 311         $errors['option_interval[' . $i .
 312         ']'] = ts('Please enter a valid integer.');
 313       }
 314
 315       $showBlocks = 'optionField_' . $i;
 316       if ($_flagOption) {
 317         $_showHide->addShow($showBlocks);
 318         $_rowError = 1;
 319       }
 320
 321       if (!empty($_emptyRow)) {
 322         $_showHide->addHide($showBlocks);
 323       }
 324       else {
 325         $_showHide->addShow($showBlocks);
 326       }
 327
 328       if ($i == self::NUM_OPTION) {
 329         $hideBlock = 'additionalOption';
 330         $_showHide->addHide($hideBlock);
 331       }
 332
 333       $_flagOption = $_emptyRow = 0;
 334     }
 335     $_showHide->addToTemplate();
 336
 337     return empty($errors) ? TRUE : $errors;
 338   }
 339
 340   /**
 341    * Process the form
 342    *
 343    * @return void
 344    */
 345   public function postProcess() {
 346     // store the submitted values in an array
 347     $status = '';
 348     $params = $this->controller->exportValues($this->_name);
 349     $params['id'] = $this->_surveyId;
 350
 351     $updateResultSet = FALSE;
 352     $resultSetOptGrpId = NULL;
 353     if ((CRM_Utils_Array::value('option_type', $params) == 2) &&
 354       !empty($params['option_group_id'])
 355     ) {
 356       $updateResultSet = TRUE;
 357       $resultSetOptGrpId = $params['option_group_id'];
 358     }
 359
 360     $recontactInterval = array();
 361     if ($updateResultSet) {
 362       $optionValue = new CRM_Core_DAO_OptionValue();
 363       $optionValue->option_group_id = $resultSetOptGrpId;
 364       $optionValue->delete();
 365
 366       $params['result_id'] = $resultSetOptGrpId;
 367     }
 368     else {
 369       $opGroupName = 'civicrm_survey_' . rand(10, 1000) . '_' . date('YmdHis');
 370
 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();
 376
 377       $params['result_id'] = $optionGroup->id;
 378     }
 379
 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;
 389
 390         if (!empty($params['default_option']) &&
 391           $params['default_option'] == $k
 392         ) {
 393           $optionValue->is_default = 1;
 394         }
 395
 396         $optionValue->save();
 397
 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];
 401         }
 402       }
 403     }
 404
 405     $params['recontact_interval'] = serialize($recontactInterval);
 406     $survey = CRM_Campaign_BAO_Survey::create($params);
 407
 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.'),
 419       );
 420       //Default value of order by
 421       $this->_params['order_bys'] = array(
 422         1 => array(
 423           'column' => 'sort_name',
 424           'order' => 'ASC',
 425         ),
 426       );
 427       // for WalkList or default
 428       $displayFields = array(
 429         'id',
 430         'sort_name',
 431         'result',
 432         'street_number',
 433         'street_name',
 434         'street_unit',
 435         'survey_response',
 436       );
 437       if (CRM_Core_OptionGroup::getValue('activity_type', 'WalkList') ==
 438         $this->_values['activity_type_id']
 439       ) {
 440         $this->_params['order_bys'] = array(
 441           1 => array(
 442             'column' => 'street_name',
 443             'order' => 'ASC',
 444           ),
 445           2 => array(
 446             'column' => 'street_number_odd_even',
 447             'order' => 'ASC',
 448           ),
 449           3 => array(
 450             'column' => 'street_number',
 451             'order' => 'ASC',
 452           ),
 453           4 => array(
 454             'column' => 'sort_name',
 455             'order' => 'ASC',
 456           ),
 457         );
 458       }
 459       elseif (CRM_Core_OptionGroup::getValue('activity_type', 'PhoneBank') ==
 460         $this->_values['activity_type_id']
 461       ) {
 462         array_push($displayFields, 'phone');
 463       }
 464       elseif ((CRM_Core_OptionGroup::getValue('activity_type', 'Survey') ==
 465           $this->_values['activity_type_id']) ||
 466         (CRM_Core_OptionGroup::getValue('activity_type', 'Canvass') ==
 467           $this->_values['activity_type_id'])
 468       ) {
 469         array_push($displayFields, 'phone', 'city', 'state_province_id', 'postal_code', 'email');
 470       }
 471       foreach ($displayFields as $key) {
 472         $this->_params['fields'][$key] = 1;
 473       }
 474       $this->_createNew = TRUE;
 475       $this->_id = CRM_Report_Utils_Report::getInstanceIDForValue('survey/detail');
 476       CRM_Report_Form_Instance::postProcess($this, FALSE);
 477
 478       $query = "SELECT MAX(id) FROM civicrm_report_instance WHERE name = %1";
 479       $reportID = CRM_Core_DAO::singleValueQuery($query, array(
 480         1 => array(
 481           "survey_{$survey->id}",
 482           'String',
 483         ),
 484       ));
 485       if ($reportID) {
 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']));
 489       }
 490     }
 491
 492     if ($status) {
 493       // reset status as we don't want status set by Instance::postProcess
 494       $session = CRM_Core_Session::singleton();
 495       $session->getStatus(TRUE);
 496       // set new status
 497       CRM_Core_Session::setStatus($status, ts('Saved'), 'success');
 498     }
 499
 500     parent::endPostProcess();
 501   }
 502
 503 }