Merge pull request civicrm#14658 from MegaphoneJon/mail-46

mail#46 - show label, not value, on contribution custom field tokens

Author: eileenmcnaughton

CRM/Contribute/BAO/Contribution.php

@@ -5907,14 +5907,38 @@ public static function replaceContributionTokens(
     }
     $contributionDetails = [];
     foreach ($contributionIds as $id) {
-      $result = civicrm_api3('Contribution', 'get', ['id' => $id]);
+      $result = self::getContributionTokenValues($id, $messageToken);
       $contributionDetails[$result['values'][$result['id']]['contact_id']]['subject'] = CRM_Utils_Token::replaceContributionTokens($subject, $result, FALSE, $subjectToken, FALSE, $escapeSmarty);
       $contributionDetails[$result['values'][$result['id']]['contact_id']]['text'] = CRM_Utils_Token::replaceContributionTokens($text, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
       $contributionDetails[$result['values'][$result['id']]['contact_id']]['html'] = CRM_Utils_Token::replaceContributionTokens($html, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
     }
     return $contributionDetails;
   }
 
+  /**
+   * Get the contribution fields for $id and display labels where
+   * appropriate (if the token is present).
+   *
+   * @param int $id
+   * @param array $messageToken
+   * @return array
+   */
+  public static function getContributionTokenValues($id, $messageToken) {
+    if (empty($id)) {
+      return [];
+    }
+    $result = civicrm_api3('Contribution', 'get', ['id' => $id]);
+    // lab.c.o mail#46 - show labels, not values, for custom fields with option values.
+    if (!empty($messageToken)) {
+      foreach ($result['values'][$id] as $fieldName => $fieldValue) {
+        if (strpos($fieldName, 'custom_') === 0 && array_search($fieldName, $messageToken['contribution']) !== FALSE) {
+          $result['values'][$id][$fieldName] = CRM_Core_BAO_CustomField::displayValue($result['values'][$id][$fieldName], $fieldName);
+        }
+      }
+    }
+    return $result;
+  }
+
   /**
    * Get invoice_number for contribution.
    *

CRM/Contribute/Form/Task/PDFLetterCommon.php

@@ -257,16 +257,7 @@ private static function resolveTokens($html_message, $contact, $contribution, $m
   public static function buildContributionArray($groupBy, $contributionIDs, $returnProperties, $skipOnHold, $skipDeceased, $messageToken, $task, $separator, $isIncludeSoftCredits) {
     $contributions = $contacts = [];
     foreach ($contributionIDs as $item => $contributionId) {
-      // Basic return attributes available to the template.
-      $returnValues = ['contact_id', 'total_amount', 'financial_type', 'receive_date', 'contribution_campaign_title'];
-      if (!empty($messageToken['contribution'])) {
-        $returnValues = array_merge($messageToken['contribution'], $returnValues);
-      }
-      // retrieve contribution tokens listed in $returnProperties using Contribution.Get API
-      $contribution = civicrm_api3('Contribution', 'getsingle', [
-        'id' => $contributionId,
-        'return' => $returnValues,
-      ]);
+      $contribution = CRM_Contribute_BAO_Contribution::getContributionTokenValues($contributionId, $messageToken)['values'][$contributionId];
       $contribution['campaign'] = CRM_Utils_Array::value('contribution_campaign_title', $contribution);
       $contributions[$contributionId] = $contribution;
 

tests/phpunit/CRM/Contribute/BAO/ContributionTest.php

@@ -1466,6 +1466,8 @@ public function testProcessOnBehalfOrganization() {
    *   This function tests whether the contribution tokens are replaced with values from contribution.
    */
   public function testReplaceContributionTokens() {
+    $customGroup = $this->customGroupCreate(['extends' => 'Contribution', 'title' => 'contribution stuff']);
+    $customField = $this->customFieldOptionValueCreate($customGroup, 'myCustomField');
     $contactId1 = $this->individualCreate();
     $params = array(
       'contact_id' => $contactId1,
@@ -1476,6 +1478,7 @@ public function testReplaceContributionTokens() {
       'invoice_id' => 67890,
       'source' => 'SSF',
       'contribution_status_id' => 2,
+      "custom_{$customField['id']}" => 'value1',
     );
     $contribution1 = $this->contributionCreate($params);
     $contactId2 = $this->individualCreate();
@@ -1488,6 +1491,7 @@ public function testReplaceContributionTokens() {
       'invoice_id' => 12345,
       'source' => 'ABC',
       'contribution_status_id' => 1,
+      "custom_{$customField['id']}" => 'value2',
     );
     $contribution2 = $this->contributionCreate($params);
     $ids = array($contribution1, $contribution2);
@@ -1496,7 +1500,8 @@ public function testReplaceContributionTokens() {
     $text = "Contribution Amount: {contribution.total_amount}";
     $html = "<p>Contribution Source: {contribution.contribution_source}</p></br>
       <p>Contribution Invoice ID: {contribution.invoice_id}</p></br>
-      <p>Contribution Receive Date: {contribution.receive_date}</p></br>";
+      <p>Contribution Receive Date: {contribution.receive_date}</p></br>
+      <p>Contribution Custom Field: {contribution.custom_{$customField['id']}}</p></br>";
 
     $subjectToken = CRM_Utils_Token::getTokens($subject);
     $messageToken = CRM_Utils_Token::getTokens($text);
@@ -1515,7 +1520,8 @@ public function testReplaceContributionTokens() {
     $this->assertEquals("Contribution Amount: $ 100.00", $contributionDetails[$contactId1]['text'], "The text does not match");
     $this->assertEquals("<p>Contribution Source: ABC</p></br>
       <p>Contribution Invoice ID: 12345</p></br>
-      <p>Contribution Receive Date: May 11th, 2015</p></br>", $contributionDetails[$contactId2]['html'], "The html does not match");
+      <p>Contribution Receive Date: May 11th, 2015</p></br>
+      <p>Contribution Custom Field: Label2</p></br>", $contributionDetails[$contactId2]['html'], "The html does not match");
   }
 
   /**

tests/phpunit/CiviTest/CiviUnitTestCase.php

@@ -1684,7 +1684,7 @@ public function customFieldOptionValueCreate($customGroup, $name, $extraParams =
       'option_value' => array('value1', 'value2'),
       'option_name' => array($name . '_1', $name . '_2'),
       'option_weight' => array(1, 2),
-      'option_status' => 1,
+      'option_status' => array(1, 1),
     );
 
     $params = array_merge($fieldParams, $optionGroup, $optionValue, $extraParams);