Dhii/i18n-interface

<?php

namespace Dhii\I18n;

use Dhii\Data\ValueAwareInterface as Value;

/**
 * Something that can act as a translator, which can translate a string format.
 *
 * The {@see translate()} method throws a more specialized
 * {@see Dhii\I18n\Exception\FormatTranslationExceptionInterface}.
 *
 * @since 0.1
 */
interface FormatTranslatorInterface extends TranslatorInterface
{
    /**
     * {@inheritdoc}
     *
     * If values are given, MUST attempt to use them for interpolating placeholders in the string.
     *
     * @since 0.1
     *
     * @param string|Stringable $format  The string format to translate
     * @param array|null        $params  A map of values to use for placeholder substitution, if any.
     * @param string|Value|null $context A context for the string, if any.
     *
     * @return string The translated string, with placeholders interpolated.
     */
    public function translate($format, $params = null, $context = null);
}