使用 formatter application component 來(lái)格式化數(shù)據(jù)炬太。默認(rèn) fomatter 由 yii\i18n\Formatter 來(lái)實(shí)現(xiàn),這個(gè)組件提供了一系列關(guān)于日期/時(shí)間,數(shù)字卡骂,貨幣等的格式化方法
$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(),這個(gè) Xzy 就是所支持的格式化類型形入。 也可以使用類方法 format() 來(lái)進(jìn)行格式化全跨,通過(guò)這個(gè)類方法,你可以更自由地控制格式化的數(shù)據(jù)唯笙,這時(shí)候螟蒸,類方法通常配合 yii\grid\GridView 或者 yii\widgets\DetailView 來(lái)使用盒使。
例子:
// output: January 1, 2014
echo Yii::$app->formatter->format('2014-01-01', 'date');
// 你可以在第二個(gè)參數(shù)指定一個(gè)數(shù)組崩掘,這個(gè)數(shù)組提供了一些配置的參數(shù)
// 例如這個(gè) 2 就是 asPercent() 方法的 $decimals 參數(shù)
// output: 12.50%
echo Yii::$app->formatter->format(0.125, ['percent', 2]);
Note: formatter 組件用來(lái)格式化最終展示給用戶的數(shù)據(jù). 如果你想要將用戶的輸入進(jìn)行格式化或者只是將一些別的日期數(shù)據(jù)進(jìn)行格式化(這里的格式化說(shuō)的是機(jī)器可讀的格式化),不要使用這個(gè)組件少办, 而應(yīng)該使用 yii\validators\DateValidator 和 yii\validators\NumberValidator 進(jìn)行用戶輸入格式化 關(guān)于日期格式化苞慢,戳這里 date()
配置 Formatter
可以對(duì) formatter 組件在 application configuration 中進(jìn)行配置
return [
???? 'components' => [
??????? 'formatter' => [
??????????? 'dateFormat' => 'dd.MM.yyyy',
??????????? 'decimalSeparator' => ',',
??????????? 'thousandSeparator' => ' ',
??????????? 'currencyCode' => 'EUR',
???? ? ? ? ],
?? ? ? ],
];? ? ? ? ? //可以參考 yii\i18n\Formatter 的配置
格式化時(shí)間/日期數(shù)據(jù)
默認(rèn)支持一下幾種格式化格式
*? date: 這個(gè)變量將被格式化為日期 January 01, 2014.
*? time: 這個(gè)變量將被格式化為時(shí)間 14:23.
*? datetime: 這個(gè)變量將被格式化為日期+時(shí)間 January 01, 2014 14:23.
*? timestamp: 這個(gè)變量將被格式化為 UNIX 時(shí)間戳 unix timestamp, 例如 1412609982.
*? relativeTime: 這個(gè)變量將被格式化為人類可讀的當(dāng)前相對(duì)時(shí)間 1 hour ago.
*? duration: 這個(gè)變量將被格式化為人類可讀的時(shí)長(zhǎng) 1 day, 2 minutes.
時(shí)間/日期數(shù)據(jù)默認(rèn)使用 date, time, datetime 方法進(jìn)行格式化,? 可以對(duì)他們進(jìn)行一些自己的配置英妓,只需在配置文件里配置 dateFormat, timeFormat, 和 datetimeFormat 即可挽放。
同時(shí),還可以配置它使用 ICU syntax蔓纠,同時(shí)也可以配置它使用 PHP date() 語(yǔ)法辑畦,只需要加上 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
時(shí)區(qū)
格式化時(shí)間/日期數(shù)據(jù)時(shí)? 將他們轉(zhuǎn)換成 time zone 這個(gè)時(shí)候腿倚,默認(rèn)的時(shí)區(qū)為 UTC纯出,除非另外指定 yii\i18n\Formatter::$defaultTimeZone。
下面使用 Europe/Berlin 作為默認(rèn) 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
不同的政府和地區(qū)政策決定不同的時(shí)區(qū), 在你的時(shí)區(qū)數(shù)據(jù)庫(kù)中可能拿不到最新的數(shù)據(jù)。 這時(shí)你可以戳 ICU manual 來(lái)查看如何更新時(shí)區(qū)暂筝。 同時(shí)箩言,這篇也可以作為參考 Setting up your PHP environment for internationalization
格式化數(shù)字
formatter 支持如下的方法
*? integer: 這個(gè)變量將被格式化為整形 e.g. 42.
*? decimal: 這個(gè)變量將被格式化為帶著逗號(hào)的指定精度的浮點(diǎn)型 e.g. 2,542.123 or 2.542,123.
*? percent: 這個(gè)變量將被格式化為百分比 e.g. 42%.
*? scientific: 這個(gè)變量將被格式化為科學(xué)計(jì)數(shù)法 e.g. 4.2E4.
*? currency: 這個(gè)變量將被格式化為貨幣 £420.00. 使用這個(gè)方法前請(qǐng)確認(rèn)是否已經(jīng)正確配置 locale
*? size: 這個(gè)變量將被格式化為人類可讀的字節(jié)數(shù) e.g. 410 kibibytes.
*? shortSize: 這個(gè)變量將被格式化為人類可讀的字節(jié)數(shù)(縮寫(xiě)) size, e.g. 410 KiB.
可以使用 decimalSeparator 和 thousandSeparator 來(lái)進(jìn)行調(diào)整。 他們都會(huì)根據(jù)當(dāng)前的 locale 來(lái)進(jìn)行格式化.
如果想要進(jìn)行更高級(jí)的配置, 可以使用 yii\i18n\Formatter::$numberFormatterOptions 和 yii\i18n\Formatter::$numberFormatterTextOptions焕襟,NumberFormatter class 來(lái)進(jìn)行格式化陨收。
舉個(gè)例子,為了調(diào)整小數(shù)部分的最大值和最小值鸵赖,可以配置 yii\i18n\Formatter::$numberFormatterOptions 如下:
'numberFormatterOptions' => [
NumberFormatter::MIN_FRACTION_DIGITS => 0,
NumberFormatter::MAX_FRACTION_DIGITS => 2,
]
其他的格式化
除了時(shí)間/日期和數(shù)字的格式化务漩,Yii 還支持如下的常用格式化
raw: 除了 null 會(huì)被 nullDisplay 格式化外,原樣輸出它褪。
text: 編碼為 HTML 格式菲饼。同時(shí)這也是 GridView DataColumn 默認(rèn)使用的方法。
ntext: 編碼為 HTML 格式列赎,換行也將被轉(zhuǎn)換宏悦。
paragraphs: 編碼為 HTML 格式,以
標(biāo)簽包裹包吝。
html: 這個(gè)數(shù)值將會(huì)被 HtmlPurifier 來(lái)進(jìn)行過(guò)濾來(lái)防御 XSS 攻擊饼煞,可以添加一些配置例如 ['html', ['Attr.AllowedFrameTargets' => ['_blank']]]。
email: 這個(gè)數(shù)值將被轉(zhuǎn)換為 mailto 鏈接诗越。
boolean: true => Yes, false => No砖瞧,可以進(jìn)行另外的配置: yii\i18n\Formatter::$booleanFormat 。
空值
空值(null)會(huì)被特殊格式化. fommater 默認(rèn)會(huì)將空值格式化為 (not set) 對(duì)應(yīng)的當(dāng)前的語(yǔ)言. 可以配置 nullDisplay 屬性來(lái)進(jìn)行個(gè)性化.
本地日期格式化
formatter 會(huì)使用當(dāng)前的 locale 來(lái)決定格式化的內(nèi)容嚷狞。 對(duì)于同樣的日期块促,不同的時(shí)區(qū)配置會(huì)有不同的輸出:
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 г.
默認(rèn)配置下,當(dāng)前 locale 決定于 yii\base\Application::$language. 可以覆蓋 yii\i18n\Formatter::$locale 屬性來(lái)滿足不同的需要床未。
Note: Yii formatter 依賴 PHP intl extension 來(lái)進(jìn)行本地?cái)?shù)據(jù)格式化 因?yàn)椴煌?ICU 庫(kù)可能會(huì)導(dǎo)致不同的輸出竭翠,所以請(qǐng)?jiān)谟玫乃袡C(jī)器上保持 ICU 庫(kù)的一致性. 請(qǐng)戳 Setting up your PHP environment for internationalization.
如果 intl 擴(kuò)展沒(méi)有被安裝,數(shù)據(jù)格式化不會(huì)考慮本地化.
在 32 位系統(tǒng)中薇搁,1901 年前或者 2038 年后的日期數(shù)據(jù)將不會(huì)被本地化斋扰,因?yàn)?ICU 使用的是 32 位的 UNIX 時(shí)間戳。