3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
38 class CRM_Campaign_Form_Gotv
extends CRM_Core_Form
{
41 * Are we forced to run a search
47 protected $_votingTab = FALSE;
49 protected $_searchVoterFor;
52 * Processing needed for buildForm and later.
54 public function preProcess() {
55 $this->_search
= CRM_Utils_Array
::value('search', $_GET);
56 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
57 $this->_surveyId
= CRM_Utils_Request
::retrieve('sid', 'Positive', $this);
58 $this->_interviewerId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
60 //does control come from voting tab interface.
61 $this->_votingTab
= $this->get('votingTab');
62 $this->_subVotingTab
= $this->get('subVotingTab');
63 $this->_searchVoterFor
= 'gotv';
64 if ($this->_votingTab
) {
65 if ($this->_subVotingTab
== 'searchANDReserve') {
66 $this->_searchVoterFor
= 'reserve';
68 elseif ($this->_subVotingTab
== 'searchANDInterview') {
69 $this->_searchVoterFor
= 'interview';
72 $this->assign('force', $this->_force
);
73 $this->assign('votingTab', $this->_votingTab
);
74 $this->assign('searchParams', json_encode($this->get('searchParams')));
75 $this->assign('buildSelector', $this->_search
);
76 $this->assign('searchVoterFor', $this->_searchVoterFor
);
77 $this->set('searchVoterFor', $this->_searchVoterFor
);
80 if ($this->_surveyId
) {
81 $surveyTitle = CRM_Core_DAO
::getFieldValue('CRM_Campaign_DAO_Survey', $this->_surveyId
, 'title');
83 $this->assign('surveyTitle', $surveyTitle);
85 //append breadcrumb to survey dashboard.
86 if (CRM_Campaign_BAO_Campaign
::accessCampaign()) {
87 $url = CRM_Utils_System
::url('civicrm/campaign', 'reset=1&subPage=survey');
88 CRM_Utils_System
::appendBreadCrumb(array(array('title' => ts('Survey(s)'), 'url' => $url)));
92 CRM_Utils_System
::setTitle(ts('GOTV (Voter Tracking)'));
96 * Build the form object.
98 public function buildQuickForm() {
103 //build common search form.
104 CRM_Campaign_BAO_Query
::buildSearchForm($this);
106 //build the array of all search params.
107 $this->_searchParams
= array();
108 foreach ($this->_elements
as $element) {
109 $name = $element->_attributes
['name'];
110 if ($name == 'qfKey') {
113 $this->_searchParams
[$name] = $name;
115 $this->set('searchParams', $this->_searchParams
);
116 $this->assign('searchParams', json_encode($this->_searchParams
));
120 if (!$this->_surveyId
) {
121 $this->_surveyId
= key(CRM_Campaign_BAO_Survey
::getSurveys(TRUE, TRUE));
124 if ($this->_force ||
$this->_votingTab
) {
125 $session = CRM_Core_Session
::singleton();
126 $userId = $session->get('userID');
127 // get interviewer id
128 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive',
129 CRM_Core_DAO
::$_nullObject, FALSE, $userId
132 $defaults['survey_interviewer_id'] = $cid;
134 if ($this->_surveyId
) {
135 $defaults['campaign_survey_id'] = $this->_surveyId
;
137 if (!empty($defaults)) {
138 $this->setDefaults($defaults);
141 //validate the required ids.
142 $this->validateIds();
145 public function validateIds() {
146 $errorMessages = array();
147 //check for required permissions.
148 if (!CRM_Core_Permission
::check('manage campaign') &&
149 !CRM_Core_Permission
::check('administer CiviCampaign') &&
150 !CRM_Core_Permission
::check("{$this->_searchVoterFor} campaign contacts")
152 $errorMessages[] = ts('You are not authorized to access this page.');
155 $surveys = CRM_Campaign_BAO_Survey
::getSurveys();
156 if (empty($surveys)) {
157 $errorMessages[] = ts("Oops. It looks like no surveys have been created. <a href='%1'>Click here to create a new survey.</a>", array(1 => CRM_Utils_System
::url('civicrm/survey/add', 'reset=1&action=add')));
160 if ($this->_force
&& !$this->_surveyId
) {
162 $errorMessages[] = ts('Could not find Survey.');
166 $this->assign('errorMessages', empty($errorMessages) ?
FALSE : $errorMessages);