3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
33 class CRM_Contribute_Form_AdditionalInfo
{
36 * Build the form object for Premium Information.
38 * Called from the CRM_Contribute_Form_Contribute function and seemingly nowhere else.
40 * Probably this should be on the form that uses it since it is not used on multiple forms.
42 * Putting it on this class doesn't seem to reduce complexity.
44 * @param CRM_Core_Form $form
46 public static function buildPremium(&$form) {
48 $form->add('hidden', 'hidden_Premium', 1);
51 $dao = new CRM_Contribute_DAO_Product();
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);
63 if ($options[0] != '') {
64 $sel2[$dao->id
] = $options;
66 $form->assign('premiums', TRUE);
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();
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";
80 $sel->setOptions([$sel1, $sel2]);
82 $form->assign('initHideBoxes', $js);
84 $form->add('datepicker', 'fulfilled_date', ts('Fulfilled'), [], FALSE, ['time' => FALSE]);
85 $form->addElement('text', 'min_amount', ts('Minimum Contribution Amount'));
89 * Build the form object for Additional Details.
91 * @param CRM_Core_Form $form
93 public static function buildAdditionalDetail(&$form) {
94 //Additional information section
95 $form->add('hidden', 'hidden_AdditionalDetail', 1);
97 $attributes = CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution');
99 $form->addField('thankyou_date', ['entity' => 'contribution'], FALSE, FALSE);
101 // add various amounts
102 $nonDeductAmount = &$form->add('text', 'non_deductible_amount', ts('Non-deductible Amount'),
103 $attributes['non_deductible_amount']
105 $form->addRule('non_deductible_amount', ts('Please enter a valid monetary value for Non-deductible Amount.'), 'money');
107 if ($form->_online
) {
108 $nonDeductAmount->freeze();
110 $feeAmount = &$form->add('text', 'fee_amount', ts('Fee Amount'),
111 $attributes['fee_amount']
113 $form->addRule('fee_amount', ts('Please enter a valid monetary value for Fee Amount.'), 'money');
114 if ($form->_online
) {
115 $feeAmount->freeze();
118 $element = &$form->add('text', 'invoice_id', ts('Invoice ID'),
119 $attributes['invoice_id']
121 if ($form->_online
) {
125 $form->addRule('invoice_id',
126 ts('This Invoice ID already exists in the database.'),
128 ['CRM_Contribute_DAO_Contribution', $form->_id
, 'invoice_id']
131 $element = $form->add('text', 'creditnote_id', ts('Credit Note ID'),
132 $attributes['creditnote_id']
134 if ($form->_online
) {
138 $form->addRule('creditnote_id',
139 ts('This Credit Note ID already exists in the database.'),
141 ['CRM_Contribute_DAO_Contribution', $form->_id
, 'creditnote_id']
145 $form->add('select', 'contribution_page_id',
146 ts('Online Contribution Page'),
148 '' => ts('- select -'),
150 CRM_Contribute_PseudoConstant
::contributionPage()
153 $form->add('textarea', 'note', ts('Notes'), ["rows" => 4, "cols" => 60]);
155 $statusName = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
156 if ($form->_id
&& $form->_values
['contribution_status_id'] == array_search('Cancelled', $statusName)) {
157 $feeAmount->freeze();
163 * used by CRM/Pledge/Form/Pledge.php
165 * Build the form object for PaymentReminders Information.
167 * @param CRM_Core_Form $form
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'), ['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'), ['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'), ['size' => 3]);
177 $form->addRule('additional_reminder_day', ts('Please enter a valid additional reminder day.'), 'positiveInteger');
181 * Process the Premium Information.
183 * @param array $params
184 * @param int $contributionID
185 * @param int $premiumID
186 * @param array $options
188 public static function processPremium($params, $contributionID, $premiumID = NULL, $options = []) {
189 $selectedProductID = $params['product_name'][0];
190 $selectedProductOptionID = CRM_Utils_Array
::value(1, $params['product_name']);
192 $dao = new CRM_Contribute_DAO_ContributionProduct();
193 $dao->contribution_id
= $contributionID;
194 $dao->product_id
= $selectedProductID;
195 $dao->fulfilled_date
= $params['fulfilled_date'];
200 'id' => $selectedProductID,
203 $productDetails = [];
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];
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;
217 $ContributionProduct->delete();
224 if ($premiumID == NULL ||
$isDeleted) {
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,
232 $premiumParams['oldPremium']['product_id'] = $ContributionProduct->product_id
;
233 $premiumParams['oldPremium']['contribution_id'] = $ContributionProduct->contribution_id
;
235 CRM_Core_BAO_FinancialTrxn
::createPremiumTrxn($premiumParams);
243 * @param array $params
244 * @param int $contactID
245 * @param int $contributionID
246 * @param int $contributionNoteID
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);
255 'entity_table' => 'civicrm_contribution',
256 'note' => $params['note'],
257 'entity_id' => $contributionID,
258 'contact_id' => $contactID,
261 if ($contributionNoteID) {
262 $noteID = ["id" => $contributionNoteID];
263 $noteParams['note'] = $noteParams['note'] ?
$noteParams['note'] : "null";
265 CRM_Core_BAO_Note
::add($noteParams, $noteID);
269 * Process the Common data.
271 * @param array $params
272 * @param array $formatted
273 * @param CRM_Core_Form $form
275 public static function postProcessCommon(&$params, &$formatted, &$form) {
277 'non_deductible_amount',
284 'contribution_page_id',
286 foreach ($fields as $f) {
287 $formatted[$f] = CRM_Utils_Array
::value($f, $params);
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']);
294 $formatted['thankyou_date'] = 'null';
297 if (!empty($params['is_email_receipt'])) {
298 $params['receipt_date'] = $formatted['receipt_date'] = date('YmdHis');
301 //special case to handle if all checkboxes are unchecked
302 $customFields = CRM_Core_BAO_CustomField
::getFields('Contribution',
305 CRM_Utils_Array
::value('financial_type_id',
309 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
310 CRM_Utils_Array
::value('id', $params, NULL),
316 * Send email receipt.
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.
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']);
340 // retrieve individual prefix value for honoree
341 if (isset($params['soft_credit'])) {
342 $softCreditTypes = $softCredits = [];
343 foreach ($params['soft_credit'] as $key => $softCredit) {
344 $softCredits[$key] = [
345 'Name' => $softCredit['contact_name'],
346 'Amount' => CRM_Utils_Money
::format($softCredit['amount'], $softCredit['currency']),
348 $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
350 $form->assign('softCreditTypes', $softCreditTypes);
351 $form->assign('softCredits', $softCredits);
354 // retrieve premium product name and assigned fulfilled
356 if (!empty($params['hidden_Premium'])) {
357 if (isset($params['product_name']) &&
358 is_array($params['product_name']) &&
359 !empty($params['product_name'])
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
;
368 if (empty($params['product_option']) && !empty($form->_options
[$productDAO->id
])) {
369 $params['product_option'] = $form->_options
[$productDAO->id
][$productOptionID];
372 if (!empty($params['fulfilled_date'])) {
373 $form->assign('fulfilled_date', $params['fulfilled_date']);
377 $form->assign('ccContribution', $ccContribution);
378 if ($ccContribution) {
379 $form->assignBillingName($params);
380 $form->assign('address', CRM_Utils_Address
::getFormattedBillingAddressFieldsFromParameters(
385 $date = CRM_Utils_Date
::format($params['credit_card_exp_date']);
386 $date = CRM_Utils_Date
::mysqlToIso($date);
387 $form->assign('credit_card_type', CRM_Utils_Array
::value('credit_card_type', $params));
388 $form->assign('credit_card_exp_date', $date);
389 $form->assign('credit_card_number',
390 CRM_Utils_System
::mungeCreditCard($params['credit_card_number'])
394 //offline contribution
395 // assigned various dates to the templates
396 $form->assign('receipt_date', CRM_Utils_Date
::processDate($params['receipt_date']));
398 if (!empty($params['cancel_date'])) {
399 $form->assign('cancel_date', CRM_Utils_Date
::processDate($params['cancel_date']));
401 if (!empty($params['thankyou_date'])) {
402 $form->assign('thankyou_date', CRM_Utils_Date
::processDate($params['thankyou_date']));
404 if ($form->_action
& CRM_Core_Action
::UPDATE
) {
405 $form->assign('lineItem', empty($form->_lineItems
) ?
FALSE : $form->_lineItems
);
410 if (!empty($params['hidden_custom'])) {
411 $contribParams = [['contribution_id', '=', $params['contribution_id'], 0, 0]];
412 if ($form->_mode
== 'test') {
413 $contribParams[] = ['contribution_test', '=', 1, 0, 0];
416 //retrieve custom data
419 foreach ($form->_groupTree
as $groupID => $group) {
420 $customFields = $customValues = [];
421 if ($groupID == 'info') {
424 foreach ($group['fields'] as $k => $field) {
425 $field['title'] = $field['label'];
426 $customFields["custom_{$k}"] = $field;
429 //build the array of customgroup contain customfields.
430 CRM_Core_BAO_UFGroup
::getValues($params['contact_id'], $customFields, $customValues, FALSE, $contribParams);
431 $customGroup[$group['title']] = $customValues;
433 //assign all custom group and corresponding fields to template.
434 $form->assign('customGroup', $customGroup);
437 $form->assign_by_ref('formValues', $params);
438 list($contributorDisplayName,
440 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($params['contact_id']);
441 $form->assign('contactID', $params['contact_id']);
442 $form->assign('contributionID', $params['contribution_id']);
444 if (!empty($params['currency'])) {
445 $form->assign('currency', $params['currency']);
448 if (!empty($params['receive_date'])) {
449 $form->assign('receive_date', CRM_Utils_Date
::processDate($params['receive_date']));
452 $template = CRM_Core_Smarty
::singleton();
453 $taxAmt = $template->get_template_vars('dataArray');
454 $eventTaxAmt = $template->get_template_vars('totalTaxAmount');
455 $prefixValue = Civi
::settings()->get('contribution_invoice_settings');
456 $invoicing = CRM_Utils_Array
::value('invoicing', $prefixValue);
457 if ((!empty($taxAmt) ||
isset($eventTaxAmt)) && (isset($invoicing) && isset($prefixValue['is_email_pdf']))) {
464 list($sendReceipt, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
466 'groupName' => 'msg_tpl_workflow_contribution',
467 'valueName' => 'contribution_offline_receipt',
468 'contactId' => $params['contact_id'],
469 'contributionId' => $params['contribution_id'],
470 'from' => $params['from_email_address'],
471 'toName' => $contributorDisplayName,
472 'toEmail' => $contributorEmail,
473 'isTest' => $form->_mode
== 'test',
474 'PDFFilename' => ts('receipt') . '.pdf',
475 'isEmailPdf' => $isEmailPdf,