Newer
Older
Dries Buytaert
committed
<?php
namespace Drupal\Core\Validation;
Alex Bronstein
committed
use Drupal\Component\Render\MarkupInterface;
Alex Bronstein
committed
use Drupal\Core\StringTranslation\TranslatableMarkup;
Alex Bronstein
committed
Dries Buytaert
committed
/**
* Translates strings using Drupal's translation system.
*
* This class is used by the Symfony validator to translate violation messages.
*/
class DrupalTranslator implements TranslatorInterface {
/**
* The locale used for translating.
*
* @var string
*/
protected $locale;
/**
* {@inheritdoc}
Dries Buytaert
committed
*/
public function trans($id, array $parameters = array(), $domain = NULL, $locale = NULL) {
Alex Bronstein
committed
// If a TranslatableMarkup object is passed in as $id, return it since the
// message has already been translated.
return $id instanceof TranslatableMarkup ? $id : t($id, $this->processParameters($parameters), $this->getOptions($domain, $locale));
Dries Buytaert
committed
}
/**
* {@inheritdoc}
Dries Buytaert
committed
*/
public function transChoice($id, $number, array $parameters = array(), $domain = NULL, $locale = NULL) {
// Violation messages can separated singular and plural versions by "|".
$ids = explode('|', $id);
if (!isset($ids[1])) {
throw new \InvalidArgumentException(sprintf('The message "%s" cannot be pluralized, because it is missing a plural (e.g. "There is one apple|There are @count apples").', $id));
}
// Normally, calls to formatPlural() need to use literal strings, like
// formatPlural($count, '1 item', '@count items')
// so that the Drupal project POTX string extractor will correctly
// extract the strings for translation and save them in a format that
// formatPlural() can work with. However, this is a special case, because
// Drupal is supporting a constraint message format from Symfony. So
// although $id looks like a variable here, it is actually coming from a
// static string in a constraint class that the POTX extractor knows about
// and has processed to work with formatPlural(), so this specific call to
// formatPlural() will work correctly.
return \Drupal::translation()->formatPlural($number, $ids[0], $ids[1], $this->processParameters($parameters), $this->getOptions($domain, $locale));
Dries Buytaert
committed
}
/**
* {@inheritdoc}
Dries Buytaert
committed
*/
public function setLocale($locale) {
$this->locale = $locale;
}
/**
* {@inheritdoc}
Dries Buytaert
committed
*/
public function getLocale() {
return $this->locale ? $this->locale : \Drupal::languageManager()->getCurrentLanguage()->getId();
Dries Buytaert
committed
}
/**
* Processes the parameters array for use with t().
*/
protected function processParameters(array $parameters) {
$return = array();
foreach ($parameters as $key => $value) {
Alex Bronstein
committed
// We allow the values in the parameters to be safe string objects. This
// can be useful when we want to use parameter values that are
Alex Bronstein
committed
// TranslatableMarkup.
if ($value instanceof MarkupInterface) {
Alex Bronstein
committed
$value = (string) $value;
}
Dries Buytaert
committed
if (is_object($value)) {
Alex Bronstein
committed
// t() does not work with objects being passed as replacement strings.
Dries Buytaert
committed
}
// Check for symfony replacement patterns in the form "{{ name }}".
elseif (strpos($key, '{{ ') === 0 && strrpos($key, ' }}') == strlen($key) - 3) {
// Transform it into a Drupal pattern using the format %name.
$key = '%' . substr($key, 3, strlen($key) - 6);
$return[$key] = $value;
}
else {
$return[$key] = $value;
}
}
return $return;
}
/**
* Returns options suitable for use with t().
*/
protected function getOptions($domain = NULL, $locale = NULL) {
// We do not support domains, so we ignore this parameter.
// If locale is left NULL, t() will default to the interface language.
$locale = isset($locale) ? $locale : $this->locale;
return array('langcode' => $locale);
}
}