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 add contacts for
40 class CRM_Campaign_Form_Task_Reserve
extends CRM_Campaign_Form_Task
{
54 protected $_interviewerId;
61 protected $_surveyDetails;
68 protected $_numVoters;
71 * Build all the data structures needed to build the form
75 public function preProcess() {
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."));
84 if (!$this->_interviewerId
) {
85 CRM_Core_Error
::statusBounce(ts("Missing Interviewer contact."));
87 if (!is_array($this->_contactIds
) ||
empty($this->_contactIds
)) {
88 CRM_Core_Error
::statusBounce(ts("Could not find contacts for reservation."));
91 $params = array('id' => $this->_surveyId
);
92 CRM_Campaign_BAO_Survey
::retrieve($params, $this->_surveyDetails
);
94 //get the survey activities.
95 $activityStatus = CRM_Core_PseudoConstant
::activityStatus('name');
100 if ($statusId = array_search($name, $activityStatus)) {
101 $statusIds[] = $statusId;
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
,
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
);
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)));
126 CRM_Utils_System
::setTitle(ts('Reserve Respondents'));
129 public function validateSurvey() {
131 $maxVoters = CRM_Utils_Array
::value('max_number_of_contacts', $this->_surveyDetails
);
133 if ($maxVoters <= $this->_numVoters
) {
134 $errorMsg = ts('The maximum number of contacts is already reserved for this interviewer.');
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
)
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)
151 CRM_Core_Error
::statusBounce($errorMsg);
156 * Build the form object
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')
174 $this->assign('hasExistingGroups', $hasExistingGroups);
179 'name' => ts('Reserve'),
180 'subName' => 'reserve',
185 if (CRM_Core_Permission
::check('manage campaign') ||
186 CRM_Core_Permission
::check('administer CiviCampaign') ||
187 CRM_Core_Permission
::check('interview campaign contacts')
191 'name' => ts('Reserve and Interview'),
192 'subName' => 'reserveToInterview',
197 'name' => ts('Cancel'),
200 $this->addButtons($buttons);
201 $this->addFormRule(array('CRM_Campaign_Form_Task_Reserve', 'formRule'), $this);
205 * Global validation rules for the form
207 * @param array $fields
208 * Posted values of the form.
214 * list of errors to be posted back to the form
217 public static function formRule($fields, $files, $self) {
219 $invalidGroupName = FALSE;
220 if (!empty($fields['newGroupName'])) {
221 $title = trim($fields['newGroupName']);
222 $name = CRM_Utils_String
::titleToVar($title);
223 $query = 'select count(*) from civicrm_group where name like %1 OR title like %2';
224 $grpCnt = CRM_Core_DAO
::singleValueQuery($query, array(
225 1 => array($name, 'String'),
226 2 => array($title, 'String'),
229 $invalidGroupName = TRUE;
230 $errors['newGroupName'] = ts('Group \'%1\' already exists.', array(1 => $fields['newGroupName']));
233 $self->assign('invalidGroupName', $invalidGroupName);
235 return empty($errors) ?
TRUE : $errors;
239 * Process the form after the input has been submitted and validated
244 public function postProcess() {
247 $maxVoters = CRM_Utils_Array
::value('max_number_of_contacts', $this->_surveyDetails
);
248 $activityStatus = CRM_Core_PseudoConstant
::activityStatus('name');
249 $statusHeld = array_search('Scheduled', $activityStatus);
251 $reservedVoterIds = array();
252 foreach ($this->_contactIds
as $cid) {
253 $subject = ts('%1', array(1 => $this->_surveyDetails
['title'])) . ' - ' . ts('Respondent Reservation');
254 $session = CRM_Core_Session
::singleton();
255 $activityParams = array(
256 'source_contact_id' => $session->get('userID'),
257 'assignee_contact_id' => array($this->_interviewerId
),
258 'target_contact_id' => array($cid),
259 'source_record_id' => $this->_surveyId
,
260 'activity_type_id' => $this->_surveyDetails
['activity_type_id'],
261 'subject' => $subject,
262 'activity_date_time' => date('YmdHis'),
263 'status_id' => $statusHeld,
264 'skipRecentView' => 1,
265 'campaign_id' => CRM_Utils_Array
::value('campaign_id', $this->_surveyDetails
),
267 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
270 $reservedVoterIds[$cid] = $cid;
272 if ($maxVoters && ($maxVoters <= ($this->_numVoters +
$countVoters))) {
277 //add reserved voters to groups.
278 $groupAdditions = $this->_addRespondentToGroup($reservedVoterIds);
281 if ($countVoters > 0) {
282 $status = '<p>' . ts("%1 Contact(s) have been reserved.", array(1 => $countVoters)) . '</p>';
283 if ($groupAdditions) {
284 $status .= '<p>' . ts('Respondent(s) has been added to %1 group(s).',
285 array(1 => implode(', ', $groupAdditions))
288 CRM_Core_Session
::setStatus($status, ts('Reservation Added'), 'success');
291 if (count($this->_contactIds
) > $countVoters) {
292 CRM_Core_Session
::setStatus(ts('Reservation did not add for %1 contact(s).',
293 array(1 => (count($this->_contactIds
) - $countVoters))
297 //get ready to jump to voter interview form.
298 $buttonName = $this->controller
->getButtonName();
299 if (!empty($reservedVoterIds) &&
300 $buttonName == '_qf_Reserve_next_reserveToInterview'
302 $this->controller
->set('surveyId', $this->_surveyId
);
303 $this->controller
->set('contactIds', $reservedVoterIds);
304 $this->controller
->set('interviewerId', $this->_interviewerId
);
305 $this->controller
->set('reserveToInterview', TRUE);
314 private function _addRespondentToGroup($contactIds) {
315 $groupAdditions = array();
316 if (empty($contactIds)) {
317 return $groupAdditions;
320 $params = $this->controller
->exportValues($this->_name
);
321 $groups = CRM_Utils_Array
::value('groups', $params, array());
322 $newGroupName = CRM_Utils_Array
::value('newGroupName', $params);
323 $newGroupDesc = CRM_Utils_Array
::value('newGroupDesc', $params);
329 'title' => $newGroupName,
330 'description' => $newGroupDesc,
333 $group = CRM_Contact_BAO_Group
::create($grpParams);
334 $groups[] = $newGroupId = $group->id
;
337 //add the respondents to groups.
338 if (is_array($groups)) {
339 $existingGroups = CRM_Core_PseudoConstant
::group();
340 foreach ($groups as $groupId) {
341 $addCount = CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $groupId);
342 $totalCount = CRM_Utils_Array
::value(1, $addCount);
343 if ($groupId == $newGroupId) {
344 $name = $newGroupName;
348 $name = $existingGroups[$groupId];
352 $url = CRM_Utils_System
::url('civicrm/group/search',
353 'reset=1&force=1&context=smog&gid=' . $groupId
355 $groupAdditions[] = '<a href="' . $url . '">' . $name . '</a>';
360 return $groupAdditions;