You are here

interface TranslatorInterface in Plug 7

TranslatorInterface.

@author Fabien Potencier <fabien@symfony.com>

@api

Hierarchy

Expanded class hierarchy of TranslatorInterface

All classes that implement TranslatorInterface

11 files declare their use of TranslatorInterface
ConstraintViolationBuilder.php in lib/Symfony/validator/Symfony/Component/Validator/Violation/ConstraintViolationBuilder.php
DefaultTranslator.php in lib/Symfony/validator/Symfony/Component/Validator/DefaultTranslator.php
ExecutionContext.php in lib/Symfony/validator/Symfony/Component/Validator/ExecutionContext.php
ExecutionContext.php in lib/Symfony/validator/Symfony/Component/Validator/Context/ExecutionContext.php
ExecutionContextFactory.php in lib/Symfony/validator/Symfony/Component/Validator/Context/ExecutionContextFactory.php

... See full list

File

lib/Symfony/translation/TranslatorInterface.php, line 21

Namespace

Symfony\Component\Translation
View source
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
   *
   * @api
   */
  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
   *
   * @api
   */
  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
   *
   * @api
   */
  public function setLocale($locale);

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

}

Members

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