<?php
final class PhutilTranslator extends Phobject {
private static $instance;
private $locale;
private $localeCode;
private $shouldPostProcess;
private $willTranslateCallback;
private $translations = array();
public static function getInstance() {
if (self::$instance === null) {
self::$instance = new PhutilTranslator();
}
return self::$instance;
}
public static function setInstance(PhutilTranslator $instance) {
self::$instance = $instance;
}
public function setLocale(PhutilLocale $locale) {
$this->locale = $locale;
$this->localeCode = $locale->getLocaleCode();
$this->shouldPostProcess = $locale->shouldPostProcessTranslations();
return $this;
}
public function setWillTranslateCallback($callback) {
$this->willTranslateCallback = $callback;
return $this;
}
public function getWillTranslateCallback() {
return $this->willTranslateCallback;
}
/**
* Add translations which will be later used by @{method:translate}.
* The parameter is an array of strings (for simple translations) or arrays
* (for translations with variants). The number of items in the array is
* language specific. It is `array($singular, $plural)` for English.
*
* array(
* 'color' => 'colour',
* '%d beer(s)' => array('%d beer', '%d beers'),
* );
*
* The arrays can be nested for strings with more variant parts:
*
* array(
* '%d char(s) on %d row(s)' => array(
* array('%d char on %d row', '%d char on %d rows'),
* array('%d chars on %d row', '%d chars on %d rows'),
* ),
* );
*
* The translation should have the same placeholders as originals. Swapping
* parameter order is possible:
*
* array(
* '%s owns %s.' => '%2$s is owned by %1$s.',
* );
*
* @param array Identifier in key, translation in value.
* @return PhutilTranslator Provides fluent interface.
*/
public function setTranslations(array $translations) {
$this->translations = $translations;
return $this;
}
/**
* @phutil-external-symbol class PhutilSafeHTML
* @phutil-external-symbol class PhutilSafeHTMLProducerInterface
* @phutil-external-symbol function phutil_escape_html
* @phutil-external-symbol function phutil_safe_html
*/
public function translate($text /* , ... */) {
$args = func_get_args();
if ($this->willTranslateCallback) {
call_user_func_array($this->willTranslateCallback, $args);
}
if (isset($this->translations[$text])) {
$translation = $this->translations[$text];
} else {
$translation = $text;
}
while (is_array($translation)) {
$arg = next($args);
$translation = $this->chooseVariant($translation, $arg);
if ($translation === null) {
$pos = key($args);
if (is_object($arg)) {
$kind = get_class($arg);
} else {
$kind = gettype($arg);
}
return sprintf(
'[Invalid Translation!] The "%s" language data offers variant '.
'translations for the plurality or gender of argument %s, but '.
'the value for that argument is not an integer, PhutilNumber, or '.
'PhutilPerson (it is a value of type "%s"). Raw input: <%s>.',
$this->localeCode,
$pos,
$kind,
$text);
}
}
array_shift($args);
foreach ($args as $k => $arg) {
if ($arg instanceof PhutilNumber) {
$args[$k] = $this->formatNumber($arg->getNumber(), $arg->getDecimals());
}
}
// Check if any arguments are PhutilSafeHTML. If they are, we will apply
// any escaping necessary and output HTML.
$is_html = false;
foreach ($args as $arg) {
if ($arg instanceof PhutilSafeHTML ||
$arg instanceof PhutilSafeHTMLProducerInterface) {
$is_html = true;
break;
}
}
if ($is_html) {
foreach ($args as $k => $arg) {
$args[$k] = (string)phutil_escape_html($arg);
}
}
$result = vsprintf($translation, $args);
if ($result === false) {
// If vsprintf() fails (often because the translated string references
// too many parameters), show the bad template with a note instead of
// returning an empty string. This makes it easier to figure out what
// went wrong and fix it.
$result = pht('[Invalid Translation!] %s', $translation);
}
if ($this->shouldPostProcess) {
$result = $this->locale->didTranslateString(
$text,
$translation,
$args,
$result);
}
if ($is_html) {
$result = phutil_safe_html($result);
}
return $result;
}
private function chooseVariant(array $translations, $variant) {
if (count($translations) == 1) {
// If we only have one variant, we can select it directly.
return reset($translations);
}
if ($variant instanceof PhutilNumber) {
$is_gender = false;
$variant = $variant->getNumber();
} else if ($variant instanceof PhutilPerson) {
$is_gender = true;
$variant = $variant->getGender();
} else if (is_int($variant)) {
$is_gender = false;
} else {
return null;
}
if ($is_gender) {
return $this->locale->selectGenderVariant($variant, $translations);
} else {
// NOTE: This is a microoptimization which slightly improves performance
// for common languages with simple plural rules. Languages do not need
// to be added here even if they use the simple rules. The benefit of
// inclusion here is small, on the order of 5%.
static $simple_plural = array(
'en_US' => true,
'en_GB' => true,
'en_ES' => true,
'ko_KR' => true,
);
if (isset($simple_plural[$this->localeCode])) {
if ($variant == 1) {
return reset($translations);
} else {
return end($translations);
}
} else {
return $this->locale->selectPluralVariant($variant, $translations);
}
}
}
/**
* Translate date formatted by `$date->format()`.
*
* @param string Format accepted by `DateTime::format()`.
* @param DateTime
* @return string Formatted and translated date.
*/
public function translateDate($format, DateTime $date) {
static $format_cache = array();
if (!isset($format_cache[$format])) {
$translatable = 'DlSFMaA';
preg_match_all(
'/['.$translatable.']|(\\\\.|[^'.$translatable.'])+/',
$format,
$format_cache[$format],
PREG_SET_ORDER);
}
$parts = array();
foreach ($format_cache[$format] as $match) {
$part = $date->format($match[0]);
if (!isset($match[1])) {
$part = $this->translate($part);
}
$parts[] = $part;
}
return implode('', $parts);
}
/**
* Format number with grouped thousands and optional decimal part. Requires
* translations of '.' (decimal point) and ',' (thousands separator). Both
* these translations must be 1 byte long with PHP < 5.4.0.
*
* @param float
* @param int
* @return string
*/
public function formatNumber($number, $decimals = 0) {
return number_format(
$number,
$decimals,
$this->translate('.'),
$this->translate(','));
}
public function validateTranslation($original, $translation) {
$pattern = '/<(\S[^>]*>?)?|&(\S[^;]*;?)?/i';
$original_matches = null;
$translation_matches = null;
preg_match_all($pattern, $original, $original_matches);
preg_match_all($pattern, $translation, $translation_matches);
sort($original_matches[0]);
sort($translation_matches[0]);
if ($original_matches[0] !== $translation_matches[0]) {
return false;
}
return true;
}
}