3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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
39 class CRM_Campaign_Form_Search
extends CRM_Core_Form_Search
{
42 * the params that are sent to the query
47 protected $_queryParams;
50 * are we restricting ourselves to a single contact
55 protected $_single = FALSE;
58 * are we restricting ourselves to a single contact
63 protected $_limit = NULL;
68 * prefix for the controller
71 protected $_prefix = "survey_";
74 private $_operation = 'reserve';
77 * processing needed for buildForm and later
81 */ function preProcess() {
83 $this->_defaults
= array();
85 //set the button name.
86 $this->_searchButtonName
= $this->getButtonName('refresh');
87 $this->_printButtonName
= $this->getButtonName('next', 'print');
88 $this->_actionButtonName
= $this->getButtonName('next', 'action');
90 //we allow the controller to set force/reset externally,
91 //useful when we are being driven by the wizard framework
92 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
93 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
94 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
95 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean', CRM_Core_DAO
::$_nullObject);
97 //operation for state machine.
98 $this->_operation
= CRM_Utils_Request
::retrieve('op', 'String', $this, FALSE, 'reserve');
100 if (!in_array($this->_operation
, array(
101 'reserve', 'release', 'interview'))) {
102 $this->_operation
= 'reserve';
103 $this->set('op', $this->_operation
);
105 $this->set('searchVoterFor', $this->_operation
);
106 $this->assign('searchVoterFor', $this->_operation
);
107 $this->assign('isFormSubmitted', $this->isSubmitted());
109 //do check permissions.
110 if (!CRM_Core_Permission
::check('administer CiviCampaign') &&
111 !CRM_Core_Permission
::check('manage campaign') &&
112 !CRM_Core_Permission
::check("{$this->_operation} campaign contacts")
114 CRM_Utils_System
::permissionDenied();
115 CRM_Utils_System
::civiExit();
118 $this->assign("context", $this->_context
);
120 // get user submitted values
121 // get it from controller only if form has been submitted, else preProcess has set this
124 $this->_formValues
= $this->get('formValues');
127 $this->_formValues
= $this->controller
->exportValues($this->_name
);
131 $this->postProcess();
132 $this->set('force', 0);
136 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
137 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
138 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
142 //get the voter clause.
143 $voterClause = $this->voterClause();
145 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
147 $selector = new CRM_Campaign_Selector_Search($this->_queryParams
,
155 if ($this->_context
== 'user') {
156 $prefix = $this->_prefix
;
159 $this->assign("{$prefix}limit", $this->_limit
);
160 $this->assign("{$prefix}single", $this->_single
);
162 $controller = new CRM_Core_Selector_Controller($selector,
163 $this->get(CRM_Utils_Pager
::PAGE_ID
),
165 CRM_Core_Action
::VIEW
,
167 CRM_Core_Selector_Controller
::TRANSFER
,
171 $controller->setEmbedded(TRUE);
172 $controller->moveFromSessionToTemplate();
174 //append breadcrumb to survey dashboard.
175 if (CRM_Campaign_BAO_Campaign
::accessCampaign()) {
176 $url = CRM_Utils_System
::url('civicrm/campaign', 'reset=1&subPage=survey');
177 CRM_Utils_System
::appendBreadCrumb(array(array('title' => ts('Survey(s)'), 'url' => $url)));
180 //set the form title.
181 CRM_Utils_System
::setTitle(ts('Find Respondents To %1', array(1 => ucfirst($this->_operation
))));
184 function setDefaultValues() {
185 //load the default survey for all actions.
186 if (empty($this->_defaults
)) {
187 $defaultSurveyId = key(CRM_Campaign_BAO_Survey
::getSurveys(TRUE, TRUE));
188 if ($defaultSurveyId) {
189 $this->_defaults
['campaign_survey_id'] = $defaultSurveyId;
193 return $this->_defaults
;
203 function buildQuickForm() {
204 parent
::buildQuickForm();
205 //build the search form.
206 CRM_Campaign_BAO_Query
::buildSearchForm($this);
208 $rows = $this->get('rows');
209 if (is_array($rows)) {
210 if (!$this->_single
) {
211 $this->addRowSelectors($rows);
214 $permission = CRM_Core_Permission
::getPermission();
215 $allTasks = CRM_Campaign_Task
::permissionedTaskTitles($permission);
217 //hack to serve right page to state machine.
218 $taskMapping = array(
224 $currentTaskValue = CRM_Utils_Array
::value($this->_operation
, $taskMapping);
225 $taskValue = array($currentTaskValue => $allTasks[$currentTaskValue]);
226 if ($this->_operation
== 'interview' && !empty($this->_formValues
['campaign_survey_id'])) {
227 $activityTypes = CRM_Core_PseudoConstant
::activityType(FALSE, TRUE, FALSE, 'label', TRUE);
229 $surveyTypeId = CRM_Core_DAO
::getFieldValue('CRM_Campaign_DAO_Survey',
230 $this->_formValues
['campaign_survey_id'],
234 $currentTaskValue => ts('Record %1 Responses',
235 array(1 => $activityTypes[$surveyTypeId])
239 $this->addTaskMenu($taskValue);
245 * The post processing of the form gets done here.
247 * Key things done during post processing are
248 * - check for reset or next request. if present, skip post procesing.
249 * - now check if user requested running a saved search, if so, then
250 * the form values associated with the saved search are used for searching.
251 * - if user has done a submit with new values the regular post submissing is
253 * The processing consists of using a Selector / Controller framework for getting the
261 function postProcess() {
268 if (!empty($_POST)) {
269 $this->_formValues
= $this->controller
->exportValues($this->_name
);
272 $this->fixFormValues();
274 //format params as per task.
275 $this->formatParams();
277 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
279 $this->set('formValues', $this->_formValues
);
280 $this->set('queryParams', $this->_queryParams
);
282 $buttonName = $this->controller
->getButtonName();
283 if ($buttonName == $this->_actionButtonName
) {
284 // check actionName and if next, then do not repeat a search, since we are going to the next page
286 // hack, make sure we reset the task values
287 $stateMachine = $this->controller
->getStateMachine();
288 $formName = $stateMachine->getTaskFormName();
290 $this->controller
->resetPage($formName);
295 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
296 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
297 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
301 //get the voter clause.
302 $voterClause = $this->voterClause();
304 $selector = new CRM_Campaign_Selector_Search($this->_queryParams
,
311 $selector->setKey($this->controller
->_key
);
314 if ($this->_context
== 'basic' ||
315 $this->_context
== 'user'
317 $prefix = $this->_prefix
;
320 $controller = new CRM_Core_Selector_Controller($selector,
321 $this->get(CRM_Utils_Pager
::PAGE_ID
),
323 CRM_Core_Action
::VIEW
,
325 CRM_Core_Selector_Controller
::SESSION
,
328 $controller->setEmbedded(TRUE);
329 $query = $selector->getQuery();
330 if ($this->_context
== 'user') {
331 $query->setSkipPermission(TRUE);
336 function formatParams() {
337 $interviewerId = CRM_Utils_Array
::value('survey_interviewer_id', $this->_formValues
);
338 if ($interviewerId) {
339 $this->set('interviewerId', $interviewerId);
342 //format multi-select group and contact types.
343 foreach (array('group', 'contact_type') as $param) {
347 $paramValue = CRM_Utils_Array
::value($param, $this->_formValues
);
348 if ($paramValue && is_array($paramValue)) {
349 unset($this->_formValues
[$param]);
350 foreach ($paramValue as $key => $value) {
351 $this->_formValues
[$param][$value] = 1;
356 //apply filter of survey contact type for search.
357 $contactType = CRM_Campaign_BAO_Survey
::getSurveyContactType(CRM_Utils_Array
::value('campaign_survey_id', $this->_formValues
));
358 if ($contactType && in_array($this->_operation
, array(
359 'reserve', 'interview'))) {
360 $this->_formValues
['contact_type'][$contactType] = 1;
363 if ($this->_operation
== 'reserve') {
364 if (!empty($this->_formValues
['campaign_survey_id'])) {
365 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Campaign_DAO_Survey',
366 $this->_formValues
['campaign_survey_id'],
370 //allow voter search in sub-part of given constituents,
371 //but make sure in case user does not select any group.
372 //get all associated campaign groups in where filter, CRM-7406
373 $groups = CRM_Utils_Array
::value('group', $this->_formValues
);
374 if ($campaignId && CRM_Utils_System
::isNull($groups)) {
375 $campGroups = CRM_Campaign_BAO_Campaign
::getCampaignGroups($campaignId);
376 foreach ($campGroups as $id => $title) $this->_formValues
['group'][$id] = 1;
379 //carry servey id w/ this.
380 $this->set('surveyId', $this->_formValues
['campaign_survey_id']);
381 unset($this->_formValues
['campaign_survey_id']);
383 unset($this->_formValues
['survey_interviewer_id']);
385 elseif ($this->_operation
== 'interview' ||
386 $this->_operation
== 'release'
388 //to conduct interview / release activity status should be scheduled.
389 $activityStatus = CRM_Core_PseudoConstant
::activityStatus('name');
390 if ($scheduledStatusId = array_search('Scheduled', $activityStatus)) {
391 $this->_formValues
['survey_status_id'] = $scheduledStatusId;
395 //pass voter search operation.
396 $this->_formValues
['campaign_search_voter_for'] = $this->_operation
;
399 function fixFormValues() {
400 // if this search has been forced
401 // then see if there are any get values, and if so over-ride the post values
402 // note that this means that GET over-rides POST :)
404 //since we have qfKey, no need to manipulate set defaults.
405 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String', CRM_Core_DAO
::$_nullObject);
407 if (!$this->_force || CRM_Utils_Rule
::qfKey($qfKey)) {
412 $surveyId = CRM_Utils_Request
::retrieve('sid', 'Positive', CRM_Core_DAO
::$_nullObject);
415 $surveyId = CRM_Utils_Type
::escape($surveyId, 'Integer');
418 // use default survey id
419 $surveyId = key(CRM_Campaign_BAO_Survey
::getSurveys(TRUE, TRUE));
422 CRM_Core_Error
::fatal('Could not find valid Survey Id.');
424 $this->_formValues
['campaign_survey_id'] = $this->_formValues
['campaign_survey_id'] = $surveyId;
426 $session = CRM_Core_Session
::singleton();
427 $userId = $session->get('userID');
429 // get interviewer id
430 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive',
431 CRM_Core_DAO
::$_nullObject, FALSE, $userId
433 //to force other contact as interviewer, user should be admin.
434 if ($cid != $userId &&
435 !CRM_Core_Permission
::check('administer CiviCampaign')
437 CRM_Utils_System
::permissionDenied();
438 CRM_Utils_System
::civiExit();
440 $this->_formValues
['survey_interviewer_id'] = $cid;
441 //get all in defaults.
442 $this->_defaults
= $this->_formValues
;
443 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
449 function voterClause() {
450 $params = array('campaign_search_voter_for' => $this->_operation
);
452 $clauseFields = array(
453 'surveyId' => 'campaign_survey_id',
454 'interviewerId' => 'survey_interviewer_id',
457 foreach ($clauseFields as $param => $key) {
458 $params[$key] = CRM_Utils_Array
::value($key, $this->_formValues
);
459 if (!$params[$key]) {
460 $params[$key] = $this->get($param);
465 $voterClause = CRM_Campaign_BAO_Query
::voterClause($params);
471 * Return a descriptive name for the page, used in wizard header
476 public function getTitle() {
477 return ts('Find Respondents');