Merge pull request #11820 from seanmadsen/CRM-21264

CRM-21264 - Fix tabular formatting of contributions in merged letters grouped by contact
civicrm · Mar 19, 2018 · 1142ce8 · 1142ce8
2 parents e7abfc3 + 5aece37
commit 1142ce8
Show file tree

Hide file tree

Showing 2 changed files with 81 additions and 7 deletions.
diff --git a/CRM/Contribute/Form/Task/PDFLetterCommon.php b/CRM/Contribute/Form/Task/PDFLetterCommon.php
@@ -188,17 +188,17 @@ public static function isValidHTMLWithTableSeparator($tokens, $html) {
    * Check that the token only appears in a table cell. The '</td><td>' separator cannot otherwise work
    * Calculate the number of times it appears IN the cell & the number of times it appears - should be the same!
    *
-   * @param $token
-   * @param $entity
-   * @param $textToSearch
+   * @param string $token
+   * @param string $entity
+   * @param string $textToSearch
    *
    * @return bool
    */
   public static function isHtmlTokenInTableCell($token, $entity, $textToSearch) {
-    $tokenToMatch = $entity . '.' . $token;
-    $dontCare = array();
-    $within = preg_match_all("|<td.+?{" . $tokenToMatch . "}.+?</td|si", $textToSearch, $dontCare);
-    $total = preg_match_all("|{" . $tokenToMatch . "}|", $textToSearch, $dontCare);
+    $tokenToMatch = $entity . '\.' . $token;
+    $pattern = '|<td(?![\w-])((?!</td>).)*\{' . $tokenToMatch . '\}.*?</td>|si';
+    $within = preg_match_all($pattern, $textToSearch);
+    $total = preg_match_all("|{" . $tokenToMatch . "}|", $textToSearch);
     return ($within == $total);
   }
 

diff --git a/tests/phpunit/CRM/Contribute/Form/Task/PDFLetterCommonTest.php b/tests/phpunit/CRM/Contribute/Form/Task/PDFLetterCommonTest.php
@@ -376,4 +376,78 @@ public function hook_aggregateTokenValues(&$values, $contactIDs, $job = NULL, $t
     }
   }
 
+  /**
+   * @param string $token
+   * @param string $entity
+   * @param string $textToSearch
+   * @param bool $expected
+   *
+   * @dataProvider isHtmlTokenInTableCellProvider
+   */
+  public function testIsHtmlTokenInTableCell($token, $entity, $textToSearch, $expected) {
+    $this->assertEquals($expected,
+      CRM_Contribute_Form_Task_PDFLetterCommon::isHtmlTokenInTableCell($token, $entity, $textToSearch)
+    );
+  }
+
+  public function isHtmlTokenInTableCellProvider() {
+    return [
+
+      'simplest TRUE' => [
+        'token',
+        'entity',
+        '<td>{entity.token}</td>',
+        TRUE,
+      ],
+
+      'simplest FALSE' => [
+        'token',
+        'entity',
+        '{entity.token}',
+        FALSE,
+      ],
+
+      'token between two tables' => [
+        'token',
+        'entity',
+        ' <table><tr><td>Top</td></tr></table>
+          {entity.token}
+          <table><tr><td>Bottom</td></tr></table>',
+        FALSE,
+      ],
+
+      'token in two tables' => [
+        'token',
+        'entity',
+        ' <table><tr><td>{entity.token}</td></tr><tr><td>foo</td></tr></table>
+          <table><tr><td>{entity.token}</td></tr><tr><td>foo</td></tr></table>',
+        TRUE,
+      ],
+
+      'token outside of table and inside of table' => [
+        'token',
+        'entity',
+        ' {entity.token}
+          <table><tr><td>{entity.token}</td></tr><tr><td>foo</td></tr></table>',
+        FALSE,
+      ],
+
+      'token inside more complicated table' => [
+        'token',
+        'entity',
+        ' <table><tr><td class="foo"><em>{entity.token}</em></td></tr></table>',
+        TRUE,
+      ],
+
+      'token inside something that looks like table cell' => [
+        'token',
+        'entity',
+        ' <tdata>{entity.token}</tdata>
+          <table><tr><td>Bottom</td></tr></table>',
+        FALSE,
+      ],
+
+    ];
+  }
+
 }