データのフォーマット

ユーザにとってより読みやすい形式でデータを表示するために、formatter アプリケーション・コンポーネントを使ってデータをフォーマットすることが出来ます。デフォルトでは、フォーマッタは [[yii\i18n\Formatter]] によって実装されており、これが、日付/時刻、数字、通貨、その他のよく使われる形式にデータをフォーマットする一連のメソッドを提供します。このフォーマッタは次のようにして使うことが出来ます。

$formatter = \Yii::$app->formatter;

// 出力: January 1, 2014
echo $formatter->asDate('2014-01-01', 'long');
 
// 出力: 12.50%
echo $formatter->asPercent(0.125, 2);
 
// 出力: <a href="mailto:cebe@example.com">cebe@example.com</a>
echo $formatter->asEmail('cebe@example.com'); 

// 出力: Yes
echo $formatter->asBoolean(true); 
// it also handles display of null values:

// 出力: (not set)
echo $formatter->asDate(null);

ご覧のように、これらのメソッドは全て asXyz() という名前を付けられており、Xyz がサポートされている形式を表しています。別の方法として、汎用メソッド [[yii\i18n\Formatter::format()|format()]] を使ってデータをフォーマットすることも出来ます。この方法を使うと望む形式をプログラム的に制御することが可能になりますので、[[yii\grid\GridView]] や [[yii\widgets\DetailView]] などのウィジェットでは、こちらがよく使われています。例えば、

// 出力: January 1, 2014
echo Yii::$app->formatter->format('2014-01-01', 'date'); 

// 配列を使ってフォーマット・メソッドのパラメータを指定することも出来ます。
// `2` は asPercent() メソッドの $decimals パラメータの値です。
// 出力: 12.50%
echo Yii::$app->formatter->format(0.125, ['percent', 2]);

Note: フォーマッタ・コンポーネントは、エンド・ユーザへの表示用に値をフォーマットすることを目的に設計されています。ユーザの入力を機械が読み取れる形式にフォーマットしたい場合、また、日付を機械が読み取れる形式にフォーマットしたいだけ、という場合には、フォーマッタは適切なツールではありません。日付と数値についてユーザ入力を変換するためには、それぞれ、[[yii\validators\DateValidator]] と [[yii\validators\NumberValidator]] を使うことが出来ます。機械が読み取れる日付と時刻のフォーマットの単純な相互変換には、PHP の date() 関数で十分です。

フォーマッタを構成する

アプリケーションの構成情報の中で formatter コンポーネントを構成して、フォーマットの規則をカスタマイズすることが出来ます。例えば、

return [
    'components' => [
        'formatter' => [
            'dateFormat' => 'dd.MM.yyyy',
            'decimalSeparator' => ',',
            'thousandSeparator' => ' ',
            'currencyCode' => 'EUR',
       ],
    ],
];

構成可能なプロパティについては、[[yii\i18n\Formatter]] を参照してください。

日付と時刻の値をフォーマットする

フォーマッタは日付と時刻に関連した下記の出力形式をサポートしています。

[[yii\i18n\Formatter::asDate()|date]] - 値は日付としてフォーマットされます。例えば January 01, 2014。
[[yii\i18n\Formatter::asTime()|time]] - 値は時刻としてフォーマットされます。例えば 14:23。
[[yii\i18n\Formatter::asDatetime()|datetime]] - 値は日付および時刻としてフォーマットされます。例えば January 01, 2014 14:23。
[[yii\i18n\Formatter::asTimestamp()|timestamp]] - 値は unix タイムスタンプとしてフォーマットされます。例えば 1412609982
[[yii\i18n\Formatter::asRelativeTime()|relativeTime]] - 値は、その日時と現在との間隔として、人間に分かりやすい言葉でフォーマットされます。例えば 1 hour ago。
[[yii\i18n\Formatter::asDuration()|duration]] - 値は継続時間として、人間に分かりやすい言葉でフォーマットされます。例えば 1 day, 2 minutes。

[[yii\i18n\Formatter::asDate()|date]]、[[yii\i18n\Formatter::asTime()|time]]、[[yii\i18n\Formatter::asDatetime()|datetime]] メソッドに使われるデフォルトの日時書式は、フォーマッタの [[yii\i18n\Formatter::$dateFormat|$dateFormat]]、 [[yii\i18n\Formatter::$timeFormat|$timeFormat]]、[[yii\i18n\Formatter::$datetimeFormat|$datetimeFormat]] を構成することで、グローバルにカスタマイズすることが出来ます。

日付と時刻のフォーマットは、ICU 構文によって指定することが出来ます。また、ICU 構文と区別するために php: という接頭辞を付けて、PHP の date() 構文を使うことも出来ます。例えば、

