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
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');
97 foreach (array('Scheduled') as $name) {
98 if ($statusId = array_search($name, $activityStatus)) {
99 $statusIds[] = $statusId;
103 // these are the activities count that are linked to the current
104 // interviewer and current survey and not the list of ALL survey activities
105 $this->_numVoters
= CRM_Campaign_BAO_Survey
::getSurveyActivities($this->_surveyId
,
106 $this->_interviewerId
,
111 //validate the selected survey.
112 $this->validateSurvey();
113 $this->assign('surveyTitle', $this->_surveyDetails
['title']);
114 $this->assign('activityType', $this->_surveyDetails
['activity_type_id']);
115 $this->assign('surveyId', $this->_surveyId
);
117 //append breadcrumb to survey dashboard.
118 if (CRM_Campaign_BAO_Campaign
::accessCampaign()) {
119 $url = CRM_Utils_System
::url('civicrm/campaign', 'reset=1&subPage=survey');
120 CRM_Utils_System
::appendBreadCrumb(array(array('title' => ts('Survey(s)'), 'url' => $url)));
124 CRM_Utils_System
::setTitle(ts('Reserve Respondents'));
127 public function validateSurvey() {
129 $maxVoters = CRM_Utils_Array
::value('max_number_of_contacts', $this->_surveyDetails
);
131 if ($maxVoters <= $this->_numVoters
) {
132 $errorMsg = ts('The maximum number of contacts is already reserved for this interviewer.');
134 elseif (count($this->_contactIds
) > ($maxVoters - $this->_numVoters
)) {
135 $errorMsg = ts('You can reserve a maximum of %count contact at a time for this survey.',
137 'plural' => 'You can reserve a maximum of %count contacts at a time for this survey.',
138 'count' => $maxVoters - $this->_numVoters
,
144 $defaultNum = CRM_Utils_Array
::value('default_number_of_contacts', $this->_surveyDetails
);
145 if (!$errorMsg && $defaultNum && (count($this->_contactIds
) > $defaultNum)) {
146 $errorMsg = ts('You can reserve a maximum of %count contact at a time for this survey.',
148 'plural' => 'You can reserve a maximum of %count contacts at a time for this survey.',
149 'count' => $defaultNum,
155 CRM_Core_Error
::statusBounce($errorMsg);
160 * Build the form object.
165 public function buildQuickForm() {
166 // allow to add contact to either new or existing group.
167 $this->addElement('text', 'ActivityType', ts('Activity Type'));
168 $this->addElement('text', 'newGroupName', ts('Name for new group'));
169 $this->addElement('text', 'newGroupDesc', ts('Description of new group'));
170 $groups = CRM_Core_PseudoConstant
::nestedGroup();
171 $hasExistingGroups = FALSE;
172 if (is_array($groups) && !empty($groups)) {
173 $hasExistingGroups = TRUE;
174 $this->addElement('select', 'groups', ts('Add respondent(s) to existing group(s)'),
175 $groups, array('multiple' => "multiple", 'class' => 'crm-select2')
178 $this->assign('hasExistingGroups', $hasExistingGroups);
183 'name' => ts('Reserve'),
184 'subName' => 'reserve',
189 if (CRM_Core_Permission
::check('manage campaign') ||
190 CRM_Core_Permission
::check('administer CiviCampaign') ||
191 CRM_Core_Permission
::check('interview campaign contacts')
195 'name' => ts('Reserve and Interview'),
196 'subName' => 'reserveToInterview',
201 'name' => ts('Cancel'),
204 $this->addButtons($buttons);
205 $this->addFormRule(array('CRM_Campaign_Form_Task_Reserve', 'formRule'), $this);
209 * Global validation rules for the form.
211 * @param array $fields
212 * Posted values of the form.
218 * list of errors to be posted back to the form
220 public static function formRule($fields, $files, $self) {
222 $invalidGroupName = FALSE;
223 if (!empty($fields['newGroupName'])) {
224 $title = trim($fields['newGroupName']);
225 $name = CRM_Utils_String
::titleToVar($title);
226 $query = 'select count(*) from civicrm_group where name like %1 OR title like %2';
227 $grpCnt = CRM_Core_DAO
::singleValueQuery($query, array(
228 1 => array($name, 'String'),
229 2 => array($title, 'String'),
232 $invalidGroupName = TRUE;
233 $errors['newGroupName'] = ts('Group \'%1\' already exists.', array(1 => $fields['newGroupName']));
236 $self->assign('invalidGroupName', $invalidGroupName);
238 return empty($errors) ?
TRUE : $errors;
242 * Process the form after the input has been submitted and validated.
247 public function postProcess() {
250 $maxVoters = CRM_Utils_Array
::value('max_number_of_contacts', $this->_surveyDetails
);
251 $activityStatus = CRM_Core_PseudoConstant
::activityStatus('name');
252 $statusHeld = array_search('Scheduled', $activityStatus);
254 $reservedVoterIds = array();
255 foreach ($this->_contactIds
as $cid) {
256 $subject = $this->_surveyDetails
['title'] . ' - ' . ts('Respondent Reservation');
257 $session = CRM_Core_Session
::singleton();
258 $activityParams = array(
259 'source_contact_id' => $session->get('userID'),
260 'assignee_contact_id' => array($this->_interviewerId
),
261 'target_contact_id' => array($cid),
262 'source_record_id' => $this->_surveyId
,
263 'activity_type_id' => $this->_surveyDetails
['activity_type_id'],
264 'subject' => $subject,
265 'activity_date_time' => date('YmdHis'),
266 'status_id' => $statusHeld,
267 'skipRecentView' => 1,
268 'campaign_id' => CRM_Utils_Array
::value('campaign_id', $this->_surveyDetails
),
270 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
273 $reservedVoterIds[$cid] = $cid;
275 if ($maxVoters && ($maxVoters <= ($this->_numVoters +
$countVoters))) {
280 //add reserved voters to groups.
281 $groupAdditions = $this->_addRespondentToGroup($reservedVoterIds);
284 if ($countVoters > 0) {
285 $status = '<p>' . ts("%count contact has been reserved.", array('plural' => '%count contacts have been reserved.', 'count' => $countVoters)) . '</p>';
286 if ($groupAdditions) {
287 $status .= '<p>' . ts('They have been added to %1.',
288 array(1 => implode(' ' . ts('and') . ' ', $groupAdditions))
291 CRM_Core_Session
::setStatus($status, ts('Reservation Added'), 'success');
294 if (count($this->_contactIds
) > $countVoters) {
295 CRM_Core_Session
::setStatus(ts('Reservation did not add for %count contact.',
297 'plural' => 'Reservation did not add for %count contacts.',
298 'count' => (count($this->_contactIds
) - $countVoters),
303 //get ready to jump to voter interview form.
304 $buttonName = $this->controller
->getButtonName();
305 if (!empty($reservedVoterIds) &&
306 $buttonName == '_qf_Reserve_next_reserveToInterview'
308 $this->controller
->set('surveyId', $this->_surveyId
);
309 $this->controller
->set('contactIds', $reservedVoterIds);
310 $this->controller
->set('interviewerId', $this->_interviewerId
);
311 $this->controller
->set('reserveToInterview', TRUE);
320 private function _addRespondentToGroup($contactIds) {
321 $groupAdditions = array();
322 if (empty($contactIds)) {
323 return $groupAdditions;
326 $params = $this->controller
->exportValues($this->_name
);
327 $groups = CRM_Utils_Array
::value('groups', $params, array());
328 $newGroupName = CRM_Utils_Array
::value('newGroupName', $params);
329 $newGroupDesc = CRM_Utils_Array
::value('newGroupDesc', $params);
335 'title' => $newGroupName,
336 'description' => $newGroupDesc,
339 $group = CRM_Contact_BAO_Group
::create($grpParams);
340 $groups[] = $newGroupId = $group->id
;
343 //add the respondents to groups.
344 if (is_array($groups)) {
345 $existingGroups = CRM_Core_PseudoConstant
::group();
346 foreach ($groups as $groupId) {
347 $addCount = CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $groupId);
348 $totalCount = CRM_Utils_Array
::value(1, $addCount);
349 if ($groupId == $newGroupId) {
350 $name = $newGroupName;
354 $name = $existingGroups[$groupId];
358 $url = CRM_Utils_System
::url('civicrm/group/search',
359 'reset=1&force=1&context=smog&gid=' . $groupId
361 $groupAdditions[] = '<a href="' . $url . '">' . $name . '</a>';
366 return $groupAdditions;