public static function FillPdfAdminFormHelper::getReplacementsDescription in FillPDF 5.0.x

Same name and namespace in other branches

1. 8.4 src/Service/FillPdfAdminFormHelper.php \Drupal\fillpdf\Service\FillPdfAdminFormHelper::getReplacementsDescription()

Returns the help text for FillPDF replacements.

Return value

\Drupal\Core\StringTranslation\TranslatableMarkup The help text.

Overrides FillPdfAdminFormHelperInterface::getReplacementsDescription

1 call to FillPdfAdminFormHelper::getReplacementsDescription()

fillpdf_update_8104 in ./fillpdf.install

Add replacements fields.

File

src/Service/FillPdfAdminFormHelper.php, line 110

Class

FillPdfAdminFormHelper

Various helper methods used in FillPDF administrative forms.

Namespace

Drupal\fillpdf\Service

Code

public static function getReplacementsDescription() {
  return new TranslatableMarkup("<p>Tokens, such as those from fields, sometimes output values that need additional\n  processing prior to being sent to the PDF. A common example is when a key within a field's <em>Allowed values</em>\n  configuration does not match the field name or option value in the PDF that you would like to be selected but you\n  do not want to change the <em>Allowed values</em> key.</p><p>This field will replace any matching values with the\n  replacements you specify. Specify <strong>one replacement per line</strong> in the format\n  <em>original value|replacement value</em>. For example, <em>yes|Y</em> will fill the PDF with\n  <strong><em>Y</em></strong> anywhere that <strong><em>yes</em></strong> would have originally\n  been used. <p>Note that omitting the <em>replacement value</em> will replace <em>original value</em>\n  with a blank, essentially erasing it.</p>");
}