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 provides the functionality to record voter's interview.
39 class CRM_Campaign_Form_Task_Interview
extends CRM_Campaign_Form_Task
{
42 * The title of the group
49 * Variable to store redirect path
52 private $_userContext;
56 private $_surveyFields;
58 private $_surveyTypeId;
60 private $_interviewerId;
62 private $_surveyActivityIds;
64 private $_votingTab = FALSE;
66 private $_surveyValues;
68 private $_resultOptions;
70 private $_allowAjaxReleaseButton;
73 * Build all the data structures needed to build the form
78 function preProcess() {
79 $this->_votingTab
= $this->get('votingTab');
80 $this->_reserveToInterview
= $this->get('reserveToInterview');
81 if ($this->_reserveToInterview ||
$this->_votingTab
) {
82 //user came from voting tab / reserve form.
84 'surveyId', 'contactIds', 'interviewerId') as $fld) {
85 $this->{"_$fld"} = $this->get($fld);
87 //get the target voter ids.
88 if ($this->_votingTab
) {
94 //get the survey id from user submitted values.
95 $this->_surveyId
= CRM_Utils_Array
::value('campaign_survey_id', $this->get('formValues'));
96 $this->_interviewerId
= CRM_Utils_Array
::value('survey_interviewer_id', $this->get('formValues'));
99 if ( $this->_surveyId
) {
100 $params = array('id' => $this->_surveyId
);
101 CRM_Campaign_BAO_Survey
::retrieve($params, $this->_surveyDetails
);
104 $orderClause = false;
105 $buttonName = $this->controller
->getButtonName();
106 if ( $buttonName == '_qf_Interview_submit_orderBy' && !empty($_POST['order_bys'])) {
107 $orderByParams = CRM_Utils_Array
::value('order_bys', $_POST);
109 elseif ( CRM_Core_OptionGroup
::getValue('activity_type','WalkList') == $this->_surveyDetails
['activity_type_id'] ) {
113 'column' => 'civicrm_address.street_name',
117 'column' => 'civicrm_address.street_number%2',
121 'column' => 'civicrm_address.street_number',
125 'column' => 'contact_a.sort_name',
132 if ( !empty($orderByParams) ) {
133 foreach ( $orderByParams as $key => $val ) {
134 if (!empty($val['column'])) {
135 $orderBy[] = "{$val['column']} {$val['order']}";
138 if ( !empty($orderBy) ) {
139 $orderClause = "ORDER BY " . implode(', ', $orderBy);
143 $this->_contactIds
= array_unique($this->_contactIds
);
144 if (!empty($this->_contactIds
) && $orderClause) {
145 $clause = 'contact_a.id IN ( ' . implode(',', $this->_contactIds
) . ' ) ';
148 FROM civicrm_contact contact_a
149 LEFT JOIN civicrm_address ON contact_a.id = civicrm_address.contact_id
153 $this->_contactIds
= array();
154 $dao = CRM_Core_DAO
::executeQuery($sql);
155 while ($dao->fetch()) {
156 $this->_contactIds
[] = $dao->id
;
161 //get the contact read only fields to display.
162 $readOnlyFields = array_merge(array(
163 'contact_type' => '',
164 'sort_name' => ts('Name'),
167 //get the read only field data.
168 $returnProperties = array_fill_keys(array_keys($readOnlyFields), 1);
169 $returnProperties['contact_sub_type'] = TRUE;
171 //validate all voters for required activity.
172 //get the survey activities for given voters.
173 $this->_surveyActivityIds
= CRM_Campaign_BAO_Survey
::voterActivityDetails($this->_surveyId
,
175 $this->_interviewerId
177 $activityStatus = CRM_Core_PseudoConstant
::activityStatus('name');
178 $scheduledStatusId = array_search('Scheduled', $activityStatus);
180 $activityIds = array();
181 foreach ($this->_contactIds
as $key => $voterId) {
182 $actVals = CRM_Utils_Array
::value($voterId, $this->_surveyActivityIds
);
183 $statusId = CRM_Utils_Array
::value('status_id', $actVals);
184 $activityId = CRM_Utils_Array
::value('activity_id', $actVals);
187 $scheduledStatusId == $statusId
189 $activityIds["activity_id_{$voterId}"] = $activityId;
192 unset($this->_contactIds
[$key]);
196 //retrieve the contact details.
197 $voterDetails = CRM_Campaign_BAO_Survey
::voterDetails($this->_contactIds
, $returnProperties);
199 $this->_allowAjaxReleaseButton
= FALSE;
200 if ($this->_votingTab
&&
201 (CRM_Core_Permission
::check('manage campaign') ||
202 CRM_Core_Permission
::check('administer CiviCampaign') ||
203 CRM_Core_Permission
::check('release campaign contacts')
206 $this->_allowAjaxReleaseButton
= TRUE;
209 //validate voter ids across profile.
210 $this->filterVoterIds();
211 $this->assign('votingTab', $this->_votingTab
);
212 $this->assign('componentIds', $this->_contactIds
);
213 $this->assign('componentIdsJson', json_encode($this->_contactIds
));
214 $this->assign('voterDetails', $voterDetails);
215 $this->assign('readOnlyFields', $readOnlyFields);
216 $this->assign('interviewerId', $this->_interviewerId
);
217 $this->assign('surveyActivityIds', json_encode($activityIds));
218 $this->assign('allowAjaxReleaseButton', $this->_allowAjaxReleaseButton
);
220 //get the survey values.
221 $this->_surveyValues
= $this->get('surveyValues');
222 if (!is_array($this->_surveyValues
)) {
223 $this->_surveyValues
= array();
224 if ($this->_surveyId
) {
225 $surveyParams = array('id' => $this->_surveyId
);
226 CRM_Campaign_BAO_Survey
::retrieve($surveyParams, $this->_surveyValues
);
228 $this->set('surveyValues', $this->_surveyValues
);
230 $this->assign('surveyValues', $this->_surveyValues
);
232 $result = CRM_Campaign_BAO_Survey
::getReportID($this->_surveyId
);
233 $this->assign("instanceId",$result);
235 //get the survey result options.
236 $this->_resultOptions
= $this->get('resultOptions');
237 if (!is_array($this->_resultOptions
)) {
238 $this->_resultOptions
= array();
239 if ($resultOptionId = CRM_Utils_Array
::value('result_id', $this->_surveyValues
)) {
240 $this->_resultOptions
= CRM_Core_OptionGroup
::valuesByID($resultOptionId);
242 $this->set('resultOptions', $this->_resultOptions
);
245 //validate the required ids.
246 $this->validateIds();
248 //append breadcrumb to survey dashboard.
249 if (CRM_Campaign_BAO_Campaign
::accessCampaign()) {
250 $url = CRM_Utils_System
::url('civicrm/campaign', 'reset=1&subPage=survey');
251 CRM_Utils_System
::appendBreadCrumb(array(array('title' => ts('Survey(s)'), 'url' => $url)));
255 $activityTypes = CRM_Core_PseudoConstant
::activityType(FALSE, TRUE, FALSE, 'label', TRUE);
256 $this->_surveyTypeId
= CRM_Utils_Array
::value('activity_type_id', $this->_surveyValues
);
257 CRM_Utils_System
::setTitle(ts('Record %1 Responses', array(1 => $activityTypes[$this->_surveyTypeId
])));
260 function validateIds() {
261 $required = array('surveyId' => ts('Could not find Survey.'),
262 'interviewerId' => ts('Could not find Interviewer.'),
263 'contactIds' => ts('No respondents are currently reserved for you to interview.'),
264 'resultOptions' => ts('Oops. It looks like there is no response option configured.'),
267 $errorMessages = array();
268 foreach ($required as $fld => $msg) {
269 if (empty($this->{"_$fld"})) {
270 if (!$this->_votingTab
) {
271 CRM_Core_Error
::statusBounce($msg);
274 $errorMessages[] = $msg;
278 $this->assign('errorMessages', empty($errorMessages) ?
FALSE : $errorMessages);
282 * Build the form object
288 function buildQuickForm() {
289 $this->assign('surveyTypeId', $this->_surveyTypeId
);
292 array('' => ' - none - ',
293 'civicrm_address.street_name' => 'Street Name',
294 'civicrm_address.street_number%2' => 'Odd / Even Street Number',
295 'civicrm_address.street_number' => 'Street Number',
296 'contact_a.sort_name' => 'Respondent Name',
298 for ($i = 1; $i < count($options); $i++
) {
299 $this->addElement('select', "order_bys[{$i}][column]", ts('Order by Column'), $options);
300 $this->addElement('select', "order_bys[{$i}][order]", ts('Order by Order'), array('ASC' => 'Ascending', 'DESC' => 'Descending'));
303 //pickup the uf fields.
304 $this->_surveyFields
= CRM_Campaign_BAO_Survey
::getSurveyResponseFields($this->_surveyId
,
308 foreach ($this->_contactIds
as $contactId) {
309 //build the profile fields.
310 foreach ($this->_surveyFields
as $name => $field) {
312 CRM_Core_BAO_UFGroup
::buildProfile($this, $field, NULL, $contactId);
316 //build the result field.
317 if (!empty($this->_resultOptions
)) {
318 $this->add('select', "field[$contactId][result]", ts('Result'),
320 '' => ts('- select -')) +
321 array_combine($this->_resultOptions
, $this->_resultOptions
)
325 $this->add('text', "field[{$contactId}][note]", ts('Note'));
327 //need to keep control for release/reserve.
328 if ($this->_allowAjaxReleaseButton
) {
329 $this->addElement('hidden',
330 "field[{$contactId}][is_release_or_reserve]", 0,
331 array('id' => "field_{$contactId}_is_release_or_reserve")
335 $this->assign('surveyFields', empty($this->_surveyFields
) ?
FALSE : $this->_surveyFields
);
337 //no need to get qf buttons.
338 if ($this->_votingTab
) {
343 array('type' => 'cancel',
344 'name' => ts('Done'),
345 'subName' => 'interview',
351 'name' => ts('Order By >>'),
352 'subName' => 'orderBy',
355 $manageCampaign = CRM_Core_Permission
::check('manage campaign');
356 $adminCampaign = CRM_Core_Permission
::check('administer CiviCampaign');
357 if ($manageCampaign ||
359 CRM_Core_Permission
::check('release campaign contacts')
363 'name' => ts('Release Respondents >>'),
364 'subName' => 'interviewToRelease',
367 if ($manageCampaign ||
369 CRM_Core_Permission
::check('reserve campaign contacts')
373 'name' => ts('Reserve More Respondents >>'),
374 'subName' => 'interviewToReserve',
378 $this->addButtons($buttons);
382 * Set default values for the form.
388 function setDefaultValues() {
389 //load default data for only contact fields.
390 $contactFields = $defaults = array();
391 foreach ($this->_surveyFields
as $name => $field) {
392 $acceptable_types = CRM_Contact_BAO_ContactType
::basicTypes();
393 $acceptable_types[] = 'Contact';
394 if (in_array($field['field_type'], $acceptable_types)) {
395 $contactFields[$name] = $field;
398 if (!empty($contactFields)) {
399 foreach ($this->_contactIds
as $contactId) {
400 CRM_Core_BAO_UFGroup
::setProfileDefaults($contactId, $contactFields, $defaults, FALSE);
404 if ( CRM_Core_OptionGroup
::getValue('activity_type','WalkList') == $this->_surveyDetails
['activity_type_id'] ) {
405 $defaults['order_bys'] =
408 'column' => 'civicrm_address.street_name',
412 'column' => 'civicrm_address.street_number%2',
416 'column' => 'civicrm_address.street_number',
420 'column' => 'contact_a.sort_name',
426 $defaults['order_bys'] =
430 'column' => 'contact_a.sort_name',
439 * Process the form after the input has been submitted and validated
445 public function postProcess() {
446 $buttonName = $this->controller
->getButtonName();
447 if ($buttonName == '_qf_Interview_done_interviewToReserve') {
448 //hey its time to stop cycle.
449 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/survey/search', 'reset=1&op=reserve'));
451 elseif ($buttonName == '_qf_Interview_next_interviewToRelease') {
452 //get ready to jump to release form.
454 'surveyId', 'contactIds', 'interviewerId') as $fld) {
455 $this->controller
->set($fld, $this->{"_$fld"});
457 $this->controller
->set('interviewToRelease', TRUE);
460 // vote is done through ajax
465 * @param array $params
469 static function registerInterview($params) {
470 $activityId = CRM_Utils_Array
::value('activity_id', $params);
471 $surveyTypeId = CRM_Utils_Array
::value('activity_type_id', $params);
472 if (!is_array($params) ||
!$surveyTypeId ||
!$activityId) {
476 static $surveyFields;
477 if (!is_array($surveyFields)) {
478 $surveyFields = CRM_Core_BAO_CustomField
::getFields('Activity',
490 $statusId = array_search('Completed', CRM_Core_PseudoConstant
::activityStatus('name'));
493 //format custom fields.
494 $customParams = CRM_Core_BAO_CustomField
::postProcess($params,
500 CRM_Core_BAO_CustomValueTable
::store($customParams, 'civicrm_activity', $activityId);
502 //process contact data.
503 $contactParams = $fields = array();
505 $contactFieldTypes = array_merge(array('Contact'), CRM_Contact_BAO_ContactType
::basicTypes());
506 $responseFields = CRM_Campaign_BAO_Survey
::getSurveyResponseFields($params['survey_id']);
507 if (!empty($responseFields)) {
508 foreach ($params as $key => $value) {
509 if (array_key_exists($key, $responseFields)) {
510 if (in_array($responseFields[$key]['field_type'], $contactFieldTypes)) {
511 $fields[$key] = $responseFields[$key];
512 $contactParams[$key] = $value;
513 if (isset($params["{$key}_id"])) {
514 $contactParams["{$key}_id"] = $params["{$key}_id"];
521 $contactId = CRM_Utils_Array
::value('voter_id', $params);
522 if ($contactId && !empty($contactParams)) {
523 CRM_Contact_BAO_Contact
::createProfileContact($contactParams, $fields, $contactId);
526 //update activity record.
527 $activity = new CRM_Activity_DAO_Activity();
528 $activity->id
= $activityId;
530 $activity->selectAdd();
531 $activity->selectAdd('activity_date_time, status_id, result, subject');
532 $activity->find(TRUE);
533 $activity->activity_date_time
= date('YmdHis');
534 $activity->status_id
= $statusId;
536 if (!empty($params['activity_date_time'])) {
537 $activity->activity_date_time
= CRM_Utils_Date
::processDate($params['activity_date_time'], $params['activity_date_time_time']);
541 $surveyTitle = CRM_Utils_Array
::value('surveyTitle', $params);
543 $subject = ts('%1', array(1 => $surveyTitle));
546 $subject .= ts('Respondent Interview');
548 $activity->subject
= $subject;
549 $activityParams = array(
550 'details' => 'details',
551 'result' => 'result',
552 'engagement_level' => 'activity_engagement_level',
553 'subject' => 'activity_subject',
554 'status_id' => 'activity_status_id',
555 'source_contact_id' => 'source_contact',
556 'location' => 'activity_location',
557 'campaign_id' => 'activity_campaign_id',
558 'duration' => 'activity_duration'
560 foreach ($activityParams as $key => $field) {
561 if (!empty($params[$field])) {
562 $activity->$key = $params[$field];
567 //really this should use Activity BAO& not be here but refactoring will have to be later
568 //actually the whole ajax call could be done as an api ajax call & post hook would be sorted
569 CRM_Utils_Hook
::post('edit', 'Activity', $activity->id
, $activity);
575 function getVoterIds() {
576 if (!$this->_interviewerId
) {
577 $session = CRM_Core_Session
::singleton();
578 $this->_interviewerId
= $session->get('userID');
580 if (!$this->_surveyId
) {
581 // use default survey id
582 $dao = new CRM_Campaign_DAO_Survey();
584 $dao->is_default
= 1;
586 $this->_surveyId
= $dao->id
;
589 $this->_contactIds
= $this->get('contactIds');
590 if (!is_array($this->_contactIds
)) {
591 //get the survey activities.
592 $activityStatus = CRM_Core_PseudoConstant
::activityStatus('name');
593 $statusIds = array();
594 if ($statusId = array_search('Scheduled', $activityStatus)) {
595 $statusIds[] = $statusId;
597 $surveyActivities = CRM_Campaign_BAO_Survey
::getSurveyVoterInfo($this->_surveyId
,
598 $this->_interviewerId
,
601 $this->_contactIds
= array();
602 foreach ($surveyActivities as $val) $this->_contactIds
[$val['voter_id']] = $val['voter_id'];
603 $this->set('contactIds', $this->_contactIds
);
607 function filterVoterIds() {
608 //do the cleanup later on.
609 if (!is_array($this->_contactIds
)) {
613 $profileId = CRM_Campaign_BAO_Survey
::getSurveyProfileId($this->_surveyId
);
615 $profileType = CRM_Core_BAO_UFField
::getProfileType($profileId);
616 if (in_array($profileType, CRM_Contact_BAO_ContactType
::basicTypes())) {
617 $voterIdCount = count($this->_contactIds
);
619 //create temporary table to store voter ids.
620 $tempTableName = CRM_Core_DAO
::createTempTableName('civicrm_survey_respondent');
621 CRM_Core_DAO
::executeQuery("DROP TABLE IF EXISTS {$tempTableName}");
623 CREATE TEMPORARY TABLE {$tempTableName} (
624 id int unsigned NOT NULL AUTO_INCREMENT,
625 survey_contact_id int unsigned NOT NULL,
629 CRM_Core_DAO
::executeQuery($query);
633 $processIds = $this->_contactIds
;
634 $insertIds = array_splice($processIds, $insertedCount, $batch);
635 if (!empty($insertIds)) {
636 $insertSQL = "INSERT IGNORE INTO {$tempTableName}( survey_contact_id )
637 VALUES (" . implode('),(', $insertIds) . ');';
638 CRM_Core_DAO
::executeQuery($insertSQL);
640 $insertedCount +
= $batch;
641 } while ($insertedCount < $voterIdCount);
644 SELECT contact.id as id
645 FROM civicrm_contact contact
646 INNER JOIN {$tempTableName} ON ( {$tempTableName}.survey_contact_id = contact.id )
647 WHERE contact.contact_type != %1";
648 $removeContact = CRM_Core_DAO
::executeQuery($query,
649 array(1 => array($profileType, 'String'))
651 while ($removeContact->fetch()) {
652 unset($this->_contactIds
[$removeContact->id
]);