mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-29 13:57:50 +08:00
Merge branch '2359-formatter-refactored' of https://github.com/Erik-r/yii2-1 into Erik-r-2359-formatter-refactored
* '2359-formatter-refactored' of https://github.com/Erik-r/yii2-1: #2359 Bugfix in normalizeDatetimeValue after regression test #2359 one test failed in Travis because standard medium date format is different in Travis then on my locale PC. #2359 testcases adapted and compatibility to old tests improved remove comment lines in asRelativeTime Typo in function call #2359 Namespace corrected #2359 Refactored formatter class #2359 which works with or without intl extension. Use PHP format patterns alsow with intl. Class is compatible with previous version.
This commit is contained in:
Carsten Brandt
@@ -4,6 +4,7 @@ Yii Framework 2 Change Log
|
||||
2.0.0-rc under development
|
||||
--------------------------
|
||||
|
||||
- Enh #2359: Refactored formatter class. One class with or without intl extension and PHP format pattern as standard. (Erik_r)
|
||||
- Bug #1263: Fixed the issue that Gii and Debug modules might be affected by incompatible asset manager configuration (qiangxue)
|
||||
- Bug #2314: Gii model generator does not generate correct relation type in some special case (qiangxue)
|
||||
- Bug #2563: Theming is not working if the path map of the theme contains ".." or "." in the paths (qiangxue)
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
59
framework/i18n/FormatDefs.php
Normal file
59
framework/i18n/FormatDefs.php
Normal file
@@ -0,0 +1,59 @@
|
||||
<?php
|
||||
|
||||
namespace yii\i18n;
|
||||
|
||||
/**
|
||||
* International format definitions for decimal separator, thousand separator, dates,
|
||||
* times and datetimes.
|
||||
*
|
||||
* Is only used if php extension isn't loaded. Otherwise the official ICU standard is
|
||||
* used.
|
||||
*
|
||||
* Returns an array per local settings. Set the option 'language' => 'de-CH' in yii
|
||||
* config file.
|
||||
*
|
||||
* Each language has xxx elements in their array like:
|
||||
* [0] = decimal separator ('.')
|
||||
* [1] = thousand separator (',')
|
||||
* [2] = date short ('y-m-d')
|
||||
* [3] = date medium ('Y-m-d')
|
||||
* [4] = date long ('F j, Y')
|
||||
* [5] = date full ('l, F j, Y')
|
||||
* [6] = time short ('H:i')
|
||||
* [7] = time medium ('H:i:s')
|
||||
* [8] = time long ('g:i:sA')
|
||||
* [9] = time full ('g:i:sA T')
|
||||
* [10] = datetime short ('y-m-d H:i')
|
||||
* [11] = datetime medium ('Y-m-d H:i:s')
|
||||
* [12] = datetime long ('F j, Y g:i:sA')
|
||||
* [13] = datetime full ('l, F j, Y g:i:sA T')
|
||||
* [14] = currency code
|
||||
*
|
||||
* @author Erik Ruedin <e.ruedin@guggach.com>
|
||||
* @version 0.1
|
||||
*/
|
||||
Class FormatDefs{
|
||||
|
||||
static function definition($local) {
|
||||
|
||||
$localDef = [
|
||||
'en-US' =>
|
||||
['.', ',', 'm/d/y', 'm/d/Y', 'F j, Y', 'l, F j, Y', 'H:i', 'H:i:s', 'g:i:sA', 'g:i:sA T', 'm/d/y H:i', 'm/d/Y H:i:s', 'F j, Y g:i:sA', 'l, F j, Y g:i:sA T', 'USD' ],
|
||||
'de-CH' =>
|
||||
['.', '\'', 'd.m.y', 'd.m.Y', 'j. F Y', 'l, j. F Y', 'H:i', 'H:i:s', 'G:i:s', 'G:i:s T', 'd.m.y H:i', 'd.m.Y H:i:s', 'F j, Y g:i:sA', 'l, F j, Y g:i:sA T', 'CHF' ],
|
||||
'de-DE' =>
|
||||
[',', '.', 'd.m.y', 'd.m.Y', 'j. F Y', 'l, j. F Y', 'H:i', 'H:i:s', 'G:i:s', 'G:i:s T', 'd.m.y H:i', 'd.m.Y H:i:s', 'F j, Y g:i:sA', 'l, F j, Y g:i:sA T', 'EUR' ],
|
||||
|
||||
];
|
||||
|
||||
if (isset($localDef[$local])){
|
||||
return $localDef[$local];
|
||||
} else{
|
||||
return [];
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -1,338 +0,0 @@
|
||||
<?php
|
||||
/**
|
||||
* @link http://www.yiiframework.com/
|
||||
* @copyright Copyright (c) 2008 Yii Software LLC
|
||||
* @license http://www.yiiframework.com/license/
|
||||
*/
|
||||
|
||||
namespace yii\i18n;
|
||||
|
||||
use Yii;
|
||||
use IntlDateFormatter;
|
||||
use NumberFormatter;
|
||||
use DateTime;
|
||||
use yii\base\InvalidConfigException;
|
||||
|
||||
/**
|
||||
* Formatter is the localized version of [[\yii\base\Formatter]].
|
||||
*
|
||||
* Formatter requires the PHP "intl" extension to be installed. Formatter supports localized
|
||||
* formatting of date, time and numbers, based on the current [[locale]].
|
||||
*
|
||||
* This Formatter can replace the `formatter` application component that is configured by default.
|
||||
* To do so, add the following to your application config under `components`:
|
||||
*
|
||||
* ```php
|
||||
* 'formatter' => [
|
||||
* 'class' => 'yii\i18n\Formatter',
|
||||
* ]
|
||||
* ```
|
||||
*
|
||||
* @author Qiang Xue <qiang.xue@gmail.com>
|
||||
* @since 2.0
|
||||
*/
|
||||
class Formatter extends \yii\base\Formatter
|
||||
{
|
||||
/**
|
||||
* @var string the locale ID that is used to localize the date and number formatting.
|
||||
* If not set, [[\yii\base\Application::language]] will be used.
|
||||
*/
|
||||
public $locale;
|
||||
/**
|
||||
* @var string the default format string to be used to format a date.
|
||||
* This can be "short", "medium", "long", or "full", which represents a preset format of different lengths.
|
||||
* It can also be a custom format as specified in the [ICU manual](http://userguide.icu-project.org/formatparse/datetime).
|
||||
*/
|
||||
public $dateFormat = 'short';
|
||||
/**
|
||||
* @var string the default format string to be used to format a time.
|
||||
* This can be "short", "medium", "long", or "full", which represents a preset format of different lengths.
|
||||
* It can also be a custom format as specified in the [ICU manual](http://userguide.icu-project.org/formatparse/datetime).
|
||||
*/
|
||||
public $timeFormat = 'short';
|
||||
/**
|
||||
* @var string the default format string to be used to format a date and time.
|
||||
* This can be "short", "medium", "long", or "full", which represents a preset format of different lengths.
|
||||
* It can also be a custom format as specified in the [ICU manual](http://userguide.icu-project.org/formatparse/datetime).
|
||||
*/
|
||||
public $datetimeFormat = 'short';
|
||||
/**
|
||||
* @var array the options to be set for the NumberFormatter objects. Please refer to
|
||||
* [PHP manual](http://php.net/manual/en/class.numberformatter.php#intl.numberformatter-constants.unumberformatattribute)
|
||||
* for the possible options. This property is used by [[createNumberFormatter]] when
|
||||
* creating a new number formatter to format decimals, currencies, etc.
|
||||
*/
|
||||
public $numberFormatOptions = [];
|
||||
/**
|
||||
* @var string the character displayed as the decimal point when formatting a number.
|
||||
* If not set, the decimal separator corresponding to [[locale]] will be used.
|
||||
*/
|
||||
public $decimalSeparator;
|
||||
/**
|
||||
* @var string the character displayed as the thousands separator character when formatting a number.
|
||||
* If not set, the thousand separator corresponding to [[locale]] will be used.
|
||||
*/
|
||||
public $thousandSeparator;
|
||||
/**
|
||||
* @var string the international currency code displayed when formatting a number.
|
||||
* If not set, the currency code corresponding to [[locale]] will be used.
|
||||
*/
|
||||
public $currencyCode;
|
||||
|
||||
/**
|
||||
* Initializes the component.
|
||||
* This method will check if the "intl" PHP extension is installed and set the
|
||||
* default value of [[locale]].
|
||||
* @throws InvalidConfigException if the "intl" PHP extension is not installed.
|
||||
*/
|
||||
public function init()
|
||||
{
|
||||
if (!extension_loaded('intl')) {
|
||||
throw new InvalidConfigException('The "intl" PHP extension is not installed. It is required to format data values in localized formats.');
|
||||
}
|
||||
if ($this->locale === null) {
|
||||
$this->locale = Yii::$app->language;
|
||||
}
|
||||
if ($this->decimalSeparator === null || $this->thousandSeparator === null || $this->currencyCode === null) {
|
||||
$formatter = new NumberFormatter($this->locale, NumberFormatter::DECIMAL);
|
||||
if ($this->decimalSeparator === null) {
|
||||
$this->decimalSeparator = $formatter->getSymbol(NumberFormatter::DECIMAL_SEPARATOR_SYMBOL);
|
||||
}
|
||||
if ($this->thousandSeparator === null) {
|
||||
$this->thousandSeparator = $formatter->getSymbol(NumberFormatter::GROUPING_SEPARATOR_SYMBOL);
|
||||
}
|
||||
if ($this->currencyCode === null) {
|
||||
$this->currencyCode = $formatter->getSymbol(NumberFormatter::INTL_CURRENCY_SYMBOL);
|
||||
}
|
||||
}
|
||||
|
||||
parent::init();
|
||||
}
|
||||
|
||||
private $_dateFormats = [
|
||||
'short' => IntlDateFormatter::SHORT,
|
||||
'medium' => IntlDateFormatter::MEDIUM,
|
||||
'long' => IntlDateFormatter::LONG,
|
||||
'full' => IntlDateFormatter::FULL,
|
||||
];
|
||||
|
||||
/**
|
||||
* Formats the value as a date.
|
||||
* @param integer|string|DateTime $value the value to be formatted. The following
|
||||
* types of value are supported:
|
||||
*
|
||||
* - an integer representing a UNIX timestamp
|
||||
* - a string that can be parsed into a UNIX timestamp via `strtotime()`
|
||||
* - a PHP DateTime object
|
||||
*
|
||||
* @param string $format the format used to convert the value into a date string.
|
||||
* If null, [[dateFormat]] will be used.
|
||||
*
|
||||
* This can be "short", "medium", "long", or "full", which represents a preset format of different lengths.
|
||||
* It can also be a custom format as specified in the [ICU manual](http://userguide.icu-project.org/formatparse/datetime).
|
||||
*
|
||||
* @return string the formatted result
|
||||
* @throws InvalidConfigException when formatting fails due to invalid parameters.
|
||||
* @see dateFormat
|
||||
*/
|
||||
public function asDate($value, $format = null)
|
||||
{
|
||||
if ($value === null) {
|
||||
return $this->nullDisplay;
|
||||
}
|
||||
$value = $this->normalizeDatetimeValue($value);
|
||||
if ($format === null) {
|
||||
$format = $this->dateFormat;
|
||||
}
|
||||
if (isset($this->_dateFormats[$format])) {
|
||||
$formatter = new IntlDateFormatter($this->locale, $this->_dateFormats[$format], IntlDateFormatter::NONE, $this->timeZone);
|
||||
} else {
|
||||
$formatter = new IntlDateFormatter($this->locale, IntlDateFormatter::NONE, IntlDateFormatter::NONE, $this->timeZone);
|
||||
if ($formatter !== null) {
|
||||
$formatter->setPattern($format);
|
||||
}
|
||||
}
|
||||
if ($formatter === null) {
|
||||
throw new InvalidConfigException(intl_get_error_message());
|
||||
}
|
||||
|
||||
return $formatter->format($value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats the value as a time.
|
||||
* @param integer|string|DateTime $value the value to be formatted. The following
|
||||
* types of value are supported:
|
||||
*
|
||||
* - an integer representing a UNIX timestamp
|
||||
* - a string that can be parsed into a UNIX timestamp via `strtotime()`
|
||||
* - a PHP DateTime object
|
||||
*
|
||||
* @param string $format the format used to convert the value into a date string.
|
||||
* If null, [[dateFormat]] will be used.
|
||||
*
|
||||
* This can be "short", "medium", "long", or "full", which represents a preset format of different lengths.
|
||||
* It can also be a custom format as specified in the [ICU manual](http://userguide.icu-project.org/formatparse/datetime).
|
||||
*
|
||||
* @return string the formatted result
|
||||
* @throws InvalidConfigException when formatting fails due to invalid parameters.
|
||||
* @see timeFormat
|
||||
*/
|
||||
public function asTime($value, $format = null)
|
||||
{
|
||||
if ($value === null) {
|
||||
return $this->nullDisplay;
|
||||
}
|
||||
$value = $this->normalizeDatetimeValue($value);
|
||||
if ($format === null) {
|
||||
$format = $this->timeFormat;
|
||||
}
|
||||
if (isset($this->_dateFormats[$format])) {
|
||||
$formatter = new IntlDateFormatter($this->locale, IntlDateFormatter::NONE, $this->_dateFormats[$format], $this->timeZone);
|
||||
} else {
|
||||
$formatter = new IntlDateFormatter($this->locale, IntlDateFormatter::NONE, IntlDateFormatter::NONE, $this->timeZone);
|
||||
if ($formatter !== null) {
|
||||
$formatter->setPattern($format);
|
||||
}
|
||||
}
|
||||
if ($formatter === null) {
|
||||
throw new InvalidConfigException(intl_get_error_message());
|
||||
}
|
||||
|
||||
return $formatter->format($value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats the value as a datetime.
|
||||
* @param integer|string|DateTime $value the value to be formatted. The following
|
||||
* types of value are supported:
|
||||
*
|
||||
* - an integer representing a UNIX timestamp
|
||||
* - a string that can be parsed into a UNIX timestamp via `strtotime()`
|
||||
* - a PHP DateTime object
|
||||
*
|
||||
* @param string $format the format used to convert the value into a date string.
|
||||
* If null, [[dateFormat]] will be used.
|
||||
*
|
||||
* This can be "short", "medium", "long", or "full", which represents a preset format of different lengths.
|
||||
* It can also be a custom format as specified in the [ICU manual](http://userguide.icu-project.org/formatparse/datetime).
|
||||
*
|
||||
* @return string the formatted result
|
||||
* @throws InvalidConfigException when formatting fails due to invalid parameters.
|
||||
* @see datetimeFormat
|
||||
*/
|
||||
public function asDatetime($value, $format = null)
|
||||
{
|
||||
if ($value === null) {
|
||||
return $this->nullDisplay;
|
||||
}
|
||||
$value = $this->normalizeDatetimeValue($value);
|
||||
if ($format === null) {
|
||||
$format = $this->datetimeFormat;
|
||||
}
|
||||
if (isset($this->_dateFormats[$format])) {
|
||||
$formatter = new IntlDateFormatter($this->locale, $this->_dateFormats[$format], $this->_dateFormats[$format], $this->timeZone);
|
||||
} else {
|
||||
$formatter = new IntlDateFormatter($this->locale, IntlDateFormatter::NONE, IntlDateFormatter::NONE, $this->timeZone);
|
||||
if ($formatter !== null) {
|
||||
$formatter->setPattern($format);
|
||||
}
|
||||
}
|
||||
if ($formatter === null) {
|
||||
throw new InvalidConfigException(intl_get_error_message());
|
||||
}
|
||||
|
||||
return $formatter->format($value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats the value as a decimal number.
|
||||
* @param mixed $value the value to be formatted
|
||||
* @param string $format the format to be used. Please refer to [ICU manual](http://www.icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
|
||||
* for details on how to specify a format.
|
||||
* @return string the formatted result.
|
||||
*/
|
||||
public function asDecimal($value, $format = null)
|
||||
{
|
||||
if ($value === null) {
|
||||
return $this->nullDisplay;
|
||||
}
|
||||
|
||||
return $this->createNumberFormatter(NumberFormatter::DECIMAL, $format)->format($value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats the value as a currency number.
|
||||
* @param mixed $value the value to be formatted
|
||||
* @param string $currency the 3-letter ISO 4217 currency code indicating the currency to use.
|
||||
* If null, [[currencyCode]] will be used.
|
||||
* @param string $format the format to be used. Please refer to [ICU manual](http://www.icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
|
||||
* for details on how to specify a format.
|
||||
* @return string the formatted result.
|
||||
*/
|
||||
public function asCurrency($value, $currency = null, $format = null)
|
||||
{
|
||||
if ($value === null) {
|
||||
return $this->nullDisplay;
|
||||
}
|
||||
|
||||
if ($currency === null){
|
||||
$currency = $this->currencyCode;
|
||||
}
|
||||
|
||||
return $this->createNumberFormatter(NumberFormatter::CURRENCY, $format)->formatCurrency($value, $currency);
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats the value as a percent number.
|
||||
* @param mixed $value the value to be formatted
|
||||
* @param string $format the format to be used. Please refer to [ICU manual](http://www.icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
|
||||
* for details on how to specify a format.
|
||||
* @return string the formatted result.
|
||||
*/
|
||||
public function asPercent($value, $format = null)
|
||||
{
|
||||
if ($value === null) {
|
||||
return $this->nullDisplay;
|
||||
}
|
||||
|
||||
return $this->createNumberFormatter(NumberFormatter::PERCENT, $format)->format($value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats the value as a scientific number.
|
||||
* @param mixed $value the value to be formatted
|
||||
* @param string $format the format to be used. Please refer to [ICU manual](http://www.icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
|
||||
* for details on how to specify a format.
|
||||
* @return string the formatted result.
|
||||
*/
|
||||
public function asScientific($value, $format = null)
|
||||
{
|
||||
if ($value === null) {
|
||||
return $this->nullDisplay;
|
||||
}
|
||||
|
||||
return $this->createNumberFormatter(NumberFormatter::SCIENTIFIC, $format)->format($value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a number formatter based on the given type and format.
|
||||
* @param integer $type the type of the number formatter
|
||||
* @param string $format the format to be used. Please refer to [ICU manual](http://www.icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
|
||||
* @return NumberFormatter the created formatter instance
|
||||
*/
|
||||
protected function createNumberFormatter($type, $format)
|
||||
{
|
||||
$formatter = new NumberFormatter($this->locale, $type);
|
||||
if ($format !== null) {
|
||||
$formatter->setPattern($format);
|
||||
}
|
||||
if (!empty($this->numberFormatOptions)) {
|
||||
foreach ($this->numberFormatOptions as $name => $attribute) {
|
||||
$formatter->setAttribute($name, $attribute);
|
||||
}
|
||||
}
|
||||
|
||||
return $formatter;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user