CRM/Event/Form/ParticipantFeeSelection.php

   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 = "Change selections for {$this->_contributorDisplayName}";
 120     if ($title) {
 121       CRM_Utils_System::setTitle(ts('%1', array(1 => $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 -')) + $statusOptions,
 185       TRUE
 186     );
 187
 188     $this->addElement('checkbox',
 189       'send_receipt',
 190       ts('Send Confirmation?'), NULL,
 191       array('onclick' => "showHideByValue('send_receipt','','notice','table-row','radio',false); showHideByValue('send_receipt','','from-email','table-row','radio',false);")
 192     );
 193
 194     $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails['from_email_id']);
 195
 196     $this->add('textarea', 'receipt_text', ts('Confirmation Message'));
 197
 198     $noteAttributes = CRM_Core_DAO::getAttribute('CRM_Core_DAO_Note');
 199     $this->add('textarea', 'note', ts('Notes'), $noteAttributes['note']);
 200
 201     $buttons[] = array(
 202       'type' => 'upload',
 203       'name' => ts('Save'),
 204       'isDefault' => TRUE,
 205     );
 206
 207     if (CRM_Event_BAO_Participant::isPrimaryParticipant($this->_participantId)) {
 208       $buttons[] = array(
 209         'type' => 'upload',
 210         'name' => ts('Save and Record Payment'),
 211         'subName' => 'new'
 212       );
 213     }
 214     $buttons[] = array(
 215       'type' => 'cancel',
 216       'name' => ts('Cancel'),
 217     );
 218
 219     $this->addButtons($buttons);
 220     $this->addFormRule(array('CRM_Event_Form_ParticipantFeeSelection', 'formRule'), $this);
 221   }
 222
 223   /**
 224    * @param $fields
 225    * @param $files
 226    * @param $self
 227    *
 228    * @return array
 229    */
 230   public static function formRule($fields, $files, $self) {
 231     $errors = array();
 232     return $errors;
 233   }
 234
 235   public function postProcess() {
 236     $params = $this->controller->exportValues($this->_name);
 237
 238     $feeBlock = $this->_values['fee'];
 239     $lineItems = $this->_values['line_items'];
 240     CRM_Event_BAO_Participant::changeFeeSelections($params, $this->_participantId, $this->_contributionId, $feeBlock, $lineItems, $this->_paidAmount, $params['priceSetId']);
 241     $this->contributionAmt = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $this->_contributionId, 'total_amount');
 242     // email sending
 243     if (CRM_Utils_Array::value('send_receipt', $params)){
 244       $fetchParticipantVals = array('id' => $this->_participantId);
 245       CRM_Event_BAO_Participant::getValues($fetchParticipantVals, $participantDetails, CRM_Core_DAO::$_nullArray);
 246       $participantParams = array_merge($params, $participantDetails[$this->_participantId]);
 247       $mailSent = $this->emailReceipt($participantParams);
 248     }
 249
 250     // update participant
 251     CRM_Core_DAO::setFieldValue('CRM_Event_DAO_Participant', $this->_participantId, 'status_id', $params['status_id']);
 252     if(!empty($params['note'])) {
 253       $noteParams = array(
 254         'entity_table' => 'civicrm_participant',
 255         'note' => $params['note'],
 256         'entity_id' => $this->_participantId,
 257         'contact_id' => $this->_contactId,
 258         'modified_date' => date('Ymd'),
 259       );
 260       CRM_Core_BAO_Note::add($noteParams);
 261     }
 262     CRM_Core_Session::setStatus(ts("The fee selection has been changed for this participant"), ts('Saved'), 'success');
 263
 264     $buttonName = $this->controller->getButtonName();
 265     if ($buttonName == $this->getButtonName('upload', 'new')) {
 266       $session = CRM_Core_Session::singleton();
 267       $session->pushUserContext(CRM_Utils_System::url('civicrm/payment/add',
 268           "reset=1&action=add&component=event&id={$this->_participantId}&cid={$this->_contactId}"
 269         ));
 270     }
 271   }
 272
 273   /**
 274    * @param array $params
 275    *
 276    * @return mixed
 277    */
 278   public function emailReceipt(&$params) {
 279     $updatedLineItem = CRM_Price_BAO_LineItem::getLineItems($this->_participantId, 'participant', NULL, FALSE);
 280     $lineItem = array();
 281     if ($updatedLineItem) {
 282       $lineItem[] = $updatedLineItem;
 283     }
 284     $this->assign('lineItem', empty($lineItem) ? FALSE : $lineItem);
 285
 286     // offline receipt sending
 287     if (array_key_exists($params['from_email_address'], $this->_fromEmails['from_email_id'])) {
 288       $receiptFrom = $params['from_email_address'];
 289     }
 290
 291     $this->assign('module', 'Event Registration');
 292     //use of the message template below requires variables in different format
 293     $event = $events = array();
 294     $returnProperties = array('fee_label', 'start_date', 'end_date', 'is_show_location', 'title');
 295
 296     //get all event details.
 297     CRM_Core_DAO::commonRetrieveAll('CRM_Event_DAO_Event', 'id', $params['event_id'], $events, $returnProperties);
 298     $event = $events[$params['event_id']];
 299     unset($event['start_date']);
 300     unset($event['end_date']);
 301
 302     $role = CRM_Event_PseudoConstant::participantRole();
 303     $participantRoles = CRM_Utils_Array::value('role_id', $params);
 304     if (is_array($participantRoles)) {
 305       $selectedRoles = array();
 306       foreach (array_keys($participantRoles) as $roleId) {
 307         $selectedRoles[] = $role[$roleId];
 308       }
 309       $event['participant_role'] = implode(', ', $selectedRoles);
 310     }
 311     else {
 312       $event['participant_role'] = CRM_Utils_Array::value($participantRoles, $role);
 313     }
 314     $event['is_monetary'] = $this->_isPaidEvent;
 315
 316     if ($params['receipt_text']) {
 317       $event['confirm_email_text'] = $params['receipt_text'];
 318     }
 319
 320     $this->assign('isAmountzero', 1);
 321     $this->assign('event', $event);
 322
 323     $this->assign('isShowLocation', $event['is_show_location']);
 324     if (CRM_Utils_Array::value('is_show_location', $event) == 1) {
 325       $locationParams = array(
 326         'entity_id' => $params['event_id'],
 327         'entity_table' => 'civicrm_event',
 328       );
 329       $location = CRM_Core_BAO_Location::getValues($locationParams, TRUE);
 330       $this->assign('location', $location);
 331     }
 332
 333     $status = CRM_Event_PseudoConstant::participantStatus();
 334     if ($this->_isPaidEvent) {
 335       $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
 336       if (!$this->_mode) {
 337         if (isset($params['payment_instrument_id'])) {
 338           $this->assign('paidBy',
 339             CRM_Utils_Array::value($params['payment_instrument_id'],
 340               $paymentInstrument
 341             )
 342           );
 343         }
 344       }
 345
 346       $this->assign('totalAmount', $this->contributionAmt);
 347
 348       $this->assign('isPrimary', 1);
 349       $this->assign('checkNumber', CRM_Utils_Array::value('check_number', $params));
 350     }
 351
 352     $this->assign('register_date', $params['register_date']);
 353     $template = CRM_Core_Smarty::singleton();
 354
 355     // Retrieve the name and email of the contact - this will be the TO for receipt email
 356     list($this->_contributorDisplayName, $this->_contributorEmail, $this->_toDoNotEmail) = CRM_Contact_BAO_Contact::getContactDetails($this->_contactId);
 357
 358     $this->_contributorDisplayName = ($this->_contributorDisplayName == ' ') ? $this->_contributorEmail : $this->_contributorDisplayName;
 359
 360     $waitStatus = CRM_Event_PseudoConstant::participantStatus(NULL, "class = 'Waiting'");
 361     if ($waitingStatus = CRM_Utils_Array::value($params['status_id'], $waitStatus)) {
 362       $this->assign('isOnWaitlist', TRUE);
 363     }
 364     $this->assign('contactID', $this->_contactId);
 365     $this->assign('participantID', $this->_participantId);
 366
 367     $sendTemplateParams = array(
 368       'groupName' => 'msg_tpl_workflow_event',
 369       'valueName' => 'event_offline_receipt',
 370       'contactId' => $this->_contactId,
 371       'isTest' => FALSE,
 372       'PDFFilename' => ts('confirmation').'.pdf',
 373     );
 374
 375     // try to send emails only if email id is present
 376     // and the do-not-email option is not checked for that contact
 377     if ($this->_contributorEmail && !$this->_toDoNotEmail) {
 378       $sendTemplateParams['from'] = $receiptFrom;
 379       $sendTemplateParams['toName'] = $this->_contributorDisplayName;
 380       $sendTemplateParams['toEmail'] = $this->_contributorEmail;
 381       $sendTemplateParams['cc'] = CRM_Utils_Array::value('cc', $this->_fromEmails);
 382       $sendTemplateParams['bcc'] = CRM_Utils_Array::value('bcc', $this->_fromEmails);
 383     }
 384
 385     list($mailSent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
 386     return $mailSent;
 387   }
 388 }