CRM/Event/Form/ParticipantFeeSelection.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  * $Id$
  17  *
  18  */
  19
  20 /**
  21  * This form used for changing / updating fee selections for the events
  22  * event/contribution is partially paid
  23  *
  24  */
  25 class CRM_Event_Form_ParticipantFeeSelection extends CRM_Core_Form {
  26
  27   public $useLivePageJS = TRUE;
  28
  29   protected $_contactId = NULL;
  30
  31   protected $_contributorDisplayName = NULL;
  32
  33   protected $_contributorEmail = NULL;
  34
  35   protected $_toDoNotEmail = NULL;
  36
  37   protected $_contributionId = NULL;
  38
  39   protected $fromEmailId = NULL;
  40
  41   public $_eventId = NULL;
  42
  43   public $_action = NULL;
  44
  45   public $_values = NULL;
  46
  47   public $_participantId = NULL;
  48
  49   protected $_participantStatus = NULL;
  50
  51   protected $_paidAmount = NULL;
  52
  53   public $_isPaidEvent = NULL;
  54
  55   protected $contributionAmt = NULL;
  56
  57   public function preProcess() {
  58     $this->_participantId = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
  59     $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
  60     $this->_eventId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $this->_participantId, 'event_id');
  61     $this->_fromEmails = CRM_Event_BAO_Event::getFromEmailIds($this->_eventId);
  62
  63     $this->_contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_participantId, 'contribution_id', 'participant_id');
  64     if (!$this->_contributionId) {
  65       if ($primaryParticipantId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Participant', $this->_participantId, 'registered_by_id')) {
  66         $this->_contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $primaryParticipantId, 'contribution_id', 'participant_id');
  67       }
  68     }
  69
  70     if ($this->_contributionId) {
  71       $this->_isPaidEvent = TRUE;
  72     }
  73     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, TRUE);
  74
  75     list($this->_contributorDisplayName, $this->_contributorEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactId);
  76     $this->assign('displayName', $this->_contributorDisplayName);
  77     $this->assign('email', $this->_contributorEmail);
  78
  79     $this->_participantStatus = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Participant', $this->_participantId, 'status_id');
  80     //set the payment mode - _mode property is defined in parent class
  81     $this->_mode = CRM_Utils_Request::retrieve('mode', 'String', $this);
  82
  83     $this->assign('contactId', $this->_contactId);
  84     $this->assign('id', $this->_participantId);
  85
  86     $paymentInfo = CRM_Contribute_BAO_Contribution::getPaymentInfo($this->_participantId, 'event');
  87     $this->_paidAmount = $paymentInfo['paid'];
  88     $this->assign('paymentInfo', $paymentInfo);
  89     $this->assign('feePaid', $this->_paidAmount);
  90
  91     $ids = CRM_Event_BAO_Participant::getParticipantIds($this->_contributionId);
  92     if (count($ids) > 1) {
  93       $total = CRM_Price_BAO_LineItem::getLineTotal($this->_contributionId);
  94       $this->assign('totalLineTotal', $total);
  95       $this->assign('lineItemTotal', $total);
  96     }
  97
  98     $title = ts("Change selections for %1", [1 => $this->_contributorDisplayName]);
  99     if ($title) {
 100       CRM_Utils_System::setTitle($title);
 101     }
 102   }
 103
 104   /**
 105    * Set default values for the form.
 106    *
 107    * @return array
 108    */
 109   public function setDefaultValues() {
 110     $params = ['id' => $this->_participantId];
 111
 112     CRM_Event_BAO_Participant::getValues($params, $defaults, $ids);
 113     $priceSetId = CRM_Price_BAO_PriceSet::getFor('civicrm_event', $this->_eventId);
 114
 115     $priceSetValues = CRM_Event_Form_EventFees::setDefaultPriceSet($this->_participantId, $this->_eventId, FALSE);
 116     $priceFieldId = (array_keys($this->_values['fee']));
 117     if (!empty($priceSetValues)) {
 118       $defaults[$this->_participantId] = array_merge($defaults[$this->_participantId], $priceSetValues);
 119     }
 120     else {
 121       foreach ($priceFieldId as $key => $value) {
 122         if (!empty($value) && ($this->_values['fee'][$value]['html_type'] == 'Radio' || $this->_values['fee'][$value]['html_type'] == 'Select') && !$this->_values['fee'][$value]['is_required']) {
 123           $fee_keys = array_keys($this->_values['fee']);
 124           $defaults[$this->_participantId]['price_' . $fee_keys[$key]] = 0;
 125         }
 126       }
 127     }
 128     $this->assign('totalAmount', CRM_Utils_Array::value('fee_amount', $defaults[$this->_participantId]));
 129     if ($this->_action == CRM_Core_Action::UPDATE) {
 130       $fee_level = $defaults[$this->_participantId]['fee_level'];
 131       CRM_Event_BAO_Participant::fixEventLevel($fee_level);
 132       $this->assign('fee_level', $fee_level);
 133       $this->assign('fee_amount', CRM_Utils_Array::value('fee_amount', $defaults[$this->_participantId]));
 134     }
 135     $defaults = $defaults[$this->_participantId];
 136     return $defaults;
 137   }
 138
 139   /**
 140    * Build form.
 141    *
 142    * @throws \CRM_Core_Exception
 143    */
 144   public function buildQuickForm() {
 145
 146     $statuses = CRM_Event_PseudoConstant::participantStatus();
 147     $this->assign('partiallyPaid', array_search('Partially paid', $statuses));
 148     $this->assign('pendingRefund', array_search('Pending refund', $statuses));
 149     $this->assign('participantStatus', $this->_participantStatus);
 150
 151     $this->assign('currencySymbol', CRM_Core_BAO_Country::defaultCurrencySymbol());
 152
 153     // line items block
 154     $lineItem = $event = [];
 155     $params = ['id' => $this->_eventId];
 156     CRM_Event_BAO_Event::retrieve($params, $event);
 157
 158     //retrieve custom information
 159     $this->_values = [];
 160
 161     CRM_Event_Form_Registration::initEventFee($this, $event['id'], $this->_action !== CRM_Core_Action::UPDATE);
 162     CRM_Event_Form_Registration_Register::buildAmount($this, TRUE);
 163
 164     if (!CRM_Utils_System::isNull(CRM_Utils_Array::value('line_items', $this->_values))) {
 165       $lineItem[] = $this->_values['line_items'];
 166     }
 167     $this->assign('lineItem', empty($lineItem) ? FALSE : $lineItem);
 168     $event = CRM_Event_BAO_Event::getEvents(0, $this->_eventId);
 169     $this->assign('eventName', $event[$this->_eventId]);
 170
 171     $statusOptions = CRM_Event_PseudoConstant::participantStatus(NULL, NULL, 'label');
 172     $this->add('select', 'status_id', ts('Participant Status'),
 173       [
 174         '' => ts('- select -'),
 175       ] + $statusOptions,
 176       TRUE
 177     );
 178
 179     $this->addElement('checkbox',
 180       'send_receipt',
 181       ts('Send Confirmation?'), NULL,
 182       ['onclick' => "showHideByValue('send_receipt','','notice','table-row','radio',false); showHideByValue('send_receipt','','from-email','table-row','radio',false);"]
 183     );
 184
 185     $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails['from_email_id']);
 186
 187     $this->add('textarea', 'receipt_text', ts('Confirmation Message'));
 188
 189     $noteAttributes = CRM_Core_DAO::getAttribute('CRM_Core_DAO_Note');
 190     $this->add('textarea', 'note', ts('Notes'), $noteAttributes['note']);
 191
 192     $buttons[] = [
 193       'type' => 'upload',
 194       'name' => ts('Save'),
 195       'isDefault' => TRUE,
 196     ];
 197
 198     if (CRM_Event_BAO_Participant::isPrimaryParticipant($this->_participantId)) {
 199       $buttons[] = [
 200         'type' => 'upload',
 201         'name' => ts('Save and Record Payment'),
 202         'subName' => 'new',
 203       ];
 204     }
 205     $buttons[] = [
 206       'type' => 'cancel',
 207       'name' => ts('Cancel'),
 208     ];
 209
 210     $this->addButtons($buttons);
 211     $this->addFormRule(['CRM_Event_Form_ParticipantFeeSelection', 'formRule'], $this);
 212   }
 213
 214   /**
 215    * @param $fields
 216    * @param $files
 217    * @param $self
 218    *
 219    * @return array
 220    */
 221   public static function formRule($fields, $files, $self) {
 222     $errors = [];
 223     return $errors;
 224   }
 225
 226   /**
 227    * Post process form.
 228    *
 229    * @throws \CRM_Core_Exception
 230    * @throws \CiviCRM_API3_Exception
 231    */
 232   public function postProcess() {
 233     $params = $this->controller->exportValues($this->_name);
 234
 235     $feeBlock = $this->_values['fee'];
 236     $lineItems = $this->_values['line_items'];
 237     CRM_Price_BAO_LineItem::changeFeeSelections($params, $this->_participantId, 'participant', $this->_contributionId, $feeBlock, $lineItems);
 238     $this->contributionAmt = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $this->_contributionId, 'total_amount');
 239     // email sending
 240     if (!empty($params['send_receipt'])) {
 241       $fetchParticipantVals = ['id' => $this->_participantId];
 242       CRM_Event_BAO_Participant::getValues($fetchParticipantVals, $participantDetails);
 243       $participantParams = array_merge($params, $participantDetails[$this->_participantId]);
 244       $mailSent = $this->emailReceipt($participantParams);
 245     }
 246
 247     // update participant
 248     CRM_Core_DAO::setFieldValue('CRM_Event_DAO_Participant', $this->_participantId, 'status_id', $params['status_id']);
 249     if (!empty($params['note'])) {
 250       $noteParams = [
 251         'entity_table' => 'civicrm_participant',
 252         'note' => $params['note'],
 253         'entity_id' => $this->_participantId,
 254         'contact_id' => $this->_contactId,
 255       ];
 256       CRM_Core_BAO_Note::add($noteParams);
 257     }
 258     CRM_Core_Session::setStatus(ts("The fee selection has been changed for this participant"), ts('Saved'), 'success');
 259
 260     $buttonName = $this->controller->getButtonName();
 261     if ($buttonName == $this->getButtonName('upload', 'new')) {
 262       $session = CRM_Core_Session::singleton();
 263       $session->pushUserContext(CRM_Utils_System::url('civicrm/payment/add',
 264         "reset=1&action=add&component=event&id={$this->_participantId}&cid={$this->_contactId}"
 265       ));
 266     }
 267   }
 268
 269   /**
 270    * @param array $params
 271    *
 272    * @return mixed
 273    */
 274   public function emailReceipt(&$params) {
 275     $updatedLineItem = CRM_Price_BAO_LineItem::getLineItems($this->_participantId, 'participant', FALSE, FALSE);
 276     $lineItem = [];
 277     if ($updatedLineItem) {
 278       $lineItem[] = $updatedLineItem;
 279     }
 280     $this->assign('lineItem', empty($lineItem) ? FALSE : $lineItem);
 281
 282     // offline receipt sending
 283     if (array_key_exists($params['from_email_address'], $this->_fromEmails['from_email_id'])) {
 284       $receiptFrom = $params['from_email_address'];
 285     }
 286
 287     $this->assign('module', 'Event Registration');
 288     //use of the message template below requires variables in different format
 289     $event = $events = [];
 290     $returnProperties = ['fee_label', 'start_date', 'end_date', 'is_show_location', 'title'];
 291
 292     //get all event details.
 293     CRM_Core_DAO::commonRetrieveAll('CRM_Event_DAO_Event', 'id', $params['event_id'], $events, $returnProperties);
 294     $event = $events[$params['event_id']];
 295     unset($event['start_date']);
 296     unset($event['end_date']);
 297
 298     $role = CRM_Event_PseudoConstant::participantRole();
 299     $participantRoles = CRM_Utils_Array::value('role_id', $params);
 300     if (is_array($participantRoles)) {
 301       $selectedRoles = [];
 302       foreach (array_keys($participantRoles) as $roleId) {
 303         $selectedRoles[] = $role[$roleId];
 304       }
 305       $event['participant_role'] = implode(', ', $selectedRoles);
 306     }
 307     else {
 308       $event['participant_role'] = CRM_Utils_Array::value($participantRoles, $role);
 309     }
 310     $event['is_monetary'] = $this->_isPaidEvent;
 311
 312     if ($params['receipt_text']) {
 313       $event['confirm_email_text'] = $params['receipt_text'];
 314     }
 315
 316     $this->assign('isAmountzero', 1);
 317     $this->assign('event', $event);
 318
 319     $this->assign('isShowLocation', $event['is_show_location']);
 320     if (CRM_Utils_Array::value('is_show_location', $event) == 1) {
 321       $locationParams = [
 322         'entity_id' => $params['event_id'],
 323         'entity_table' => 'civicrm_event',
 324       ];
 325       $location = CRM_Core_BAO_Location::getValues($locationParams, TRUE);
 326       $this->assign('location', $location);
 327     }
 328
 329     $status = CRM_Event_PseudoConstant::participantStatus();
 330     if ($this->_isPaidEvent) {
 331       $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
 332       if (!$this->_mode) {
 333         if (isset($params['payment_instrument_id'])) {
 334           $this->assign('paidBy',
 335             CRM_Utils_Array::value($params['payment_instrument_id'],
 336               $paymentInstrument
 337             )
 338           );
 339         }
 340       }
 341
 342       $this->assign('totalAmount', $this->contributionAmt);
 343
 344       $this->assign('isPrimary', 1);
 345       $this->assign('checkNumber', CRM_Utils_Array::value('check_number', $params));
 346     }
 347
 348     $this->assign('register_date', $params['register_date']);
 349     $template = CRM_Core_Smarty::singleton();
 350
 351     // Retrieve the name and email of the contact - this will be the TO for receipt email
 352     list($this->_contributorDisplayName, $this->_contributorEmail, $this->_toDoNotEmail) = CRM_Contact_BAO_Contact::getContactDetails($this->_contactId);
 353
 354     $this->_contributorDisplayName = ($this->_contributorDisplayName == ' ') ? $this->_contributorEmail : $this->_contributorDisplayName;
 355
 356     $waitStatus = CRM_Event_PseudoConstant::participantStatus(NULL, "class = 'Waiting'");
 357     if ($waitingStatus = CRM_Utils_Array::value($params['status_id'], $waitStatus)) {
 358       $this->assign('isOnWaitlist', TRUE);
 359     }
 360     $this->assign('contactID', $this->_contactId);
 361     $this->assign('participantID', $this->_participantId);
 362
 363     $sendTemplateParams = [
 364       'groupName' => 'msg_tpl_workflow_event',
 365       'valueName' => 'event_offline_receipt',
 366       'contactId' => $this->_contactId,
 367       'isTest' => FALSE,
 368       'PDFFilename' => ts('confirmation') . '.pdf',
 369     ];
 370
 371     // try to send emails only if email id is present
 372     // and the do-not-email option is not checked for that contact
 373     if ($this->_contributorEmail && !$this->_toDoNotEmail) {
 374       $sendTemplateParams['from'] = $receiptFrom;
 375       $sendTemplateParams['toName'] = $this->_contributorDisplayName;
 376       $sendTemplateParams['toEmail'] = $this->_contributorEmail;
 377       $sendTemplateParams['cc'] = CRM_Utils_Array::value('cc', $this->_fromEmails);
 378       $sendTemplateParams['bcc'] = CRM_Utils_Array::value('bcc', $this->_fromEmails);
 379     }
 380
 381     list($mailSent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
 382     return $mailSent;
 383   }
 384
 385 }