* @since 2.0 */ class I18N extends Component { /** * @var array list of [[MessageSource]] configurations or objects. The array keys are message * categories, and the array values are the corresponding [[MessageSource]] objects or the configurations * for creating the [[MessageSource]] objects. The message categories can contain the wildcard '*' at the end * to match multiple categories with the same prefix. For example, 'app\*' matches both 'app\cat1' and 'app\cat2'. * * This property may be modified on the fly by extensions who want to have their own message sources * registered under their own namespaces. * * The category "yii" and "app" are always defined. The former refers to the messages used in the Yii core * framework code, while the latter refers to the default message category for custom application code. * By default, both of these categories use [[PhpMessageSource]] and the corresponding message files are * stored under "@yii/messages" and "@app/messages", respectively. * * You may override the configuration of both categories. */ public $translations; /** * Initializes the component by configuring the default message categories. */ public function init() { parent::init(); if (!isset($this->translations['yii'])) { $this->translations['yii'] = [ 'class' => 'yii\i18n\PhpMessageSource', 'sourceLanguage' => 'en_US', 'basePath' => '@yii/messages', ]; } if (!isset($this->translations['app'])) { $this->translations['app'] = [ 'class' => 'yii\i18n\PhpMessageSource', 'sourceLanguage' => 'en_US', 'basePath' => '@app/messages', ]; } } /** * Translates a message to the specified language. * * After translation the message will be formatted using [[MessageFormatter]] if it contains * ICU message format and `$params` are not empty. * * @param string $category the message category. * @param string $message the message to be translated. * @param array $params the parameters that will be used to replace the corresponding placeholders in the message. * @param string $language the language code (e.g. `en_US`, `en`). * @return string the translated message. */ public function translate($category, $message, $params, $language) { $message = $this->getMessageSource($category)->translate($category, $message, $language); $params = (array)$params; if ($params === []) { return $message; } if (preg_match('~{\s*[\d\w]+\s*,~u', $message)) { $formatter = new MessageFormatter($language, $message); if ($formatter === null) { Yii::warning("$language message from category $category is invalid. Message is: $message."); return $message; } $result = $formatter->format($params); if ($result === false) { $errorMessage = $formatter->getErrorMessage(); Yii::warning("$language message from category $category failed with error: $errorMessage. Message is: $message."); return $message; } else { return $result; } } $p = []; foreach($params as $name => $value) { $p['{' . $name . '}'] = $value; } return strtr($message, $p); } /** * Formats a message using using [[MessageFormatter]]. * * @param string $message the message to be formatted. * @param array $params the parameters that will be used to replace the corresponding placeholders in the message. * @param string $language the language code (e.g. `en_US`, `en`). * @return string the formatted message. */ public function format($message, $params, $language) { $params = (array)$params; if ($params === []) { return $message; } if (preg_match('~{\s*[\d\w]+\s*,~u', $message)) { $formatter = new MessageFormatter($language, $message); if ($formatter === null) { Yii::warning("Message for $language is invalid: $message."); return $message; } $result = $formatter->format($params); if ($result === false) { $errorMessage = $formatter->getErrorMessage(); Yii::warning("Formatting message for $language failed with error: $errorMessage. Message is: $message."); return $message; } else { return $result; } } $p = []; foreach($params as $name => $value) { $p['{' . $name . '}'] = $value; } return strtr($message, $p); } /** * Returns the message source for the given category. * @param string $category the category name. * @return MessageSource the message source for the given category. * @throws InvalidConfigException if there is no message source available for the specified category. */ public function getMessageSource($category) { if (isset($this->translations[$category])) { $source = $this->translations[$category]; } else { // try wildcard matching foreach ($this->translations as $pattern => $config) { if ($pattern === '*' || substr($pattern, -1) === '*' && strpos($category, rtrim($pattern, '*')) === 0) { $source = $config; break; } } } if (isset($source)) { return $source instanceof MessageSource ? $source : Yii::createObject($source); } else { throw new InvalidConfigException("Unable to locate message source for category '$category'."); } } }