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
35 * This class contains Contribution Page related functions.
37 class CRM_Contribute_BAO_ContributionPage
extends CRM_Contribute_DAO_ContributionPage
{
40 * Creates a contribution page.
42 * @param array $params
44 * @return CRM_Contribute_DAO_ContributionPage
46 public static function create($params) {
47 $financialTypeId = NULL;
48 if (!empty($params['id']) && !CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution_page', $params['id'], NULL, 1)) {
49 $financialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage', $params['id'], 'financial_type_id');
52 if (isset($params['payment_processor']) && is_array($params['payment_processor'])) {
53 $params['payment_processor'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $params['payment_processor']);
55 $hook = empty($params['id']) ?
'create' : 'edit';
56 CRM_Utils_Hook
::pre($hook, 'ContributionPage', CRM_Utils_Array
::value('id', $params), $params);
57 $dao = new CRM_Contribute_DAO_ContributionPage();
58 $dao->copyValues($params);
60 if ($financialTypeId && !empty($params['financial_type_id']) && $financialTypeId != $params['financial_type_id']) {
61 CRM_Price_BAO_PriceFieldValue
::updateFinancialType($params['id'], 'civicrm_contribution_page', $params['financial_type_id']);
63 CRM_Utils_Hook
::post($hook, 'ContributionPage', $dao->id
, $dao);
68 * Update the is_active flag in the db.
70 * @deprecated - this bypasses hooks.
73 * Id of the database record.
74 * @param bool $is_active
75 * Value we want to set the is_active field.
78 * true if we found and updated the object, else false
80 public static function setIsActive($id, $is_active) {
81 return CRM_Core_DAO
::setFieldValue('CRM_Contribute_DAO_ContributionPage', $id, 'is_active', $is_active);
85 * Load values for a contribution page.
88 * @param array $values
90 public static function setValues($id, &$values) {
91 $modules = ['CiviContribute', 'soft_credit', 'on_behalf'];
92 $values['custom_pre_id'] = $values['custom_post_id'] = NULL;
94 $params = ['id' => $id];
95 CRM_Core_DAO
::commonRetrieve('CRM_Contribute_DAO_ContributionPage', $params, $values);
97 // get the profile ids
99 'entity_table' => 'civicrm_contribution_page',
103 // retrieve profile id as also unserialize module_data corresponding to each $module
104 foreach ($modules as $module) {
105 $ufJoinParams['module'] = $module;
106 $ufJoin = new CRM_Core_DAO_UFJoin();
107 $ufJoin->copyValues($ufJoinParams);
108 if ($module == 'CiviContribute') {
109 $ufJoin->orderBy('weight asc');
111 while ($ufJoin->fetch()) {
112 if ($ufJoin->weight
== 1) {
113 $values['custom_pre_id'] = $ufJoin->uf_group_id
;
116 $values['custom_post_id'] = $ufJoin->uf_group_id
;
122 if (!$ufJoin->is_active
) {
125 $params = CRM_Contribute_BAO_ContributionPage
::formatModuleData($ufJoin->module_data
, TRUE, $module);
126 $values = array_merge($params, $values);
127 if ($module == 'soft_credit') {
128 $values['honoree_profile_id'] = $ufJoin->uf_group_id
;
129 $values['honor_block_is_active'] = $ufJoin->is_active
;
132 $values['onbehalf_profile_id'] = $ufJoin->uf_group_id
;
141 * @param int $contactID
143 * @param array $values
144 * Associated array of fields.
145 * @param bool $isTest
147 * @param bool $returnMessageText
148 * Return the message text instead of sending the mail.
150 * @param array $fieldTypes
152 public static function sendMail($contactID, $values, $isTest = FALSE, $returnMessageText = FALSE, $fieldTypes = NULL) {
154 $params = ['custom_pre_id' => [], 'custom_post_id' => []];
157 // We are trying to fight the good fight against leaky variables (CRM-17519) so let's get really explicit
158 // about ensuring the variables we want for the template are defined.
159 // @todo add to this until all tpl params are explicit in this function and not waltzing around the codebase.
160 // Next stage is to remove this & ensure there are no e-notices - ie. all are set before they hit this fn.
161 $valuesRequiredForTemplate = [
164 'customPre_grouptitle',
165 'customPost_grouptitle',
173 foreach ($valuesRequiredForTemplate as $valueRequiredForTemplate) {
174 if (!isset($values[$valueRequiredForTemplate])) {
175 $values[$valueRequiredForTemplate] = NULL;
179 if (isset($values['custom_pre_id'])) {
180 $preProfileType = CRM_Core_BAO_UFField
::getProfileType($values['custom_pre_id']);
181 if ($preProfileType == 'Membership' && !empty($values['membership_id'])) {
182 $params['custom_pre_id'] = [
186 $values['membership_id'],
192 elseif ($preProfileType == 'Contribution' && !empty($values['contribution_id'])) {
193 $params['custom_pre_id'] = [
197 $values['contribution_id'],
204 $gIds['custom_pre_id'] = $values['custom_pre_id'];
207 if (isset($values['custom_post_id'])) {
208 $postProfileType = CRM_Core_BAO_UFField
::getProfileType($values['custom_post_id']);
209 if ($postProfileType == 'Membership' && !empty($values['membership_id'])) {
210 $params['custom_post_id'] = [
214 $values['membership_id'],
220 elseif ($postProfileType == 'Contribution' && !empty($values['contribution_id'])) {
221 $params['custom_post_id'] = [
225 $values['contribution_id'],
232 $gIds['custom_post_id'] = $values['custom_post_id'];
235 if (!empty($values['is_for_organization'])) {
236 if (!empty($values['membership_id'])) {
237 $params['onbehalf_profile'] = [
241 $values['membership_id'],
247 elseif (!empty($values['contribution_id'])) {
248 $params['onbehalf_profile'] = [
252 $values['contribution_id'],
260 //check whether it is a test drive
261 if ($isTest && !empty($params['custom_pre_id'])) {
262 $params['custom_pre_id'][] = [
271 if ($isTest && !empty($params['custom_post_id'])) {
272 $params['custom_post_id'][] = [
281 if (!$returnMessageText && !empty($gIds)) {
282 //send notification email if field values are set (CRM-1941)
283 foreach ($gIds as $key => $gId) {
285 $email = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gId, 'notify');
287 $val = CRM_Core_BAO_UFGroup
::checkFieldsEmptyValues($gId, $contactID, CRM_Utils_Array
::value($key, $params), TRUE);
288 CRM_Core_BAO_UFGroup
::commonSendMail($contactID, $val);
294 if (!empty($values['is_email_receipt']) ||
!empty($values['onbehalf_dupe_alert']) ||
297 $template = CRM_Core_Smarty
::singleton();
299 // get the billing location type
300 if (!array_key_exists('related_contact', $values)) {
301 $billingLocationTypeId = CRM_Core_BAO_LocationType
::getBilling();
304 // presence of related contact implies onbehalf of org case,
305 // where location type is set to default.
306 $locType = CRM_Core_BAO_LocationType
::getDefault();
307 $billingLocationTypeId = $locType->id
;
310 if (!array_key_exists('related_contact', $values)) {
311 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID, FALSE, $billingLocationTypeId);
313 // get primary location email if no email exist( for billing location).
315 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID);
317 if (empty($displayName)) {
318 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID);
321 //for display profile need to get individual contact id,
322 //hence get it from related_contact if on behalf of org true CRM-3767
323 //CRM-5001 Contribution/Membership:: On Behalf of Organization,
324 //If profile GROUP contain the Individual type then consider the
325 //profile is of Individual ( including the custom data of membership/contribution )
326 //IF Individual type not present in profile then it is consider as Organization data.
327 $userID = $contactID;
328 if ($preID = CRM_Utils_Array
::value('custom_pre_id', $values)) {
329 if (!empty($values['related_contact'])) {
330 $preProfileTypes = CRM_Core_BAO_UFGroup
::profileGroups($preID);
331 //@todo - following line should not refer to undefined $postProfileTypes? figure out way to test
332 if (in_array('Individual', $preProfileTypes) ||
in_array('Contact', $postProfileTypes)) {
333 //Take Individual contact ID
334 $userID = CRM_Utils_Array
::value('related_contact', $values);
337 list($values['customPre_grouptitle'], $values['customPre']) = self
::getProfileNameAndFields($preID, $userID, $params['custom_pre_id']);
339 $userID = $contactID;
340 if ($postID = CRM_Utils_Array
::value('custom_post_id', $values)) {
341 if (!empty($values['related_contact'])) {
342 $postProfileTypes = CRM_Core_BAO_UFGroup
::profileGroups($postID);
343 if (in_array('Individual', $postProfileTypes) ||
in_array('Contact', $postProfileTypes)) {
344 //Take Individual contact ID
345 $userID = CRM_Utils_Array
::value('related_contact', $values);
348 list($values['customPost_grouptitle'], $values['customPost']) = self
::getProfileNameAndFields($postID, $userID, $params['custom_post_id']);
350 if (isset($values['honor'])) {
351 $honorValues = $values['honor'];
352 $template->_values
= ['honoree_profile_id' => $values['honoree_profile_id']];
353 CRM_Contribute_BAO_ContributionSoft
::formatHonoreeProfileFields(
355 $honorValues['honor_profile_values'],
356 $honorValues['honor_id']
360 $title = isset($values['title']) ?
$values['title'] : CRM_Contribute_PseudoConstant
::contributionPage($values['contribution_page_id']);
362 // Set email variables explicitly to avoid leaky smarty variables.
363 // All of these will be assigned to the template, replacing any that might be assigned elsewhere.
366 'receiptFromEmail' => CRM_Utils_Array
::value('receipt_from_email', $values),
367 'contactID' => $contactID,
368 'displayName' => $displayName,
369 'contributionID' => CRM_Utils_Array
::value('contribution_id', $values),
370 'contributionOtherID' => CRM_Utils_Array
::value('contribution_other_id', $values),
372 'lineItem' => CRM_Utils_Array
::value('lineItem', $values),
374 'priceSetID' => CRM_Utils_Array
::value('priceSetID', $values),
376 'isShare' => CRM_Utils_Array
::value('is_share', $values),
377 'thankyou_title' => CRM_Utils_Array
::value('thankyou_title', $values),
378 'customPre' => $values['customPre'],
379 'customPre_grouptitle' => $values['customPre_grouptitle'],
380 'customPost' => $values['customPost'],
381 'customPost_grouptitle' => $values['customPost_grouptitle'],
382 'useForMember' => $values['useForMember'],
383 'membership_assign' => $values['membership_assign'],
384 'amount' => $values['amount'],
385 'is_pay_later' => $values['is_pay_later'],
386 'receipt_date' => !$values['receipt_date'] ?
NULL : date('YmdHis', strtotime($values['receipt_date'])),
387 'pay_later_receipt' => CRM_Utils_Array
::value('pay_later_receipt', $values),
388 'honor_block_is_active' => CRM_Utils_Array
::value('honor_block_is_active', $values),
389 'contributionStatus' => CRM_Utils_Array
::value('contribution_status', $values),
392 if ($contributionTypeId = CRM_Utils_Array
::value('financial_type_id', $values)) {
393 $tplParams['financialTypeId'] = $contributionTypeId;
394 $tplParams['financialTypeName'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType',
395 $contributionTypeId);
397 $tplParams['contributionTypeName'] = $tplParams['financialTypeName'];
398 $tplParams['contributionTypeId'] = $contributionTypeId;
401 if ($contributionPageId = CRM_Utils_Array
::value('id', $values)) {
402 $tplParams['contributionPageId'] = $contributionPageId;
405 // address required during receipt processing (pdf and email receipt)
406 if ($displayAddress = CRM_Utils_Array
::value('address', $values)) {
407 $tplParams['address'] = $displayAddress;
411 $originalCCReceipt = CRM_Utils_Array
::value('cc_receipt', $values);
413 // cc to related contacts of contributor OR the one who
414 // signs up. Is used for cases like - on behalf of
415 // contribution / signup ..etc
416 if (array_key_exists('related_contact', $values)) {
417 list($ccDisplayName, $ccEmail) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($values['related_contact']);
418 $ccMailId = "{$ccDisplayName} <{$ccEmail}>";
420 //@todo - this is the only place in this function where $values is altered - but I can't find any evidence it is used
421 $values['cc_receipt'] = !empty($values['cc_receipt']) ?
($values['cc_receipt'] . ',' . $ccMailId) : $ccMailId;
423 // reset primary-email in the template
424 $tplParams['email'] = $ccEmail;
426 $tplParams['onBehalfName'] = $displayName;
427 $tplParams['onBehalfEmail'] = $email;
429 if (!empty($values['onbehalf_profile_id'])) {
430 self
::buildCustomDisplay($values['onbehalf_profile_id'], 'onBehalfProfile', $contactID, $template, $params['onbehalf_profile'], $fieldTypes);
434 // use either the contribution or membership receipt, based on whether it’s a membership-related contrib or not
435 $sendTemplateParams = [
436 'groupName' => !empty($values['isMembership']) ?
'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
437 'valueName' => !empty($values['isMembership']) ?
'membership_online_receipt' : 'contribution_online_receipt',
438 'contactId' => $contactID,
439 'tplParams' => $tplParams,
441 'PDFFilename' => 'receipt.pdf',
444 if ($returnMessageText) {
445 list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
447 'subject' => $subject,
449 'to' => $displayName,
454 if (empty($values['receipt_from_name']) && empty($values['receipt_from_name'])) {
455 list($values['receipt_from_name'], $values['receipt_from_email']) = CRM_Core_BAO_Domain
::getNameAndEmail();
458 if ($values['is_email_receipt']) {
459 $sendTemplateParams['from'] = CRM_Utils_Array
::value('receipt_from_name', $values) . ' <' . $values['receipt_from_email'] . '>';
460 $sendTemplateParams['toName'] = $displayName;
461 $sendTemplateParams['toEmail'] = $email;
462 $sendTemplateParams['cc'] = CRM_Utils_Array
::value('cc_receipt', $values);
463 $sendTemplateParams['bcc'] = CRM_Utils_Array
::value('bcc_receipt', $values);
464 //send email with pdf invoice
465 $template = CRM_Core_Smarty
::singleton();
466 $taxAmt = $template->get_template_vars('dataArray');
467 $prefixValue = Civi
::settings()->get('contribution_invoice_settings');
468 $invoicing = CRM_Utils_Array
::value('invoicing', $prefixValue);
469 if (isset($invoicing) && isset($prefixValue['is_email_pdf'])) {
470 $sendTemplateParams['isEmailPdf'] = TRUE;
471 $sendTemplateParams['contributionId'] = $values['contribution_id'];
473 list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
476 // send duplicate alert, if dupe match found during on-behalf-of processing.
477 if (!empty($values['onbehalf_dupe_alert'])) {
478 $sendTemplateParams['groupName'] = 'msg_tpl_workflow_contribution';
479 $sendTemplateParams['valueName'] = 'contribution_dupalert';
480 $sendTemplateParams['from'] = ts('Automatically Generated') . " <{$values['receipt_from_email']}>";
481 $sendTemplateParams['toName'] = CRM_Utils_Array
::value('receipt_from_name', $values);
482 $sendTemplateParams['toEmail'] = CRM_Utils_Array
::value('receipt_from_email', $values);
483 $sendTemplateParams['tplParams']['onBehalfID'] = $contactID;
484 $sendTemplateParams['tplParams']['receiptMessage'] = $message;
486 // fix cc and reset back to original, CRM-6976
487 $sendTemplateParams['cc'] = $originalCCReceipt;
489 CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
495 * Get the profile title and fields.
499 * @param array $params
500 * @param array $fieldTypes
504 protected static function getProfileNameAndFields($gid, $cid, &$params, $fieldTypes = []) {
508 if (CRM_Core_BAO_UFGroup
::filterUFGroups($gid, $cid)) {
509 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::VIEW
, NULL, NULL, FALSE, NULL, FALSE, NULL, CRM_Core_Permission
::CREATE
, NULL);
510 foreach ($fields as $k => $v) {
512 $groupTitle = $v["groupTitle"];
514 // suppress all file fields from display and formatting fields
516 CRM_Utils_Array
::value('data_type', $v, '') == 'File' ||
517 CRM_Utils_Array
::value('name', $v, '') == 'image_URL' ||
518 CRM_Utils_Array
::value('field_type', $v) == 'Formatting'
523 if (!empty($fieldTypes) && (!in_array($v['field_type'], $fieldTypes))) {
528 CRM_Core_BAO_UFGroup
::getValues($cid, $fields, $values, FALSE, $params);
531 return [$groupTitle, $values];
535 * Send the emails for Recurring Contribution Notification.
537 * @param string $type
539 * @param int $contactID
540 * Contact id for contributor.
542 * Contribution page id.
543 * @param object $recur
544 * Object of recurring contribution table.
545 * @param bool|object $autoRenewMembership is it a auto renew membership.
547 public static function recurringNotify($type, $contactID, $pageID, $recur, $autoRenewMembership = FALSE) {
549 $isEmailReceipt = FALSE;
551 CRM_Core_DAO
::commonRetrieveAll('CRM_Contribute_DAO_ContributionPage', 'id', $pageID, $value, [
555 'receipt_from_email',
559 $isEmailReceipt = CRM_Utils_Array
::value('is_email_receipt', $value[$pageID]);
561 elseif ($recur->id
) {
562 // This means we are coming from back-office - ie. no page ID, but recurring.
563 // Ideally this information would be passed into the function clearly rather than guessing by convention.
564 $isEmailReceipt = TRUE;
567 if ($isEmailReceipt) {
569 $receiptFrom = '"' . CRM_Utils_Array
::value('receipt_from_name', $value[$pageID]) . '" <' . $value[$pageID]['receipt_from_email'] . '>';
571 $receiptFromName = $value[$pageID]['receipt_from_name'];
572 $receiptFromEmail = $value[$pageID]['receipt_from_email'];
575 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
576 $receiptFrom = "$domainValues[0] <$domainValues[1]>";
577 $receiptFromName = $domainValues[0];
578 $receiptFromEmail = $domainValues[1];
581 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID, FALSE);
583 'groupName' => 'msg_tpl_workflow_contribution',
584 'valueName' => 'contribution_recurring_notify',
585 'contactId' => $contactID,
587 'recur_frequency_interval' => $recur->frequency_interval
,
588 'recur_frequency_unit' => $recur->frequency_unit
,
589 'recur_installments' => $recur->installments
,
590 'recur_start_date' => $recur->start_date
,
591 'recur_end_date' => $recur->end_date
,
592 'recur_amount' => $recur->amount
,
593 'recur_txnType' => $type,
594 'displayName' => $displayName,
595 'receipt_from_name' => $receiptFromName,
596 'receipt_from_email' => $receiptFromEmail,
597 'auto_renew_membership' => $autoRenewMembership,
599 'from' => $receiptFrom,
600 'toName' => $displayName,
605 $templatesParams['cc'] = CRM_Utils_Array
::value('cc_receipt', $value[$pageID]);
606 $templatesParams['bcc'] = CRM_Utils_Array
::value('bcc_receipt', $value[$pageID]);
609 // in some cases its just recurringNotify() thats called for the first time and these urls don't get set.
610 // like in PaypalPro, & therefore we set it here additionally.
611 $template = CRM_Core_Smarty
::singleton();
612 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($recur->id
, 'recur', 'obj');
613 $url = $paymentProcessor->subscriptionURL($recur->id
, 'recur', 'cancel');
614 $template->assign('cancelSubscriptionUrl', $url);
616 $url = $paymentProcessor->subscriptionURL($recur->id
, 'recur', 'billing');
617 $template->assign('updateSubscriptionBillingUrl', $url);
619 $url = $paymentProcessor->subscriptionURL($recur->id
, 'recur', 'update');
620 $template->assign('updateSubscriptionUrl', $url);
623 list($sent) = CRM_Core_BAO_MessageTemplate
::sendTemplate($templatesParams);
626 CRM_Core_Error
::debug_log_message('Success: mail sent for recurring notification.');
629 CRM_Core_Error
::debug_log_message('Failure: mail not sent for recurring notification.');
635 * Add the custom fields for contribution page (ie profile).
637 * @deprecated assigning values to smarty like this is risky because
638 * - it is hard to debug since $name is used in the assign
639 * - it is potentially 'leaky' - it's better to do this on the form
640 * or close to where it is used / required. See CRM-17519 for leakage e.g.
644 * @param string $name
648 * @param array $params
649 * Params to build component whereclause.
651 * @param array|null $fieldTypes
653 public static function buildCustomDisplay($gid, $name, $cid, &$template, &$params, $fieldTypes = NULL) {
654 list($groupTitle, $values) = self
::getProfileNameAndFields($gid, $cid, $params, $fieldTypes);
655 if (!empty($values)) {
656 $template->assign($name, $values);
658 $template->assign($name . "_grouptitle", $groupTitle);
662 * Make a copy of a contribution page, including all the blocks in the page.
665 * The contribution page id to copy.
667 * @return CRM_Contribute_DAO_ContributionPage
669 public static function copy($id) {
672 'title' => ts('Copy of') . ' ',
675 $copy = CRM_Core_DAO
::copyGeneric('CRM_Contribute_DAO_ContributionPage', [
677 ], NULL, $fieldsFix);
679 //copying all the blocks pertaining to the contribution page
680 $copyPledgeBlock = CRM_Core_DAO
::copyGeneric('CRM_Pledge_DAO_PledgeBlock', [
682 'entity_table' => 'civicrm_contribution_page',
684 'entity_id' => $copy->id
,
687 $copyMembershipBlock = CRM_Core_DAO
::copyGeneric('CRM_Member_DAO_MembershipBlock', [
689 'entity_table' => 'civicrm_contribution_page',
691 'entity_id' => $copy->id
,
694 $copyUFJoin = CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_UFJoin', [
696 'entity_table' => 'civicrm_contribution_page',
698 'entity_id' => $copy->id
,
701 $copyWidget = CRM_Core_DAO
::copyGeneric('CRM_Contribute_DAO_Widget', [
702 'contribution_page_id' => $id,
704 'contribution_page_id' => $copy->id
,
708 CRM_Price_BAO_PriceSet
::copyPriceSet('civicrm_contribution_page', $id, $copy->id
);
710 $copyTellFriend = CRM_Core_DAO
::copyGeneric('CRM_Friend_DAO_Friend', [
712 'entity_table' => 'civicrm_contribution_page',
714 'entity_id' => $copy->id
,
717 $copyPersonalCampaignPages = CRM_Core_DAO
::copyGeneric('CRM_PCP_DAO_PCPBlock', [
719 'entity_table' => 'civicrm_contribution_page',
721 'entity_id' => $copy->id
,
722 'target_entity_id' => $copy->id
,
725 $copyPremium = CRM_Core_DAO
::copyGeneric('CRM_Contribute_DAO_Premium', [
727 'entity_table' => 'civicrm_contribution_page',
729 'entity_id' => $copy->id
,
733 FROM civicrm_premiums
734 WHERE entity_table = 'civicrm_contribution_page'
735 AND entity_id ={$id}";
737 $premiumDao = CRM_Core_DAO
::executeQuery($premiumQuery);
738 while ($premiumDao->fetch()) {
739 if ($premiumDao->id
) {
740 CRM_Core_DAO
::copyGeneric('CRM_Contribute_DAO_PremiumsProduct', [
741 'premiums_id' => $premiumDao->id
,
743 'premiums_id' => $copyPremium->id
,
750 CRM_Utils_Hook
::copy('ContributionPage', $copy);
756 * Get info for all sections enable/disable.
758 * @param array $contribPageIds
760 * info regarding all sections.
762 public static function getSectionInfo($contribPageIds = []) {
765 if (is_array($contribPageIds) && !empty($contribPageIds)) {
766 $whereClause = 'WHERE civicrm_contribution_page.id IN ( ' . implode(', ', $contribPageIds) . ' )';
781 SELECT civicrm_contribution_page.id as id,
782 civicrm_contribution_page.financial_type_id as settings,
783 amount_block_is_active as amount,
784 civicrm_membership_block.id as membership,
785 civicrm_uf_join.id as custom,
786 civicrm_contribution_page.thankyou_title as thankyou,
787 civicrm_tell_friend.id as friend,
788 civicrm_pcp_block.id as pcp,
789 civicrm_contribution_widget.id as widget,
790 civicrm_premiums.id as premium
791 FROM civicrm_contribution_page
792 LEFT JOIN civicrm_membership_block ON ( civicrm_membership_block.entity_id = civicrm_contribution_page.id
793 AND civicrm_membership_block.entity_table = 'civicrm_contribution_page'
794 AND civicrm_membership_block.is_active = 1 )
795 LEFT JOIN civicrm_uf_join ON ( civicrm_uf_join.entity_id = civicrm_contribution_page.id
796 AND civicrm_uf_join.entity_table = 'civicrm_contribution_page'
797 AND module = 'CiviContribute'
798 AND civicrm_uf_join.is_active = 1 )
799 LEFT JOIN civicrm_tell_friend ON ( civicrm_tell_friend.entity_id = civicrm_contribution_page.id
800 AND civicrm_tell_friend.entity_table = 'civicrm_contribution_page'
801 AND civicrm_tell_friend.is_active = 1)
802 LEFT JOIN civicrm_pcp_block ON ( civicrm_pcp_block.entity_id = civicrm_contribution_page.id
803 AND civicrm_pcp_block.entity_table = 'civicrm_contribution_page'
804 AND civicrm_pcp_block.is_active = 1 )
805 LEFT JOIN civicrm_contribution_widget ON ( civicrm_contribution_widget.contribution_page_id = civicrm_contribution_page.id
806 AND civicrm_contribution_widget.is_active = 1 )
807 LEFT JOIN civicrm_premiums ON ( civicrm_premiums.entity_id = civicrm_contribution_page.id
808 AND civicrm_premiums.entity_table = 'civicrm_contribution_page'
809 AND civicrm_premiums.premiums_active = 1 )
812 $contributionPage = CRM_Core_DAO
::executeQuery($query);
813 while ($contributionPage->fetch()) {
814 if (!isset($info[$contributionPage->id
]) ||
!is_array($info[$contributionPage->id
])) {
815 $info[$contributionPage->id
] = array_fill_keys(array_values($sections), FALSE);
817 foreach ($sections as $section) {
818 if ($contributionPage->$section) {
819 $info[$contributionPage->id
][$section] = TRUE;
828 * Get options for a given field.
829 * @see CRM_Core_DAO::buildOptions
831 * @param string $fieldName
832 * @param string $context : @see CRM_Core_DAO::buildOptionsContext
833 * @param array $props : whatever is known about this dao object
837 public static function buildOptions($fieldName, $context = NULL, $props = []) {
839 // Special logic for fields whose options depend on context or properties
840 switch ($fieldName) {
841 case 'financial_type_id':
842 // Fixme - this is going to ignore context, better to get conditions, add params, and call PseudoConstant::get
843 return CRM_Financial_BAO_FinancialType
::getIncomeFinancialType();
847 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);
851 * Get or Set honor/on_behalf params for processing module_data or setting default values.
853 * @param array $params :
854 * @param bool $setDefault : If yes then returns array to used for setting default value afterward
855 * @param string $module : processing module_data for which module? e.g. soft_credit, on_behalf
857 * @return array|string
859 public static function formatModuleData($params, $setDefault = FALSE, $module) {
860 $tsLocale = CRM_Core_I18n
::getLocale();
861 $config = CRM_Core_Config
::singleton();
862 $json = $jsonDecode = NULL;
863 $domain = new CRM_Core_DAO_Domain();
866 $moduleDataFormat = [
868 1 => 'soft_credit_types',
875 1 => 'is_for_organization',
882 //When we are fetching the honor params respecting both multi and mono lingual state
883 //and setting it to default param of Contribution Page's Main and Setting form
885 $jsonDecode = json_decode($params);
886 $jsonDecode = (array) $jsonDecode->$module;
887 if (!$domain->locales
&& !empty($jsonDecode['default'])) {
889 $jsonDecode +
= (array) $jsonDecode['default'];
890 unset($jsonDecode['default']);
892 elseif (!empty($jsonDecode[$tsLocale])) {
894 foreach ($jsonDecode[$tsLocale] as $column => $value) {
895 $jsonDecode[$column] = $value;
897 unset($jsonDecode[$tsLocale]);
902 //check and handle multilingual honoree params
903 if (!$domain->locales
) {
904 //if in singlelingual state simply return the array format
905 $json = [$module => NULL];
906 foreach ($moduleDataFormat[$module] as $key => $attribute) {
907 if ($key === 'multilingual') {
908 $json[$module]['default'] = [];
909 foreach ($attribute as $attr) {
910 $json[$module]['default'][$attr] = $params[$attr];
914 $json[$module][$attribute] = $params[$attribute];
917 $json = json_encode($json);
920 //if in multilingual state then retrieve the module_data against this contribution and
921 //merge with earlier module_data json data to current so not to lose earlier multilingual module_data information
922 $json = [$module => NULL];
923 foreach ($moduleDataFormat[$module] as $key => $attribute) {
924 if ($key === 'multilingual') {
925 $json[$module][$config->lcMessages
] = [];
926 foreach ($attribute as $attr) {
927 $json[$module][$config->lcMessages
][$attr] = $params[$attr];
931 $json[$module][$attribute] = $params[$attribute];
935 $ufJoinDAO = new CRM_Core_DAO_UFJoin();
936 $ufJoinDAO->module
= $module;
937 $ufJoinDAO->entity_id
= $params['id'];
938 $ufJoinDAO->find(TRUE);
939 $jsonData = json_decode($ufJoinDAO->module_data
);
941 $json[$module] = array_merge((array) $jsonData->$module, $json[$module]);
943 $json = json_encode($json);
949 * Generate html for pdf in confirmation receipt email attachment.
950 * @param int $contributionId
951 * Contribution Page Id.
953 * Contact id for contributor.
956 public static function addInvoicePdfToEmail($contributionId, $userID) {
957 $contributionID = [$contributionId];
958 $contactId = [$userID];
960 'output' => 'pdf_invoice',
961 'forPage' => 'confirmpage',
963 $pdfHtml = CRM_Contribute_Form_Task_Invoice
::printPDF($contributionID, $pdfParams, $contactId);
968 * Helper to determine if the page supports separate membership payments.
970 * @param int $id form id
973 * isSeparateMembershipPayment
975 public static function getIsMembershipPayment($id) {
976 $membershipBlocks = civicrm_api3('membership_block', 'get', [
977 'entity_table' => 'civicrm_contribution_page',
979 'sequential' => TRUE,
981 if (!$membershipBlocks['count']) {
984 return $membershipBlocks['values'][0]['is_separate_payment'];