4 +--------------------------------------------------------------------+
5 | Copyright CiviCRM LLC. All rights reserved. |
7 | This work is published under the GNU AGPLv3 license with some |
8 | permitted exceptions and without any warranty. For full license |
9 | and copyright information, see https://civicrm.org/licensing |
10 +--------------------------------------------------------------------+
16 * @copyright CiviCRM LLC https://civicrm.org/licensing
20 * This class generates form components to transfer an Event to another participant
23 class CRM_Event_Form_SelfSvcTransfer
extends CRM_Core_Form
{
30 protected $_from_participant_id;
37 protected $_from_contact_id;
39 * last name of the participant to transfer to
44 protected $_to_contact_last_name;
46 * first name of the participant to transfer to
51 protected $_to_contact_first_name;
53 * email of participant
58 protected $_to_contact_email;
64 protected $_to_contact_id;
66 * event to be cancelled/transferred
76 protected $_event_title;
82 protected $_event_start_date;
94 protected $_participant = [];
100 protected $_part_values;
106 protected $_details = [];
112 protected $_line_items = [];
118 protected $contact_id;
121 * Is backoffice form?
125 protected $isBackoffice = FALSE;
128 * Get source values for transfer based on participant id in URL. Line items will
129 * be transferred to this participant - at this point no transaction changes processed
133 * @throws \CRM_Core_Exception
135 public function preProcess() {
136 $session = CRM_Core_Session
::singleton();
137 $this->_userContext
= $session->readUserContext();
138 $this->_from_participant_id
= CRM_Utils_Request
::retrieve('pid', 'Positive', $this, FALSE, NULL, 'REQUEST');
139 $this->_userChecksum
= CRM_Utils_Request
::retrieve('cs', 'String', $this, FALSE, NULL, 'REQUEST');
140 $this->isBackoffice
= CRM_Utils_Request
::retrieve('is_backoffice', 'String', $this, FALSE, NULL, 'REQUEST') ??
FALSE;
141 $params = ['id' => $this->_from_participant_id
];
142 $participant = $values = [];
143 $this->_participant
= CRM_Event_BAO_Participant
::getValues($params, $values, $participant);
144 $this->_part_values
= $values[$this->_from_participant_id
];
145 $this->set('values', $this->_part_values
);
146 $this->_event_id
= $this->_part_values
['event_id'];
147 $url = CRM_Utils_System
::url('civicrm/event/info', "reset=1&id={$this->_event_id}");
148 $this->_from_contact_id
= $this->_part_values
['participant_contact_id'];
149 $validUser = CRM_Contact_BAO_Contact_Utils
::validChecksum($this->_from_contact_id
, $this->_userChecksum
);
150 if (!$validUser && !CRM_Core_Permission
::check('edit all events')) {
151 CRM_Core_Error
::statusBounce(ts('You do not have sufficient permission to transfer/cancel this participant.'), $url);
153 $this->assign('action', $this->_action
);
154 if ($this->_from_participant_id
) {
155 $this->assign('participantId', $this->_from_participant_id
);
159 $this->_event_title
= CRM_Event_BAO_Event
::getFieldValue('CRM_Event_DAO_Event', $this->_event_id
, $daoName);
160 $daoName = 'start_date';
161 $this->_event_start_date
= CRM_Event_BAO_Event
::getFieldValue('CRM_Event_DAO_Event', $this->_event_id
, $daoName);
162 [$displayName, $email] = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_from_contact_id
);
163 $this->_contact_name
= $displayName;
164 $this->_contact_email
= $email;
166 $details = CRM_Event_BAO_Participant
::participantDetails($this->_from_participant_id
);
167 $selfServiceDetails = CRM_Event_BAO_Participant
::getSelfServiceEligibility($this->_from_participant_id
, $url, $this->isBackoffice
);
168 if (!$selfServiceDetails['eligible']) {
169 CRM_Core_Error
::statusBounce($selfServiceDetails['ineligible_message'], $url, ts('Sorry'));
171 $details = array_merge($details, $selfServiceDetails);
172 $this->assign('details', $details);
173 //This participant row will be cancelled. Get line item(s) to cancel
174 $this->selfsvctransferUrl
= CRM_Utils_System
::url('civicrm/event/selfsvcupdate',
175 "reset=1&id={$this->_from_participant_id}&id=0");
176 $this->selfsvctransferText
= ts('Update');
177 $this->selfsvctransferButtonText
= ts('Update');
181 * Build form for input of transferree email, name
185 public function buildQuickForm() {
186 // use entityRef select field for contact when this form is used by staff/admin user
187 if ($this->isBackoffice
) {
188 $this->addEntityRef("contact_id", ts('Select Contact'), ['create' => TRUE], TRUE);
190 // for front-end user show and use the basic three fields used to create a contact
192 $this->add('text', 'email', ts('To Email'), $this->_contact_email
, TRUE);
193 $this->add('text', 'last_name', ts('To Last Name'), $this->_to_contact_last_name
, TRUE);
194 $this->add('text', 'first_name', ts('To First Name'), $this->_to_contact_first_name
, TRUE);
200 'name' => ts('Transfer Registration'),
203 $this->addFormRule(['CRM_Event_Form_SelfSvcTransfer', 'formRule'], $this);
204 parent
::buildQuickForm();
210 * return @array _defaults
212 public function setDefaultValues() {
213 $this->_defaults
= [];
214 return $this->_defaults
;
218 * Validate email and name input
220 * return array $errors
222 public static function formRule($fields, $files, $self) {
224 if (!empty($fields['contact_id'])) {
225 $to_contact_id = $fields['contact_id'];
228 //check that either an email or firstname+lastname is included in the form(CRM-9587)
229 $to_contact_id = self
::checkProfileComplete($fields, $errors, $self);
231 //To check if the user is already registered for the event(CRM-2426)
232 if (!empty($to_contact_id)) {
233 self
::checkRegistration($fields, $self, $to_contact_id, $errors);
235 //return parent::formrule($fields, $files, $self);
236 return empty($errors) ?
TRUE : $errors;
240 * Check whether profile (name, email) is complete
244 public static function checkProfileComplete($fields, &$errors, $self) {
246 foreach ($fields as $fieldname => $fieldvalue) {
247 if (substr($fieldname, 0, 5) == 'email' && $fieldvalue) {
248 $email = $fieldvalue;
251 if (empty($email) && (empty($fields['first_name']) ||
empty($fields['last_name']))) {
252 $message = ts("Mandatory fields (first name and last name, OR email address) are missing from this form.");
253 $errors['_qf_default'] = $message;
255 $contact = CRM_Contact_BAO_Contact
::matchContactOnEmail($email, "");
256 $contact_id = empty($contact->contact_id
) ?
NULL : $contact->contact_id
;
257 if (!CRM_Utils_Rule
::email($fields['email'])) {
258 $errors['email'] = ts('Enter valid email address.');
260 if (empty($errors) && empty($contact_id)) {
262 'email-Primary' => $fields['email'] ??
NULL,
263 'first_name' => $fields['first_name'] ??
NULL,
264 'last_name' => $fields['last_name'] ??
NULL,
265 'is_deleted' => $fields['is_deleted'] ??
FALSE,
267 //create new contact for this name/email pair
268 //if new contact, no need to check for contact already registered
269 $contact_id = CRM_Contact_BAO_Contact
::createProfileContact($params, $fields, $contact_id);
275 * Check contact details
279 public static function checkRegistration($fields, $self, $contact_id, &$errors) {
280 // verify whether this contact already registered for this event
281 $contact_details = CRM_Contact_BAO_Contact
::getContactDetails($contact_id);
282 $display_name = $contact_details[0];
283 $query = 'select event_id from civicrm_participant where contact_id = ' . $contact_id;
284 $dao = CRM_Core_DAO
::executeQuery($query);
285 while ($dao->fetch()) {
286 $to_event_id[] = $dao->event_id
;
288 if (!empty($to_event_id)) {
289 foreach ($to_event_id as $id) {
290 if ($id == $self->_event_id
) {
291 $errors['email'] = $display_name . ts(" is already registered for this event");
298 * Process transfer - first add the new participant to the event, then cancel
299 * source participant - send confirmation email to transferee
301 * @throws \CiviCRM_API3_Exception
303 public function postProcess() {
304 //For transfer, process form to allow selection of transferree
305 $params = $this->controller
->exportValues($this->_name
);
306 if (!empty($params['contact_id'])) {
307 $contact_id = $params['contact_id'];
310 //cancel 'from' participant row
311 $contact_id_result = civicrm_api3('Contact', 'get', [
314 'email' => $params['email'],
315 'options' => ['limit' => 1],
317 $contact_id_result = $contact_id_result['values'][0];
318 $contact_id = $contact_id_result['contact_id'];
319 $contact_is_deleted = $contact_id_result['contact_is_deleted'];
320 if ($contact_is_deleted ||
!is_numeric($contact_id)) {
321 CRM_Core_Error
::statusBounce(ts('Contact does not exist.'));
325 $this->transferParticipantRegistration($contact_id, $this->_from_participant_id
);
327 $contact_details = CRM_Contact_BAO_Contact
::getContactDetails($contact_id);
328 $display_name = current($contact_details);
329 $this->assign('to_participant', $display_name);
330 $this->sendCancellation();
331 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contact_id);
332 $statusMsg = ts('Event registration information for %1 has been updated.', [1 => $displayName]);
333 $statusMsg .= ' ' . ts('A confirmation email has been sent to %1.', [1 => $email]);
334 CRM_Core_Session
::setStatus($statusMsg, ts('Registration Transferred'), 'success');
335 if ($this->isBackoffice
) {
338 $url = CRM_Utils_System
::url('civicrm/event/info', "reset=1&id={$this->_event_id}");
339 CRM_Utils_System
::redirect($url);
343 * Based on input, create participant row for transferee and send email
345 * @param $participant
347 * @throws \API_Exception
348 * @throws \CRM_Core_Exception
349 * @throws \CiviCRM_API3_Exception
351 public function participantTransfer($participant): void
{
352 $contactDetails = civicrm_api3('Contact', 'getsingle', ['id' => $participant->contact_id
, 'return' => ['display_name', 'email']]);
354 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
355 $participantDetails = [];
356 $query = 'SELECT * FROM civicrm_participant WHERE id = ' . $participant->id
;
357 $dao = CRM_Core_DAO
::executeQuery($query);
358 while ($dao->fetch()) {
359 $participantDetails[$dao->id
] = [
361 'role' => $participantRoles[$dao->role_id
],
362 'is_test' => $dao->is_test
,
363 'event_id' => $dao->event_id
,
364 'status_id' => $dao->status_id
,
365 'fee_amount' => $dao->fee_amount
,
366 'contact_id' => $dao->contact_id
,
367 'register_date' => $dao->register_date
,
368 'registered_by_id' => $dao->registered_by_id
,
373 $eventParams = ['id' => $participant->event_id
];
374 CRM_Event_BAO_Event
::retrieve($eventParams, $eventDetails);
375 //get default participant role.
376 $eventDetails['participant_role'] = $participantRoles[$eventDetails['default_role_id']] ??
NULL;
377 //get the location info
379 'entity_id' => $participant->event_id
,
380 'entity_table' => 'civicrm_event',
382 $eventDetails['location'] = CRM_Core_BAO_Location
::getValues($locParams, TRUE);
383 $toEmail = $contactDetails['email'] ??
NULL;
385 //take a receipt from as event else domain.
386 $receiptFrom = CRM_Core_BAO_Domain
::getNameAndEmail(FALSE, TRUE);
387 $receiptFrom = reset($receiptFrom);
388 if (!empty($eventDetails['confirm_from_name']) && !empty($eventDetails['confirm_from_email'])) {
389 $receiptFrom = $eventDetails['confirm_from_name'] . ' <' . $eventDetails['confirm_from_email'] . '>';
391 $participantName = $contactDetails['display_name'];
393 'event' => $eventDetails,
394 'participant' => $participantDetails[$participant->id
],
395 'participantID' => $participant->id
,
396 'participant_status' => 'Registered',
399 $sendTemplateParams = [
400 'groupName' => 'msg_tpl_workflow_event',
401 'valueName' => 'event_online_receipt',
402 'contactId' => $participantDetails[$participant->id
]['contact_id'],
403 'tplParams' => $tplParams,
404 'from' => $receiptFrom,
405 'toName' => $participantName,
406 'toEmail' => $toEmail,
407 'cc' => $eventDetails['cc_confirm'] ??
NULL,
408 'bcc' => $eventDetails['bcc_confirm'] ??
NULL,
410 CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
415 * Send confirmation of cancellation to source participant
419 public function sendCancellation() {
421 $domain = CRM_Core_BAO_Domain
::getDomain();
430 'contact' => CRM_Core_SelectValues
::contactTokens(),
432 foreach ($tokens['domain'] as $token) {
433 $domainValues[$token] = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain);
436 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
437 $participantDetails = [];
438 $query = "SELECT * FROM civicrm_participant WHERE id = {$this->_from_participant_id}";
439 $dao = CRM_Core_DAO
::executeQuery($query);
440 while ($dao->fetch()) {
441 $participantDetails[$dao->id
] = [
443 'role' => $participantRoles[$dao->role_id
],
444 'is_test' => $dao->is_test
,
445 'event_id' => $dao->event_id
,
446 'status_id' => $dao->status_id
,
447 'fee_amount' => $dao->fee_amount
,
448 'contact_id' => $dao->contact_id
,
449 'register_date' => $dao->register_date
,
450 'registered_by_id' => $dao->registered_by_id
,
454 $eventParams = ['id' => $this->_event_id
];
455 CRM_Event_BAO_Event
::retrieve($eventParams, $eventDetails[$this->_event_id
]);
456 //get default participant role.
457 $eventDetails[$this->_event_id
]['participant_role'] = $participantRoles[$eventDetails[$this->_event_id
]['default_role_id']] ??
NULL;
458 //get the location info
459 $locParams = ['entity_id' => $this->_event_id
, 'entity_table' => 'civicrm_event'];
460 $eventDetails[$this->_event_id
]['location'] = CRM_Core_BAO_Location
::getValues($locParams, TRUE);
461 //send a 'cancelled' email to user, and cc the event's cc_confirm email
462 CRM_Event_BAO_Participant
::sendTransitionParticipantMail($this->_from_participant_id
,
463 $participantDetails[$this->_from_participant_id
],
464 $eventDetails[$this->_event_id
],
469 $statusMsg = ts('Event registration information for %1 has been updated.', [1 => $this->_contact_name
]);
470 $statusMsg .= ' ' . ts('A cancellation email has been sent to %1.', [1 => $this->_contact_email
]);
471 CRM_Core_Session
::setStatus($statusMsg, ts('Thanks'), 'success');
475 * Move Participant registration to new contact.
477 * @param int $toContactID
478 * @param int $fromParticipantID
480 * @throws \CRM_Core_Exception
481 * @throws \CiviCRM_API3_Exception
483 public function transferParticipantRegistration($toContactID, $fromParticipantID) {
484 $toParticipantValues = \Civi\Api4\Participant
::get()
485 ->addWhere('id', '=', $fromParticipantID)
488 $participantPayments = civicrm_api3('ParticipantPayment', 'get', [
490 'participant_id' => $fromParticipantID,
492 unset($toParticipantValues['id']);
493 $toParticipantValues['contact_id'] = $toContactID;
494 $toParticipantValues['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Event_BAO_Participant', 'status_id', 'Registered');
495 $toParticipantValues['register_date'] = date("Y-m-d");
496 //first create the new participant row -don't set registered_by yet or email won't be sent
497 $participant = CRM_Event_BAO_Participant
::create($toParticipantValues);
498 foreach ($participantPayments as $payment) {
499 civicrm_api3('ParticipantPayment', 'create', ['id' => $payment['id'], 'participant_id' => $participant->id
]);
501 //send a confirmation email to the new participant
502 $this->participantTransfer($participant);
503 //now update registered_by_id
504 $query = "UPDATE civicrm_participant cp SET cp.registered_by_id = %1 WHERE cp.id = ({$participant->id})";
505 $params = [1 => [$fromParticipantID, 'Integer']];
506 CRM_Core_DAO
::executeQuery($query, $params);
507 //copy line items to new participant
508 $line_items = CRM_Price_BAO_LineItem
::getLineItems($fromParticipantID);
509 foreach ($line_items as $id => $item) {
510 //Remove contribution id from older participant line item.
511 CRM_Core_DAO
::singleValueQuery('UPDATE civicrm_line_item SET contribution_id = NULL WHERE id = %1', [1 => [$id, 'Integer']]);
513 $item['entity_id'] = $participant->id
;
515 $item['entity_table'] = "civicrm_participant";
516 $tolineItem = CRM_Price_BAO_LineItem
::create($item);
518 //Update Financial Item for previous line item row.
519 $prevFinancialItem = CRM_Financial_BAO_FinancialItem
::getPreviousFinancialItem($id);
520 $prevFinancialItem['contact_id'] = $toContactID;
521 $prevFinancialItem['entity_id'] = $tolineItem->id
;
522 CRM_Financial_BAO_FinancialItem
::create($prevFinancialItem);
524 //now cancel the from participant record, leaving the original line-item(s)
526 $value_from['id'] = $fromParticipantID;
527 $tansferId = array_search('Transferred', CRM_Event_PseudoConstant
::participantStatus(NULL, "class = 'Negative'"));
528 $value_from['status_id'] = $tansferId;
529 $value_from['transferred_to_contact_id'] = $toContactID;
530 CRM_Event_BAO_Participant
::create($value_from);