4 +--------------------------------------------------------------------+
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2019 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2019
38 * This class generates form components to transfer an Event to another participant
41 class CRM_Event_Form_SelfSvcTransfer
extends CRM_Core_Form
{
48 protected $_from_participant_id;
55 protected $_from_contact_id;
57 * last name of the particpant to transfer to
62 protected $_to_contact_last_name;
64 * first name of the particpant to transfer to
69 protected $_to_contact_first_name;
71 * email of participant
76 protected $_to_contact_email;
82 protected $_to_contact_id;
84 * event to be cancelled/transferred
94 protected $_event_title;
100 protected $_event_start_date;
112 protected $_participant = [];
118 protected $_part_values;
124 protected $_details = [];
130 protected $_line_items = [];
136 protected $contact_id;
139 * Is backoffice form?
143 protected $isBackoffice = FALSE;
146 * Get source values for transfer based on participant id in URL. Line items will
147 * be transferred to this participant - at this point no transaction changes processed
151 public function preProcess() {
152 $config = CRM_Core_Config
::singleton();
153 $session = CRM_Core_Session
::singleton();
154 $this->_userContext
= $session->readUserContext();
155 $this->_from_participant_id
= CRM_Utils_Request
::retrieve('pid', 'Positive', $this, FALSE, NULL, 'REQUEST');
156 $this->_userChecksum
= CRM_Utils_Request
::retrieve('cs', 'String', $this, FALSE, NULL, 'REQUEST');
157 $this->isBackoffice
= CRM_Utils_Request
::retrieve('is_backoffice', 'String', $this, FALSE, NULL, 'REQUEST');
158 $params = ['id' => $this->_from_participant_id
];
159 $participant = $values = [];
160 $this->_participant
= CRM_Event_BAO_Participant
::getValues($params, $values, $participant);
161 $this->_part_values
= $values[$this->_from_participant_id
];
162 $this->set('values', $this->_part_values
);
163 $this->_event_id
= $this->_part_values
['event_id'];
164 $url = CRM_Utils_System
::url('civicrm/event/info', "reset=1&id={$this->_event_id}");
165 $this->_from_contact_id
= $this->_part_values
['participant_contact_id'];
166 $validUser = CRM_Contact_BAO_Contact_Utils
::validChecksum($this->_from_contact_id
, $this->_userChecksum
);
167 if (!$validUser && !CRM_Core_Permission
::check('edit all events')) {
168 CRM_Core_Error
::statusBounce(ts('You do not have sufficient permission to transfer/cancel this participant.'), $url);
170 $this->assign('action', $this->_action
);
171 if ($this->_from_participant_id
) {
172 $this->assign('participantId', $this->_from_participant_id
);
176 $this->_event_title
= CRM_Event_BAO_Event
::getFieldValue('CRM_Event_DAO_Event', $this->_event_id
, $daoName);
177 $daoName = 'start_date';
178 $this->_event_start_date
= CRM_Event_BAO_Event
::getFieldValue('CRM_Event_DAO_Event', $this->_event_id
, $daoName);
179 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_from_contact_id
);
180 $this->_contact_name
= $displayName;
181 $this->_contact_email
= $email;
183 $details = CRM_Event_BAO_Participant
::participantDetails($this->_from_participant_id
);
184 $optionGroupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'participant_role', 'id', 'name');
186 SELECT cpst.name as status, cov.name as role, cp.fee_level, cp.fee_amount, cp.register_date, civicrm_event.start_date
187 FROM civicrm_participant cp
188 LEFT JOIN civicrm_participant_status_type cpst ON cpst.id = cp.status_id
189 LEFT JOIN civicrm_option_value cov ON cov.value = cp.role_id and cov.option_group_id = {$optionGroupId}
190 LEFT JOIN civicrm_event ON civicrm_event.id = cp.event_id
191 WHERE cp.id = {$this->_from_participant_id}";
192 $dao = CRM_Core_DAO
::executeQuery($query);
193 while ($dao->fetch()) {
194 $details['status'] = $dao->status
;
195 $details['role'] = $dao->role
;
196 $details['fee_level'] = $dao->fee_level
;
197 $details['fee_amount'] = $dao->fee_amount
;
198 $details['register_date'] = $dao->register_date
;
199 $details['event_start_date'] = $dao->start_date
;
201 $this->assign('details', $details);
202 //This participant row will be cancelled. Get line item(s) to cancel
203 $this->selfsvctransferUrl
= CRM_Utils_System
::url('civicrm/event/selfsvcupdate',
204 "reset=1&id={$this->_from_participant_id}&id=0");
205 $this->selfsvctransferText
= ts('Update');
206 $this->selfsvctransferButtonText
= ts('Update');
210 * Build form for input of transferree email, name
214 public function buildQuickForm() {
215 // use entityRef select field for contact when this form is used by staff/admin user
216 if ($this->isBackoffice
) {
217 $this->addEntityRef("contact_id", ts('Select Contact'), ['create' => TRUE], TRUE);
219 // for front-end user show and use the basic three fields used to create a contact
221 $this->add('text', 'email', ts('To Email'), ts($this->_contact_email
), TRUE);
222 $this->add('text', 'last_name', ts('To Last Name'), ts($this->_to_contact_last_name
), TRUE);
223 $this->add('text', 'first_name', ts('To First Name'), ts($this->_to_contact_first_name
), TRUE);
229 'name' => ts('Transfer Registration'),
232 $this->addFormRule(['CRM_Event_Form_SelfSvcTransfer', 'formRule'], $this);
233 parent
::buildQuickForm();
239 * return @array _defaults
241 public function setDefaultValues() {
242 $this->_defaults
= [];
243 return $this->_defaults
;
247 * Validate email and name input
249 * return array $errors
251 public static function formRule($fields, $files, $self) {
253 if (!empty($fields['contact_id'])) {
254 $to_contact_id = $fields['contact_id'];
257 //check that either an email or firstname+lastname is included in the form(CRM-9587)
258 $to_contact_id = self
::checkProfileComplete($fields, $errors, $self);
260 //To check if the user is already registered for the event(CRM-2426)
261 if (!empty($to_contact_id)) {
262 self
::checkRegistration($fields, $self, $to_contact_id, $errors);
264 //return parent::formrule($fields, $files, $self);
265 return empty($errors) ?
TRUE : $errors;
269 * Check whether profile (name, email) is complete
273 public static function checkProfileComplete($fields, &$errors, $self) {
275 foreach ($fields as $fieldname => $fieldvalue) {
276 if (substr($fieldname, 0, 5) == 'email' && $fieldvalue) {
277 $email = $fieldvalue;
280 if (!$email && !(CRM_Utils_Array
::value('first_name', $fields) &&
281 CRM_Utils_Array
::value('last_name', $fields))) {
282 $defaults = $params = ['id' => $eventId];
283 CRM_Event_BAO_Event
::retrieve($params, $defaults);
284 $message = ts("Mandatory fields (first name and last name, OR email address) are missing from this form.");
285 $errors['_qf_default'] = $message;
287 $contact = CRM_Contact_BAO_Contact
::matchContactOnEmail($email, "");
288 $contact_id = empty($contact->contact_id
) ?
NULL : $contact->contact_id
;
289 if (!CRM_Utils_Rule
::email($fields['email'])) {
290 $errors['email'] = ts('Enter valid email address.');
292 if (empty($errors) && empty($contact_id)) {
294 'email-Primary' => CRM_Utils_Array
::value('email', $fields, NULL),
295 'first_name' => CRM_Utils_Array
::value('first_name', $fields, NULL),
296 'last_name' => CRM_Utils_Array
::value('last_name', $fields, NULL),
297 'is_deleted' => CRM_Utils_Array
::value('is_deleted', $fields, FALSE),
299 //create new contact for this name/email pair
300 //if new contact, no need to check for contact already registered
301 $contact_id = CRM_Contact_BAO_Contact
::createProfileContact($params, $fields, $contact_id);
307 * Check contact details
311 public static function checkRegistration($fields, $self, $contact_id, &$errors) {
312 // verify whether this contact already registered for this event
313 $contact_details = CRM_Contact_BAO_Contact
::getContactDetails($contact_id);
314 $display_name = $contact_details[0];
315 $query = "select event_id from civicrm_participant where contact_id = " . $contact_id;
316 $dao = CRM_Core_DAO
::executeQuery($query);
317 while ($dao->fetch()) {
318 $to_event_id[] = $dao->event_id
;
320 if (!empty($to_event_id)) {
321 foreach ($to_event_id as $id) {
322 if ($id == $self->_event_id
) {
323 $errors['email'] = $display_name . ts(" is already registered for this event");
330 * Process transfer - first add the new participant to the event, then cancel
331 * source participant - send confirmation email to transferee
333 public function postProcess() {
334 //For transfer, process form to allow selection of transferree
335 $params = $this->controller
->exportValues($this->_name
);
336 if (!empty($params['contact_id'])) {
337 $contact_id = $params['contact_id'];
340 //cancel 'from' participant row
341 $contact_id_result = civicrm_api3('Contact', 'get', [
344 'email' => $params['email'],
345 'options' => ['limit' => 1],
347 $contact_id_result = $contact_id_result['values'][0];
348 $contact_id = $contact_id_result['contact_id'];
349 $contact_is_deleted = $contact_id_result['contact_is_deleted'];
350 if ($contact_is_deleted ||
!is_numeric($contact_id)) {
351 CRM_Core_Error
::statusBounce(ts('Contact does not exist.'));
354 $from_participant = $params = [];
355 $query = "select role_id, source, fee_level, is_test, is_pay_later, fee_amount, discount_id, fee_currency,campaign_id, discount_amount from civicrm_participant where id = " . $this->_from_participant_id
;
356 $dao = CRM_Core_DAO
::executeQuery($query);
358 while ($dao->fetch()) {
359 $value_to['role_id'] = $dao->role_id
;
360 $value_to['source'] = $dao->source
;
361 $value_to['fee_level'] = $dao->fee_level
;
362 $value_to['is_test'] = $dao->is_test
;
363 $value_to['is_pay_later'] = $dao->is_pay_later
;
364 $value_to['fee_amount'] = $dao->fee_amount
;
366 $value_to['contact_id'] = $contact_id;
367 $value_to['event_id'] = $this->_event_id
;
368 $value_to['status_id'] = CRM_Core_PseudoConstant
::getKey(
369 'CRM_Event_BAO_Participant',
373 $value_to['register_date'] = date("Y-m-d");
374 //first create the new participant row -don't set registered_by yet or email won't be sent
375 $participant = CRM_Event_BAO_Participant
::create($value_to);
376 //send a confirmation email to the new participant
377 $this->participantTransfer($participant);
378 //now update registered_by_id
379 $query = "UPDATE civicrm_participant cp SET cp.registered_by_id = %1 WHERE cp.id = ({$participant->id})";
380 $params = [1 => [$this->_from_participant_id
, 'Integer']];
381 $dao = CRM_Core_DAO
::executeQuery($query, $params);
382 //copy line items to new participant
383 $line_items = CRM_Price_BAO_LineItem
::getLineItems($this->_from_participant_id
);
384 foreach ($line_items as $item) {
385 $item['entity_id'] = $participant->id
;
387 $item['entity_table'] = "civicrm_participant";
388 $new_item = CRM_Price_BAO_LineItem
::create($item);
390 //now cancel the from participant record, leaving the original line-item(s)
392 $value_from['id'] = $this->_from_participant_id
;
393 $tansferId = array_search('Transferred', CRM_Event_PseudoConstant
::participantStatus(NULL, "class = 'Negative'"));
394 $value_from['status_id'] = $tansferId;
395 $value_from['transferred_to_contact_id'] = $contact_id;
396 $contact_details = CRM_Contact_BAO_Contact
::getContactDetails($contact_id);
397 $display_name = current($contact_details);
398 $this->assign('to_participant', $display_name);
399 CRM_Event_BAO_Participant
::create($value_from);
400 $this->sendCancellation();
401 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contact_id);
402 $statusMsg = ts('Event registration information for %1 has been updated.', [1 => $displayName]);
403 $statusMsg .= ' ' . ts('A confirmation email has been sent to %1.', [1 => $email]);
404 CRM_Core_Session
::setStatus($statusMsg, ts('Registration Transferred'), 'success');
405 if ($this->isBackoffice
) {
408 $url = CRM_Utils_System
::url('civicrm/event/info', "reset=1&id={$this->_event_id}");
409 CRM_Utils_System
::redirect($url);
413 * Based on input, create participant row for transferee and send email
417 public function participantTransfer($participant) {
418 $contactDetails = [];
419 $contactIds[] = $participant->contact_id
;
420 list($currentContactDetails) = CRM_Utils_Token
::getTokenDetails($contactIds, NULL,
421 FALSE, FALSE, NULL, [], 'CRM_Event_BAO_Participant');
422 foreach ($currentContactDetails as $contactId => $contactValues) {
423 $contactDetails[$contactId] = $contactValues;
425 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
426 $participantDetails = [];
427 $query = "SELECT * FROM civicrm_participant WHERE id = " . $participant->id
;
428 $dao = CRM_Core_DAO
::executeQuery($query);
429 while ($dao->fetch()) {
430 $participantDetails[$dao->id
] = [
432 'role' => $participantRoles[$dao->role_id
],
433 'is_test' => $dao->is_test
,
434 'event_id' => $dao->event_id
,
435 'status_id' => $dao->status_id
,
436 'fee_amount' => $dao->fee_amount
,
437 'contact_id' => $dao->contact_id
,
438 'register_date' => $dao->register_date
,
439 'registered_by_id' => $dao->registered_by_id
,
443 if (empty($domainValues)) {
444 $domain = CRM_Core_BAO_Domain
::getDomain();
453 'contact' => CRM_Core_SelectValues
::contactTokens(),
455 foreach ($tokens['domain'] as $token) {
456 $domainValues[$token] = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain);
460 $eventParams = ['id' => $participant->event_id
];
461 CRM_Event_BAO_Event
::retrieve($eventParams, $eventDetails);
462 //get default participant role.
463 $eventDetails['participant_role'] = CRM_Utils_Array
::value($eventDetails['default_role_id'], $participantRoles);
464 //get the location info
466 'entity_id' => $participant->event_id
,
467 'entity_table' => 'civicrm_event',
469 $eventDetails['location'] = CRM_Core_BAO_Location
::getValues($locParams, TRUE);
470 $toEmail = CRM_Utils_Array
::value('email', $contactDetails[$participant->contact_id
]);
472 //take a receipt from as event else domain.
473 $receiptFrom = $domainValues['name'] . ' <' . $domainValues['email'] . '>';
474 if (!empty($eventDetails['confirm_from_name']) && !empty($eventDetails['confirm_from_email'])) {
475 $receiptFrom = $eventDetails['confirm_from_name'] . ' <' . $eventDetails['confirm_from_email'] . '>';
477 $participantName = $contactDetails[$participant->contact_id
]['display_name'];
479 'event' => $eventDetails,
480 'participant' => $participantDetails[$participant->id
],
481 'participantID' => $participant->id
,
482 'participant_status' => 'Registered',
485 $sendTemplateParams = [
486 'groupName' => 'msg_tpl_workflow_event',
487 'valueName' => 'event_online_receipt',
488 'contactId' => $participantDetails[$participant->id
]['contact_id'],
489 'tplParams' => $tplParams,
490 'from' => $receiptFrom,
491 'toName' => $participantName,
492 'toEmail' => $toEmail,
493 'cc' => CRM_Utils_Array
::value('cc_confirm', $eventDetails),
494 'bcc' => CRM_Utils_Array
::value('bcc_confirm', $eventDetails),
496 CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
501 * Send confirmation of cancellation to source participant
505 public function sendCancellation() {
507 $domain = CRM_Core_BAO_Domain
::getDomain();
516 'contact' => CRM_Core_SelectValues
::contactTokens(),
518 foreach ($tokens['domain'] as $token) {
519 $domainValues[$token] = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain);
521 $participantRoles = [];
522 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
523 $participantDetails = [];
524 $query = "SELECT * FROM civicrm_participant WHERE id = {$this->_from_participant_id}";
525 $dao = CRM_Core_DAO
::executeQuery($query);
526 while ($dao->fetch()) {
527 $participantDetails[$dao->id
] = [
529 'role' => $participantRoles[$dao->role_id
],
530 'is_test' => $dao->is_test
,
531 'event_id' => $dao->event_id
,
532 'status_id' => $dao->status_id
,
533 'fee_amount' => $dao->fee_amount
,
534 'contact_id' => $dao->contact_id
,
535 'register_date' => $dao->register_date
,
536 'registered_by_id' => $dao->registered_by_id
,
540 $eventParams = ['id' => $this->_event_id
];
541 CRM_Event_BAO_Event
::retrieve($eventParams, $eventDetails[$this->_event_id
]);
542 //get default participant role.
543 $eventDetails[$this->_event_id
]['participant_role'] = CRM_Utils_Array
::value($eventDetails[$this->_event_id
]['default_role_id'], $participantRoles);
544 //get the location info
545 $locParams = ['entity_id' => $this->_event_id
, 'entity_table' => 'civicrm_event'];
546 $eventDetails[$this->_event_id
]['location'] = CRM_Core_BAO_Location
::getValues($locParams, TRUE);
547 //get contact details
548 $contactIds[$this->_from_contact_id
] = $this->_from_contact_id
;
549 list($currentContactDetails) = CRM_Utils_Token
::getTokenDetails($contactIds, NULL,
550 FALSE, FALSE, NULL, [],
551 'CRM_Event_BAO_Participant'
553 foreach ($currentContactDetails as $contactId => $contactValues) {
554 $contactDetails[$this->_from_contact_id
] = $contactValues;
556 //send a 'cancelled' email to user, and cc the event's cc_confirm email
557 $mail = CRM_Event_BAO_Participant
::sendTransitionParticipantMail($this->_from_participant_id
,
558 $participantDetails[$this->_from_participant_id
],
559 $eventDetails[$this->_event_id
],
560 $contactDetails[$this->_from_contact_id
],
565 $statusMsg = ts('Event registration information for %1 has been updated.', [1 => $this->_contact_name
]);
566 $statusMsg .= ' ' . ts('A cancellation email has been sent to %1.', [1 => $this->_contact_email
]);
567 CRM_Core_Session
::setStatus($statusMsg, ts('Thanks'), 'success');