CRM/Contribute/Form/AdditionalInfo.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.7                                                |
   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  */
  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] = '-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->addDateTime('thankyou_date', ts('Thank-you Sent'), FALSE, array('formatType' => 'activityDateTime'));
 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     $netAmount = &$form->add('text', 'net_amount', ts('Net Amount'),
 119       $attributes['net_amount']
 120     );
 121     $form->addRule('net_amount', ts('Please enter a valid monetary value for Net Amount.'), 'money');
 122     if ($form->_online) {
 123       $netAmount->freeze();
 124     }
 125     $element = &$form->add('text', 'invoice_id', ts('Invoice ID'),
 126       $attributes['invoice_id']
 127     );
 128     if ($form->_online) {
 129       $element->freeze();
 130     }
 131     else {
 132       $form->addRule('invoice_id',
 133         ts('This Invoice ID already exists in the database.'),
 134         'objectExists',
 135         array('CRM_Contribute_DAO_Contribution', $form->_id, 'invoice_id')
 136       );
 137     }
 138     $element = $form->add('text', 'creditnote_id', ts('Credit Note ID'),
 139       $attributes['creditnote_id']
 140     );
 141     if ($form->_online) {
 142       $element->freeze();
 143     }
 144     else {
 145       $form->addRule('creditnote_id',
 146         ts('This Credit Note ID already exists in the database.'),
 147         'objectExists',
 148         array('CRM_Contribute_DAO_Contribution', $form->_id, 'creditnote_id')
 149       );
 150     }
 151
 152     $form->add('select', 'contribution_page_id',
 153       ts('Online Contribution Page'),
 154       array(
 155         '' => ts('- select -'),
 156       ) +
 157       CRM_Contribute_PseudoConstant::contributionPage()
 158     );
 159
 160     $form->add('textarea', 'note', ts('Notes'), array("rows" => 4, "cols" => 60));
 161
 162     $statusName = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 163     if ($form->_id && $form->_values['contribution_status_id'] == array_search('Cancelled', $statusName)) {
 164       $netAmount->freeze();
 165       $feeAmount->freeze();
 166     }
 167
 168   }
 169
 170   /**
 171    * used by  CRM/Pledge/Form/Pledge.php
 172    *
 173    * Build the form object for PaymentReminders Information.
 174    *
 175    * @param CRM_Core_Form $form
 176    */
 177   public static function buildPaymentReminders(&$form) {
 178     //PaymentReminders section
 179     $form->add('hidden', 'hidden_PaymentReminders', 1);
 180     $form->add('text', 'initial_reminder_day', ts('Send Initial Reminder'), array('size' => 3));
 181     $form->addRule('initial_reminder_day', ts('Please enter a valid reminder day.'), 'positiveInteger');
 182     $form->add('text', 'max_reminders', ts('Send up to'), array('size' => 3));
 183     $form->addRule('max_reminders', ts('Please enter a valid No. of reminders.'), 'positiveInteger');
 184     $form->add('text', 'additional_reminder_day', ts('Send additional reminders'), array('size' => 3));
 185     $form->addRule('additional_reminder_day', ts('Please enter a valid additional reminder day.'), 'positiveInteger');
 186   }
 187
 188   /**
 189    * Process the Premium Information.
 190    *
 191    * @param array $params
 192    * @param int $contributionID
 193    * @param int $premiumID
 194    * @param array $options
 195    */
 196   public static function processPremium($params, $contributionID, $premiumID = NULL, $options = array()) {
 197     $selectedProductID = $params['product_name'][0];
 198     $selectedProductOptionID = $params['product_name'][1];
 199
 200     $dao = new CRM_Contribute_DAO_ContributionProduct();
 201     $dao->contribution_id = $contributionID;
 202     $dao->product_id = $selectedProductID;
 203     $dao->fulfilled_date = CRM_Utils_Date::processDate($params['fulfilled_date'], NULL, TRUE);
 204     $isDeleted = FALSE;
 205
 206     //CRM-11106
 207     $premiumParams = array(
 208       'id' => $selectedProductID,
 209     );
 210
 211     $productDetails = array();
 212     CRM_Contribute_BAO_ManagePremiums::retrieve($premiumParams, $productDetails);
 213     $dao->financial_type_id = CRM_Utils_Array::value('financial_type_id', $productDetails);
 214     if (!empty($options[$selectedProductID])) {
 215       $dao->product_option = $options[$selectedProductID][$selectedProductOptionID];
 216     }
 217     if ($premiumID) {
 218       $ContributionProduct = new CRM_Contribute_DAO_ContributionProduct();
 219       $ContributionProduct->id = $premiumID;
 220       $ContributionProduct->find(TRUE);
 221       if ($ContributionProduct->product_id == $selectedProductID) {
 222         $dao->id = $premiumID;
 223       }
 224       else {
 225         $ContributionProduct->delete();
 226         $isDeleted = TRUE;
 227       }
 228     }
 229
 230     $dao->save();
 231     //CRM-11106
 232     if ($premiumID == NULL || $isDeleted) {
 233       $premiumParams = array(
 234         'cost' => CRM_Utils_Array::value('cost', $productDetails),
 235         'currency' => CRM_Utils_Array::value('currency', $productDetails),
 236         'financial_type_id' => CRM_Utils_Array::value('financial_type_id', $productDetails),
 237         'contributionId' => $contributionID,
 238       );
 239       if ($isDeleted) {
 240         $premiumParams['oldPremium']['product_id'] = $ContributionProduct->product_id;
 241         $premiumParams['oldPremium']['contribution_id'] = $ContributionProduct->contribution_id;
 242       }
 243       CRM_Core_BAO_FinancialTrxn::createPremiumTrxn($premiumParams);
 244     }
 245   }
 246
 247   /**
 248    * Process the Note.
 249    *
 250    *
 251    * @param array $params
 252    * @param int $contactID
 253    * @param int $contributionID
 254    * @param int $contributionNoteID
 255    */
 256   public static function processNote($params, $contactID, $contributionID, $contributionNoteID = NULL) {
 257     //process note
 258     $noteParams = array(
 259       'entity_table' => 'civicrm_contribution',
 260       'note' => $params['note'],
 261       'entity_id' => $contributionID,
 262       'contact_id' => $contactID,
 263     );
 264     $noteID = array();
 265     if ($contributionNoteID) {
 266       $noteID = array("id" => $contributionNoteID);
 267       $noteParams['note'] = $noteParams['note'] ? $noteParams['note'] : "null";
 268     }
 269     CRM_Core_BAO_Note::add($noteParams, $noteID);
 270   }
 271
 272   /**
 273    * Process the Common data.
 274    *
 275    * @param array $params
 276    * @param array $formatted
 277    * @param CRM_Core_Form $form
 278    */
 279   public static function postProcessCommon(&$params, &$formatted, &$form) {
 280     $fields = array(
 281       'non_deductible_amount',
 282       'total_amount',
 283       'fee_amount',
 284       'net_amount',
 285       'trxn_id',
 286       'invoice_id',
 287       'creditnote_id',
 288       'campaign_id',
 289       'contribution_page_id',
 290     );
 291     foreach ($fields as $f) {
 292       $formatted[$f] = CRM_Utils_Array::value($f, $params);
 293     }
 294
 295     if (!empty($params['thankyou_date']) && !CRM_Utils_System::isNull($params['thankyou_date'])) {
 296       $formatted['thankyou_date'] = CRM_Utils_Date::processDate($params['thankyou_date'], $params['thankyou_date_time']);
 297     }
 298     else {
 299       $formatted['thankyou_date'] = 'null';
 300     }
 301
 302     if (!empty($params['is_email_receipt'])) {
 303       $params['receipt_date'] = $formatted['receipt_date'] = date('YmdHis');
 304     }
 305
 306     //special case to handle if all checkboxes are unchecked
 307     $customFields = CRM_Core_BAO_CustomField::getFields('Contribution',
 308       FALSE,
 309       FALSE,
 310       CRM_Utils_Array::value('financial_type_id',
 311         $params
 312       )
 313     );
 314     $formatted['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 315       CRM_Utils_Array::value('id', $params, NULL),
 316       'Contribution'
 317     );
 318   }
 319
 320   /**
 321    * Send email receipt.
 322    *
 323    * @param CRM_Core_Form $form
 324    *   instance of Contribution form.
 325    * @param array $params
 326    *   (reference ) an assoc array of name/value pairs.
 327    * @param bool $ccContribution
 328    *   is it credit card contribution.
 329    *
 330    * @return array
 331    */
 332   public static function emailReceipt(&$form, &$params, $ccContribution = FALSE) {
 333     $form->assign('receiptType', 'contribution');
 334     // Retrieve Financial Type Name from financial_type_id
 335     $params['contributionType_name'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialType',
 336       $params['financial_type_id']);
 337     if (!empty($params['payment_instrument_id'])) {
 338       $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
 339       $params['paidBy'] = $paymentInstrument[$params['payment_instrument_id']];
 340     }
 341
 342     // retrieve individual prefix value for honoree
 343     if (isset($params['soft_credit'])) {
 344       $softCreditTypes = $softCredits = array();
 345       foreach ($params['soft_credit'] as $key => $softCredit) {
 346         $softCredits[$key] = array(
 347           'Name' => $softCredit['contact_name'],
 348           'Amount' => CRM_Utils_Money::format($softCredit['amount'], $softCredit['currency']),
 349         );
 350         $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
 351       }
 352       $form->assign('softCreditTypes', $softCreditTypes);
 353       $form->assign('softCredits', $softCredits);
 354     }
 355
 356     // retrieve premium product name and assigned fulfilled
 357     // date to template
 358     if (!empty($params['hidden_Premium'])) {
 359       if (isset($params['product_name']) &&
 360         is_array($params['product_name']) &&
 361         !empty($params['product_name'])
 362       ) {
 363         $productDAO = new CRM_Contribute_DAO_Product();
 364         $productDAO->id = $params['product_name'][0];
 365         $productOptionID = $params['product_name'][1];
 366         $productDAO->find(TRUE);
 367         $params['product_name'] = $productDAO->name;
 368         $params['product_sku'] = $productDAO->sku;
 369
 370         if (empty($params['product_option']) && !empty($form->_options[$productDAO->id])) {
 371           $params['product_option'] = $form->_options[$productDAO->id][$productOptionID];
 372         }
 373       }
 374
 375       if (!empty($params['fulfilled_date'])) {
 376         $form->assign('fulfilled_date', CRM_Utils_Date::processDate($params['fulfilled_date']));
 377       }
 378     }
 379
 380     $form->assign('ccContribution', $ccContribution);
 381     if ($ccContribution) {
 382       //build the name.
 383       $name = CRM_Utils_Array::value('billing_first_name', $params);
 384       if (!empty($params['billing_middle_name'])) {
 385         $name .= " {$params['billing_middle_name']}";
 386       }
 387       $name .= ' ' . CRM_Utils_Array::value('billing_last_name', $params);
 388       $name = trim($name);
 389       $form->assign('billingName', $name);
 390
 391       //assign the address formatted up for display
 392       $addressParts = array(
 393         "street_address" => "billing_street_address-{$form->_bltID}",
 394         "city" => "billing_city-{$form->_bltID}",
 395         "postal_code" => "billing_postal_code-{$form->_bltID}",
 396         "state_province" => "state_province-{$form->_bltID}",
 397         "country" => "country-{$form->_bltID}",
 398       );
 399
 400       $addressFields = array();
 401       foreach ($addressParts as $name => $field) {
 402         $addressFields[$name] = CRM_Utils_Array::value($field, $params);
 403       }
 404       $form->assign('address', CRM_Utils_Address::format($addressFields));
 405
 406       $date = CRM_Utils_Date::format($params['credit_card_exp_date']);
 407       $date = CRM_Utils_Date::mysqlToIso($date);
 408       $form->assign('credit_card_type', CRM_Utils_Array::value('credit_card_type', $params));
 409       $form->assign('credit_card_exp_date', $date);
 410       $form->assign('credit_card_number',
 411         CRM_Utils_System::mungeCreditCard($params['credit_card_number'])
 412       );
 413     }
 414     else {
 415       //offline contribution
 416       // assigned various dates to the templates
 417       $form->assign('receipt_date', CRM_Utils_Date::processDate($params['receipt_date']));
 418
 419       if (!empty($params['cancel_date'])) {
 420         $form->assign('cancel_date', CRM_Utils_Date::processDate($params['cancel_date']));
 421       }
 422       if (!empty($params['thankyou_date'])) {
 423         $form->assign('thankyou_date', CRM_Utils_Date::processDate($params['thankyou_date']));
 424       }
 425       if ($form->_action & CRM_Core_Action::UPDATE) {
 426         $form->assign('lineItem', empty($form->_lineItems) ? FALSE : $form->_lineItems);
 427       }
 428     }
 429
 430     //handle custom data
 431     if (!empty($params['hidden_custom'])) {
 432       $contribParams = array(array('contribution_id', '=', $params['contribution_id'], 0, 0));
 433       if ($form->_mode == 'test') {
 434         $contribParams[] = array('contribution_test', '=', 1, 0, 0);
 435       }
 436
 437       //retrieve custom data
 438       $customGroup = array();
 439
 440       foreach ($form->_groupTree as $groupID => $group) {
 441         $customFields = $customValues = array();
 442         if ($groupID == 'info') {
 443           continue;
 444         }
 445         foreach ($group['fields'] as $k => $field) {
 446           $field['title'] = $field['label'];
 447           $customFields["custom_{$k}"] = $field;
 448         }
 449
 450         //build the array of customgroup contain customfields.
 451         CRM_Core_BAO_UFGroup::getValues($params['contact_id'], $customFields, $customValues, FALSE, $contribParams);
 452         $customGroup[$group['title']] = $customValues;
 453       }
 454       //assign all custom group and corresponding fields to template.
 455       $form->assign('customGroup', $customGroup);
 456     }
 457
 458     $form->assign_by_ref('formValues', $params);
 459     list($contributorDisplayName,
 460       $contributorEmail
 461       ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($params['contact_id']);
 462     $form->assign('contactID', $params['contact_id']);
 463     $form->assign('contributionID', $params['contribution_id']);
 464
 465     if (!empty($params['currency'])) {
 466       $form->assign('currency', $params['currency']);
 467     }
 468
 469     if (!empty($params['receive_date'])) {
 470       $form->assign('receive_date', CRM_Utils_Date::processDate($params['receive_date']));
 471     }
 472
 473     $template = CRM_Core_Smarty::singleton();
 474     $taxAmt = $template->get_template_vars('dataArray');
 475     $eventTaxAmt = $template->get_template_vars('totalTaxAmount');
 476     $prefixValue = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME, 'contribution_invoice_settings');
 477     $invoicing = CRM_Utils_Array::value('invoicing', $prefixValue);
 478     if ((!empty($taxAmt) || isset($eventTaxAmt)) && (isset($invoicing) && isset($prefixValue['is_email_pdf']))) {
 479       $isEmailPdf = TRUE;
 480     }
 481     else {
 482       $isEmailPdf = FALSE;
 483     }
 484
 485     list($sendReceipt, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate(
 486       array(
 487         'groupName' => 'msg_tpl_workflow_contribution',
 488         'valueName' => 'contribution_offline_receipt',
 489         'contactId' => $params['contact_id'],
 490         'contributionId' => $params['contribution_id'],
 491         'from' => $params['from_email_address'],
 492         'toName' => $contributorDisplayName,
 493         'toEmail' => $contributorEmail,
 494         'isTest' => $form->_mode == 'test',
 495         'PDFFilename' => ts('receipt') . '.pdf',
 496         'isEmailPdf' => $isEmailPdf,
 497       )
 498     );
 499
 500     return $sendReceipt;
 501   }
 502
 503 }