3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
36 * This class contains all campaign related functions that are called using AJAX (jQuery)
38 class CRM_Campaign_Page_AJAX
{
40 static function registerInterview() {
52 foreach ($fields as $fld) {
53 $params[$fld] = CRM_Utils_Array
::value($fld, $_POST);
55 $params['details'] = CRM_Utils_Array
::value('note', $_POST);
56 $voterId = $params['voter_id'];
57 $activityId = $params['activity_id'];
59 $customKey = "field_{$voterId}_custom";
60 foreach ($_POST as $key => $value) {
61 if (strpos($key, $customKey) !== FALSE) {
62 $customFieldKey = str_replace(str_replace(substr($customKey, -6), '', $customKey), '', $key);
63 $params[$customFieldKey] = $value;
67 if (isset($_POST['field']) &&
68 CRM_Utils_Array
::value($voterId, $_POST['field']) &&
69 is_array($_POST['field'][$voterId])
71 foreach ($_POST['field'][$voterId] as $fieldKey => $value) {
72 $params[$fieldKey] = $value;
76 //lets pickup contat related fields.
77 foreach ($_POST as $key => $value) {
78 if (strpos($key, "field_{$voterId}_") !== FALSE &&
79 strpos($key, "field_{$voterId}_custom") === FALSE
81 $key = substr($key, strlen("field_{$voterId}_"));
82 $params[$key] = $value;
88 'voter_id' => $voterId,
89 'activity_id' => $params['interviewer_id'],
92 //time to validate custom data.
93 $errors = CRM_Core_BAO_CustomField
::validateCustomData($params);
94 if (is_array($errors) && !empty($errors)) {
95 $result['errors'] = $errors;
96 echo json_encode($result);
97 CRM_Utils_System
::civiExit();
100 //process the response/interview data.
101 $activityId = CRM_Campaign_Form_Task_Interview
::registerInterview($params);
103 $result['status'] = 'success';
106 echo json_encode($result);
108 CRM_Utils_System
::civiExit();
111 static function loadOptionGroupDetails() {
113 $id = CRM_Utils_Array
::value('option_group_id', $_POST);
118 $groupParams['id'] = $id;
119 CRM_Core_OptionValue
::getValues($groupParams, $opValues);
122 $surveyId = CRM_Utils_Array
::value('survey_id', $_POST);
124 $survey = new CRM_Campaign_DAO_Survey();
125 $survey->id
= $surveyId;
126 $survey->result_id
= $id;
127 if ($survey->find(TRUE)) {
128 if ($survey->recontact_interval
) {
129 $recontactInterval = unserialize($survey->recontact_interval
);
130 foreach ($opValues as $opValId => $opVal) {
131 if (is_numeric($recontactInterval[$opVal['label']])) {
132 $opValues[$opValId]['interval'] = $recontactInterval[$opVal['label']];
139 if (!empty($opValues)) {
145 'result' => $opValues,
148 echo json_encode($result);
149 CRM_Utils_System
::civiExit();
152 function voterList() {
153 //get the search criteria params.
154 $searchParams = explode(',', CRM_Utils_Array
::value('searchCriteria', $_POST));
156 $params = $searchRows = array();
157 foreach ($searchParams as $param) {
158 if (CRM_Utils_Array
::value($param, $_POST)) {
159 $params[$param] = $_POST[$param];
163 //format multi-select group and contact types.
165 'group', 'contact_type') as $param) {
166 $paramValue = CRM_Utils_Array
::value($param, $params);
168 unset($params[$param]);
169 $paramValue = explode(',', $paramValue);
170 foreach ($paramValue as $key => $value) {
171 $params[$param][$value] = 1;
176 $voterClauseParams = array();
178 'campaign_survey_id', 'survey_interviewer_id', 'campaign_search_voter_for') as $fld) {
179 $voterClauseParams[$fld] = CRM_Utils_Array
::value($fld, $params);
182 $interviewerId = $surveyTypeId = $surveyId = NULL;
183 $searchVoterFor = $params['campaign_search_voter_for'];
184 if ($searchVoterFor == 'reserve') {
185 if (CRM_Utils_Array
::value('campaign_survey_id', $params)) {
186 $survey = new CRM_Campaign_DAO_Survey();
187 $survey->id
= $surveyId = $params['campaign_survey_id'];
188 $survey->selectAdd('campaign_id, activity_type_id');
190 $campaignId = $survey->campaign_id
;
191 $surveyTypeId = $survey->activity_type_id
;
193 //allow voter search in sub-part of given constituents,
194 //but make sure in case user does not select any group.
195 //get all associated campaign groups in where filter, CRM-7406
196 $groups = CRM_Utils_Array
::value('group', $params);
197 if ($campaignId && CRM_Utils_System
::isNull($groups)) {
198 $campaignGroups = CRM_Campaign_BAO_Campaign
::getCampaignGroups($campaignId);
199 foreach ($campaignGroups as $id => $group) $params['group'][$id] = 1;
202 //apply filter of survey contact type for search.
203 $contactType = CRM_Campaign_BAO_Survey
::getSurveyContactType($surveyId);
205 $params['contact_type'][$contactType] = 1;
208 unset($params['campaign_survey_id']);
210 unset($params['survey_interviewer_id']);
213 //get the survey status in where clause.
214 $scheduledStatusId = array_search('Scheduled', CRM_Core_PseudoConstant
::activityStatus('name'));
215 if ($scheduledStatusId) {
216 $params['survey_status_id'] = $scheduledStatusId;
218 //BAO/Query knows reserve/release/interview processes.
219 if ($params['campaign_search_voter_for'] == 'gotv') {
220 $params['campaign_search_voter_for'] = 'release';
224 $selectorCols = array(
232 // get the data table params.
233 $dataTableParams = array(
234 'sEcho' => array('name' => 'sEcho',
239 'name' => 'iDisplayStart',
244 'name' => 'iDisplayLength',
249 'name' => 'iSortCol_0',
251 'default' => 'sort_name',
253 'sortOrder' => array(
254 'name' => 'sSortDir_0',
259 foreach ($dataTableParams as $pName => $pValues) {
260 $
$pName = $pValues['default'];
261 if (CRM_Utils_Array
::value($pValues['name'], $_POST)) {
262 $
$pName = CRM_Utils_Type
::escape($_POST[$pValues['name']], $pValues['type']);
263 if ($pName == 'sort')$
$pName = $selectorCols[$
$pName];
267 $queryParams = CRM_Contact_BAO_Query
::convertFormValues($params);
268 $query = new CRM_Contact_BAO_Query($queryParams,
269 NULL, NULL, FALSE, FALSE,
270 CRM_Contact_BAO_Query
::MODE_CAMPAIGN
,
274 //get the voter clause to restrict and validate search.
275 $voterClause = CRM_Campaign_BAO_Query
::voterClause($voterClauseParams);
277 $searchCount = $query->searchQuery(0, 0, NULL,
281 CRM_Utils_Array
::value('whereClause', $voterClause),
283 CRM_Utils_Array
::value('fromClause', $voterClause)
286 $iTotal = $searchCount;
288 $selectorCols = array(
289 'contact_type', 'sort_name', 'street_address',
290 'street_name', 'street_number', 'street_unit',
293 $extraVoterColName = 'is_interview_conducted';
294 if ($params['campaign_search_voter_for'] = 'reserve') {
295 $extraVoterColName = 'reserve_voter';
298 if ($searchCount > 0) {
299 if ($searchCount < $offset) {
303 $config = CRM_Core_Config
::singleton();
305 // get the result of the search
306 $result = $query->searchQuery($offset, $rowCount, $sort,
310 CRM_Utils_Array
::value('whereClause', $voterClause),
312 CRM_Utils_Array
::value('fromClause', $voterClause)
314 while ($result->fetch()) {
315 $contactID = $result->contact_id
;
316 $typeImage = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
317 $result->contact_sub_type
: $result->contact_type
,
322 $searchRows[$contactID] = array('id' => $contactID);
323 foreach ($selectorCols as $col) {
324 $val = $result->$col;
325 if ($col == 'contact_type') {
328 $searchRows[$contactID][$col] = $val;
330 if ($searchVoterFor == 'reserve') {
331 $voterExtraColHtml = '<input type="checkbox" id="survey_activity[' . $contactID . ']" name="survey_activity[' . $contactID . ']" value=' . $contactID . ' onClick="processVoterData( this, \'reserve\' );" />';
332 $msg = ts('Respondent Reserved.');
333 $voterExtraColHtml .= " <span id='success_msg_{$contactID}' class='ok' style='display:none;'>$msg</span>";
335 elseif ($searchVoterFor == 'gotv') {
336 $surveyActId = $result->survey_activity_id
;
337 $voterExtraColHtml = '<input type="checkbox" id="survey_activity[' . $surveyActId . ']" name="survey_activity[' . $surveyActId . ']" value=' . $surveyActId . ' onClick="processVoterData( this, \'gotv\' );" />';
338 $msg = ts('Vote Recorded');
339 $voterExtraColHtml .= " <span id='success_msg_{$surveyActId}' class='ok' style='display:none;'>$msg</span>";
342 $surveyActId = $result->survey_activity_id
;
343 $voterExtraColHtml = '<input type="checkbox" id="survey_activity[' . $surveyActId . ']" name="survey_activity[' . $surveyActId . ']" value=' . $surveyActId . ' onClick="processVoterData( this, \'release\' );" />';
344 $msg = ts('Vote Recorded');
345 $voterExtraColHtml .= " <span id='success_msg_{$surveyActId}' class='ok' style='display:none;'>$msg</span>";
347 $searchRows[$contactID][$extraVoterColName] = $voterExtraColHtml;
351 $selectorElements = array_merge($selectorCols, array($extraVoterColName));
353 $iFilteredTotal = $iTotal;
355 echo CRM_Utils_JSON
::encodeDataTableSelector($searchRows, $sEcho, $iTotal, $iFilteredTotal, $selectorElements);
356 CRM_Utils_System
::civiExit();
359 function processVoterData() {
361 $operation = CRM_Utils_Type
::escape($_POST['operation'], 'String');
362 if ($operation == 'release') {
363 $activityId = CRM_Utils_Type
::escape($_POST['activity_id'], 'Integer');
364 $isDelete = CRM_Utils_String
::strtoboolstr(CRM_Utils_Type
::escape($_POST['isDelete'], 'String'));
366 CRM_Core_DAO
::setFieldValue('CRM_Activity_DAO_Activity',
375 elseif ($operation == 'reserve') {
377 $createActivity = TRUE;
378 if (CRM_Utils_Array
::value('activity_id', $_POST)) {
379 $activityId = CRM_Utils_Type
::escape($_POST['activity_id'], 'Integer');
381 $createActivity = FALSE;
382 $activityUpdated = CRM_Core_DAO
::setFieldValue('CRM_Activity_DAO_Activity',
387 if ($activityUpdated) {
392 if ($createActivity) {
397 'assignee_contact_id',
399 $activityParams = array();
400 foreach ($ids as $id) {
401 $val = CRM_Utils_Array
::value($id, $_POST);
403 $createActivity = FALSE;
406 $activityParams[$id] = CRM_Utils_Type
::escape($val, 'Integer');
409 if ($createActivity) {
410 $isReserved = CRM_Utils_String
::strtoboolstr(CRM_Utils_Type
::escape($_POST['isReserved'], 'String'));
411 $activityStatus = CRM_Core_PseudoConstant
::activityStatus('name');
412 $scheduledStatusId = array_search('Scheduled', $activityStatus);
414 $surveyValues = array();
415 $surveyParams = array('id' => $activityParams['source_record_id']);
416 CRM_Core_DAO
::commonRetrieve('CRM_Campaign_DAO_Survey',
419 array('title', 'activity_type_id', 'campaign_id')
422 $activityTypeId = $surveyValues['activity_type_id'];
424 $surveytitle = CRM_Utils_Array
::value('surveyTitle', $_POST);
426 $surveytitle = $surveyValues['title'];
429 $subject = ts('%1', array(1 => $surveytitle)) . ' - ' . ts('Respondent Reservation');
430 $activityParams['subject'] = $subject;
431 $activityParams['status_id'] = $scheduledStatusId;
432 $activityParams['skipRecentView'] = 1;
433 $activityParams['activity_date_time'] = date('YmdHis');
434 $activityParams['activity_type_id'] = $activityTypeId;
435 $activityParams['campaign_id'] = isset($surveyValues['campaign_id']) ?
$surveyValues['campaign_id'] : NULL;
437 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
443 //delete reserved activity for given voter.
444 $voterIds = array($activityParams['target_contact_id']);
445 $activities = CRM_Campaign_BAO_Survey
::voterActivityDetails($activityParams['source_record_id'],
447 $activityParams['source_contact_id'],
448 array($scheduledStatusId)
450 foreach ($activities as $voterId => $values) {
451 $activityId = CRM_Utils_Array
::value('activity_id', $values);
452 if ($activityId && ($values['status_id'] == $scheduledStatusId)) {
453 CRM_Core_DAO
::setFieldValue('CRM_Activity_DAO_Activity',
465 elseif ($operation == 'gotv') {
466 $activityId = CRM_Utils_Type
::escape($_POST['activity_id'], 'Integer');
467 $hasVoted = CRM_Utils_String
::strtoboolstr(CRM_Utils_Type
::escape($_POST['hasVoted'], 'String'));
475 CRM_Core_DAO
::setFieldValue('CRM_Activity_DAO_Activity',
484 echo json_encode(array('status' => $status));
485 CRM_Utils_System
::civiExit();
488 function allActiveCampaigns() {
489 $currentCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns();
490 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, TRUE, FALSE, TRUE);
493 'title' => ts('- select -'),
495 foreach ($campaigns as $value => $title) {
497 if (!array_key_exists($value, $currentCampaigns)) {
498 $class = 'status-past';
507 if (count($options) > 1) {
513 'campaigns' => $options,
516 echo json_encode($results);
518 CRM_Utils_System
::civiExit();
521 function campaignGroups() {
522 $surveyId = CRM_Utils_Request
::retrieve('survey_id', 'Positive',
523 CRM_Core_DAO
::$_nullObject, FALSE, NULL, 'POST'
525 $campGroups = array();
527 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Campaign_DAO_Survey', $surveyId, 'campaign_id');
529 $campGroups = CRM_Campaign_BAO_Campaign
::getCampaignGroups($campaignId);
533 //CRM-7406 --If there is no campaign or no group associated with
534 //campaign of given survey, lets allow to search across all groups.
535 if (empty($campGroups)) {
536 $campGroups = CRM_Core_PseudoConstant
::group();
540 'title' => ts('- select -'),
542 foreach ($campGroups as $grpId => $title) {
549 'status' => 'success',
553 echo json_encode($results);
555 CRM_Utils_System
::civiExit();
559 * Retrieve campaigns as for campaign dashboard.
562 function campaignList() {
563 //get the search criteria params.
564 $searchParams = explode(',', CRM_Utils_Array
::value('searchCriteria', $_POST));
566 $params = $searchRows = array();
567 foreach ($searchParams as $param) {
568 if (CRM_Utils_Array
::value($param, $_POST)) {
569 $params[$param] = $_POST[$param];
573 //this is sequence columns on datatable.
574 $selectorCols = array(
590 // get the data table params.
591 $dataTableParams = array(
592 'sEcho' => array('name' => 'sEcho',
597 'name' => 'iDisplayStart',
602 'name' => 'iDisplayLength',
607 'name' => 'iSortCol_0',
609 'default' => 'start_date',
611 'sortOrder' => array(
612 'name' => 'sSortDir_0',
617 foreach ($dataTableParams as $pName => $pValues) {
618 $
$pName = $pValues['default'];
619 if (CRM_Utils_Array
::value($pValues['name'], $_POST)) {
620 $
$pName = CRM_Utils_Type
::escape($_POST[$pValues['name']], $pValues['type']);
621 if ($pName == 'sort') {
622 $
$pName = $selectorCols[$
$pName];
627 'sort', 'offset', 'rowCount', 'sortOrder') as $sortParam) {
628 $params[$sortParam] = $
$sortParam;
631 $searchCount = CRM_Campaign_BAO_Campaign
::getCampaignSummary($params, TRUE);
632 $campaigns = CRM_Campaign_Page_DashBoard
::getCampaignSummary($params);
633 $iTotal = $searchCount;
635 if ($searchCount > 0) {
636 if ($searchCount < $offset) {
639 foreach ($campaigns as $campaignID => $values) {
640 foreach ($selectorCols as $col) {
641 $searchRows[$campaignID][$col] = CRM_Utils_Array
::value($col, $values);
646 $selectorElements = $selectorCols;
648 $iFilteredTotal = $iTotal;
650 echo CRM_Utils_JSON
::encodeDataTableSelector($searchRows, $sEcho, $iTotal, $iFilteredTotal, $selectorElements);
651 CRM_Utils_System
::civiExit();
655 * Retrieve survey for survey dashboard.
658 function surveyList() {
659 //get the search criteria params.
660 $searchParams = explode(',', CRM_Utils_Array
::value('searchCriteria', $_POST));
662 $params = $searchRows = array();
663 foreach ($searchParams as $param) {
664 if (CRM_Utils_Array
::value($param, $_POST)) {
665 $params[$param] = $_POST[$param];
669 //this is sequence columns on datatable.
670 $selectorCols = array(
678 'default_number_of_contacts',
679 'max_number_of_contacts',
688 // get the data table params.
689 $dataTableParams = array(
690 'sEcho' => array('name' => 'sEcho',
695 'name' => 'iDisplayStart',
700 'name' => 'iDisplayLength',
705 'name' => 'iSortCol_0',
707 'default' => 'created_date',
709 'sortOrder' => array(
710 'name' => 'sSortDir_0',
715 foreach ($dataTableParams as $pName => $pValues) {
716 $
$pName = $pValues['default'];
717 if (CRM_Utils_Array
::value($pValues['name'], $_POST)) {
718 $
$pName = CRM_Utils_Type
::escape($_POST[$pValues['name']], $pValues['type']);
719 if ($pName == 'sort') {
720 $
$pName = $selectorCols[$
$pName];
725 'sort', 'offset', 'rowCount', 'sortOrder') as $sortParam) {
726 $params[$sortParam] = $
$sortParam;
729 $surveys = CRM_Campaign_Page_DashBoard
::getSurveySummary($params);
730 $searchCount = CRM_Campaign_BAO_Survey
::getSurveySummary($params, TRUE);
731 $iTotal = $searchCount;
733 if ($searchCount > 0) {
734 if ($searchCount < $offset) {
737 foreach ($surveys as $surveyID => $values) {
738 foreach ($selectorCols as $col) {
739 $searchRows[$surveyID][$col] = CRM_Utils_Array
::value($col, $values);
744 $selectorElements = $selectorCols;
746 $iFilteredTotal = $iTotal;
748 echo CRM_Utils_JSON
::encodeDataTableSelector($searchRows, $sEcho, $iTotal, $iFilteredTotal, $selectorElements);
749 CRM_Utils_System
::civiExit();
753 * Retrieve petitions for petition dashboard.
756 function petitionList() {
757 //get the search criteria params.
758 $searchParams = explode(',', CRM_Utils_Array
::value('searchCriteria', $_POST));
760 $params = $searchRows = array();
761 foreach ($searchParams as $param) {
762 if (CRM_Utils_Array
::value($param, $_POST)) {
763 $params[$param] = $_POST[$param];
767 //this is sequence columns on datatable.
768 $selectorCols = array(
781 // get the data table params.
782 $dataTableParams = array(
783 'sEcho' => array('name' => 'sEcho',
788 'name' => 'iDisplayStart',
793 'name' => 'iDisplayLength',
798 'name' => 'iSortCol_0',
800 'default' => 'created_date',
802 'sortOrder' => array(
803 'name' => 'sSortDir_0',
808 foreach ($dataTableParams as $pName => $pValues) {
809 $
$pName = $pValues['default'];
810 if (CRM_Utils_Array
::value($pValues['name'], $_POST)) {
811 $
$pName = CRM_Utils_Type
::escape($_POST[$pValues['name']], $pValues['type']);
812 if ($pName == 'sort') {
813 $
$pName = $selectorCols[$
$pName];
818 'sort', 'offset', 'rowCount', 'sortOrder') as $sortParam) {
819 $params[$sortParam] = $
$sortParam;
822 $petitions = CRM_Campaign_Page_DashBoard
::getPetitionSummary($params);
823 $searchCount = CRM_Campaign_BAO_Petition
::getPetitionSummary($params, TRUE);
824 $iTotal = $searchCount;
826 if ($searchCount > 0) {
827 if ($searchCount < $offset) {
830 foreach ($petitions as $petitionID => $values) {
831 foreach ($selectorCols as $col) {
832 $searchRows[$petitionID][$col] = CRM_Utils_Array
::value($col, $values);
837 $selectorElements = $selectorCols;
839 $iFilteredTotal = $iTotal;
841 echo CRM_Utils_JSON
::encodeDataTableSelector($searchRows, $sEcho, $iTotal, $iFilteredTotal, $selectorElements);
842 CRM_Utils_System
::civiExit();