Issue #3005964 by tim-diels, awolfey: Move Glossify tip sanitizing to theme function

glossify.module

@@ -14,6 +14,7 @@ function glossify_theme() {
       'variables' => [
         'word' => NULL,
         'tip' => NULL,
+        'tip_raw' => NULL,
         'langcode' => NULL,
       ],
     ],
@@ -21,6 +22,7 @@ function glossify_theme() {
       'variables' => [
         'word' => NULL,
         'tip' => NULL,
+        'tip_raw' => NULL,
         'tipurl' => NULL,
       ],
     ],

src/GlossifyBase.php

@@ -148,11 +148,13 @@ abstract class GlossifyBase extends FilterBase {
           }
           else {
             $tip = '';
+            $tip_raw = '';
             if ($displaytype == 'links' || $displaytype == 'tooltips_links') {
 
               // Insert the matched term instance as link.
               if ($displaytype == 'tooltips_links') {
                 $tip = $this->sanitizeTip((string) $term->tip, $tooltip_truncate);
+                $tip_raw = $this->sanitizeRawTip((string) $term->tip, $tooltip_truncate);
               }
               if (\Drupal::hasContainer()) {
                 $tipurl = Url::fromUri('internal:' . str_replace('[id]', $term->id, $urlpattern));
@@ -164,6 +166,7 @@ abstract class GlossifyBase extends FilterBase {
                 '#theme' => 'glossify_link',
                 '#word' => $term_txt,
                 '#tip' => $tip,
+                '#tip_raw' => $tip_raw,
                 '#tipurl' => $tipurl,
               ];
               $word = $this->renderLink($word_link);
@@ -172,11 +175,13 @@ abstract class GlossifyBase extends FilterBase {
               // Has to be 'tooltips'.
               // Insert the matched term instance as tooltip.
               $tip = $this->sanitizeTip($term->tip, $tooltip_truncate);
+              $tip_raw = $this->sanitizeRawTip($term->tip, $tooltip_truncate);
 
               $word_tip = [
                 '#theme' => 'glossify_tooltip',
                 '#word' => $term_txt,
                 '#tip' => $tip,
+                '#tip_raw' => $tip_raw,
                 '#langcode' => $langcode,
               ];
               $word = $this->renderTip($word_tip);
@@ -245,4 +250,25 @@ abstract class GlossifyBase extends FilterBase {
     return $tip;
   }
 
+  /**
+   * Cleanup and truncate raw tip text.
+   *
+   * @param string $tip
+   *   The tooltip string.
+   * @param bool $truncate
+   *   Whether to truncate the tooltip string.
+   *
+   * @return string
+   *   The prepared tooltip string.
+   */
+  private function sanitizeRawTip($tip, $truncate = TRUE) {
+    // Maximise tooltip text length.
+    if ($truncate) {
+      // @todo: How to properly truncate the tip if it contains HTML?
+      // @see https://www.drupal.org/project/drupal/issues/2279655
+      $tip = Unicode::truncate($tip, 300, TRUE, TRUE);
+    }
+    return $tip;
+  }
+
 }

templates/glossify-link.html.twig

@@ -6,6 +6,7 @@
  * Available variables:
  * - word: the text where the tooltips applies to.
  * - tip: the tooltip text.
+ * - tip_raw: the tooltip text in its raw format.
  * - tipurl: the tooltip link.
  *
  * @ingroup themeable

templates/glossify-tooltip.html.twig

@@ -6,6 +6,7 @@
  * Available variables:
  * - word: the text where the tooltips applies to.
  * - tip: the tooltip text.
+ * - tip_raw: the tooltip text in its raw format.
  * - langcode: the tooltip language code.
  *
  * @ingroup themeable