TranslatorInterface.php in Plug 7

Namespace

Symfony\Component\Translation

File

lib/Symfony/translation/TranslatorInterface.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Translation;


/**
 * TranslatorInterface.
 *
 * @author Fabien Potencier <[e-mail]>
 *
 * @api
 */
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();

}

Interfaces

Name	Description
TranslatorInterface	TranslatorInterface.