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