<?php

/*

 * This file is part of the Symfony package.

 *

 * (c) Fabien Potencier <fabien@symfony.com>

 *

 * 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 <fabien@symfony.com>

 *

 * @api

 */

interface TranslatorInterface

{

    /**

     * Translates the given message.

     *

     * @param string $id         The message id

     * @param array  $parameters An array of parameters for the message

     * @param string $domain     The domain for the message

     * @param string $locale     The locale

     *

     * @return string The translated string

     *

     * @api

     */

    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

     * @param integer $number     The number to use to find the indice of the message

     * @param array   $parameters An array of parameters for the message

     * @param string  $domain     The domain for the message

     * @param string  $locale     The locale

     *

     * @return string The translated string

     *

     * @api

     */

    function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null);

    /**

     * Sets the current locale.

     *

     * @param string $locale The locale

     *

     * @api

     */

    function setLocale($locale);

    /**

     * Returns the current locale.

     *

     * @return string The locale

     *

     * @api

     */

    function getLocale();

}