interface TranslatorInterface in Zircon Profile 8

Interface for objects capable of string translation.

Hierarchy

• interface \Drupal\Core\StringTranslation\Translator\TranslatorInterface

3 files declare their use of TranslatorInterface

LanguageRequestSubscriber.php in core/modules/language/src/EventSubscriber/LanguageRequestSubscriber.php

Contains \Drupal\language\EventSubscriber\LanguageRequestSubscriber.

LocaleTranslation.php in core/modules/locale/src/LocaleTranslation.php

Contains \Drupal\locale\LocaleTranslation.

TranslationManager.php in core/lib/Drupal/Core/StringTranslation/TranslationManager.php

Contains \Drupal\Core\StringTranslation\TranslationManager.

File

core/lib/Drupal/Core/StringTranslation/Translator/TranslatorInterface.php, line 13

Contains \Drupal\Core\StringTranslation\Translator\TranslatorInterface.

Namespace

Drupal\Core\StringTranslation\Translator

interface TranslatorInterface {

  /**
   * Retrieves English string to given language.
   *
   * @param string $langcode
   *   Language code to translate to.
   * @param string $string
   *   The source string.
   * @param string $context
   *   The string context.
   *
   * @return string|FALSE
   *   Translated string if there is a translation, FALSE if not.
   */
  public function getStringTranslation($langcode, $string, $context);

  /**
   * Resets translation cache.
   *
   * Since most translation systems implement some form of caching, this
   * provides a way to delete that cache.
   */
  public function reset();

}

Members

Name	Modifiers	Type	Description	Overrides
TranslatorInterface::getStringTranslation	public	function	Retrieves English string to given language.	3
TranslatorInterface::reset	public	function	Resets translation cache.	3