/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237