CRM/Contribute/Form/AdditionalInfo.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  */
  17 class CRM_Contribute_Form_AdditionalInfo {
  18
  19   /**
  20    * Build the form object for Premium Information.
  21    *
  22    * Called from the CRM_Contribute_Form_Contribute function and seemingly nowhere else.
  23    *
  24    * Probably this should be on the form that uses it since it is not used on multiple forms.
  25    *
  26    * Putting it on this class doesn't seem to reduce complexity.
  27    *
  28    * @param CRM_Core_Form $form
  29    */
  30   public static function buildPremium($form) {
  31     //premium section
  32     $form->add('hidden', 'hidden_Premium', 1);
  33     $sel1 = $sel2 = [];
  34
  35     $dao = new CRM_Contribute_DAO_Product();
  36     $dao->is_active = 1;
  37     $dao->find();
  38     $min_amount = [];
  39     $sel1[0] = ts('-select product-');
  40     while ($dao->fetch()) {
  41       $sel1[$dao->id] = $dao->name . " ( " . $dao->sku . " )";
  42       $min_amount[$dao->id] = $dao->min_contribution;
  43       $options = explode(',', $dao->options);
  44       foreach ($options as $k => $v) {
  45         $options[$k] = trim($v);
  46       }
  47       if ($options[0] != '') {
  48         $sel2[$dao->id] = $options;
  49       }
  50       $form->assign('premiums', TRUE);
  51     }
  52     $form->_options = $sel2;
  53     $form->assign('mincontribution', $min_amount);
  54     $sel = &$form->addElement('hierselect', "product_name", ts('Premium'), 'onclick="showMinContrib();"');
  55     $js = "<script type='text/javascript'>\n";
  56     $formName = 'document.forms.' . $form->getName();
  57
  58     for ($k = 1; $k < 2; $k++) {
  59       if (!isset($defaults['product_name'][$k]) || (!$defaults['product_name'][$k])) {
  60         $js .= "{$formName}['product_name[$k]'].style.display = 'none';\n";
  61       }
  62     }
  63
  64     $sel->setOptions([$sel1, $sel2]);
  65     $js .= "</script>\n";
  66     $form->assign('initHideBoxes', $js);
  67
  68     $form->add('datepicker', 'fulfilled_date', ts('Fulfilled'), [], FALSE, ['time' => FALSE]);
  69     $form->addElement('text', 'min_amount', ts('Minimum Contribution Amount'));
  70   }
  71
  72   /**
  73    * Build the form object for Additional Details.
  74    *
  75    * @param CRM_Core_Form $form
  76    */
  77   public static function buildAdditionalDetail(&$form) {
  78     //Additional information section
  79     $form->add('hidden', 'hidden_AdditionalDetail', 1);
  80
  81     $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution');
  82
  83     $form->addField('thankyou_date', ['entity' => 'contribution'], FALSE, FALSE);
  84
  85     // add various amounts
  86     $nonDeductAmount = &$form->add('text', 'non_deductible_amount', ts('Non-deductible Amount'),
  87       $attributes['non_deductible_amount']
  88     );
  89     $form->addRule('non_deductible_amount', ts('Please enter a valid monetary value for Non-deductible Amount.'), 'money');
  90
  91     if ($form->_online) {
  92       $nonDeductAmount->freeze();
  93     }
  94     $feeAmount = &$form->add('text', 'fee_amount', ts('Fee Amount'),
  95       $attributes['fee_amount']
  96     );
  97     $form->addRule('fee_amount', ts('Please enter a valid monetary value for Fee Amount.'), 'money');
  98     if ($form->_online) {
  99       $feeAmount->freeze();
 100     }
 101
 102     $element = &$form->add('text', 'invoice_id', ts('Invoice ID'),
 103       $attributes['invoice_id']
 104     );
 105     if ($form->_online) {
 106       $element->freeze();
 107     }
 108     else {
 109       $form->addRule('invoice_id',
 110         ts('This Invoice ID already exists in the database.'),
 111         'objectExists',
 112         ['CRM_Contribute_DAO_Contribution', $form->_id, 'invoice_id']
 113       );
 114     }
 115     $element = $form->add('text', 'creditnote_id', ts('Credit Note ID'),
 116       $attributes['creditnote_id']
 117     );
 118     if ($form->_online) {
 119       $element->freeze();
 120     }
 121     else {
 122       $form->addRule('creditnote_id',
 123         ts('This Credit Note ID already exists in the database.'),
 124         'objectExists',
 125         ['CRM_Contribute_DAO_Contribution', $form->_id, 'creditnote_id']
 126       );
 127     }
 128
 129     $form->add('select', 'contribution_page_id',
 130       ts('Online Contribution Page'),
 131       [
 132         '' => ts('- select -'),
 133       ] +
 134       CRM_Contribute_PseudoConstant::contributionPage()
 135     );
 136
 137     $form->add('textarea', 'note', ts('Notes'), ["rows" => 4, "cols" => 60]);
 138
 139     $statusName = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 140     if ($form->_id && $form->_values['contribution_status_id'] == array_search('Cancelled', $statusName)) {
 141       $feeAmount->freeze();
 142     }
 143
 144   }
 145
 146   /**
 147    * used by  CRM/Pledge/Form/Pledge.php
 148    *
 149    * Build the form object for PaymentReminders Information.
 150    *
 151    * @param CRM_Core_Form $form
 152    */
 153   public static function buildPaymentReminders(&$form) {
 154     //PaymentReminders section
 155     $form->add('hidden', 'hidden_PaymentReminders', 1);
 156     $form->add('text', 'initial_reminder_day', ts('Send Initial Reminder'), ['size' => 3]);
 157     $form->addRule('initial_reminder_day', ts('Please enter a valid reminder day.'), 'positiveInteger');
 158     $form->add('text', 'max_reminders', ts('Send up to'), ['size' => 3]);
 159     $form->addRule('max_reminders', ts('Please enter a valid No. of reminders.'), 'positiveInteger');
 160     $form->add('text', 'additional_reminder_day', ts('Send additional reminders'), ['size' => 3]);
 161     $form->addRule('additional_reminder_day', ts('Please enter a valid additional reminder day.'), 'positiveInteger');
 162   }
 163
 164   /**
 165    * Process the Premium Information.
 166    *
 167    * @param array $params
 168    * @param int $contributionID
 169    * @param int $premiumID
 170    * @param array $options
 171    */
 172   public static function processPremium($params, $contributionID, $premiumID = NULL, $options = []) {
 173     $selectedProductID = $params['product_name'][0];
 174     $selectedProductOptionID = $params['product_name'][1] ?? NULL;
 175
 176     $dao = new CRM_Contribute_DAO_ContributionProduct();
 177     $dao->contribution_id = $contributionID;
 178     $dao->product_id = $selectedProductID;
 179     $dao->fulfilled_date = $params['fulfilled_date'];
 180     $isDeleted = FALSE;
 181
 182     //CRM-11106
 183     $premiumParams = [
 184       'id' => $selectedProductID,
 185     ];
 186
 187     $productDetails = [];
 188     CRM_Contribute_BAO_Product::retrieve($premiumParams, $productDetails);
 189     $dao->financial_type_id = $productDetails['financial_type_id'] ?? NULL;
 190     if (!empty($options[$selectedProductID])) {
 191       $dao->product_option = $options[$selectedProductID][$selectedProductOptionID];
 192     }
 193
 194     // This IF condition codeblock does the following:
 195     // 1. If premium is present then get previous contribution-product mapping record (if any) based on contribtuion ID.
 196     //   If found and the product chosen doesn't matches with old done, then delete or else set the ID for update
 197     // 2. If no product is chosen theb delete the previous contribution-product mapping record based on contribtuion ID.
 198     if ($premiumID || empty($selectedProductID)) {
 199       $ContributionProduct = new CRM_Contribute_DAO_ContributionProduct();
 200       $ContributionProduct->contribution_id = $contributionID;
 201       $ContributionProduct->find(TRUE);
 202       // here $selectedProductID can be 0 in case one unselect the premium product on backoffice update form
 203       if ($ContributionProduct->product_id == $selectedProductID) {
 204         $dao->id = $premiumID;
 205       }
 206       else {
 207         $ContributionProduct->delete();
 208         $isDeleted = TRUE;
 209       }
 210     }
 211
 212     // only add/update contribution product when a product is selected
 213     if (!empty($selectedProductID)) {
 214       $dao->save();
 215     }
 216
 217     //CRM-11106
 218     if ($premiumID == NULL || $isDeleted) {
 219       $premiumParams = [
 220         'cost' => $productDetails['cost'] ?? NULL,
 221         'currency' => $productDetails['currency'] ?? NULL,
 222         'financial_type_id' => $productDetails['financial_type_id'] ?? NULL,
 223         'contributionId' => $contributionID,
 224       ];
 225       if ($isDeleted) {
 226         $premiumParams['oldPremium']['product_id'] = $ContributionProduct->product_id;
 227         $premiumParams['oldPremium']['contribution_id'] = $ContributionProduct->contribution_id;
 228       }
 229       CRM_Core_BAO_FinancialTrxn::createPremiumTrxn($premiumParams);
 230     }
 231   }
 232
 233   /**
 234    * Process the Note.
 235    *
 236    *
 237    * @param array $params
 238    * @param int $contactID
 239    * @param int $contributionID
 240    * @param int $contributionNoteID
 241    */
 242   public static function processNote($params, $contactID, $contributionID, $contributionNoteID = NULL) {
 243     if (CRM_Utils_System::isNull($params['note']) && $contributionNoteID) {
 244       CRM_Core_BAO_Note::deleteRecord(['id' => $contributionNoteID]);
 245       $status = ts('Selected Note has been deleted successfully.');
 246       CRM_Core_Session::setStatus($status, ts('Deleted'), 'success');
 247       return;
 248     }
 249     //process note
 250     $noteParams = [
 251       'entity_table' => 'civicrm_contribution',
 252       'note' => $params['note'],
 253       'entity_id' => $contributionID,
 254       'contact_id' => $contactID,
 255     ];
 256     $noteID = [];
 257     if ($contributionNoteID) {
 258       $noteID = ["id" => $contributionNoteID];
 259       $noteParams['note'] = $noteParams['note'] ? $noteParams['note'] : "null";
 260     }
 261     CRM_Core_BAO_Note::add($noteParams, $noteID);
 262   }
 263
 264   /**
 265    * Process the Common data.
 266    *
 267    * @param array $params
 268    * @param array $formatted
 269    * @param CRM_Core_Form $form
 270    */
 271   public static function postProcessCommon(&$params, &$formatted, &$form) {
 272     $fields = [
 273       'non_deductible_amount',
 274       'total_amount',
 275       'fee_amount',
 276       'trxn_id',
 277       'invoice_id',
 278       'creditnote_id',
 279       'campaign_id',
 280       'contribution_page_id',
 281     ];
 282     foreach ($fields as $f) {
 283       $formatted[$f] = $params[$f] ?? NULL;
 284     }
 285
 286     if (!empty($params['thankyou_date'])) {
 287       $formatted['thankyou_date'] = CRM_Utils_Date::processDate($params['thankyou_date']);
 288     }
 289     else {
 290       $formatted['thankyou_date'] = 'null';
 291     }
 292
 293     if (!empty($params['is_email_receipt'])) {
 294       $params['receipt_date'] = $formatted['receipt_date'] = date('YmdHis');
 295     }
 296
 297     $formatted['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 298        $params['id'] ?? NULL,
 299       'Contribution'
 300     );
 301   }
 302
 303   /**
 304    * Send email receipt.
 305    *
 306    * @param \CRM_Core_Form $form
 307    *   instance of Contribution form.
 308    * @param array $params
 309    *   (reference ) an assoc array of name/value pairs.
 310    * @param bool $ccContribution
 311    *   is it credit card contribution.
 312    *
 313    * @return array
 314    * @throws \CRM_Core_Exception
 315    */
 316   public static function emailReceipt(&$form, &$params, $ccContribution = FALSE) {
 317     $form->assign('receiptType', 'contribution');
 318     // Retrieve Financial Type Name from financial_type_id
 319     $params['contributionType_name'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialType',
 320       $params['financial_type_id']);
 321     if (!empty($params['payment_instrument_id'])) {
 322       $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
 323       $params['paidBy'] = $paymentInstrument[$params['payment_instrument_id']];
 324       if ($params['paidBy'] != 'Check' && isset($params['check_number'])) {
 325         unset($params['check_number']);
 326       }
 327     }
 328
 329     // retrieve individual prefix value for honoree
 330     if (isset($params['soft_credit'])) {
 331       $softCreditTypes = $softCredits = [];
 332       foreach ($params['soft_credit'] as $key => $softCredit) {
 333         $softCredits[$key] = [
 334           'Name' => $softCredit['contact_name'],
 335           'Amount' => CRM_Utils_Money::format($softCredit['amount'], $softCredit['currency']),
 336         ];
 337         $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
 338       }
 339       $form->assign('softCreditTypes', $softCreditTypes);
 340       $form->assign('softCredits', $softCredits);
 341     }
 342
 343     // retrieve premium product name and assigned fulfilled
 344     // date to template
 345     if (!empty($params['hidden_Premium'])) {
 346       if (isset($params['product_name']) &&
 347         is_array($params['product_name']) &&
 348         !empty($params['product_name'])
 349       ) {
 350         $productDAO = new CRM_Contribute_DAO_Product();
 351         $productDAO->id = $params['product_name'][0];
 352         $productOptionID = $params['product_name'][1];
 353         $productDAO->find(TRUE);
 354         $params['product_name'] = $productDAO->name;
 355         $params['product_sku'] = $productDAO->sku;
 356
 357         if (empty($params['product_option']) && !empty($form->_options[$productDAO->id])) {
 358           $params['product_option'] = $form->_options[$productDAO->id][$productOptionID];
 359         }
 360       }
 361       if (!empty($params['fulfilled_date'])) {
 362         $form->assign('fulfilled_date', $params['fulfilled_date']);
 363       }
 364     }
 365
 366     $form->assign('ccContribution', $ccContribution);
 367     if ($ccContribution) {
 368       $form->assignBillingName($params);
 369       $form->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters(
 370         $params,
 371         $form->_bltID
 372       ));
 373
 374       $valuesForForm = CRM_Contribute_Form_AbstractEditPayment::formatCreditCardDetails($params);
 375       $form->assignVariables($valuesForForm, ['credit_card_exp_date', 'credit_card_type', 'credit_card_number']);
 376     }
 377     else {
 378       //offline contribution
 379       // assigned various dates to the templates
 380       $form->assign('receipt_date', CRM_Utils_Date::processDate($params['receipt_date']));
 381
 382       if (!empty($params['cancel_date'])) {
 383         $form->assign('cancel_date', CRM_Utils_Date::processDate($params['cancel_date']));
 384       }
 385       if (!empty($params['thankyou_date'])) {
 386         $form->assign('thankyou_date', CRM_Utils_Date::processDate($params['thankyou_date']));
 387       }
 388       if ($form->_action & CRM_Core_Action::UPDATE) {
 389         $form->assign('lineItem', empty($form->_lineItems) ? FALSE : $form->_lineItems);
 390       }
 391     }
 392
 393     //handle custom data
 394     if (!empty($params['hidden_custom'])) {
 395       $contribParams = [['contribution_id', '=', $params['contribution_id'], 0, 0]];
 396       if ($form->_mode == 'test') {
 397         $contribParams[] = ['contribution_test', '=', 1, 0, 0];
 398       }
 399
 400       //retrieve custom data
 401       $customGroup = [];
 402
 403       foreach ($form->_groupTree as $groupID => $group) {
 404         $customFields = $customValues = [];
 405         if ($groupID == 'info') {
 406           continue;
 407         }
 408         foreach ($group['fields'] as $k => $field) {
 409           $field['title'] = $field['label'];
 410           $customFields["custom_{$k}"] = $field;
 411         }
 412
 413         //build the array of customgroup contain customfields.
 414         CRM_Core_BAO_UFGroup::getValues($params['contact_id'], $customFields, $customValues, FALSE, $contribParams);
 415         $customGroup[$group['title']] = $customValues;
 416       }
 417       //assign all custom group and corresponding fields to template.
 418       $form->assign('customGroup', $customGroup);
 419     }
 420
 421     $form->assign_by_ref('formValues', $params);
 422     list($contributorDisplayName,
 423       $contributorEmail
 424       ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($params['contact_id']);
 425     $form->assign('contactID', $params['contact_id']);
 426     $form->assign('contributionID', $params['contribution_id']);
 427
 428     if (!empty($params['currency'])) {
 429       $form->assign('currency', $params['currency']);
 430     }
 431
 432     if (!empty($params['receive_date'])) {
 433       $form->assign('receive_date', CRM_Utils_Date::processDate($params['receive_date']));
 434     }
 435
 436     [$sendReceipt] = CRM_Core_BAO_MessageTemplate::sendTemplate(
 437       [
 438         'workflow' => 'contribution_offline_receipt',
 439         'contactId' => $params['contact_id'],
 440         'contributionId' => $params['contribution_id'],
 441         'tokenContext' => ['contributionId' => (int) $params['contribution_id'], 'contactId' => $params['contact_id']],
 442         'from' => $params['from_email_address'],
 443         'toName' => $contributorDisplayName,
 444         'toEmail' => $contributorEmail,
 445         'isTest' => $form->_mode === 'test',
 446         'PDFFilename' => ts('receipt') . '.pdf',
 447         'isEmailPdf' => Civi::settings()->get('invoice_is_email_pdf'),
 448       ]
 449     );
 450
 451     return $sendReceipt;
 452   }
 453
 454 }