CRM/Campaign/Form/Task/Reserve.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 provides the functionality to add contacts for
  38  * voter reservation.
  39  */
  40 class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task {
  41
  42   /**
  43    * Survet id`
  44    *
  45    * @var int
  46    */
  47   protected $_surveyId;
  48
  49   /**
  50    * Interviewer id
  51    *
  52    * @var int
  53    */
  54   protected $_interviewerId;
  55
  56   /**
  57    * Survey details
  58    *
  59    * @var object
  60    */
  61   protected $_surveyDetails;
  62
  63   /**
  64    * Number of voters
  65    *
  66    * @var int
  67    */
  68   protected $_numVoters;
  69
  70   /**
  71    * Build all the data structures needed to build the form
  72    *
  73    * @return void
  74    */
  75   public function preProcess() {
  76     parent::preProcess();
  77
  78     //get the survey id from user submitted values.
  79     $this->_surveyId = $this->get('surveyId');
  80     $this->_interviewerId = $this->get('interviewerId');
  81     if (!$this->_surveyId) {
  82       CRM_Core_Error::statusBounce(ts("Could not find Survey Id."));
  83     }
  84     if (!$this->_interviewerId) {
  85       CRM_Core_Error::statusBounce(ts("Missing Interviewer contact."));
  86     }
  87     if (!is_array($this->_contactIds) || empty($this->_contactIds)) {
  88       CRM_Core_Error::statusBounce(ts("Could not find contacts for reservation."));
  89     }
  90
  91     $params = array('id' => $this->_surveyId);
  92     CRM_Campaign_BAO_Survey::retrieve($params, $this->_surveyDetails);
  93
  94     //get the survey activities.
  95     $activityStatus = CRM_Core_PseudoConstant::activityStatus('name');
  96     $statusIds = array();
  97     foreach (array(
  98                'Scheduled'
  99              ) as $name) {
 100       if ($statusId = array_search($name, $activityStatus)) {
 101         $statusIds[] = $statusId;
 102       }
 103     }
 104
 105     // these are the activities count that are linked to the current
 106     // interviewer and current survey and not the list of ALL survey activities
 107     $this->_numVoters = CRM_Campaign_BAO_Survey::getSurveyActivities($this->_surveyId,
 108       $this->_interviewerId,
 109       $statusIds,
 110       NULL,
 111       TRUE
 112     );
 113     //validate the selected survey.
 114     $this->validateSurvey();
 115     $this->assign('surveyTitle', $this->_surveyDetails['title']);
 116     $this->assign('activityType', $this->_surveyDetails['activity_type_id']);
 117     $this->assign('surveyId', $this->_surveyId);
 118
 119     //append breadcrumb to survey dashboard.
 120     if (CRM_Campaign_BAO_Campaign::accessCampaign()) {
 121       $url = CRM_Utils_System::url('civicrm/campaign', 'reset=1&subPage=survey');
 122       CRM_Utils_System::appendBreadCrumb(array(array('title' => ts('Survey(s)'), 'url' => $url)));
 123     }
 124
 125     //set the title.
 126     CRM_Utils_System::setTitle(ts('Reserve Respondents'));
 127   }
 128
 129   public function validateSurvey() {
 130     $errorMsg = NULL;
 131     $maxVoters = CRM_Utils_Array::value('max_number_of_contacts', $this->_surveyDetails);
 132     if ($maxVoters) {
 133       if ($maxVoters <= $this->_numVoters) {
 134         $errorMsg = ts('The maximum number of contacts is already reserved for this interviewer.');
 135       }
 136       elseif (count($this->_contactIds) > ($maxVoters - $this->_numVoters)) {
 137         $errorMsg = ts('You can reserve a maximum of %1 contact(s) at a time for this survey.',
 138           array(1 => $maxVoters - $this->_numVoters)
 139         );
 140       }
 141     }
 142
 143     $defaultNum = CRM_Utils_Array::value('default_number_of_contacts', $this->_surveyDetails);
 144     if (!$errorMsg && $defaultNum && (count($this->_contactIds) > $defaultNum)) {
 145       $errorMsg = ts('You can reserve a maximum of %1 contact(s) at a time for this survey.',
 146         array(1 => $defaultNum)
 147       );
 148     }
 149
 150     if ($errorMsg) {
 151       CRM_Core_Error::statusBounce($errorMsg);
 152     }
 153   }
 154
 155   /**
 156    * Build the form object
 157    *
 158    *
 159    * @return void
 160    */
 161   public function buildQuickForm() {
 162     // allow to add contact to either new or existing group.
 163     $this->addElement('text', 'ActivityType', ts('Activity Type'));
 164     $this->addElement('text', 'newGroupName', ts('Name for new group'));
 165     $this->addElement('text', 'newGroupDesc', ts('Description of new group'));
 166     $groups = CRM_Core_PseudoConstant::nestedGroup();
 167     $hasExistingGroups = FALSE;
 168     if (is_array($groups) && !empty($groups)) {
 169       $hasExistingGroups = TRUE;
 170       $this->addElement('select', 'groups', ts('Add respondent(s) to existing group(s)'),
 171         $groups, array('multiple' => "multiple", 'class' => 'crm-select2')
 172       );
 173     }
 174     $this->assign('hasExistingGroups', $hasExistingGroups);
 175
 176     $buttons = array(
 177       array(
 178         'type' => 'done',
 179         'name' => ts('Reserve'),
 180         'subName' => 'reserve',
 181         'isDefault' => TRUE,
 182       )
 183     );
 184
 185     if (CRM_Core_Permission::check('manage campaign') ||
 186       CRM_Core_Permission::check('administer CiviCampaign') ||
 187       CRM_Core_Permission::check('interview campaign contacts')
 188     ) {
 189       $buttons[] = array(
 190         'type' => 'next',
 191         'name' => ts('Reserve and Interview'),
 192         'subName' => 'reserveToInterview',
 193       );
 194     }
 195     $buttons[] = array(
 196       'type' => 'back',
 197       'name' => ts('Cancel'),
 198     );
 199
 200     $this->addButtons($buttons);
 201     $this->addFormRule(array('CRM_Campaign_Form_Task_Reserve', 'formRule'), $this);
 202   }
 203
 204   /**
 205    * Global validation rules for the form
 206    *
 207    * @param array $fields
 208    *   Posted values of the form.
 209    *
 210    * @param $files
 211    * @param $self
 212    *
 213    * @return array
 214    *   list of errors to be posted back to the form
 215    */
 216   public static function formRule($fields, $files, $self) {
 217     $errors = array();
 218     $invalidGroupName = FALSE;
 219     if (!empty($fields['newGroupName'])) {
 220       $title = trim($fields['newGroupName']);
 221       $name = CRM_Utils_String::titleToVar($title);
 222       $query = 'select count(*) from civicrm_group where name like %1 OR title like %2';
 223       $grpCnt = CRM_Core_DAO::singleValueQuery($query, array(
 224         1 => array($name, 'String'),
 225         2 => array($title, 'String'),
 226       ));
 227       if ($grpCnt) {
 228         $invalidGroupName = TRUE;
 229         $errors['newGroupName'] = ts('Group \'%1\' already exists.', array(1 => $fields['newGroupName']));
 230       }
 231     }
 232     $self->assign('invalidGroupName', $invalidGroupName);
 233
 234     return empty($errors) ? TRUE : $errors;
 235   }
 236
 237   /**
 238    * Process the form after the input has been submitted and validated
 239    *
 240    *
 241    * @return void
 242    */
 243   public function postProcess() {
 244     //add reservation.
 245     $countVoters = 0;
 246     $maxVoters = CRM_Utils_Array::value('max_number_of_contacts', $this->_surveyDetails);
 247     $activityStatus = CRM_Core_PseudoConstant::activityStatus('name');
 248     $statusHeld = array_search('Scheduled', $activityStatus);
 249
 250     $reservedVoterIds = array();
 251     foreach ($this->_contactIds as $cid) {
 252       $subject = ts('%1', array(1 => $this->_surveyDetails['title'])) . ' - ' . ts('Respondent Reservation');
 253       $session = CRM_Core_Session::singleton();
 254       $activityParams = array(
 255         'source_contact_id' => $session->get('userID'),
 256         'assignee_contact_id' => array($this->_interviewerId),
 257         'target_contact_id' => array($cid),
 258         'source_record_id' => $this->_surveyId,
 259         'activity_type_id' => $this->_surveyDetails['activity_type_id'],
 260         'subject' => $subject,
 261         'activity_date_time' => date('YmdHis'),
 262         'status_id' => $statusHeld,
 263         'skipRecentView' => 1,
 264         'campaign_id' => CRM_Utils_Array::value('campaign_id', $this->_surveyDetails),
 265       );
 266       $activity = CRM_Activity_BAO_Activity::create($activityParams);
 267       if ($activity->id) {
 268         $countVoters++;
 269         $reservedVoterIds[$cid] = $cid;
 270       }
 271       if ($maxVoters && ($maxVoters <= ($this->_numVoters + $countVoters))) {
 272         break;
 273       }
 274     }
 275
 276     //add reserved voters to groups.
 277     $groupAdditions = $this->_addRespondentToGroup($reservedVoterIds);
 278
 279     // Success message
 280     if ($countVoters > 0) {
 281       $status = '<p>' . ts("%1 Contact(s) have been reserved.", array(1 => $countVoters)) . '</p>';
 282       if ($groupAdditions) {
 283         $status .= '<p>' . ts('Respondent(s) has been added to %1 group(s).',
 284             array(1 => implode(', ', $groupAdditions))
 285           ) . '</p>';
 286       }
 287       CRM_Core_Session::setStatus($status, ts('Reservation Added'), 'success');
 288     }
 289     // Error message
 290     if (count($this->_contactIds) > $countVoters) {
 291       CRM_Core_Session::setStatus(ts('Reservation did not add for %1 contact(s).',
 292         array(1 => (count($this->_contactIds) - $countVoters))
 293       ), ts('Notice'));
 294     }
 295
 296     //get ready to jump to voter interview form.
 297     $buttonName = $this->controller->getButtonName();
 298     if (!empty($reservedVoterIds) &&
 299       $buttonName == '_qf_Reserve_next_reserveToInterview'
 300     ) {
 301       $this->controller->set('surveyId', $this->_surveyId);
 302       $this->controller->set('contactIds', $reservedVoterIds);
 303       $this->controller->set('interviewerId', $this->_interviewerId);
 304       $this->controller->set('reserveToInterview', TRUE);
 305     }
 306   }
 307
 308   /**
 309    * @param $contactIds
 310    *
 311    * @return array
 312    */
 313   private function _addRespondentToGroup($contactIds) {
 314     $groupAdditions = array();
 315     if (empty($contactIds)) {
 316       return $groupAdditions;
 317     }
 318
 319     $params = $this->controller->exportValues($this->_name);
 320     $groups = CRM_Utils_Array::value('groups', $params, array());
 321     $newGroupName = CRM_Utils_Array::value('newGroupName', $params);
 322     $newGroupDesc = CRM_Utils_Array::value('newGroupDesc', $params);
 323
 324     $newGroupId = NULL;
 325     //create new group.
 326     if ($newGroupName) {
 327       $grpParams = array(
 328         'title' => $newGroupName,
 329         'description' => $newGroupDesc,
 330         'is_active' => TRUE,
 331       );
 332       $group = CRM_Contact_BAO_Group::create($grpParams);
 333       $groups[] = $newGroupId = $group->id;
 334     }
 335
 336     //add the respondents to groups.
 337     if (is_array($groups)) {
 338       $existingGroups = CRM_Core_PseudoConstant::group();
 339       foreach ($groups as $groupId) {
 340         $addCount = CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $groupId);
 341         $totalCount = CRM_Utils_Array::value(1, $addCount);
 342         if ($groupId == $newGroupId) {
 343           $name = $newGroupName;
 344           $new = TRUE;
 345         }
 346         else {
 347           $name = $existingGroups[$groupId];
 348           $new = FALSE;
 349         }
 350         if ($totalCount) {
 351           $url = CRM_Utils_System::url('civicrm/group/search',
 352             'reset=1&force=1&context=smog&gid=' . $groupId
 353           );
 354           $groupAdditions[] = '<a href="' . $url . '">' . $name . '</a>';
 355         }
 356       }
 357     }
 358
 359     return $groupAdditions;
 360   }
 361 }