使用 formatter application component 來格式化數據。默認 fomatter 由 yii\i18n\Formatter 來實現,這個組件提供了一系列關于日期/時間,數字,貨幣等的格式化方法
$formatter = \Yii::$app->formatter;
// output: January 1, 2014
echo $formatter->asDate('2014-01-01', 'long');
// output: 12.50%
echo $formatter->asPercent(0.125, 2);
echo $formatter->asEmail('cebe@example.com');?????
// output: Yes
echo $formatter->asBoolean(true);
// it also handles display of null values:
// output: (Not set)
echo $formatter->asDate(null);
所有的方法都形似 asXyz(),這個 Xzy 就是所支持的格式化類型。 也可以使用類方法 format() 來進行格式化,通過這個類方法,你可以更自由地控制格式化的數據,這時候,類方法通常配合 yii\grid\GridView 或者 yii\widgets\DetailView 來使用。
例子:
// output: January 1, 2014
echo Yii::$app->formatter->format('2014-01-01', 'date');
// 你可以在第二個參數指定一個數組,這個數組提供了一些配置的參數
// 例如這個 2 就是 asPercent() 方法的 $decimals 參數
// output: 12.50%
echo Yii::$app->formatter->format(0.125, ['percent', 2]);
Note: formatter 組件用來格式化最終展示給用戶的數據. 如果你想要將用戶的輸入進行格式化或者只是將一些別的日期數據進行格式化(這里的格式化說的是機器可讀的格式化),不要使用這個組件, 而應該使用 yii\validators\DateValidator 和 yii\validators\NumberValidator 進行用戶輸入格式化 關于日期格式化,戳這里 date()
配置 Formatter
可以對 formatter 組件在 application configuration 中進行配置
return [
???? 'components' => [
??????? 'formatter' => [
??????????? 'dateFormat' => 'dd.MM.yyyy',
??????????? 'decimalSeparator' => ',',
??????????? 'thousandSeparator' => ' ',
??????????? 'currencyCode' => 'EUR',
???? ? ? ? ],
?? ? ? ],
];? ? ? ? ? //可以參考 yii\i18n\Formatter 的配置
格式化時間/日期數據
默認支持一下幾種格式化格式
*? date: 這個變量將被格式化為日期 January 01, 2014.
*? time: 這個變量將被格式化為時間 14:23.
*? datetime: 這個變量將被格式化為日期+時間 January 01, 2014 14:23.
*? timestamp: 這個變量將被格式化為 UNIX 時間戳 unix timestamp, 例如 1412609982.
*? relativeTime: 這個變量將被格式化為人類可讀的當前相對時間 1 hour ago.
*? duration: 這個變量將被格式化為人類可讀的時長 1 day, 2 minutes.
時間/日期數據默認使用 date, time, datetime 方法進行格式化,? 可以對他們進行一些自己的配置,只需在配置文件里配置 dateFormat, timeFormat, 和 datetimeFormat 即可。
同時,還可以配置它使用 ICU syntax,同時也可以配置它使用 PHP date() 語法,只需要加上 php: 前綴即可。
// ICU format
echo Yii::$app->formatter->asDate('now', 'yyyy-MM-dd'); // 2014-10-06
// PHP date()-format
echo Yii::$app->formatter->asDate('now', 'php:Y-m-d'); // 2014-10-06
時區
格式化時間/日期數據時? 將他們轉換成 time zone 這個時候,默認的時區為 UTC,除非另外指定 yii\i18n\Formatter::$defaultTimeZone。
下面使用 Europe/Berlin 作為默認 time zone
// formatting a UNIX timestamp as a time
echo Yii::$app->formatter->asTime(1412599260); // 14:41:00
// formatting a datetime string (in UTC) as a time
echo Yii::$app->formatter->asTime('2014-10-06 12:41:00'); // 14:41:00
// formatting a datetime string (in CEST) as a time
echo Yii::$app->formatter->asTime('2014-10-06 14:41:00 CEST'); // 14:41:00
不同的政府和地區政策決定不同的時區, 在你的時區數據庫中可能拿不到最新的數據。 這時你可以戳 ICU manual 來查看如何更新時區。 同時,這篇也可以作為參考 Setting up your PHP environment for internationalization
格式化數字
formatter 支持如下的方法
*? integer: 這個變量將被格式化為整形 e.g. 42.
*? decimal: 這個變量將被格式化為帶著逗號的指定精度的浮點型 e.g. 2,542.123 or 2.542,123.
*? percent: 這個變量將被格式化為百分比 e.g. 42%.
*? scientific: 這個變量將被格式化為科學計數法 e.g. 4.2E4.
*? currency: 這個變量將被格式化為貨幣 £420.00. 使用這個方法前請確認是否已經正確配置 locale
*? size: 這個變量將被格式化為人類可讀的字節數 e.g. 410 kibibytes.
*? shortSize: 這個變量將被格式化為人類可讀的字節數(縮寫) size, e.g. 410 KiB.
可以使用 decimalSeparator 和 thousandSeparator 來進行調整。 他們都會根據當前的 locale 來進行格式化.
如果想要進行更高級的配置, 可以使用 yii\i18n\Formatter::$numberFormatterOptions 和 yii\i18n\Formatter::$numberFormatterTextOptions,NumberFormatter class 來進行格式化。
舉個例子,為了調整小數部分的最大值和最小值,可以配置 yii\i18n\Formatter::$numberFormatterOptions 如下:
'numberFormatterOptions' => [
NumberFormatter::MIN_FRACTION_DIGITS => 0,
NumberFormatter::MAX_FRACTION_DIGITS => 2,
]
其他的格式化
除了時間/日期和數字的格式化,Yii 還支持如下的常用格式化
raw: 除了 null 會被 nullDisplay 格式化外,原樣輸出。
text: 編碼為 HTML 格式。同時這也是 GridView DataColumn 默認使用的方法。
ntext: 編碼為 HTML 格式,換行也將被轉換。
paragraphs: 編碼為 HTML 格式,以
標簽包裹。
html: 這個數值將會被 HtmlPurifier 來進行過濾來防御 XSS 攻擊,可以添加一些配置例如 ['html', ['Attr.AllowedFrameTargets' => ['_blank']]]。
email: 這個數值將被轉換為 mailto 鏈接。
boolean: true => Yes, false => No,可以進行另外的配置: yii\i18n\Formatter::$booleanFormat 。
空值
空值(null)會被特殊格式化. fommater 默認會將空值格式化為 (not set) 對應的當前的語言. 可以配置 nullDisplay 屬性來進行個性化.
本地日期格式化
formatter 會使用當前的 locale 來決定格式化的內容。 對于同樣的日期,不同的時區配置會有不同的輸出:
Yii::$app->formatter->locale = 'en-US';
echo Yii::$app->formatter->asDate('2014-01-01'); // output: January 1, 2014
Yii::$app->formatter->locale = 'de-DE';
echo Yii::$app->formatter->asDate('2014-01-01'); // output: 1. Januar 2014
Yii::$app->formatter->locale = 'ru-RU';
echo Yii::$app->formatter->asDate('2014-01-01'); // output: 1 января 2014 г.
默認配置下,當前 locale 決定于 yii\base\Application::$language. 可以覆蓋 yii\i18n\Formatter::$locale 屬性來滿足不同的需要。
Note: Yii formatter 依賴 PHP intl extension 來進行本地數據格式化 因為不同的 ICU 庫可能會導致不同的輸出,所以請在用的所有機器上保持 ICU 庫的一致性. 請戳 Setting up your PHP environment for internationalization.
如果 intl 擴展沒有被安裝,數據格式化不會考慮本地化.
在 32 位系統中,1901 年前或者 2038 年后的日期數據將不會被本地化,因為 ICU 使用的是 32 位的 UNIX 時間戳。