3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * This class contains Contribution Page related functions.
39 class CRM_Contribute_BAO_ContributionPage
extends CRM_Contribute_DAO_ContributionPage
{
42 * takes an associative array and creates a contribution page object
44 * @param array $params (reference ) an assoc array of name/value pairs
46 * @return object CRM_Contribute_DAO_ContributionPage object
50 public static function &create(&$params) {
51 $financialTypeId = NULL;
52 if (!empty($params['id']) && !CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution_page', $params['id'], NULL, 1)) {
53 $financialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage', $params['id'], 'financial_type_id');
55 $dao = new CRM_Contribute_DAO_ContributionPage();
56 $dao->copyValues($params);
58 if ($financialTypeId && !empty($params['financial_type_id']) && $financialTypeId != $params['financial_type_id']) {
59 CRM_Price_BAO_PriceFieldValue
::updateFinancialType($params['id'], 'civicrm_contribution_page', $params['financial_type_id']);
65 * update the is_active flag in the db
67 * @param int $id id of the database record
68 * @param boolean $is_active value we want to set the is_active field
70 * @return Object DAO object on success, null otherwise
73 static function setIsActive($id, $is_active) {
74 return CRM_Core_DAO
::setFieldValue('CRM_Contribute_DAO_ContributionPage', $id, 'is_active', $is_active);
81 static function setValues($id, &$values) {
86 CRM_Core_DAO
::commonRetrieve('CRM_Contribute_DAO_ContributionPage', $params, $values);
88 // get the profile ids
89 $ufJoinParams = array(
90 'module' => 'CiviContribute',
91 'entity_table' => 'civicrm_contribution_page',
94 list($values['custom_pre_id'], $customPostIds) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
96 if (!empty($customPostIds)) {
97 $values['custom_post_id'] = $customPostIds[0];
100 $values['custom_post_id'] = '';
102 // // add an accounting code also
103 // if ($values ['financial_type_id']) {
104 // $values ['accountingCode'] = CRM_Core_DAO::getFieldValue( 'CRM_Financial_DAO_FinancialType', $values ['financial_type_id'], 'accounting_code' );
109 * Function to send the emails
111 * @param int $contactID contact id
112 * @param array $values associated array of fields
113 * @param boolean $isTest if in test mode
114 * @param boolean $returnMessageText return the message text instead of sending the mail
116 * @param null $fieldTypes
122 static function sendMail($contactID, $values, $isTest = FALSE, $returnMessageText = FALSE, $fieldTypes = NULL) {
123 $gIds = $params = array();
125 if (isset($values['custom_pre_id'])) {
126 $preProfileType = CRM_Core_BAO_UFField
::getProfileType($values['custom_pre_id']);
127 if ($preProfileType == 'Membership' && !empty($values['membership_id'])) {
128 $params['custom_pre_id'] = array(
132 $values['membership_id'],
138 elseif ($preProfileType == 'Contribution' && !empty($values['contribution_id'])) {
139 $params['custom_pre_id'] = array(
143 $values['contribution_id'],
150 $gIds['custom_pre_id'] = $values['custom_pre_id'];
153 if (isset($values['custom_post_id'])) {
154 $postProfileType = CRM_Core_BAO_UFField
::getProfileType($values['custom_post_id']);
155 if ($postProfileType == 'Membership' && !empty($values['membership_id'])) {
156 $params['custom_post_id'] = array(
160 $values['membership_id'],
166 elseif ($postProfileType == 'Contribution' && !empty($values['contribution_id'])) {
167 $params['custom_post_id'] = array(
171 $values['contribution_id'],
178 $gIds['custom_post_id'] = $values['custom_post_id'];
181 if (!empty($values['is_for_organization'])) {
182 if (!empty($values['membership_id'])) {
183 $params['onbehalf_profile'] = array(
187 $values['membership_id'],
193 elseif (!empty($values['contribution_id'])) {
194 $params['onbehalf_profile'] = array(
198 $values['contribution_id'],
206 //check whether it is a test drive
207 if ($isTest && !empty($params['custom_pre_id'])) {
208 $params['custom_pre_id'][] = array(
217 if ($isTest && !empty($params['custom_post_id'])) {
218 $params['custom_post_id'][] = array(
227 if (!$returnMessageText && !empty($gIds)) {
228 //send notification email if field values are set (CRM-1941)
229 foreach ($gIds as $key => $gId) {
231 $email = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gId, 'notify');
233 $val = CRM_Core_BAO_UFGroup
::checkFieldsEmptyValues($gId, $contactID, CRM_Utils_Array
::value($key, $params), true );
234 CRM_Core_BAO_UFGroup
::commonSendMail($contactID, $val);
240 if (!empty($values['is_email_receipt']) ||
!empty($values['onbehalf_dupe_alert']) ||
243 $template = CRM_Core_Smarty
::singleton();
245 // get the billing location type
246 if (!array_key_exists('related_contact', $values)) {
247 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id', array(), 'validate');
248 $billingLocationTypeId = array_search('Billing', $locationTypes);
251 // presence of related contact implies onbehalf of org case,
252 // where location type is set to default.
253 $locType = CRM_Core_BAO_LocationType
::getDefault();
254 $billingLocationTypeId = $locType->id
;
257 if (!array_key_exists('related_contact', $values)) {
258 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID, FALSE, $billingLocationTypeId);
260 // get primary location email if no email exist( for billing location).
262 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID);
264 if (empty($displayName)) {
265 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID);
268 //for display profile need to get individual contact id,
269 //hence get it from related_contact if on behalf of org true CRM-3767
270 //CRM-5001 Contribution/Membership:: On Behalf of Organization,
271 //If profile GROUP contain the Individual type then consider the
272 //profile is of Individual ( including the custom data of membership/contribution )
273 //IF Individual type not present in profile then it is consider as Organization data.
274 $userID = $contactID;
275 if ($preID = CRM_Utils_Array
::value('custom_pre_id', $values)) {
276 if (!empty($values['related_contact'])) {
277 $preProfileTypes = CRM_Core_BAO_UFGroup
::profileGroups($preID);
278 //@todo - following line should not refer to undefined $postProfileTypes? figure out way to test
279 if (in_array('Individual', $preProfileTypes) ||
in_array('Contact', $postProfileTypes)) {
280 //Take Individual contact ID
281 $userID = CRM_Utils_Array
::value('related_contact', $values);
284 self
::buildCustomDisplay($preID, 'customPre', $userID, $template, $params['custom_pre_id']);
286 $userID = $contactID;
287 if ($postID = CRM_Utils_Array
::value('custom_post_id', $values)) {
288 if (!empty($values['related_contact'])) {
289 $postProfileTypes = CRM_Core_BAO_UFGroup
::profileGroups($postID);
290 if (in_array('Individual', $postProfileTypes) ||
in_array('Contact', $postProfileTypes)) {
291 //Take Individual contact ID
292 $userID = CRM_Utils_Array
::value('related_contact', $values);
295 self
::buildCustomDisplay($postID, 'customPost', $userID, $template, $params['custom_post_id']);
297 if (isset($values['honor'])) {
298 $honorValues = $values['honor'];
299 CRM_Contribute_BAO_ContributionSoft
::formatHonoreeProfileFields(
301 $honorValues['honor_profile_values'],
302 $honorValues['honor_profile_id'],
303 $honorValues['honor_id']
307 $title = isset($values['title']) ?
$values['title'] : CRM_Contribute_PseudoConstant
::contributionPage($values['contribution_page_id']);
309 // set email in the template here
312 'receiptFromEmail' => CRM_Utils_Array
::value('receipt_from_email', $values),
313 'contactID' => $contactID,
314 'displayName' => $displayName,
315 'contributionID' => CRM_Utils_Array
::value('contribution_id', $values),
316 'contributionOtherID' => CRM_Utils_Array
::value('contribution_other_id', $values),
317 'membershipID' => CRM_Utils_Array
::value('membership_id', $values),
319 'lineItem' => CRM_Utils_Array
::value('lineItem', $values),
321 'priceSetID' => CRM_Utils_Array
::value('priceSetID', $values),
323 'isShare' => CRM_Utils_Array
::value('is_share', $values),
326 if ($contributionTypeId = CRM_Utils_Array
::value('financial_type_id', $values)) {
327 $tplParams['contributionTypeId'] = $contributionTypeId;
328 $tplParams['contributionTypeName'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType',
329 $contributionTypeId);
332 if ($contributionPageId = CRM_Utils_Array
::value('id', $values)) {
333 $tplParams['contributionPageId'] = $contributionPageId;
336 // address required during receipt processing (pdf and email receipt)
337 if ($displayAddress = CRM_Utils_Array
::value('address', $values)) {
338 $tplParams['address'] = $displayAddress;
342 $originalCCReceipt = CRM_Utils_Array
::value('cc_receipt', $values);
344 // cc to related contacts of contributor OR the one who
345 // signs up. Is used for cases like - on behalf of
346 // contribution / signup ..etc
347 if (array_key_exists('related_contact', $values)) {
348 list($ccDisplayName, $ccEmail) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($values['related_contact']);
349 $ccMailId = "{$ccDisplayName} <{$ccEmail}>";
351 //@todo - this is the only place in this function where $values is altered - but I can't find any evidence it is used
352 $values['cc_receipt'] = !empty($values['cc_receipt']) ?
($values['cc_receipt'] . ',' . $ccMailId) : $ccMailId;
354 // reset primary-email in the template
355 $tplParams['email'] = $ccEmail;
357 $tplParams['onBehalfName'] = $displayName;
358 $tplParams['onBehalfEmail'] = $email;
360 $ufJoinParams = array(
361 'module' => 'onBehalf',
362 'entity_table' => 'civicrm_contribution_page',
363 'entity_id' => $values['id'],
365 $OnBehalfProfile = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
366 $profileId = $OnBehalfProfile[0];
367 $userID = $contactID;
368 self
::buildCustomDisplay($profileId, 'onBehalfProfile', $userID, $template, $params['onbehalf_profile'], $fieldTypes);
371 // use either the contribution or membership receipt, based on whether it’s a membership-related contrib or not
372 $sendTemplateParams = array(
373 'groupName' => $tplParams['membershipID'] ?
'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
374 'valueName' => $tplParams['membershipID'] ?
'membership_online_receipt' : 'contribution_online_receipt',
375 'contactId' => $contactID,
376 'tplParams' => $tplParams,
378 'PDFFilename' => 'receipt.pdf',
381 if ($returnMessageText) {
382 list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
384 'subject' => $subject,
386 'to' => $displayName,
391 if ($values['is_email_receipt']) {
392 $sendTemplateParams['from'] = CRM_Utils_Array
::value('receipt_from_name', $values) . ' <' . $values['receipt_from_email'] . '>';
393 $sendTemplateParams['toName'] = $displayName;
394 $sendTemplateParams['toEmail'] = $email;
395 $sendTemplateParams['cc'] = CRM_Utils_Array
::value('cc_receipt', $values);
396 $sendTemplateParams['bcc'] = CRM_Utils_Array
::value('bcc_receipt', $values);
397 //send email with pdf invoice
398 $template = CRM_Core_Smarty
::singleton( );
399 $taxAmt = $template->get_template_vars('dataArray');
400 $prefixValue = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
401 $invoicing = CRM_Utils_Array
::value('invoicing', $prefixValue);
402 if (count($taxAmt) > 0 && (isset($invoicing) && isset($prefixValue['is_email_pdf']))) {
403 $sendTemplateParams['isEmailPdf'] = True;
404 $sendTemplateParams['contributionId'] = $values['contribution_id'];
406 list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
409 // send duplicate alert, if dupe match found during on-behalf-of processing.
410 if (!empty($values['onbehalf_dupe_alert'])) {
411 $sendTemplateParams['groupName'] = 'msg_tpl_workflow_contribution';
412 $sendTemplateParams['valueName'] = 'contribution_dupalert';
413 $sendTemplateParams['from'] = ts('Automatically Generated') . " <{$values['receipt_from_email']}>";
414 $sendTemplateParams['toName'] = CRM_Utils_Array
::value('receipt_from_name', $values);
415 $sendTemplateParams['toEmail'] = CRM_Utils_Array
::value('receipt_from_email', $values);
416 $sendTemplateParams['tplParams']['onBehalfID'] = $contactID;
417 $sendTemplateParams['tplParams']['receiptMessage'] = $message;
419 // fix cc and reset back to original, CRM-6976
420 $sendTemplateParams['cc'] = $originalCCReceipt;
422 CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
428 * Construct the message to be sent by the send function
438 function composeMessage($tplParams, $contactID, $isTest) {
439 $sendTemplateParams = array(
440 'groupName' => $tplParams['membershipID'] ?
'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
441 'valueName' => $tplParams['membershipID'] ?
'membership_online_receipt' : 'contribution_online_receipt',
442 'contactId' => $contactID,
443 'tplParams' => $tplParams,
445 'PDFFilename' => 'receipt.pdf',
447 if ($returnMessageText) {
448 list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
450 'subject' => $subject,
452 'to' => $displayName,
459 * Function to send the emails for Recurring Contribution Notication
461 * @param string $type txnType
462 * @param int $contactID contact id for contributor
463 * @param int $pageID contribution page id
464 * @param object $recur object of recurring contribution table
465 * @param bool|object $autoRenewMembership is it a auto renew membership.
471 static function recurringNotify($type, $contactID, $pageID, $recur, $autoRenewMembership = FALSE) {
474 CRM_Core_DAO
::commonRetrieveAll('CRM_Contribute_DAO_ContributionPage', 'id', $pageID, $value, array(
478 'receipt_from_email',
484 $isEmailReceipt = CRM_Utils_Array
::value('is_email_receipt', $value[$pageID]);
485 $isOfflineRecur = FALSE;
486 if (!$pageID && $recur->id
) {
487 $isOfflineRecur = TRUE;
489 if ($isEmailReceipt ||
$isOfflineRecur) {
491 $receiptFrom = '"' . CRM_Utils_Array
::value('receipt_from_name', $value[$pageID]) . '" <' . $value[$pageID]['receipt_from_email'] . '>';
493 $receiptFromName = $value[$pageID]['receipt_from_name'];
494 $receiptFromEmail = $value[$pageID]['receipt_from_email'];
497 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
498 $receiptFrom = "$domainValues[0] <$domainValues[1]>";
499 $receiptFromName = $domainValues[0];
500 $receiptFromEmail = $domainValues[1];
503 list($displayName, $email) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID, FALSE);
504 $templatesParams = array(
505 'groupName' => 'msg_tpl_workflow_contribution',
506 'valueName' => 'contribution_recurring_notify',
507 'contactId' => $contactID,
508 'tplParams' => array(
509 'recur_frequency_interval' => $recur->frequency_interval
,
510 'recur_frequency_unit' => $recur->frequency_unit
,
511 'recur_installments' => $recur->installments
,
512 'recur_start_date' => $recur->start_date
,
513 'recur_end_date' => $recur->end_date
,
514 'recur_amount' => $recur->amount
,
515 'recur_txnType' => $type,
516 'displayName' => $displayName,
517 'receipt_from_name' => $receiptFromName,
518 'receipt_from_email' => $receiptFromEmail,
519 'auto_renew_membership' => $autoRenewMembership,
521 'from' => $receiptFrom,
522 'toName' => $displayName,
527 $templatesParams['cc'] = CRM_Utils_Array
::value('cc_receipt', $value[$pageID]);
528 $templatesParams['bcc'] = CRM_Utils_Array
::value('bcc_receipt', $value[$pageID]);
531 // in some cases its just recurringNotify() thats called for the first time and these urls don't get set.
532 // like in PaypalPro, & therefore we set it here additionally.
533 $template = CRM_Core_Smarty
::singleton();
534 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($recur->id
, 'recur', 'obj');
535 $url = $paymentProcessor->subscriptionURL($recur->id
, 'recur');
536 $template->assign('cancelSubscriptionUrl', $url);
538 $url = $paymentProcessor->subscriptionURL($recur->id
, 'recur', 'billing');
539 $template->assign('updateSubscriptionBillingUrl', $url);
541 $url = $paymentProcessor->subscriptionURL($recur->id
, 'recur', 'update');
542 $template->assign('updateSubscriptionUrl', $url);
545 list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate($templatesParams);
548 CRM_Core_Error
::debug_log_message('Success: mail sent for recurring notification.');
551 CRM_Core_Error
::debug_log_message('Failure: mail not sent for recurring notification.');
557 * Function to add the custom fields for contribution page (ie profile)
559 * @param int $gid uf group id
560 * @param string $name
561 * @param int $cid contact id
563 * @param array $params params to build component whereclause
565 * @param null $fieldTypes
571 public static function buildCustomDisplay($gid, $name, $cid, &$template, &$params, $fieldTypes = NULL) {
573 if (CRM_Core_BAO_UFGroup
::filterUFGroups($gid, $cid)) {
576 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::VIEW
, NULL, NULL, FALSE, NULL, FALSE, NULL, CRM_Core_Permission
::CREATE
, NULL);
577 foreach ($fields as $k => $v) {
579 $groupTitle = $v["groupTitle"];
581 // suppress all file fields from display and formatting fields
583 CRM_Utils_Array
::value('data_type', $v, '') == 'File' ||
584 CRM_Utils_Array
::value('name', $v, '') == 'image_URL' ||
585 CRM_Utils_Array
::value('field_type', $v) == 'Formatting'
590 if (!empty($fieldTypes) && (!in_array($v['field_type'], $fieldTypes))) {
596 $template->assign($name . "_grouptitle", $groupTitle);
599 CRM_Core_BAO_UFGroup
::getValues($cid, $fields, $values, FALSE, $params);
601 if (count($values)) {
602 $template->assign($name, $values);
609 * This function is to make a copy of a contribution page, including
610 * all the blocks in the page
612 * @param int $id the contribution page id to copy
614 * @return the copy object
618 static function copy($id) {
621 'title' => ts('Copy of') . ' ',
624 $copy = &CRM_Core_DAO
::copyGeneric('CRM_Contribute_DAO_ContributionPage', array(
626 ), NULL, $fieldsFix);
628 //copying all the blocks pertaining to the contribution page
629 $copyPledgeBlock = &CRM_Core_DAO
::copyGeneric('CRM_Pledge_DAO_PledgeBlock', array(
631 'entity_table' => 'civicrm_contribution_page',
633 'entity_id' => $copy->id
,
636 $copyMembershipBlock = &CRM_Core_DAO
::copyGeneric('CRM_Member_DAO_MembershipBlock', array(
638 'entity_table' => 'civicrm_contribution_page',
640 'entity_id' => $copy->id
,
643 $copyUFJoin = &CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_UFJoin', array(
645 'entity_table' => 'civicrm_contribution_page',
647 'entity_id' => $copy->id
,
650 $copyWidget = &CRM_Core_DAO
::copyGeneric('CRM_Contribute_DAO_Widget', array(
651 'contribution_page_id' => $id,
653 'contribution_page_id' => $copy->id
,
657 CRM_Price_BAO_PriceSet
::copyPriceSet('civicrm_contribution_page', $id, $copy->id
);
659 $copyTellFriend = &CRM_Core_DAO
::copyGeneric('CRM_Friend_DAO_Friend', array(
661 'entity_table' => 'civicrm_contribution_page',
663 'entity_id' => $copy->id
,
666 $copyPersonalCampaignPages = &CRM_Core_DAO
::copyGeneric('CRM_PCP_DAO_PCPBlock', array(
668 'entity_table' => 'civicrm_contribution_page',
670 'entity_id' => $copy->id
,
673 $copyPremium = &CRM_Core_DAO
::copyGeneric('CRM_Contribute_DAO_Premium', array(
675 'entity_table' => 'civicrm_contribution_page',
677 'entity_id' => $copy->id
,
681 FROM civicrm_premiums
682 WHERE entity_table = 'civicrm_contribution_page'
683 AND entity_id ={$id}";
685 $premiumDao = CRM_Core_DAO
::executeQuery($premiumQuery, CRM_Core_DAO
::$_nullArray);
686 while ($premiumDao->fetch()) {
687 if ($premiumDao->id
) {
688 $copyPremiumProduct = & CRM_Core_DAO
::copyGeneric('CRM_Contribute_DAO_PremiumsProduct', array(
689 'premiums_id' => $premiumDao->id
,
691 'premiums_id' => $copyPremium->id
,
698 CRM_Utils_Hook
::copy('ContributionPage', $copy);
704 * Function to check if contribution page contains payment
705 * processor that supports recurring payment
707 * @param int $contributionPageId Contribution Page Id
709 * @return boolean true if payment processor supports recurring
715 static function checkRecurPaymentProcessor($contributionPageId) {
719 FROM civicrm_contribution_page cp,
720 civicrm_payment_processor pp
721 WHERE cp.payment_processor = pp.id
722 AND cp.id = {$contributionPageId}
725 if ($recurring = &CRM_Core_DAO
::singleValueQuery($sql, CRM_Core_DAO
::$_nullArray)) {
732 * Function to get info for all sections enable/disable.
734 * @param array $contribPageIds
735 * @return array $info info regarding all sections.
739 static function getSectionInfo($contribPageIds = array()) {
742 if (is_array($contribPageIds) && !empty($contribPageIds)) {
743 $whereClause = 'WHERE civicrm_contribution_page.id IN ( ' . implode(', ', $contribPageIds) . ' )';
758 SELECT civicrm_contribution_page.id as id,
759 civicrm_contribution_page.financial_type_id as settings,
760 amount_block_is_active as amount,
761 civicrm_membership_block.id as membership,
762 civicrm_uf_join.id as custom,
763 civicrm_contribution_page.thankyou_title as thankyou,
764 civicrm_tell_friend.id as friend,
765 civicrm_pcp_block.id as pcp,
766 civicrm_contribution_widget.id as widget,
767 civicrm_premiums.id as premium
768 FROM civicrm_contribution_page
769 LEFT JOIN civicrm_membership_block ON ( civicrm_membership_block.entity_id = civicrm_contribution_page.id
770 AND civicrm_membership_block.entity_table = 'civicrm_contribution_page'
771 AND civicrm_membership_block.is_active = 1 )
772 LEFT JOIN civicrm_uf_join ON ( civicrm_uf_join.entity_id = civicrm_contribution_page.id
773 AND civicrm_uf_join.entity_table = 'civicrm_contribution_page'
774 AND module = 'CiviContribute'
775 AND civicrm_uf_join.is_active = 1 )
776 LEFT JOIN civicrm_tell_friend ON ( civicrm_tell_friend.entity_id = civicrm_contribution_page.id
777 AND civicrm_tell_friend.entity_table = 'civicrm_contribution_page'
778 AND civicrm_tell_friend.is_active = 1)
779 LEFT JOIN civicrm_pcp_block ON ( civicrm_pcp_block.entity_id = civicrm_contribution_page.id
780 AND civicrm_pcp_block.entity_table = 'civicrm_contribution_page'
781 AND civicrm_pcp_block.is_active = 1 )
782 LEFT JOIN civicrm_contribution_widget ON ( civicrm_contribution_widget.contribution_page_id = civicrm_contribution_page.id
783 AND civicrm_contribution_widget.is_active = 1 )
784 LEFT JOIN civicrm_premiums ON ( civicrm_premiums.entity_id = civicrm_contribution_page.id
785 AND civicrm_premiums.entity_table = 'civicrm_contribution_page'
786 AND civicrm_premiums.premiums_active = 1 )
789 $contributionPage = CRM_Core_DAO
::executeQuery($query);
790 while ($contributionPage->fetch()) {
791 if (!isset($info[$contributionPage->id
]) ||
!is_array($info[$contributionPage->id
])) {
792 $info[$contributionPage->id
] = array_fill_keys(array_values($sections), FALSE);
794 foreach ($sections as $section) {
795 if ($contributionPage->$section) {
796 $info[$contributionPage->id
][$section] = TRUE;
805 * Get options for a given field.
806 * @see CRM_Core_DAO::buildOptions
808 * @param String $fieldName
809 * @param String $context: @see CRM_Core_DAO::buildOptionsContext
810 * @param Array $props: whatever is known about this dao object
814 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
816 // Special logic for fields whose options depend on context or properties
817 switch ($fieldName) {
818 case 'financial_type_id':
819 // Fixme - this is going to ignore context, better to get conditions, add params, and call PseudoConstant::get
820 return CRM_Financial_BAO_FinancialType
::getIncomeFinancialType();
823 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);
827 * Get or Set multilingually affected honor params for processing module_data or setting default values.
829 * @param Array|String $params: Array when we need to format it according to language state or String as a json encode
830 * @param Boolean $setDefault: If yes then returns array to used for setting default value afterward
832 * @return array|string
834 public static function formatMultilingualHonorParams($params, $setDefault = FALSE) {
835 $config = CRM_Core_Config
::singleton();
836 $sctJson = $sctJsonDecode = NULL;
837 $domain = new CRM_Core_DAO_Domain();
840 //When we are fetching the honor params respecting both multi and mono lingual state
841 //and setting it to default param of Contribution Page's Main and Setting form
843 $sctJsonDecode = json_decode($params);
844 $sctJsonDecode = (array) $sctJsonDecode->soft_credit
;
845 if (!$domain->locales
&& !empty($sctJsonDecode['default'])) {
847 $sctJsonDecode +
= (array) $sctJsonDecode['default'];
849 elseif (!empty($sctJsonDecode[$config->lcMessages
])) {
851 foreach ($sctJsonDecode[$config->lcMessages
] as $column => $value) {
852 $sctJsonDecode[$column] = $value;
854 unset($sctJsonDecode[$config->lcMessages
]);
856 return $sctJsonDecode;
859 //check and handle multilingual honoree params
860 if (!$domain->locales
) {
861 //if in singlelingual state simply return the array format
862 $sctJson = json_encode(
864 'soft_credit' => array(
865 'soft_credit_types' => $params['soft_credit_types'],
867 'honor_block_title' => $params['honor_block_title'],
868 'honor_block_text' => $params['honor_block_text']
875 //if in multilingual state then retrieve the module_data against this contribution and
876 //merge with earlier module_data json data to current so not to lose earlier multilingual module_data information
878 'soft_credit' => array(
879 'soft_credit_types' => $params['soft_credit_types'],
880 $config->lcMessages
=> array (
881 'honor_block_title' => $params['honor_block_title'],
882 'honor_block_text' => $params['honor_block_text']
887 $ufJoinDAO = new CRM_Core_DAO_UFJoin();
888 $ufJoinDAO->module
= 'soft_credit';
889 $ufJoinDAO->entity_id
= $params['id'];
890 $ufJoinDAO->find(TRUE);
891 $jsonData = json_decode($ufJoinDAO->module_data
);
893 $sctJson['soft_credit'] = array_merge((array)$jsonData->soft_credit
, $sctJson['soft_credit']);
895 $sctJson = json_encode($sctJson);
901 * Generate html for pdf in confirmation receipt email attachment
902 * @param int $contributionId Contribution Page Id
903 * @param int $userID contact id for contributor
904 * @return array $pdfHtml
906 static function addInvoicePdfToEmail($contributionId, $userID) {
907 $contributionID = array($contributionId);
908 $contactId = array($userID);
910 'output' => 'pdf_invoice',
911 'forPage' => 'confirmpage'
913 $pdfHtml = CRM_Contribute_Form_Task_Invoice
::printPDF($contributionID,
914 $pdfParams, $contactId, CRM_Core_DAO
::$_nullObject);
919 * helper to determine if the page supports separate membership payments
920 * @param integer id form id
922 * @return bool isSeparateMembershipPayment
924 static function getIsMembershipPayment($id) {
925 $membershipBlocks = civicrm_api3('membership_block', 'get', array('entity_table' => 'civicrm_contribution_page', 'entity_id' => $id, 'sequential' => TRUE));
926 if(!$membershipBlocks['count']) {
929 return $membershipBlocks['values'][0]['is_separate_payment'];