// ICU 形式
echo Yii::$app->formatter->asDate('now', 'yyyy-MM-dd'); // 2014-10-06

// PHP date() 形式
echo Yii::$app->formatter->asDate('now', 'php:Y-m-d'); // 2014-10-06

Info: PHP 形式の書式の文字の中には ICU でサポートされておらず、従って PHP intl エクステンションでもサポートされていないため、 Yii のフォーマッタで使用できないものがあります。それらの文字のほとんどのもの (w, t, L, B, u, I, Z) は、日付の書式としては大して有用ではなく、むしろ日数の計算をするのに使われるものです。しかし、S と U は有用かも知れません。これらの動作は次のようにして達成することが出来ます。
S は、月の何日目かを示す英語の序数接尾詞序詞 (すなわ st, nd, rd または th ) ですが、これの代りに以下のような代替手段が使用出来ます。
$f = Yii::$app->formatter;
$d = $f->asOrdinal($f->asDate('2017-05-15', 'php:j'));
echo "On the $d day of the month.";  // "On the 15th day of the month." と表示
U、すなわち Unix エポックに対しては、[[yii\i18n\Formatter::asTimestamp()|timestamp]] 形式を使うことが出来ます。

複数の言語をサポートする必要があるアプリケーションを扱う場合には、ロケールごとに異なる日付と時刻のフォーマットを指定しなければならないことがよくあります。この仕事を単純化するためには、(long、short などの) フォーマットのショートカットを代りに使うことが出来ます。フォーマッタは、現在アクティブな [[yii\i18n\Formatter::locale|locale]] に従って、フォーマットのショートカットを適切なフォーマットに変換します。フォーマットのショートカットとして、次のものがサポートされています (例は en_GB がアクティブなロケールであると仮定したものです)。

short: 日付は 06/10/2014、時刻は 15:58 を出力
medium: 6 Oct 2014 と 15:58:42 を出力
long: 6 October 2014 と 15:58:42 GMT を出力
full: Monday, 6 October 2014 と 15:58:42 GMT を出力

Info: ja_JP ロケールでは、次のようになります。

short: 2014/10/06 と 15:58 medium: 2014/10/06 と 15:58:42 long: 2014年10月6日 と 15:58:42 JST full: 2014年10月6日月曜日 と 15時58分42秒日本標準時

バージョン 2.0.7 以降では、さまざまな暦法に従って日付をフォーマットすることが可能です。通常とは異なる暦法を使用する方法については、フォーマッタの [[yii\i18n\Formatter::$calendar|$calendar]] プロパティの API ドキュメントを参照して下さい。

タイム・ゾーン

日時の値をフォーマットするときに、Yii はその値をターゲット・[[yii\i18n\Formatter::timeZone|タイム・ゾーン]] に変換します。フォーマットされる日付の値は、タイム・ゾーンが明示的に指定されるか、[[yii\i18n\Formatter::defaultTimeZone]] が構成されるかしていない限り、 UTC であると見なされます。

次の例では、ターゲット・[[yii\i18n\Formatter::timeZone|タイム・ゾーン]] が Europe/Berlin に設定されているものとします。

// UNIX タイムスタンプを時刻としてフォーマット
echo Yii::$app->formatter->asTime(1412599260); // 14:41:00

// UTC の日付時刻文字列を時刻としてフォーマット
echo Yii::$app->formatter->asTime('2014-10-06 12:41:00'); // 14:41:00

// CEST の日付時刻文字列を時刻としてフォーマット
echo Yii::$app->formatter->asTime('2014-10-06 14:41:00 CEST'); // 14:41:00

Info: ターゲット・[[yii\i18n\Formatter::timeZone|タイム・ゾーン]] が Asia/Tokyo である場合は、次のようになります。
echo Yii::$app->formatter->asTime(1412599260); // 21:41:00
echo Yii::$app->formatter->asTime('2014-10-06 12:41:00'); // 21:41:00
echo Yii::$app->formatter->asTime('2014-10-06 21:41:00 JST'); // 21:41:00

フォーマッタ・コンポーネントに対して [[yii\i18n\Formatter::timeZone|タイム・ゾーン]] が明示的に設定されていない場合は、 [[yii\base\Application::timeZone|アプリケーションで設定されたタイム・ゾーン]] (PHP の構成で設定されたタイム・ゾーンと同じ) が使用されます。

