interface TranslatorInterface in Zircon Profile 8

TranslatorInterface.

@author Fabien Potencier <[e-mail]>

Hierarchy

• interface \Symfony\Component\Translation\TranslatorInterface

13 files declare their use of TranslatorInterface

ConstraintViolationBuilder.php in vendor/symfony/validator/Violation/ConstraintViolationBuilder.php

DefaultTranslator.php in vendor/symfony/validator/DefaultTranslator.php

ExecutionContext.php in vendor/symfony/validator/ExecutionContext.php

ExecutionContext.php in vendor/symfony/validator/Context/ExecutionContext.php

ExecutionContextFactory.php in vendor/symfony/validator/Context/ExecutionContextFactory.php

... See full list

File

vendor/symfony/translation/TranslatorInterface.php, line 19

Namespace

Symfony\Component\Translation

interface TranslatorInterface {

  /**
   * Translates the given message.
   *
   * @param string      $id         The message id (may also be an object that can be cast to string)
   * @param array       $parameters An array of parameters for the message
   * @param string|null $domain     The domain for the message or null to use the default
   * @param string|null $locale     The locale or null to use the default
   *
   * @throws \InvalidArgumentException If the locale contains invalid characters
   *
   * @return string The translated string
   */
  public function trans($id, array $parameters = array(), $domain = null, $locale = null);

  /**
   * Translates the given choice message by choosing a translation according to a number.
   *
   * @param string      $id         The message id (may also be an object that can be cast to string)
   * @param int         $number     The number to use to find the indice of the message
   * @param array       $parameters An array of parameters for the message
   * @param string|null $domain     The domain for the message or null to use the default
   * @param string|null $locale     The locale or null to use the default
   *
   * @throws \InvalidArgumentException If the locale contains invalid characters
   *
   * @return string The translated string
   */
  public function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null);

  /**
   * Sets the current locale.
   *
   * @param string $locale The locale
   *
   * @throws \InvalidArgumentException If the locale contains invalid characters
   */
  public function setLocale($locale);

  /**
   * Returns the current locale.
   *
   * @return string The locale
   */
  public function getLocale();

}

Members

Name	Modifiers	Type	Description	Overrides
TranslatorInterface::getLocale	public	function	Returns the current locale.	6
TranslatorInterface::setLocale	public	function	Sets the current locale.	6
TranslatorInterface::trans	public	function	Translates the given message.	6
TranslatorInterface::transChoice	public	function	Translates the given choice message by choosing a translation according to a number.	6