From cfc57c20f06a207a74b1effd9e46d6f31b5300aa Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Wed, 23 Oct 2013 20:25:38 +0200 Subject: [PATCH] Allow ITU message format in validator messages fixes #991 --- framework/yii/i18n/I18N.php | 41 +++++++++++++++++++++++ framework/yii/validators/BooleanValidator.php | 4 +-- framework/yii/validators/CompareValidator.php | 4 +-- framework/yii/validators/FileValidator.php | 10 +++--- framework/yii/validators/NumberValidator.php | 4 +-- framework/yii/validators/RequiredValidator.php | 2 +- framework/yii/validators/StringValidator.php | 6 ++-- framework/yii/validators/Validator.php | 6 ++-- tests/unit/framework/validators/ValidatorTest.php | 2 +- 9 files changed, 60 insertions(+), 19 deletions(-) diff --git a/framework/yii/i18n/I18N.php b/framework/yii/i18n/I18N.php index 57978a0..bd9409c 100644 --- a/framework/yii/i18n/I18N.php +++ b/framework/yii/i18n/I18N.php @@ -63,6 +63,9 @@ class I18N extends Component /** * Translates a message to the specified language. * + * After translation the message will be parsed using [[MessageFormatter]] if it contains + * ITU 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. @@ -102,6 +105,44 @@ class I18N extends Component } /** + * 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. diff --git a/framework/yii/validators/BooleanValidator.php b/framework/yii/validators/BooleanValidator.php index 2504b8a..02b11d7 100644 --- a/framework/yii/validators/BooleanValidator.php +++ b/framework/yii/validators/BooleanValidator.php @@ -58,8 +58,8 @@ class BooleanValidator extends Validator $value = $object->$attribute; if (!$this->validateValue($value)) { $this->addError($object, $attribute, $this->message, [ - '{true}' => $this->trueValue, - '{false}' => $this->falseValue, + 'true' => $this->trueValue, + 'false' => $this->falseValue, ]); } } diff --git a/framework/yii/validators/CompareValidator.php b/framework/yii/validators/CompareValidator.php index 3ff459b..8a694ad 100644 --- a/framework/yii/validators/CompareValidator.php +++ b/framework/yii/validators/CompareValidator.php @@ -143,8 +143,8 @@ class CompareValidator extends Validator } if (!$valid) { $this->addError($object, $attribute, $this->message, [ - '{compareAttribute}' => $compareLabel, - '{compareValue}' => $compareValue, + 'compareAttribute' => $compareLabel, + 'compareValue' => $compareValue, ]); } } diff --git a/framework/yii/validators/FileValidator.php b/framework/yii/validators/FileValidator.php index 8024d10..f27c010 100644 --- a/framework/yii/validators/FileValidator.php +++ b/framework/yii/validators/FileValidator.php @@ -144,7 +144,7 @@ class FileValidator extends Validator $this->addError($object, $attribute, $this->uploadRequired); } if (count($files) > $this->maxFiles) { - $this->addError($object, $attribute, $this->tooMany, ['{attribute}' => $attribute, '{limit}' => $this->maxFiles]); + $this->addError($object, $attribute, $this->tooMany, ['limit' => $this->maxFiles]); } else { foreach ($files as $file) { $this->validateFile($object, $attribute, $file); @@ -171,18 +171,18 @@ class FileValidator extends Validator switch ($file->error) { case UPLOAD_ERR_OK: if ($this->maxSize !== null && $file->size > $this->maxSize) { - $this->addError($object, $attribute, $this->tooBig, ['{file}' => $file->name, '{limit}' => $this->getSizeLimit()]); + $this->addError($object, $attribute, $this->tooBig, ['file' => $file->name, 'limit' => $this->getSizeLimit()]); } if ($this->minSize !== null && $file->size < $this->minSize) { - $this->addError($object, $attribute, $this->tooSmall, ['{file}' => $file->name, '{limit}' => $this->minSize]); + $this->addError($object, $attribute, $this->tooSmall, ['file' => $file->name, 'limit' => $this->minSize]); } if (!empty($this->types) && !in_array(strtolower(pathinfo($file->name, PATHINFO_EXTENSION)), $this->types, true)) { - $this->addError($object, $attribute, $this->wrongType, ['{file}' => $file->name, '{extensions}' => implode(', ', $this->types)]); + $this->addError($object, $attribute, $this->wrongType, ['file' => $file->name, 'extensions' => implode(', ', $this->types)]); } break; case UPLOAD_ERR_INI_SIZE: case UPLOAD_ERR_FORM_SIZE: - $this->addError($object, $attribute, $this->tooBig, ['{file}' => $file->name, '{limit}' => $this->getSizeLimit()]); + $this->addError($object, $attribute, $this->tooBig, ['file' => $file->name, 'limit' => $this->getSizeLimit()]); break; case UPLOAD_ERR_PARTIAL: $this->addError($object, $attribute, $this->message); diff --git a/framework/yii/validators/NumberValidator.php b/framework/yii/validators/NumberValidator.php index ec72dcf..0df73e6 100644 --- a/framework/yii/validators/NumberValidator.php +++ b/framework/yii/validators/NumberValidator.php @@ -91,10 +91,10 @@ class NumberValidator extends Validator $this->addError($object, $attribute, $this->message); } if ($this->min !== null && $value < $this->min) { - $this->addError($object, $attribute, $this->tooSmall, ['{min}' => $this->min]); + $this->addError($object, $attribute, $this->tooSmall, ['min' => $this->min]); } if ($this->max !== null && $value > $this->max) { - $this->addError($object, $attribute, $this->tooBig, ['{max}' => $this->max]); + $this->addError($object, $attribute, $this->tooBig, ['max' => $this->max]); } } diff --git a/framework/yii/validators/RequiredValidator.php b/framework/yii/validators/RequiredValidator.php index 88bd03d..eb4a394 100644 --- a/framework/yii/validators/RequiredValidator.php +++ b/framework/yii/validators/RequiredValidator.php @@ -75,7 +75,7 @@ class RequiredValidator extends Validator $this->addError($object, $attribute, $this->message); } else { $this->addError($object, $attribute, $this->message, [ - '{requiredValue}' => $this->requiredValue, + 'requiredValue' => $this->requiredValue, ]); } } diff --git a/framework/yii/validators/StringValidator.php b/framework/yii/validators/StringValidator.php index a6383b9..329cab0 100644 --- a/framework/yii/validators/StringValidator.php +++ b/framework/yii/validators/StringValidator.php @@ -112,13 +112,13 @@ class StringValidator extends Validator $length = mb_strlen($value, $this->encoding); if ($this->min !== null && $length < $this->min) { - $this->addError($object, $attribute, $this->tooShort, ['{min}' => $this->min]); + $this->addError($object, $attribute, $this->tooShort, ['min' => $this->min]); } if ($this->max !== null && $length > $this->max) { - $this->addError($object, $attribute, $this->tooLong, ['{max}' => $this->max]); + $this->addError($object, $attribute, $this->tooLong, ['max' => $this->max]); } if ($this->length !== null && $length !== $this->length) { - $this->addError($object, $attribute, $this->notEqual, ['{length}' => $this->length]); + $this->addError($object, $attribute, $this->notEqual, ['length' => $this->length]); } } diff --git a/framework/yii/validators/Validator.php b/framework/yii/validators/Validator.php index 46ab673..dc0e935 100644 --- a/framework/yii/validators/Validator.php +++ b/framework/yii/validators/Validator.php @@ -251,9 +251,9 @@ abstract class Validator extends Component public function addError($object, $attribute, $message, $params = []) { $value = $object->$attribute; - $params['{attribute}'] = $object->getAttributeLabel($attribute); - $params['{value}'] = is_array($value) ? 'array()' : $value; - $object->addError($attribute, strtr($message, $params)); + $params['attribute'] = $object->getAttributeLabel($attribute); + $params['value'] = is_array($value) ? 'array()' : $value; + $object->addError($attribute, Yii::$app->getI18n()->format($message, $params, Yii::$app->language)); } /** diff --git a/tests/unit/framework/validators/ValidatorTest.php b/tests/unit/framework/validators/ValidatorTest.php index 351dba8..0cd56d9 100644 --- a/tests/unit/framework/validators/ValidatorTest.php +++ b/tests/unit/framework/validators/ValidatorTest.php @@ -220,7 +220,7 @@ class ValidatorTest extends TestCase $errors = $m->getErrors('attr_msg_val'); $this->assertEquals('attr_msg_val::array()', $errors[0]); $m = $this->getTestModel(['attr_msg_val' => 'abc']); - $val->addError($m, 'attr_msg_val', '{attribute}::{value}::{param}', ['{param}' => 'param_value']); + $val->addError($m, 'attr_msg_val', '{attribute}::{value}::{param}', ['param' => 'param_value']); $errors = $m->getErrors('attr_msg_val'); $this->assertEquals('attr_msg_val::abc::param_value', $errors[0]); }