Note: タイム・ゾーンは世界中のさまざまな政府によって作られる規則に従うものであり、頻繁に変更されるものであるため、あなたのシステムにインストールされたタイム・ゾーンのデータベースが最新の情報を持っていない可能性が大いにあります。タイム・ゾーン・データベースの更新についての詳細は、 ICU マニュアルで参照することが出来ます。 PHP 環境を国際化のために設定するも参照してください。

数値をフォーマットする

フォーマッタは、数値に関連した下記の出力フォーマットをサポートしています。

[[yii\i18n\Formatter::asInteger()|integer]] - 値は整数としてフォーマットされます。例えば 42。
[[yii\i18n\Formatter::asDecimal()|decimal]] - 値は小数点と三桁ごとの区切りを考慮して十進数としてフォーマットされます。例えば 2,542.123 または 2.542,123。
[[yii\i18n\Formatter::asPercent()|percent]] - 値は百分率としてフォーマットされます。例えば 42%。
[[yii\i18n\Formatter::asScientific()|scientific]] - 値は科学記法による数値としてフォーマットされます。例えば 4.2E4。
[[yii\i18n\Formatter::asCurrency()|currency]] - 値は通貨の値としてフォーマットされます。例えば £420.00。この関数が正しく働くためには、en_GB や en_US のように、ロケールが国コードを含んでいる必要があります。なぜなら、この場合は言語だけでは曖昧になるからです。
[[yii\i18n\Formatter::asSize()|size]] - バイト数である値が人間にとって読みやすいサイズとしてフォーマットされます。例えば 410 キビバイト。
[[yii\i18n\Formatter::asShortSize()|shortSize]] - [[yii\i18n\Formatter::asSize()|size]] の短いバージョンです。例えば 410 KiB。

数値のフォーマットに使われる書式は、デフォルトではロケールに従って設定される [[yii\i18n\Formatter::decimalSeparator|decimalSeparator]] と [[yii\i18n\Formatter::thousandSeparator|thousandSeparator]] を使って調整することが出来ます。

更に高度な設定のためには、[[yii\i18n\Formatter::numberFormatterOptions]] と [[yii\i18n\Formatter::numberFormatterTextOptions]] を使って、内部的に使用される NumberFormatter クラスを構成することが出来ます。例えば、小数部の最大桁数と最小桁数を調整するためには、次のように [[yii\i18n\Formatter::numberFormatterOptions]] プロパティを構成します。

'numberFormatterOptions' => [
    NumberFormatter::MIN_FRACTION_DIGITS => 0,
    NumberFormatter::MAX_FRACTION_DIGITS => 2,
]

その他のフォーマット

日付/時刻と数値のフォーマット以外にも、Yii はよく使われるフォーマットをサポートしています。その中には、次のものが含まれます。

[[yii\i18n\Formatter::asRaw()|raw]] - 値はそのまま出力されます。 null 値が [[nullDisplay]] を使ってフォーマットされる以外は、何の効果もない擬似フォーマッタです。
[[yii\i18n\Formatter::asText()|text]] - 値は HTML エンコードされます。これは GridView DataColumn で使われるデフォルトのフォーマットです。
[[yii\i18n\Formatter::asNtext()|ntext]] - 値は HTML エンコードされ、改行文字が強制改行に変換された平文テキストとしてフォーマットされます。
[[yii\i18n\Formatter::asParagraphs()|paragraphs]] - 値は HTML エンコードされ、 <p> タグに囲まれた段落としてフォーマットされます。
[[yii\i18n\Formatter::asHtml()|html]] - 値は XSS 攻撃を避けるために [[HtmlPurifier]] を使って浄化されます。 ['html', ['Attr.AllowedFrameTargets' => ['_blank']]] のような追加のオプションを渡すことが出来ます。
[[yii\i18n\Formatter::asEmail()|email]] - 値は mailto リンクとしてフォーマットされます。
[[yii\i18n\Formatter::asImage()|image]] - 値は image タグとしてフォーマットされます。
[[yii\i18n\Formatter::asUrl()|url]] - 値はハイパーリンクとしてフォーマットされます。
[[yii\i18n\Formatter::asBoolean()|boolean]] - 値は真偽値としてフォーマットされます。デフォルトでは、true は Yes、false は No とレンダリングされ、現在のアプリケーションの言語に翻訳されます。この動作は [[yii\i18n\Formatter::booleanFormat]] プロパティを構成して調整できます。

`null` 値

Null 値は特殊な方法でフォーマットされます。空文字列を表示する代りに、フォーマッタは null 値を事前定義された文字列 (そのデフォルト値は (not set) です) に変換し、それを現在のアプリケーションの言語に翻訳します。この文字列は [[yii\i18n\Formatter::nullDisplay|nullDisplay]] プロパティを構成してカスタマイズすることが出来ます。