Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CRM-20747: {contribution.campaign} token not working on Contribution ThankYou letter #10533

Merged
merged 1 commit into from
Jul 1, 2017
Merged

CRM-20747: {contribution.campaign} token not working on Contribution ThankYou letter #10533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions CRM/Contribute/Form/Task/PDFLetterCommon.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,10 +246,8 @@ private static function resolveTokens($html_message, $contact, $contribution, $m
public static function buildContributionArray($groupBy, $contributionIDs, $returnProperties, $skipOnHold, $skipDeceased, $messageToken, $task, $separator, $isIncludeSoftCredits) {
$contributions = $contacts = $notSent = array();
foreach ($contributionIDs as $item => $contributionId) {
// get contribution information

// basic return attributes needed, see below for there usage
$returnValues = array('contact_id', 'total_amount');
$returnValues = array('contact_id', 'total_amount', 'contribution_campaign_title');
if (!empty($messageToken['contribution'])) {
$returnValues = array_merge($messageToken['contribution'], $returnValues);
}
Expand All @@ -258,6 +256,7 @@ public static function buildContributionArray($groupBy, $contributionIDs, $retur
'id' => $contributionId,
'return' => $returnValues,
));
$contribution['campaign'] = CRM_Utils_Array::value('contribution_campaign_title', $contribution);
$contributions[$contributionId] = $contribution;

if ($isIncludeSoftCredits) {
Expand Down
8 changes: 6 additions & 2 deletions tests/phpunit/CRM/Contribute/Form/Task/PDFLetterCommonTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,25 +78,27 @@ public function testBuildContributionArray() {
);
$customField = $this->callAPISuccess('CustomField', 'create', $params);
$customFieldKey = 'custom_' . $customField['id'];
$campaignTitle = 'Test Campaign ' . substr(sha1(rand()), 0, 7);

$params = array(
'contact_id' => $this->_individualId,
'total_amount' => 6,
'campaign_id' => $this->campaignCreate(array('title' => $campaignTitle), FALSE),
'financial_type_id' => 'Donation',
$customFieldKey => 'Text_' . substr(sha1(rand()), 0, 7),
);
$contributionIDs = $returnProperties = array();
$result = $this->callAPISuccess('Contribution', 'create', $params);
$contributionIDs[] = $result['id'];
$result = $this->callAPISuccess('Contribution', 'create', $params);
$contributionIDs[] = $result['id'];
$this->hookClass->setHook('civicrm_tokenValues', array($this, 'hookTokenValues'));

// assume that there are two token {contribution.financial_type} and
// {contribution.custom_N} in message content
$messageToken = array(
'contribution' => array(
'financial_type',
'payment_instrument',
'campaign',
$customFieldKey,
),
);
Expand All @@ -106,6 +108,8 @@ public function testBuildContributionArray() {
$this->assertEquals('Anthony', $contacts[$this->_individualId]['first_name']);
$this->assertEquals('emo', $contacts[$this->_individualId]['favourite_emoticon']);
$this->assertEquals('Donation', $contributions[$result['id']]['financial_type']);
$this->assertEquals($campaignTitle, $contributions[$result['id']]['campaign']);
$this->assertEquals('Check', $contributions[$result['id']]['payment_instrument']);
// CRM-20359: assert that contribution custom field token is rightfully replaced by its value
$this->assertEquals($params[$customFieldKey], $contributions[$result['id']][$customFieldKey]);

Expand Down
18 changes: 13 additions & 5 deletions tests/phpunit/CiviTest/CiviUnitTestCase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1952,12 +1952,15 @@ public function ufjoinDelete($params = NULL) {
/**
* @param array $params
* Optional parameters.
* @param bool $reloadConfig
* While enabling CiviCampaign component, we shouldn't always forcibly
* reload config as this hinder hook call in test environment
*
* @return int
* Campaign ID.
*/
public function campaignCreate($params = array()) {
$this->enableCiviCampaign();
public function campaignCreate($params = array(), $reloadConfig = TRUE) {
$this->enableCiviCampaign($reloadConfig);
$campaign = $this->callAPISuccess('campaign', 'create', array_merge(array(
'name' => 'big_campaign',
'title' => 'Campaign',
Expand Down Expand Up @@ -2248,11 +2251,16 @@ public function noteCreate($cId) {

/**
* Enable CiviCampaign Component.
*
* @param bool $reloadConfig
* Force relaod config or not
*/
public function enableCiviCampaign() {
public function enableCiviCampaign($reloadConfig = TRUE) {
CRM_Core_BAO_ConfigSetting::enableComponent('CiviCampaign');
// force reload of config object
$config = CRM_Core_Config::singleton(TRUE, TRUE);
if ($reloadConfig) {
// force reload of config object
$config = CRM_Core_Config::singleton(TRUE, TRUE);
}
//flush cache by calling with reset
$activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, TRUE, 'name', TRUE);
}
Expand Down