TranslatorInterface.php in Drupal 9

Namespace

Drupal\Core\StringTranslation\Translator

File

core/lib/Drupal/Core/StringTranslation/Translator/TranslatorInterface.php

<?php

namespace Drupal\Core\StringTranslation\Translator;


/**
 * Interface for objects capable of string translation.
 */
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();

}

Interfaces

Name	Description
TranslatorInterface	Interface for objects capable of string translation.