CRM/Contribute/Form/AdditionalInfo.php

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