988 lines
37 KiB
PHP
988 lines
37 KiB
PHP
<?php
|
||
/*
|
||
+--------------------------------------------------------------------+
|
||
| CiviCRM version 4.7 |
|
||
+--------------------------------------------------------------------+
|
||
| Copyright CiviCRM LLC (c) 2004-2017 |
|
||
+--------------------------------------------------------------------+
|
||
| This file is a part of CiviCRM. |
|
||
| |
|
||
| CiviCRM is free software; you can copy, modify, and distribute it |
|
||
| under the terms of the GNU Affero General Public License |
|
||
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
||
| |
|
||
| CiviCRM is distributed in the hope that it will be useful, but |
|
||
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
||
| See the GNU Affero General Public License for more details. |
|
||
| |
|
||
| You should have received a copy of the GNU Affero General Public |
|
||
| License and the CiviCRM Licensing Exception along |
|
||
| with this program; if not, contact CiviCRM LLC |
|
||
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
||
| GNU Affero General Public License or the licensing of CiviCRM, |
|
||
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
||
+--------------------------------------------------------------------+
|
||
*/
|
||
|
||
/**
|
||
*
|
||
* @package CRM
|
||
* @copyright CiviCRM LLC (c) 2004-2017
|
||
*/
|
||
|
||
/**
|
||
* This class contains Contribution Page related functions.
|
||
*/
|
||
class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_ContributionPage {
|
||
|
||
/**
|
||
* Creates a contribution page.
|
||
*
|
||
* @param array $params
|
||
*
|
||
* @return CRM_Contribute_DAO_ContributionPage
|
||
*/
|
||
public static function create($params) {
|
||
$financialTypeId = NULL;
|
||
if (!empty($params['id']) && !CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $params['id'], NULL, 1)) {
|
||
$financialTypeId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $params['id'], 'financial_type_id');
|
||
}
|
||
|
||
if (isset($params['payment_processor']) && is_array($params['payment_processor'])) {
|
||
$params['payment_processor'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $params['payment_processor']);
|
||
}
|
||
$hook = empty($params['id']) ? 'create' : 'edit';
|
||
CRM_Utils_Hook::pre($hook, 'ContributionPage', CRM_Utils_Array::value('id', $params), $params);
|
||
$dao = new CRM_Contribute_DAO_ContributionPage();
|
||
$dao->copyValues($params);
|
||
$dao->save();
|
||
if ($financialTypeId && !empty($params['financial_type_id']) && $financialTypeId != $params['financial_type_id']) {
|
||
CRM_Price_BAO_PriceFieldValue::updateFinancialType($params['id'], 'civicrm_contribution_page', $params['financial_type_id']);
|
||
}
|
||
CRM_Utils_Hook::post($hook, 'ContributionPage', $dao->id, $dao);
|
||
return $dao;
|
||
}
|
||
|
||
/**
|
||
* Update the is_active flag in the db.
|
||
*
|
||
* @deprecated - this bypasses hooks.
|
||
*
|
||
* @param int $id
|
||
* Id of the database record.
|
||
* @param bool $is_active
|
||
* Value we want to set the is_active field.
|
||
*
|
||
* @return Object
|
||
* DAO object on success, null otherwise
|
||
*/
|
||
public static function setIsActive($id, $is_active) {
|
||
return CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_ContributionPage', $id, 'is_active', $is_active);
|
||
}
|
||
|
||
/**
|
||
* Load values for a contribution page.
|
||
*
|
||
* @param int $id
|
||
* @param array $values
|
||
*/
|
||
public static function setValues($id, &$values) {
|
||
$modules = array('CiviContribute', 'soft_credit', 'on_behalf');
|
||
$values['custom_pre_id'] = $values['custom_post_id'] = NULL;
|
||
|
||
$params = array('id' => $id);
|
||
CRM_Core_DAO::commonRetrieve('CRM_Contribute_DAO_ContributionPage', $params, $values);
|
||
|
||
// get the profile ids
|
||
$ufJoinParams = array(
|
||
'entity_table' => 'civicrm_contribution_page',
|
||
'entity_id' => $id,
|
||
);
|
||
|
||
// retrieve profile id as also unserialize module_data corresponding to each $module
|
||
foreach ($modules as $module) {
|
||
$ufJoinParams['module'] = $module;
|
||
$ufJoin = new CRM_Core_DAO_UFJoin();
|
||
$ufJoin->copyValues($ufJoinParams);
|
||
if ($module == 'CiviContribute') {
|
||
$ufJoin->orderBy('weight asc');
|
||
$ufJoin->find();
|
||
while ($ufJoin->fetch()) {
|
||
if ($ufJoin->weight == 1) {
|
||
$values['custom_pre_id'] = $ufJoin->uf_group_id;
|
||
}
|
||
else {
|
||
$values['custom_post_id'] = $ufJoin->uf_group_id;
|
||
}
|
||
}
|
||
}
|
||
else {
|
||
$ufJoin->find(TRUE);
|
||
if (!$ufJoin->is_active) {
|
||
continue;
|
||
}
|
||
$params = CRM_Contribute_BAO_ContributionPage::formatModuleData($ufJoin->module_data, TRUE, $module);
|
||
$values = array_merge($params, $values);
|
||
if ($module == 'soft_credit') {
|
||
$values['honoree_profile_id'] = $ufJoin->uf_group_id;
|
||
$values['honor_block_is_active'] = $ufJoin->is_active;
|
||
}
|
||
else {
|
||
$values['onbehalf_profile_id'] = $ufJoin->uf_group_id;
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Send the emails.
|
||
*
|
||
* @param int $contactID
|
||
* Contact id.
|
||
* @param array $values
|
||
* Associated array of fields.
|
||
* @param bool $isTest
|
||
* If in test mode.
|
||
* @param bool $returnMessageText
|
||
* Return the message text instead of sending the mail.
|
||
*
|
||
* @param array $fieldTypes
|
||
*/
|
||
public static function sendMail($contactID, $values, $isTest = FALSE, $returnMessageText = FALSE, $fieldTypes = NULL) {
|
||
$gIds = array();
|
||
$params = array('custom_pre_id' => array(), 'custom_post_id' => array());
|
||
$email = NULL;
|
||
|
||
// We are trying to fight the good fight against leaky variables (CRM-17519) so let's get really explicit
|
||
// about ensuring the variables we want for the template are defined.
|
||
// @todo add to this until all tpl params are explicit in this function and not waltzing around the codebase.
|
||
// Next stage is to remove this & ensure there are no e-notices - ie. all are set before they hit this fn.
|
||
$valuesRequiredForTemplate = array(
|
||
'customPre',
|
||
'customPost',
|
||
'customPre_grouptitle',
|
||
'customPost_grouptitle',
|
||
'useForMember',
|
||
'membership_assign',
|
||
'amount',
|
||
'receipt_date',
|
||
'is_pay_later',
|
||
);
|
||
|
||
foreach ($valuesRequiredForTemplate as $valueRequiredForTemplate) {
|
||
if (!isset($values[$valueRequiredForTemplate])) {
|
||
$values[$valueRequiredForTemplate] = NULL;
|
||
}
|
||
}
|
||
|
||
if (isset($values['custom_pre_id'])) {
|
||
$preProfileType = CRM_Core_BAO_UFField::getProfileType($values['custom_pre_id']);
|
||
if ($preProfileType == 'Membership' && !empty($values['membership_id'])) {
|
||
$params['custom_pre_id'] = array(
|
||
array(
|
||
'member_id',
|
||
'=',
|
||
$values['membership_id'],
|
||
0,
|
||
0,
|
||
),
|
||
);
|
||
}
|
||
elseif ($preProfileType == 'Contribution' && !empty($values['contribution_id'])) {
|
||
$params['custom_pre_id'] = array(
|
||
array(
|
||
'contribution_id',
|
||
'=',
|
||
$values['contribution_id'],
|
||
0,
|
||
0,
|
||
),
|
||
);
|
||
}
|
||
|
||
$gIds['custom_pre_id'] = $values['custom_pre_id'];
|
||
}
|
||
|
||
if (isset($values['custom_post_id'])) {
|
||
$postProfileType = CRM_Core_BAO_UFField::getProfileType($values['custom_post_id']);
|
||
if ($postProfileType == 'Membership' && !empty($values['membership_id'])) {
|
||
$params['custom_post_id'] = array(
|
||
array(
|
||
'member_id',
|
||
'=',
|
||
$values['membership_id'],
|
||
0,
|
||
0,
|
||
),
|
||
);
|
||
}
|
||
elseif ($postProfileType == 'Contribution' && !empty($values['contribution_id'])) {
|
||
$params['custom_post_id'] = array(
|
||
array(
|
||
'contribution_id',
|
||
'=',
|
||
$values['contribution_id'],
|
||
0,
|
||
0,
|
||
),
|
||
);
|
||
}
|
||
|
||
$gIds['custom_post_id'] = $values['custom_post_id'];
|
||
}
|
||
|
||
if (!empty($values['is_for_organization'])) {
|
||
if (!empty($values['membership_id'])) {
|
||
$params['onbehalf_profile'] = array(
|
||
array(
|
||
'member_id',
|
||
'=',
|
||
$values['membership_id'],
|
||
0,
|
||
0,
|
||
),
|
||
);
|
||
}
|
||
elseif (!empty($values['contribution_id'])) {
|
||
$params['onbehalf_profile'] = array(
|
||
array(
|
||
'contribution_id',
|
||
'=',
|
||
$values['contribution_id'],
|
||
0,
|
||
0,
|
||
),
|
||
);
|
||
}
|
||
}
|
||
|
||
//check whether it is a test drive
|
||
if ($isTest && !empty($params['custom_pre_id'])) {
|
||
$params['custom_pre_id'][] = array(
|
||
'contribution_test',
|
||
'=',
|
||
1,
|
||
0,
|
||
0,
|
||
);
|
||
}
|
||
|
||
if ($isTest && !empty($params['custom_post_id'])) {
|
||
$params['custom_post_id'][] = array(
|
||
'contribution_test',
|
||
'=',
|
||
1,
|
||
0,
|
||
0,
|
||
);
|
||
}
|
||
|
||
if (!$returnMessageText && !empty($gIds)) {
|
||
//send notification email if field values are set (CRM-1941)
|
||
foreach ($gIds as $key => $gId) {
|
||
if ($gId) {
|
||
$email = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $gId, 'notify');
|
||
if ($email) {
|
||
$val = CRM_Core_BAO_UFGroup::checkFieldsEmptyValues($gId, $contactID, CRM_Utils_Array::value($key, $params), TRUE);
|
||
CRM_Core_BAO_UFGroup::commonSendMail($contactID, $val);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
if (!empty($values['is_email_receipt']) || !empty($values['onbehalf_dupe_alert']) ||
|
||
$returnMessageText
|
||
) {
|
||
$template = CRM_Core_Smarty::singleton();
|
||
|
||
// get the billing location type
|
||
if (!array_key_exists('related_contact', $values)) {
|
||
$billingLocationTypeId = CRM_Core_BAO_LocationType::getBilling();
|
||
}
|
||
else {
|
||
// presence of related contact implies onbehalf of org case,
|
||
// where location type is set to default.
|
||
$locType = CRM_Core_BAO_LocationType::getDefault();
|
||
$billingLocationTypeId = $locType->id;
|
||
}
|
||
|
||
if (!array_key_exists('related_contact', $values)) {
|
||
list($displayName, $email) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contactID, FALSE, $billingLocationTypeId);
|
||
}
|
||
// get primary location email if no email exist( for billing location).
|
||
if (!$email) {
|
||
list($displayName, $email) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contactID);
|
||
}
|
||
if (empty($displayName)) {
|
||
list($displayName, $email) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contactID);
|
||
}
|
||
|
||
//for display profile need to get individual contact id,
|
||
//hence get it from related_contact if on behalf of org true CRM-3767
|
||
//CRM-5001 Contribution/Membership:: On Behalf of Organization,
|
||
//If profile GROUP contain the Individual type then consider the
|
||
//profile is of Individual ( including the custom data of membership/contribution )
|
||
//IF Individual type not present in profile then it is consider as Organization data.
|
||
$userID = $contactID;
|
||
if ($preID = CRM_Utils_Array::value('custom_pre_id', $values)) {
|
||
if (!empty($values['related_contact'])) {
|
||
$preProfileTypes = CRM_Core_BAO_UFGroup::profileGroups($preID);
|
||
//@todo - following line should not refer to undefined $postProfileTypes? figure out way to test
|
||
if (in_array('Individual', $preProfileTypes) || in_array('Contact', $postProfileTypes)) {
|
||
//Take Individual contact ID
|
||
$userID = CRM_Utils_Array::value('related_contact', $values);
|
||
}
|
||
}
|
||
list($values['customPre_grouptitle'], $values['customPre']) = self::getProfileNameAndFields($preID, $userID, $params['custom_pre_id']);
|
||
}
|
||
$userID = $contactID;
|
||
if ($postID = CRM_Utils_Array::value('custom_post_id', $values)) {
|
||
if (!empty($values['related_contact'])) {
|
||
$postProfileTypes = CRM_Core_BAO_UFGroup::profileGroups($postID);
|
||
if (in_array('Individual', $postProfileTypes) || in_array('Contact', $postProfileTypes)) {
|
||
//Take Individual contact ID
|
||
$userID = CRM_Utils_Array::value('related_contact', $values);
|
||
}
|
||
}
|
||
list($values['customPost_grouptitle'], $values['customPost']) = self::getProfileNameAndFields($postID, $userID, $params['custom_post_id']);
|
||
}
|
||
if (isset($values['honor'])) {
|
||
$honorValues = $values['honor'];
|
||
$template->_values = array('honoree_profile_id' => $values['honoree_profile_id']);
|
||
CRM_Contribute_BAO_ContributionSoft::formatHonoreeProfileFields(
|
||
$template,
|
||
$honorValues['honor_profile_values'],
|
||
$honorValues['honor_id']
|
||
);
|
||
}
|
||
|
||
$title = isset($values['title']) ? $values['title'] : CRM_Contribute_PseudoConstant::contributionPage($values['contribution_page_id']);
|
||
|
||
// Set email variables explicitly to avoid leaky smarty variables.
|
||
// All of these will be assigned to the template, replacing any that might be assigned elsewhere.
|
||
$tplParams = array(
|
||
'email' => $email,
|
||
'receiptFromEmail' => CRM_Utils_Array::value('receipt_from_email', $values),
|
||
'contactID' => $contactID,
|
||
'displayName' => $displayName,
|
||
'contributionID' => CRM_Utils_Array::value('contribution_id', $values),
|
||
'contributionOtherID' => CRM_Utils_Array::value('contribution_other_id', $values),
|
||
// CRM-5095
|
||
'lineItem' => CRM_Utils_Array::value('lineItem', $values),
|
||
// CRM-5095
|
||
'priceSetID' => CRM_Utils_Array::value('priceSetID', $values),
|
||
'title' => $title,
|
||
'isShare' => CRM_Utils_Array::value('is_share', $values),
|
||
'thankyou_title' => CRM_Utils_Array::value('thankyou_title', $values),
|
||
'customPre' => $values['customPre'],
|
||
'customPre_grouptitle' => $values['customPre_grouptitle'],
|
||
'customPost' => $values['customPost'],
|
||
'customPost_grouptitle' => $values['customPost_grouptitle'],
|
||
'useForMember' => $values['useForMember'],
|
||
'membership_assign' => $values['membership_assign'],
|
||
'amount' => $values['amount'],
|
||
'is_pay_later' => $values['is_pay_later'],
|
||
'receipt_date' => !$values['receipt_date'] ? NULL : date('YmdHis', strtotime($values['receipt_date'])),
|
||
'pay_later_receipt' => CRM_Utils_Array::value('pay_later_receipt', $values),
|
||
'honor_block_is_active' => CRM_Utils_Array::value('honor_block_is_active', $values),
|
||
'contributionStatus' => CRM_Utils_Array::value('contribution_status', $values),
|
||
);
|
||
|
||
if ($contributionTypeId = CRM_Utils_Array::value('financial_type_id', $values)) {
|
||
$tplParams['financialTypeId'] = $contributionTypeId;
|
||
$tplParams['financialTypeName'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialType',
|
||
$contributionTypeId);
|
||
// Legacy support
|
||
$tplParams['contributionTypeName'] = $tplParams['financialTypeName'];
|
||
$tplParams['contributionTypeId'] = $contributionTypeId;
|
||
}
|
||
|
||
if ($contributionPageId = CRM_Utils_Array::value('id', $values)) {
|
||
$tplParams['contributionPageId'] = $contributionPageId;
|
||
}
|
||
|
||
// address required during receipt processing (pdf and email receipt)
|
||
if ($displayAddress = CRM_Utils_Array::value('address', $values)) {
|
||
$tplParams['address'] = $displayAddress;
|
||
}
|
||
|
||
// CRM-6976
|
||
$originalCCReceipt = CRM_Utils_Array::value('cc_receipt', $values);
|
||
|
||
// cc to related contacts of contributor OR the one who
|
||
// signs up. Is used for cases like - on behalf of
|
||
// contribution / signup ..etc
|
||
if (array_key_exists('related_contact', $values)) {
|
||
list($ccDisplayName, $ccEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($values['related_contact']);
|
||
$ccMailId = "{$ccDisplayName} <{$ccEmail}>";
|
||
|
||
//@todo - this is the only place in this function where $values is altered - but I can't find any evidence it is used
|
||
$values['cc_receipt'] = !empty($values['cc_receipt']) ? ($values['cc_receipt'] . ',' . $ccMailId) : $ccMailId;
|
||
|
||
// reset primary-email in the template
|
||
$tplParams['email'] = $ccEmail;
|
||
|
||
$tplParams['onBehalfName'] = $displayName;
|
||
$tplParams['onBehalfEmail'] = $email;
|
||
|
||
if (!empty($values['onbehalf_profile_id'])) {
|
||
self::buildCustomDisplay($values['onbehalf_profile_id'], 'onBehalfProfile', $contactID, $template, $params['onbehalf_profile'], $fieldTypes);
|
||
}
|
||
}
|
||
|
||
// use either the contribution or membership receipt, based on whether it’s a membership-related contrib or not
|
||
$sendTemplateParams = array(
|
||
'groupName' => !empty($values['isMembership']) ? 'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
|
||
'valueName' => !empty($values['isMembership']) ? 'membership_online_receipt' : 'contribution_online_receipt',
|
||
'contactId' => $contactID,
|
||
'tplParams' => $tplParams,
|
||
'isTest' => $isTest,
|
||
'PDFFilename' => 'receipt.pdf',
|
||
);
|
||
|
||
if ($returnMessageText) {
|
||
list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
|
||
return array(
|
||
'subject' => $subject,
|
||
'body' => $message,
|
||
'to' => $displayName,
|
||
'html' => $html,
|
||
);
|
||
}
|
||
|
||
if (empty($values['receipt_from_name']) && empty($values['receipt_from_name'])) {
|
||
list($values['receipt_from_name'], $values['receipt_from_email']) = CRM_Core_BAO_Domain::getNameAndEmail();
|
||
}
|
||
|
||
if ($values['is_email_receipt']) {
|
||
$sendTemplateParams['from'] = CRM_Utils_Array::value('receipt_from_name', $values) . ' <' . $values['receipt_from_email'] . '>';
|
||
$sendTemplateParams['toName'] = $displayName;
|
||
$sendTemplateParams['toEmail'] = $email;
|
||
$sendTemplateParams['cc'] = CRM_Utils_Array::value('cc_receipt', $values);
|
||
$sendTemplateParams['bcc'] = CRM_Utils_Array::value('bcc_receipt', $values);
|
||
//send email with pdf invoice
|
||
$template = CRM_Core_Smarty::singleton();
|
||
$taxAmt = $template->get_template_vars('dataArray');
|
||
$prefixValue = Civi::settings()->get('contribution_invoice_settings');
|
||
$invoicing = CRM_Utils_Array::value('invoicing', $prefixValue);
|
||
if (isset($invoicing) && isset($prefixValue['is_email_pdf'])) {
|
||
$sendTemplateParams['isEmailPdf'] = TRUE;
|
||
$sendTemplateParams['contributionId'] = $values['contribution_id'];
|
||
}
|
||
list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
|
||
}
|
||
|
||
// send duplicate alert, if dupe match found during on-behalf-of processing.
|
||
if (!empty($values['onbehalf_dupe_alert'])) {
|
||
$sendTemplateParams['groupName'] = 'msg_tpl_workflow_contribution';
|
||
$sendTemplateParams['valueName'] = 'contribution_dupalert';
|
||
$sendTemplateParams['from'] = ts('Automatically Generated') . " <{$values['receipt_from_email']}>";
|
||
$sendTemplateParams['toName'] = CRM_Utils_Array::value('receipt_from_name', $values);
|
||
$sendTemplateParams['toEmail'] = CRM_Utils_Array::value('receipt_from_email', $values);
|
||
$sendTemplateParams['tplParams']['onBehalfID'] = $contactID;
|
||
$sendTemplateParams['tplParams']['receiptMessage'] = $message;
|
||
|
||
// fix cc and reset back to original, CRM-6976
|
||
$sendTemplateParams['cc'] = $originalCCReceipt;
|
||
|
||
CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Get the profile title and fields.
|
||
*
|
||
* @param int $gid
|
||
* @param int $cid
|
||
* @param array $params
|
||
* @param array $fieldTypes
|
||
*
|
||
* @return array
|
||
*/
|
||
protected static function getProfileNameAndFields($gid, $cid, &$params, $fieldTypes = array()) {
|
||
$groupTitle = NULL;
|
||
$values = array();
|
||
if ($gid) {
|
||
if (CRM_Core_BAO_UFGroup::filterUFGroups($gid, $cid)) {
|
||
$fields = CRM_Core_BAO_UFGroup::getFields($gid, FALSE, CRM_Core_Action::VIEW, NULL, NULL, FALSE, NULL, FALSE, NULL, CRM_Core_Permission::CREATE, NULL);
|
||
foreach ($fields as $k => $v) {
|
||
if (!$groupTitle) {
|
||
$groupTitle = $v["groupTitle"];
|
||
}
|
||
// suppress all file fields from display and formatting fields
|
||
if (
|
||
CRM_Utils_Array::value('data_type', $v, '') == 'File' ||
|
||
CRM_Utils_Array::value('name', $v, '') == 'image_URL' ||
|
||
CRM_Utils_Array::value('field_type', $v) == 'Formatting'
|
||
) {
|
||
unset($fields[$k]);
|
||
}
|
||
|
||
if (!empty($fieldTypes) && (!in_array($v['field_type'], $fieldTypes))) {
|
||
unset($fields[$k]);
|
||
}
|
||
}
|
||
|
||
CRM_Core_BAO_UFGroup::getValues($cid, $fields, $values, FALSE, $params);
|
||
}
|
||
}
|
||
return array($groupTitle, $values);
|
||
}
|
||
|
||
/**
|
||
* Send the emails for Recurring Contribution Notification.
|
||
*
|
||
* @param string $type
|
||
* TxnType.
|
||
* @param int $contactID
|
||
* Contact id for contributor.
|
||
* @param int $pageID
|
||
* Contribution page id.
|
||
* @param object $recur
|
||
* Object of recurring contribution table.
|
||
* @param bool|object $autoRenewMembership is it a auto renew membership.
|
||
*/
|
||
public static function recurringNotify($type, $contactID, $pageID, $recur, $autoRenewMembership = FALSE) {
|
||
$value = array();
|
||
$isEmailReceipt = FALSE;
|
||
if ($pageID) {
|
||
CRM_Core_DAO::commonRetrieveAll('CRM_Contribute_DAO_ContributionPage', 'id', $pageID, $value, array(
|
||
'title',
|
||
'is_email_receipt',
|
||
'receipt_from_name',
|
||
'receipt_from_email',
|
||
'cc_receipt',
|
||
'bcc_receipt',
|
||
));
|
||
$isEmailReceipt = CRM_Utils_Array::value('is_email_receipt', $value[$pageID]);
|
||
}
|
||
elseif ($recur->id) {
|
||
// This means we are coming from back-office - ie. no page ID, but recurring.
|
||
// Ideally this information would be passed into the function clearly rather than guessing by convention.
|
||
$isEmailReceipt = TRUE;
|
||
}
|
||
|
||
if ($isEmailReceipt) {
|
||
if ($pageID) {
|
||
$receiptFrom = '"' . CRM_Utils_Array::value('receipt_from_name', $value[$pageID]) . '" <' . $value[$pageID]['receipt_from_email'] . '>';
|
||
|
||
$receiptFromName = $value[$pageID]['receipt_from_name'];
|
||
$receiptFromEmail = $value[$pageID]['receipt_from_email'];
|
||
}
|
||
else {
|
||
$domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
|
||
$receiptFrom = "$domainValues[0] <$domainValues[1]>";
|
||
$receiptFromName = $domainValues[0];
|
||
$receiptFromEmail = $domainValues[1];
|
||
}
|
||
|
||
list($displayName, $email) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contactID, FALSE);
|
||
$templatesParams = array(
|
||
'groupName' => 'msg_tpl_workflow_contribution',
|
||
'valueName' => 'contribution_recurring_notify',
|
||
'contactId' => $contactID,
|
||
'tplParams' => array(
|
||
'recur_frequency_interval' => $recur->frequency_interval,
|
||
'recur_frequency_unit' => $recur->frequency_unit,
|
||
'recur_installments' => $recur->installments,
|
||
'recur_start_date' => $recur->start_date,
|
||
'recur_end_date' => $recur->end_date,
|
||
'recur_amount' => $recur->amount,
|
||
'recur_txnType' => $type,
|
||
'displayName' => $displayName,
|
||
'receipt_from_name' => $receiptFromName,
|
||
'receipt_from_email' => $receiptFromEmail,
|
||
'auto_renew_membership' => $autoRenewMembership,
|
||
),
|
||
'from' => $receiptFrom,
|
||
'toName' => $displayName,
|
||
'toEmail' => $email,
|
||
);
|
||
//CRM-13811
|
||
if ($pageID) {
|
||
$templatesParams['cc'] = CRM_Utils_Array::value('cc_receipt', $value[$pageID]);
|
||
$templatesParams['bcc'] = CRM_Utils_Array::value('bcc_receipt', $value[$pageID]);
|
||
}
|
||
if ($recur->id) {
|
||
// in some cases its just recurringNotify() thats called for the first time and these urls don't get set.
|
||
// like in PaypalPro, & therefore we set it here additionally.
|
||
$template = CRM_Core_Smarty::singleton();
|
||
$paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($recur->id, 'recur', 'obj');
|
||
$url = $paymentProcessor->subscriptionURL($recur->id, 'recur', 'cancel');
|
||
$template->assign('cancelSubscriptionUrl', $url);
|
||
|
||
$url = $paymentProcessor->subscriptionURL($recur->id, 'recur', 'billing');
|
||
$template->assign('updateSubscriptionBillingUrl', $url);
|
||
|
||
$url = $paymentProcessor->subscriptionURL($recur->id, 'recur', 'update');
|
||
$template->assign('updateSubscriptionUrl', $url);
|
||
}
|
||
|
||
list($sent) = CRM_Core_BAO_MessageTemplate::sendTemplate($templatesParams);
|
||
|
||
if ($sent) {
|
||
CRM_Core_Error::debug_log_message('Success: mail sent for recurring notification.');
|
||
}
|
||
else {
|
||
CRM_Core_Error::debug_log_message('Failure: mail not sent for recurring notification.');
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Add the custom fields for contribution page (ie profile).
|
||
*
|
||
* @deprecated assigning values to smarty like this is risky because
|
||
* - it is hard to debug since $name is used in the assign
|
||
* - it is potentially 'leaky' - it's better to do this on the form
|
||
* or close to where it is used / required. See CRM-17519 for leakage e.g.
|
||
*
|
||
* @param int $gid
|
||
* Uf group id.
|
||
* @param string $name
|
||
* @param int $cid
|
||
* Contact id.
|
||
* @param $template
|
||
* @param array $params
|
||
* Params to build component whereclause.
|
||
*
|
||
* @param array|null $fieldTypes
|
||
*/
|
||
public static function buildCustomDisplay($gid, $name, $cid, &$template, &$params, $fieldTypes = NULL) {
|
||
list($groupTitle, $values) = self::getProfileNameAndFields($gid, $cid, $params, $fieldTypes);
|
||
if (!empty($values)) {
|
||
$template->assign($name, $values);
|
||
}
|
||
$template->assign($name . "_grouptitle", $groupTitle);
|
||
}
|
||
|
||
/**
|
||
* Make a copy of a contribution page, including all the blocks in the page.
|
||
*
|
||
* @param int $id
|
||
* The contribution page id to copy.
|
||
*
|
||
* @return CRM_Contribute_DAO_ContributionPage
|
||
*/
|
||
public static function copy($id) {
|
||
$fieldsFix = array(
|
||
'prefix' => array(
|
||
'title' => ts('Copy of') . ' ',
|
||
),
|
||
);
|
||
$copy = &CRM_Core_DAO::copyGeneric('CRM_Contribute_DAO_ContributionPage', array(
|
||
'id' => $id,
|
||
), NULL, $fieldsFix);
|
||
|
||
//copying all the blocks pertaining to the contribution page
|
||
$copyPledgeBlock = &CRM_Core_DAO::copyGeneric('CRM_Pledge_DAO_PledgeBlock', array(
|
||
'entity_id' => $id,
|
||
'entity_table' => 'civicrm_contribution_page',
|
||
), array(
|
||
'entity_id' => $copy->id,
|
||
));
|
||
|
||
$copyMembershipBlock = &CRM_Core_DAO::copyGeneric('CRM_Member_DAO_MembershipBlock', array(
|
||
'entity_id' => $id,
|
||
'entity_table' => 'civicrm_contribution_page',
|
||
), array(
|
||
'entity_id' => $copy->id,
|
||
));
|
||
|
||
$copyUFJoin = &CRM_Core_DAO::copyGeneric('CRM_Core_DAO_UFJoin', array(
|
||
'entity_id' => $id,
|
||
'entity_table' => 'civicrm_contribution_page',
|
||
), array(
|
||
'entity_id' => $copy->id,
|
||
));
|
||
|
||
$copyWidget = &CRM_Core_DAO::copyGeneric('CRM_Contribute_DAO_Widget', array(
|
||
'contribution_page_id' => $id,
|
||
), array(
|
||
'contribution_page_id' => $copy->id,
|
||
));
|
||
|
||
//copy price sets
|
||
CRM_Price_BAO_PriceSet::copyPriceSet('civicrm_contribution_page', $id, $copy->id);
|
||
|
||
$copyTellFriend = &CRM_Core_DAO::copyGeneric('CRM_Friend_DAO_Friend', array(
|
||
'entity_id' => $id,
|
||
'entity_table' => 'civicrm_contribution_page',
|
||
), array(
|
||
'entity_id' => $copy->id,
|
||
));
|
||
|
||
$copyPersonalCampaignPages = &CRM_Core_DAO::copyGeneric('CRM_PCP_DAO_PCPBlock', array(
|
||
'entity_id' => $id,
|
||
'entity_table' => 'civicrm_contribution_page',
|
||
), array(
|
||
'entity_id' => $copy->id,
|
||
'target_entity_id' => $copy->id,
|
||
));
|
||
|
||
$copyPremium = &CRM_Core_DAO::copyGeneric('CRM_Contribute_DAO_Premium', array(
|
||
'entity_id' => $id,
|
||
'entity_table' => 'civicrm_contribution_page',
|
||
), array(
|
||
'entity_id' => $copy->id,
|
||
));
|
||
$premiumQuery = "
|
||
SELECT id
|
||
FROM civicrm_premiums
|
||
WHERE entity_table = 'civicrm_contribution_page'
|
||
AND entity_id ={$id}";
|
||
|
||
$premiumDao = CRM_Core_DAO::executeQuery($premiumQuery, CRM_Core_DAO::$_nullArray);
|
||
while ($premiumDao->fetch()) {
|
||
if ($premiumDao->id) {
|
||
CRM_Core_DAO::copyGeneric('CRM_Contribute_DAO_PremiumsProduct', array(
|
||
'premiums_id' => $premiumDao->id,
|
||
), array(
|
||
'premiums_id' => $copyPremium->id,
|
||
));
|
||
}
|
||
}
|
||
|
||
$copy->save();
|
||
|
||
CRM_Utils_Hook::copy('ContributionPage', $copy);
|
||
|
||
return $copy;
|
||
}
|
||
|
||
/**
|
||
* Get info for all sections enable/disable.
|
||
*
|
||
* @param array $contribPageIds
|
||
* @return array
|
||
* info regarding all sections.
|
||
*/
|
||
public static function getSectionInfo($contribPageIds = array()) {
|
||
$info = array();
|
||
$whereClause = NULL;
|
||
if (is_array($contribPageIds) && !empty($contribPageIds)) {
|
||
$whereClause = 'WHERE civicrm_contribution_page.id IN ( ' . implode(', ', $contribPageIds) . ' )';
|
||
}
|
||
|
||
$sections = array(
|
||
'settings',
|
||
'amount',
|
||
'membership',
|
||
'custom',
|
||
'thankyou',
|
||
'friend',
|
||
'pcp',
|
||
'widget',
|
||
'premium',
|
||
);
|
||
$query = "
|
||
SELECT civicrm_contribution_page.id as id,
|
||
civicrm_contribution_page.financial_type_id as settings,
|
||
amount_block_is_active as amount,
|
||
civicrm_membership_block.id as membership,
|
||
civicrm_uf_join.id as custom,
|
||
civicrm_contribution_page.thankyou_title as thankyou,
|
||
civicrm_tell_friend.id as friend,
|
||
civicrm_pcp_block.id as pcp,
|
||
civicrm_contribution_widget.id as widget,
|
||
civicrm_premiums.id as premium
|
||
FROM civicrm_contribution_page
|
||
LEFT JOIN civicrm_membership_block ON ( civicrm_membership_block.entity_id = civicrm_contribution_page.id
|
||
AND civicrm_membership_block.entity_table = 'civicrm_contribution_page'
|
||
AND civicrm_membership_block.is_active = 1 )
|
||
LEFT JOIN civicrm_uf_join ON ( civicrm_uf_join.entity_id = civicrm_contribution_page.id
|
||
AND civicrm_uf_join.entity_table = 'civicrm_contribution_page'
|
||
AND module = 'CiviContribute'
|
||
AND civicrm_uf_join.is_active = 1 )
|
||
LEFT JOIN civicrm_tell_friend ON ( civicrm_tell_friend.entity_id = civicrm_contribution_page.id
|
||
AND civicrm_tell_friend.entity_table = 'civicrm_contribution_page'
|
||
AND civicrm_tell_friend.is_active = 1)
|
||
LEFT JOIN civicrm_pcp_block ON ( civicrm_pcp_block.entity_id = civicrm_contribution_page.id
|
||
AND civicrm_pcp_block.entity_table = 'civicrm_contribution_page'
|
||
AND civicrm_pcp_block.is_active = 1 )
|
||
LEFT JOIN civicrm_contribution_widget ON ( civicrm_contribution_widget.contribution_page_id = civicrm_contribution_page.id
|
||
AND civicrm_contribution_widget.is_active = 1 )
|
||
LEFT JOIN civicrm_premiums ON ( civicrm_premiums.entity_id = civicrm_contribution_page.id
|
||
AND civicrm_premiums.entity_table = 'civicrm_contribution_page'
|
||
AND civicrm_premiums.premiums_active = 1 )
|
||
$whereClause";
|
||
|
||
$contributionPage = CRM_Core_DAO::executeQuery($query);
|
||
while ($contributionPage->fetch()) {
|
||
if (!isset($info[$contributionPage->id]) || !is_array($info[$contributionPage->id])) {
|
||
$info[$contributionPage->id] = array_fill_keys(array_values($sections), FALSE);
|
||
}
|
||
foreach ($sections as $section) {
|
||
if ($contributionPage->$section) {
|
||
$info[$contributionPage->id][$section] = TRUE;
|
||
}
|
||
}
|
||
}
|
||
|
||
return $info;
|
||
}
|
||
|
||
/**
|
||
* Get options for a given field.
|
||
* @see CRM_Core_DAO::buildOptions
|
||
*
|
||
* @param string $fieldName
|
||
* @param string $context : @see CRM_Core_DAO::buildOptionsContext
|
||
* @param array $props : whatever is known about this dao object
|
||
*
|
||
* @return array|bool
|
||
*/
|
||
public static function buildOptions($fieldName, $context = NULL, $props = array()) {
|
||
$params = array();
|
||
// Special logic for fields whose options depend on context or properties
|
||
switch ($fieldName) {
|
||
case 'financial_type_id':
|
||
// Fixme - this is going to ignore context, better to get conditions, add params, and call PseudoConstant::get
|
||
return CRM_Financial_BAO_FinancialType::getIncomeFinancialType();
|
||
|
||
break;
|
||
}
|
||
return CRM_Core_PseudoConstant::get(__CLASS__, $fieldName, $params, $context);
|
||
}
|
||
|
||
/**
|
||
* Get or Set honor/on_behalf params for processing module_data or setting default values.
|
||
*
|
||
* @param array $params :
|
||
* @param bool $setDefault : If yes then returns array to used for setting default value afterward
|
||
* @param string $module : processing module_data for which module? e.g. soft_credit, on_behalf
|
||
*
|
||
* @return array|string
|
||
*/
|
||
public static function formatModuleData($params, $setDefault = FALSE, $module) {
|
||
$tsLocale = CRM_Core_I18n::getLocale();
|
||
$config = CRM_Core_Config::singleton();
|
||
$json = $jsonDecode = NULL;
|
||
$domain = new CRM_Core_DAO_Domain();
|
||
$domain->find(TRUE);
|
||
|
||
$moduleDataFormat = array(
|
||
'soft_credit' => array(
|
||
1 => 'soft_credit_types',
|
||
'multilingual' => array(
|
||
'honor_block_title',
|
||
'honor_block_text',
|
||
),
|
||
),
|
||
'on_behalf' => array(
|
||
1 => 'is_for_organization',
|
||
'multilingual' => array(
|
||
'for_organization',
|
||
),
|
||
),
|
||
);
|
||
|
||
//When we are fetching the honor params respecting both multi and mono lingual state
|
||
//and setting it to default param of Contribution Page's Main and Setting form
|
||
if ($setDefault) {
|
||
$jsonDecode = json_decode($params);
|
||
$jsonDecode = (array) $jsonDecode->$module;
|
||
if (!$domain->locales && !empty($jsonDecode['default'])) {
|
||
//monolingual state
|
||
$jsonDecode += (array) $jsonDecode['default'];
|
||
unset($jsonDecode['default']);
|
||
}
|
||
elseif (!empty($jsonDecode[$tsLocale])) {
|
||
//multilingual state
|
||
foreach ($jsonDecode[$tsLocale] as $column => $value) {
|
||
$jsonDecode[$column] = $value;
|
||
}
|
||
unset($jsonDecode[$tsLocale]);
|
||
}
|
||
return $jsonDecode;
|
||
}
|
||
|
||
//check and handle multilingual honoree params
|
||
if (!$domain->locales) {
|
||
//if in singlelingual state simply return the array format
|
||
$json = array($module => NULL);
|
||
foreach ($moduleDataFormat[$module] as $key => $attribute) {
|
||
if ($key === 'multilingual') {
|
||
$json[$module]['default'] = array();
|
||
foreach ($attribute as $attr) {
|
||
$json[$module]['default'][$attr] = $params[$attr];
|
||
}
|
||
}
|
||
else {
|
||
$json[$module][$attribute] = $params[$attribute];
|
||
}
|
||
}
|
||
$json = json_encode($json);
|
||
}
|
||
else {
|
||
//if in multilingual state then retrieve the module_data against this contribution and
|
||
//merge with earlier module_data json data to current so not to lose earlier multilingual module_data information
|
||
$json = array($module => NULL);
|
||
foreach ($moduleDataFormat[$module] as $key => $attribute) {
|
||
if ($key === 'multilingual') {
|
||
$json[$module][$config->lcMessages] = array();
|
||
foreach ($attribute as $attr) {
|
||
$json[$module][$config->lcMessages][$attr] = $params[$attr];
|
||
}
|
||
}
|
||
else {
|
||
$json[$module][$attribute] = $params[$attribute];
|
||
}
|
||
}
|
||
|
||
$ufJoinDAO = new CRM_Core_DAO_UFJoin();
|
||
$ufJoinDAO->module = $module;
|
||
$ufJoinDAO->entity_id = $params['id'];
|
||
$ufJoinDAO->find(TRUE);
|
||
$jsonData = json_decode($ufJoinDAO->module_data);
|
||
if ($jsonData) {
|
||
$json[$module] = array_merge((array) $jsonData->$module, $json[$module]);
|
||
}
|
||
$json = json_encode($json);
|
||
}
|
||
return $json;
|
||
}
|
||
|
||
/**
|
||
* Generate html for pdf in confirmation receipt email attachment.
|
||
* @param int $contributionId
|
||
* Contribution Page Id.
|
||
* @param int $userID
|
||
* Contact id for contributor.
|
||
* @return array
|
||
*/
|
||
public static function addInvoicePdfToEmail($contributionId, $userID) {
|
||
$contributionID = array($contributionId);
|
||
$contactId = array($userID);
|
||
$pdfParams = array(
|
||
'output' => 'pdf_invoice',
|
||
'forPage' => 'confirmpage',
|
||
);
|
||
$pdfHtml = CRM_Contribute_Form_Task_Invoice::printPDF($contributionID, $pdfParams, $contactId);
|
||
return $pdfHtml;
|
||
}
|
||
|
||
/**
|
||
* Helper to determine if the page supports separate membership payments.
|
||
*
|
||
* @param int $id form id
|
||
*
|
||
* @return bool
|
||
* isSeparateMembershipPayment
|
||
*/
|
||
public static function getIsMembershipPayment($id) {
|
||
$membershipBlocks = civicrm_api3('membership_block', 'get', array(
|
||
'entity_table' => 'civicrm_contribution_page',
|
||
'entity_id' => $id,
|
||
'sequential' => TRUE,
|
||
));
|
||
if (!$membershipBlocks['count']) {
|
||
return FALSE;
|
||
}
|
||
return $membershipBlocks['values'][0]['is_separate_payment'];
|
||
}
|
||
|
||
}
|