CRM/Batch/Form/Entry.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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 useful, 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-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class provides the functionality for batch entry for contributions/memberships
  38  */
  39 class CRM_Batch_Form_Entry extends CRM_Core_Form {
  40
  41   /**
  42    * Maximum profile fields that will be displayed.
  43    */
  44   protected $_rowCount = 1;
  45
  46   /**
  47    * Batch id.
  48    */
  49   protected $_batchId;
  50
  51   /**
  52    * Batch information.
  53    */
  54   protected $_batchInfo = array();
  55
  56   /**
  57    * Store the profile id associated with the batch type.
  58    */
  59   protected $_profileId;
  60
  61   public $_action;
  62
  63   public $_mode;
  64
  65   public $_params;
  66
  67   public $_membershipId = NULL;
  68   /**
  69    * When not to reset sort_name.
  70    */
  71   protected $_preserveDefault = TRUE;
  72
  73   /**
  74    * Contact fields.
  75    */
  76   protected $_contactFields = array();
  77
  78   /**
  79    * Fields array of fields in the batch profile.
  80    * (based on the uf_field table data)
  81    * (this can't be protected as it is passed into the CRM_Contact_Form_Task_Batch::parseStreetAddress function
  82    * (although a future refactoring might hopefully change that so it uses the api & the function is not
  83    * required
  84    * @var array
  85    */
  86   public $_fields = array();
  87
  88   /**
  89    * Build all the data structures needed to build the form.
  90    *
  91    * @return void
  92    */
  93   public function preProcess() {
  94     $this->_batchId = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
  95
  96     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
  97
  98     if (empty($this->_batchInfo)) {
  99       $params = array('id' => $this->_batchId);
 100       CRM_Batch_BAO_Batch::retrieve($params, $this->_batchInfo);
 101
 102       $this->assign('batchTotal', !empty($this->_batchInfo['total']) ? $this->_batchInfo['total'] : NULL);
 103       $this->assign('batchType', $this->_batchInfo['type_id']);
 104
 105       // get the profile id associted with this batch type
 106       $this->_profileId = CRM_Batch_BAO_Batch::getProfileId($this->_batchInfo['type_id']);
 107     }
 108     CRM_Core_Resources::singleton()
 109       ->addScriptFile('civicrm', 'templates/CRM/Batch/Form/Entry.js', 1, 'html-header')
 110       ->addSetting(array('batch' => array('type_id' => $this->_batchInfo['type_id'])))
 111       ->addSetting(array('setting' => array('monetaryThousandSeparator' => CRM_Core_Config::singleton()->monetaryThousandSeparator)))
 112       ->addSetting(array('setting' => array('monetaryDecimalPoint' => CRM_Core_Config::singleton()->monetaryDecimalPoint)));
 113
 114   }
 115
 116   /**
 117    * Build the form object.
 118    *
 119    *
 120    * @return void
 121    */
 122   public function buildQuickForm() {
 123     if (!$this->_profileId) {
 124       CRM_Core_Error::fatal(ts('Profile for bulk data entry is missing.'));
 125     }
 126
 127     $this->addElement('hidden', 'batch_id', $this->_batchId);
 128
 129     $batchTypes = CRM_Core_Pseudoconstant::get('CRM_Batch_DAO_Batch', 'type_id', array('flip' => 1), 'validate');
 130     // get the profile information
 131     if ($this->_batchInfo['type_id'] == $batchTypes['Contribution']) {
 132       CRM_Utils_System::setTitle(ts('Batch Data Entry for Contributions'));
 133       $customFields = CRM_Core_BAO_CustomField::getFields('Contribution');
 134     }
 135     elseif ($this->_batchInfo['type_id'] == $batchTypes['Membership']) {
 136       CRM_Utils_System::setTitle(ts('Batch Data Entry for Memberships'));
 137       $customFields = CRM_Core_BAO_CustomField::getFields('Membership');
 138     }
 139     elseif ($this->_batchInfo['type_id'] == $batchTypes['Pledge Payment']) {
 140       CRM_Utils_System::setTitle(ts('Batch Data Entry for Pledge Payments'));
 141       $customFields = CRM_Core_BAO_CustomField::getFields('Contribution');
 142     }
 143     $this->_fields = array();
 144     $this->_fields = CRM_Core_BAO_UFGroup::getFields($this->_profileId, FALSE, CRM_Core_Action::VIEW);
 145
 146     // remove file type field and then limit fields
 147     $suppressFields = FALSE;
 148     $removehtmlTypes = array('File', 'Autocomplete-Select');
 149     foreach ($this->_fields as $name => $field) {
 150       if ($cfID = CRM_Core_BAO_CustomField::getKeyID($name) &&
 151         in_array($this->_fields[$name]['html_type'], $removehtmlTypes)
 152       ) {
 153         $suppressFields = TRUE;
 154         unset($this->_fields[$name]);
 155       }
 156
 157       //fix to reduce size as we are using this field in grid
 158       if (is_array($field['attributes']) && $this->_fields[$name]['attributes']['size'] > 19) {
 159         //shrink class to "form-text-medium"
 160         $this->_fields[$name]['attributes']['size'] = 19;
 161       }
 162     }
 163
 164     $this->addFormRule(array('CRM_Batch_Form_Entry', 'formRule'), $this);
 165
 166     // add the force save button
 167     $forceSave = $this->getButtonName('upload', 'force');
 168
 169     $this->addElement('submit',
 170       $forceSave,
 171       ts('Ignore Mismatch & Process the Batch?')
 172     );
 173
 174     $this->addButtons(array(
 175         array(
 176           'type' => 'upload',
 177           'name' => ts('Validate & Process the Batch'),
 178           'isDefault' => TRUE,
 179         ),
 180         array(
 181           'type' => 'cancel',
 182           'name' => ts('Save & Continue Later'),
 183         ),
 184       )
 185     );
 186
 187     $this->assign('rowCount', $this->_batchInfo['item_count'] + 1);
 188
 189     $fileFieldExists = FALSE;
 190     $preserveDefaultsArray = array(
 191       'first_name',
 192       'last_name',
 193       'middle_name',
 194       'organization_name',
 195       'household_name',
 196     );
 197
 198     $contactTypes = array('Contact', 'Individual', 'Household', 'Organization');
 199     $contactReturnProperties = array();
 200     $config = CRM_Core_Config::singleton();
 201
 202     for ($rowNumber = 1; $rowNumber <= $this->_batchInfo['item_count']; $rowNumber++) {
 203       $this->addEntityRef("primary_contact_id[{$rowNumber}]", '', array(
 204           'create' => TRUE,
 205           'placeholder' => ts('- select -'),
 206         ));
 207
 208       // special field specific to membership batch udpate
 209       if ($this->_batchInfo['type_id'] == 2) {
 210         $options = array(
 211           1 => ts('Add Membership'),
 212           2 => ts('Renew Membership'),
 213         );
 214         $this->add('select', "member_option[$rowNumber]", '', $options);
 215       }
 216       if ($this->_batchInfo['type_id'] == $batchTypes['Pledge Payment']) {
 217         $options = array('' => '-select-');
 218         $optionTypes = array(
 219           '1' => ts('Adjust Pledge Payment Schedule?'),
 220           '2' => ts('Adjust Total Pledge Amount?'),
 221         );
 222         $this->add('select', "option_type[$rowNumber]", NULL, $optionTypes);
 223         if (!empty($this->_batchId) && !empty($this->_batchInfo['data']) && !empty($rowNumber)) {
 224           $dataValues = json_decode($this->_batchInfo['data'], TRUE);
 225           if (!empty($dataValues['values']['primary_contact_id'][$rowNumber])) {
 226             $pledgeIDs = CRM_Pledge_BAO_Pledge::getContactPledges($dataValues['values']['primary_contact_id'][$rowNumber]);
 227             foreach ($pledgeIDs as $pledgeID) {
 228               $pledgePayment = CRM_Pledge_BAO_PledgePayment::getOldestPledgePayment($pledgeID);
 229               $options += array($pledgeID => CRM_Utils_Date::customFormat($pledgePayment['schedule_date'], '%m/%d/%Y') . ', ' . $pledgePayment['amount'] . ' ' . $pledgePayment['currency']);
 230             }
 231           }
 232         }
 233
 234         $this->add('select', "open_pledges[$rowNumber]", '', $options);
 235       }
 236
 237       foreach ($this->_fields as $name => $field) {
 238         if (in_array($field['field_type'], $contactTypes)) {
 239           $fld = explode('-', $field['name']);
 240           $contactReturnProperties[$field['name']] = $fld[0];
 241         }
 242         CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, NULL, FALSE, FALSE, $rowNumber);
 243
 244         if (in_array($field['name'], $preserveDefaultsArray)) {
 245           $this->_preserveDefault = FALSE;
 246         }
 247       }
 248     }
 249
 250     $this->assign('fields', $this->_fields);
 251     CRM_Core_Resources::singleton()
 252       ->addSetting(array(
 253         'contact' => array(
 254           'return' => implode(',', $contactReturnProperties),
 255           'fieldmap' => array_flip($contactReturnProperties),
 256         ),
 257       ));
 258
 259     // don't set the status message when form is submitted.
 260     $buttonName = $this->controller->getButtonName('submit');
 261
 262     if ($suppressFields && $buttonName != '_qf_Entry_next') {
 263       CRM_Core_Session::setStatus(ts("File or Autocomplete-Select type field(s) in the selected profile are not supported for Batch Update."), ts('Some Fields Excluded'), 'info');
 264     }
 265   }
 266
 267   /**
 268    * Form validations.
 269    *
 270    * @param array $params
 271    *   Posted values of the form.
 272    * @param array $files
 273    *   List of errors to be posted back to the form.
 274    * @param array $self
 275    *   Form object.
 276    *
 277    * @return array
 278    *   list of errors to be posted back to the form
 279    */
 280   public static function formRule($params, $files, $self) {
 281     $errors = array();
 282     $batchTypes = CRM_Core_Pseudoconstant::get('CRM_Batch_DAO_Batch', 'type_id', array('flip' => 1), 'validate');
 283     $fields = array(
 284       'total_amount' => 'Amount',
 285       'financial_type' => 'Financial Type',
 286       'payment_instrument' => 'Paid By',
 287     );
 288
 289     //CRM-16480 if contact is selected, validate financial type and amount field.
 290     foreach ($params['field'] as $key => $value) {
 291       foreach ($fields as $field => $label) {
 292         if (!empty($params['primary_contact_id'][$key]) && empty($value[$field])) {
 293           $errors["field[$key][$field]"] = ts('%1 is a required field.', array(1 => $label));
 294         }
 295       }
 296     }
 297
 298     if (!empty($params['_qf_Entry_upload_force'])) {
 299       if (!empty($errors)) {
 300         return $errors;
 301       }
 302       return TRUE;
 303     }
 304
 305     $batchTotal = 0;
 306     foreach ($params['field'] as $key => $value) {
 307       $batchTotal += $value['total_amount'];
 308
 309       //validate for soft credit fields
 310       if (!empty($params['soft_credit_contact_id'][$key]) && empty($params['soft_credit_amount'][$key])) {
 311         $errors["soft_credit_amount[$key]"] = ts('Please enter the soft credit amount.');
 312       }
 313       if (!empty($params['soft_credit_amount']) && !empty($params['soft_credit_amount'][$key]) && CRM_Utils_Rule::cleanMoney(CRM_Utils_Array::value($key, $params['soft_credit_amount'])) > CRM_Utils_Rule::cleanMoney($value['total_amount'])) {
 314         $errors["soft_credit_amount[$key]"] = ts('Soft credit amount should not be greater than the total amount');
 315       }
 316
 317       //membership type is required for membership batch entry
 318       if ($self->_batchInfo['type_id'] == $batchTypes['Membership']) {
 319         if (empty($value['membership_type'][1])) {
 320           $errors["field[$key][membership_type]"] = ts('Membership type is a required field.');
 321         }
 322       }
 323     }
 324     if ($self->_batchInfo['type_id'] == $batchTypes['Pledge Payment']) {
 325       foreach (array_unique($params["open_pledges"]) as $value) {
 326         $duplicateRows = array_keys($params["open_pledges"], $value);
 327         if (count($duplicateRows) > 1) {
 328           foreach ($duplicateRows as $key) {
 329             $errors["open_pledges[$key]"] = ts('You can not record two payments for the same pledge in a single batch.');
 330           }
 331         }
 332       }
 333     }
 334     if ((string) $batchTotal != $self->_batchInfo['total']) {
 335       $self->assign('batchAmountMismatch', TRUE);
 336       $errors['_qf_defaults'] = ts('Total for amounts entered below does not match the expected batch total.');
 337     }
 338
 339     if (!empty($errors)) {
 340       return $errors;
 341     }
 342
 343     $self->assign('batchAmountMismatch', FALSE);
 344     return TRUE;
 345   }
 346
 347   /**
 348    * Override default cancel action.
 349    */
 350   public function cancelAction() {
 351     // redirect to batch listing
 352     CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/batch', 'reset=1'));
 353     CRM_Utils_System::civiExit();
 354   }
 355
 356   /**
 357    * Set default values for the form.
 358    *
 359    *
 360    * @return void
 361    */
 362   public function setDefaultValues() {
 363     if (empty($this->_fields)) {
 364       return;
 365     }
 366
 367     // for add mode set smart defaults
 368     if ($this->_action & CRM_Core_Action::ADD) {
 369       list($currentDate, $currentTime) = CRM_Utils_Date::setDateDefaults(NULL, 'activityDateTime');
 370
 371       //get all status
 372       $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 373       $completeStatus = array_search('Completed', $allStatus);
 374       $specialFields = array(
 375         'join_date' => $currentDate,
 376         'receive_date' => $currentDate,
 377         'receive_date_time' => $currentTime,
 378         'contribution_status_id' => $completeStatus,
 379       );
 380
 381       for ($rowNumber = 1; $rowNumber <= $this->_batchInfo['item_count']; $rowNumber++) {
 382         foreach ($specialFields as $key => $value) {
 383           $defaults['field'][$rowNumber][$key] = $value;
 384         }
 385       }
 386     }
 387     else {
 388       // get the cached info from data column of civicrm_batch
 389       $data = CRM_Core_DAO::getFieldValue('CRM_Batch_BAO_Batch', $this->_batchId, 'data');
 390       $defaults = json_decode($data, TRUE);
 391       $defaults = $defaults['values'];
 392     }
 393
 394     return $defaults;
 395   }
 396
 397   /**
 398    * Process the form after the input has been submitted and validated.
 399    *
 400    *
 401    * @return void
 402    */
 403   public function postProcess() {
 404     $params = $this->controller->exportValues($this->_name);
 405     $params['actualBatchTotal'] = 0;
 406
 407     // get the profile information
 408     $batchTypes = CRM_Core_Pseudoconstant::get('CRM_Batch_DAO_Batch', 'type_id', array('flip' => 1), 'validate');
 409     if (in_array($this->_batchInfo['type_id'], array($batchTypes['Pledge Payment'], $batchTypes['Contribution']))) {
 410       $this->processContribution($params);
 411     }
 412     elseif ($this->_batchInfo['type_id'] == $batchTypes['Membership']) {
 413       $this->processMembership($params);
 414     }
 415
 416     // update batch to close status
 417     $paramValues = array(
 418       'id' => $this->_batchId,
 419       // close status
 420       'status_id' => CRM_Core_OptionGroup::getValue('batch_status', 'Closed', 'name'),
 421       'total' => $params['actualBatchTotal'],
 422     );
 423
 424     CRM_Batch_BAO_Batch::create($paramValues);
 425
 426     // set success status
 427     CRM_Core_Session::setStatus("", ts("Batch Processed."), "success");
 428
 429     CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/batch', 'reset=1'));
 430   }
 431
 432   /**
 433    * Process contribution records.
 434    *
 435    * @param array $params
 436    *   Associated array of submitted values.
 437    *
 438    *
 439    * @return void
 440    */
 441   private function processContribution(&$params) {
 442     $dates = array(
 443       'receive_date',
 444       'receipt_date',
 445       'thankyou_date',
 446       'cancel_date',
 447     );
 448
 449     // get the price set associated with offline contribution record.
 450     $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', 'default_contribution_amount', 'id', 'name');
 451     $this->_priceSet = current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId));
 452     $priceFieldID = CRM_Price_BAO_PriceSet::getOnlyPriceFieldID($this->_priceSet);
 453     $priceFieldValueID = CRM_Price_BAO_PriceSet::getOnlyPriceFieldValueID($this->_priceSet);
 454
 455     if (isset($params['field'])) {
 456       foreach ($params['field'] as $key => $value) {
 457         // if contact is not selected we should skip the row
 458         if (empty($params['primary_contact_id'][$key])) {
 459           continue;
 460         }
 461
 462         $value['contact_id'] = CRM_Utils_Array::value($key, $params['primary_contact_id']);
 463
 464         // update contact information
 465         $this->updateContactInfo($value);
 466
 467         //build soft credit params
 468         if (!empty($params['soft_credit_contact_id'][$key]) && !empty($params['soft_credit_amount'][$key])) {
 469           $value['soft_credit'][$key]['contact_id'] = $params['soft_credit_contact_id'][$key];
 470           $value['soft_credit'][$key]['amount'] = CRM_Utils_Rule::cleanMoney($params['soft_credit_amount'][$key]);
 471
 472           //CRM-15350: if soft-credit-type profile field is disabled or removed then
 473           //we choose configured SCT default value
 474           if (!empty($params['soft_credit_type'][$key])) {
 475             $value['soft_credit'][$key]['soft_credit_type_id'] = $params['soft_credit_type'][$key];
 476           }
 477           else {
 478             $value['soft_credit'][$key]['soft_credit_type_id'] = CRM_Core_OptionGroup::getDefaultValue("soft_credit_type");
 479           }
 480         }
 481
 482         $value['custom'] = CRM_Core_BAO_CustomField::postProcess($value,
 483           CRM_Core_DAO::$_nullObject,
 484           NULL,
 485           'Contribution'
 486         );
 487
 488         foreach ($dates as $val) {
 489           if (!empty($value[$val])) {
 490             $value[$val] = CRM_Utils_Date::processDate($value[$val], $value[$val . '_time'], TRUE);
 491           }
 492         }
 493
 494         if (!empty($value['send_receipt'])) {
 495           $value['receipt_date'] = date('Y-m-d His');
 496         }
 497         // these translations & date handling are required because we are calling BAO directly rather than the api
 498         $fieldTranslations = array(
 499           'financial_type' => 'financial_type_id',
 500           'payment_instrument' => 'payment_instrument_id',
 501           'contribution_source' => 'source',
 502           'contribution_note' => 'note',
 503
 504         );
 505         foreach ($fieldTranslations as $formField => $baoField) {
 506           if (isset($value[$formField])) {
 507             $value[$baoField] = $value[$formField];
 508           }
 509           unset($value[$formField]);
 510         }
 511
 512         $params['actualBatchTotal'] += $value['total_amount'];
 513         $value['batch_id'] = $this->_batchId;
 514         $value['skipRecentView'] = TRUE;
 515
 516         // build line item params
 517         $this->_priceSet['fields'][$priceFieldID]['options'][$priceFieldValueID]['amount'] = $value['total_amount'];
 518         $value['price_' . $priceFieldID] = 1;
 519
 520         $lineItem = array();
 521         CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'], $value, $lineItem[$priceSetId]);
 522
 523         //unset amount level since we always use quick config price set
 524         unset($value['amount_level']);
 525
 526         //CRM-11529 for back office transactions
 527         //when financial_type_id is passed in form, update the
 528         //line items with the financial type selected in form
 529         if (!empty($value['financial_type_id']) && !empty($lineItem[$priceSetId])) {
 530           foreach ($lineItem[$priceSetId] as &$values) {
 531             $values['financial_type_id'] = $value['financial_type_id'];
 532           }
 533         }
 534         $value['line_item'] = $lineItem;
 535         //finally call contribution create for all the magic
 536         $contribution = CRM_Contribute_BAO_Contribution::create($value, CRM_Core_DAO::$_nullArray);
 537         $batchTypes = CRM_Core_Pseudoconstant::get('CRM_Batch_DAO_Batch', 'type_id', array('flip' => 1), 'validate');
 538         if (!empty($this->_batchInfo['type_id']) && ($this->_batchInfo['type_id'] == $batchTypes['Pledge Payment'])) {
 539           $adjustTotalAmount = FALSE;
 540           if (isset($params['option_type'][$key])) {
 541             if ($params['option_type'][$key] == 2) {
 542               $adjustTotalAmount = TRUE;
 543             }
 544           }
 545           $pledgeId = $params['open_pledges'][$key];
 546           if (is_numeric($pledgeId)) {
 547             $result = CRM_Pledge_BAO_PledgePayment::getPledgePayments($pledgeId);
 548             $pledgePaymentId = 0;
 549             foreach ($result as $key => $values) {
 550               if ($values['status'] != 'Completed') {
 551                 $pledgePaymentId = $values['id'];
 552                 break;
 553               }
 554             }
 555             CRM_Core_DAO::setFieldValue('CRM_Pledge_DAO_PledgePayment', $pledgePaymentId, 'contribution_id', $contribution->id);
 556             CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeId,
 557               array($pledgePaymentId),
 558               $contribution->contribution_status_id,
 559               NULL,
 560               $contribution->total_amount,
 561               $adjustTotalAmount
 562             );
 563           }
 564         }
 565
 566         //process premiums
 567         if (!empty($value['product_name'])) {
 568           if ($value['product_name'][0] > 0) {
 569             list($products, $options) = CRM_Contribute_BAO_Premium::getPremiumProductInfo();
 570
 571             $value['hidden_Premium'] = 1;
 572             $value['product_option'] = CRM_Utils_Array::value(
 573               $value['product_name'][1],
 574               $options[$value['product_name'][0]]
 575             );
 576
 577             $premiumParams = array(
 578               'product_id' => $value['product_name'][0],
 579               'contribution_id' => $contribution->id,
 580               'product_option' => $value['product_option'],
 581               'quantity' => 1,
 582             );
 583             CRM_Contribute_BAO_Contribution::addPremium($premiumParams);
 584           }
 585         }
 586         // end of premium
 587
 588         //send receipt mail.
 589         if ($contribution->id && !empty($value['send_receipt'])) {
 590           // add the domain email id
 591           $domainEmail = CRM_Core_BAO_Domain::getNameAndEmail();
 592           $domainEmail = "$domainEmail[0] <$domainEmail[1]>";
 593           $value['from_email_address'] = $domainEmail;
 594           $value['contribution_id'] = $contribution->id;
 595           CRM_Contribute_Form_AdditionalInfo::emailReceipt($this, $value);
 596         }
 597       }
 598     }
 599     return TRUE;
 600   }
 601
 602   /**
 603    * Process membership records.
 604    *
 605    * @param array $params
 606    *   Associated array of submitted values.
 607    *
 608    *
 609    * @return bool
 610    */
 611   private function processMembership(&$params) {
 612     $dateTypes = array(
 613       'join_date' => 'joinDate',
 614       'membership_start_date' => 'startDate',
 615       'membership_end_date' => 'endDate',
 616     );
 617
 618     $dates = array(
 619       'join_date',
 620       'start_date',
 621       'end_date',
 622       'reminder_date',
 623     );
 624
 625     // get the price set associated with offline memebership
 626     $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');
 627     $this->_priceSet = $priceSets = current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId));
 628
 629     if (isset($params['field'])) {
 630       $customFields = array();
 631       foreach ($params['field'] as $key => $value) {
 632         // if contact is not selected we should skip the row
 633         if (empty($params['primary_contact_id'][$key])) {
 634           continue;
 635         }
 636
 637         $value['contact_id'] = CRM_Utils_Array::value($key, $params['primary_contact_id']);
 638
 639         // update contact information
 640         $this->updateContactInfo($value);
 641
 642         $membershipTypeId = $value['membership_type_id'] = $value['membership_type'][1];
 643
 644         foreach ($dateTypes as $dateField => $dateVariable) {
 645           $$dateVariable = CRM_Utils_Date::processDate($value[$dateField]);
 646         }
 647
 648         $calcDates = array();
 649         $calcDates[$membershipTypeId] = CRM_Member_BAO_MembershipType::getDatesForMembershipType($membershipTypeId,
 650           $joinDate, $startDate, $endDate
 651         );
 652
 653         foreach ($calcDates as $memType => $calcDate) {
 654           foreach ($dates as $d) {
 655             //first give priority to form values then calDates.
 656             $date = CRM_Utils_Array::value($d, $value);
 657             if (!$date) {
 658               $date = CRM_Utils_Array::value($d, $calcDate);
 659             }
 660
 661             $value[$d] = CRM_Utils_Date::processDate($date);
 662           }
 663         }
 664
 665         if (!empty($value['send_receipt'])) {
 666           $value['receipt_date'] = date('Y-m-d His');
 667         }
 668
 669         if (!empty($value['membership_source'])) {
 670           $value['source'] = $value['membership_source'];
 671         }
 672
 673         unset($value['membership_source']);
 674
 675         //Get the membership status
 676         if (!empty($value['membership_status'])) {
 677           $value['status_id'] = $value['membership_status'];
 678           unset($value['membership_status']);
 679         }
 680
 681         if (empty($customFields)) {
 682           // membership type custom data
 683           $customFields = CRM_Core_BAO_CustomField::getFields('Membership', FALSE, FALSE, $membershipTypeId);
 684
 685           $customFields = CRM_Utils_Array::crmArrayMerge($customFields,
 686             CRM_Core_BAO_CustomField::getFields('Membership',
 687               FALSE, FALSE, NULL, NULL, TRUE
 688             )
 689           );
 690         }
 691
 692         //check for custom data
 693         $value['custom'] = CRM_Core_BAO_CustomField::postProcess($params['field'][$key],
 694           $customFields,
 695           $key,
 696           'Membership',
 697           $membershipTypeId
 698         );
 699
 700         if (!empty($value['financial_type'])) {
 701           $value['financial_type_id'] = $value['financial_type'];
 702         }
 703
 704         if (!empty($value['payment_instrument'])) {
 705           $value['payment_instrument_id'] = $value['payment_instrument'];
 706         }
 707
 708         // handle soft credit
 709         if (!empty($params['soft_credit_contact_id'][$key]) && !empty($params['soft_credit_amount'][$key])) {
 710           $value['soft_credit'][$key]['contact_id'] = $params['soft_credit_contact_id'][$key];
 711           $value['soft_credit'][$key]['amount'] = CRM_Utils_Rule::cleanMoney($params['soft_credit_amount'][$key]);
 712
 713           //CRM-15350: if soft-credit-type profile field is disabled or removed then
 714           //we choose Gift as default value as per Gift Membership rule
 715           if (!empty($params['soft_credit_type'][$key])) {
 716             $value['soft_credit'][$key]['soft_credit_type_id'] = $params['soft_credit_type'][$key];
 717           }
 718           else {
 719             $value['soft_credit'][$key]['soft_credit_type_id'] = CRM_Core_OptionGroup::getValue('soft_credit_type', 'Gift', 'name');
 720           }
 721         }
 722
 723         if (!empty($value['receive_date'])) {
 724           $value['receive_date'] = CRM_Utils_Date::processDate($value['receive_date'], $value['receive_date_time'], TRUE);
 725         }
 726
 727         $params['actualBatchTotal'] += $value['total_amount'];
 728
 729         unset($value['financial_type']);
 730         unset($value['payment_instrument']);
 731
 732         $value['batch_id'] = $this->_batchId;
 733         $value['skipRecentView'] = TRUE;
 734
 735         // make entry in line item for contribution
 736
 737         $editedFieldParams = array(
 738           'price_set_id' => $priceSetId,
 739           'name' => $value['membership_type'][0],
 740         );
 741
 742         $editedResults = array();
 743         CRM_Price_BAO_PriceField::retrieve($editedFieldParams, $editedResults);
 744
 745         if (!empty($editedResults)) {
 746           unset($this->_priceSet['fields']);
 747           $this->_priceSet['fields'][$editedResults['id']] = $priceSets['fields'][$editedResults['id']];
 748           unset($this->_priceSet['fields'][$editedResults['id']]['options']);
 749           $fid = $editedResults['id'];
 750           $editedFieldParams = array(
 751             'price_field_id' => $editedResults['id'],
 752             'membership_type_id' => $value['membership_type_id'],
 753           );
 754
 755           $editedResults = array();
 756           CRM_Price_BAO_PriceFieldValue::retrieve($editedFieldParams, $editedResults);
 757           $this->_priceSet['fields'][$fid]['options'][$editedResults['id']] = $priceSets['fields'][$fid]['options'][$editedResults['id']];
 758           if (!empty($value['total_amount'])) {
 759             $this->_priceSet['fields'][$fid]['options'][$editedResults['id']]['amount'] = $value['total_amount'];
 760           }
 761
 762           $fieldID = key($this->_priceSet['fields']);
 763           $value['price_' . $fieldID] = $editedResults['id'];
 764
 765           $lineItem = array();
 766           CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'],
 767             $value, $lineItem[$priceSetId]
 768           );
 769
 770           //CRM-11529 for backoffice transactions
 771           //when financial_type_id is passed in form, update the
 772           //lineitems with the financial type selected in form
 773           if (!empty($value['financial_type_id']) && !empty($lineItem[$priceSetId])) {
 774             foreach ($lineItem[$priceSetId] as &$values) {
 775               $values['financial_type_id'] = $value['financial_type_id'];
 776             }
 777           }
 778
 779           $value['lineItems'] = $lineItem;
 780           $value['processPriceSet'] = TRUE;
 781         }
 782         // end of contribution related section
 783
 784         unset($value['membership_type']);
 785         unset($value['membership_start_date']);
 786         unset($value['membership_end_date']);
 787
 788         $value['is_renew'] = FALSE;
 789         if (!empty($params['member_option']) && CRM_Utils_Array::value($key, $params['member_option']) == 2) {
 790           $this->_params = $params;
 791           $value['is_renew'] = TRUE;
 792           $membership = CRM_Member_BAO_Membership::renewMembershipFormWrapper(
 793             $value['contact_id'],
 794             $value['membership_type_id'],
 795             FALSE, $this, NULL, NULL,
 796             $value['custom']
 797           );
 798
 799           // make contribution entry
 800           $contrbutionParams = array_merge($value, array('membership_id' => $membership->id));
 801           CRM_Member_BAO_Membership::recordMembershipContribution($contrbutionParams);
 802         }
 803         else {
 804           $membership = CRM_Member_BAO_Membership::create($value, CRM_Core_DAO::$_nullArray);
 805         }
 806
 807         //process premiums
 808         if (!empty($value['product_name'])) {
 809           if ($value['product_name'][0] > 0) {
 810             list($products, $options) = CRM_Contribute_BAO_Premium::getPremiumProductInfo();
 811
 812             $value['hidden_Premium'] = 1;
 813             $value['product_option'] = CRM_Utils_Array::value(
 814               $value['product_name'][1],
 815               $options[$value['product_name'][0]]
 816             );
 817
 818             $premiumParams = array(
 819               'product_id' => $value['product_name'][0],
 820               'contribution_id' => CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipPayment', $membership->id, 'contribution_id', 'membership_id'),
 821               'product_option' => $value['product_option'],
 822               'quantity' => 1,
 823             );
 824             CRM_Contribute_BAO_Contribution::addPremium($premiumParams);
 825           }
 826         }
 827         // end of premium
 828
 829         //send receipt mail.
 830         if ($membership->id && !empty($value['send_receipt'])) {
 831
 832           // add the domain email id
 833           $domainEmail = CRM_Core_BAO_Domain::getNameAndEmail();
 834           $domainEmail = "$domainEmail[0] <$domainEmail[1]>";
 835
 836           $value['from_email_address'] = $domainEmail;
 837           $value['membership_id'] = $membership->id;
 838           $value['contribution_id'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipPayment', $membership->id, 'contribution_id', 'membership_id');
 839           CRM_Member_Form_Membership::emailReceipt($this, $value, $membership);
 840         }
 841       }
 842     }
 843     return TRUE;
 844   }
 845
 846   /**
 847    * Update contact information.
 848    *
 849    * @param array $value
 850    *   Associated array of submitted values.
 851    *
 852    *
 853    * @return void
 854    */
 855   private function updateContactInfo(&$value) {
 856     $value['preserveDBName'] = $this->_preserveDefault;
 857
 858     //parse street address, CRM-7768
 859     CRM_Contact_Form_Task_Batch::parseStreetAddress($value, $this);
 860
 861     CRM_Contact_BAO_Contact::createProfileContact($value, $this->_fields,
 862       $value['contact_id']
 863     );
 864   }
 865
 866   /**
 867    * Function exists purely for unit testing purposes. If you feel tempted to use this in live code
 868    * then it probably means there is some functionality that needs to be moved
 869    * out of the form layer
 870    *
 871    * @param array $params
 872    *
 873    * @return bool
 874    */
 875   public function testProcessMembership($params) {
 876     return $this->processMembership($params);
 877   }
 878
 879   /**
 880    * Function exists purely for unit testing purposes. If you feel tempted to use this in live code
 881    * then it probably means there is some functionality that needs to be moved
 882    * out of the form layer
 883    *
 884    * @param array $params
 885    *
 886    * @return bool
 887    */
 888   public function testProcessContribution($params) {
 889     return $this->processContribution($params);
 890   }
 891
 892 }