NumberFormatter::format

numfmt_format

数値をフォーマットする

説明

オブジェクト指向型

public stringfalse NumberFormatter::format(intfloat $num, int $type = NumberFormatter::TYPE_DEFAULT)

手続き型

stringfalse numfmt_format(NumberFormatter $formatter, intfloat $num, int $type = NumberFormatter::TYPE_DEFAULT)

数値をフォーマット規則にしたがってフォーマットします。

パラメータ

formatter

NumberFormatter オブジェクト。

num

フォーマットする値。int あるいは float で指定します。その他の型は数値に変換されます。

type

使用する フォーマット形式NumberFormatter::TYPE_CURRENCY はサポートされていないので注意して下さい。 NumberFormatter::TYPE_CURRENCY を使いたい場合、 代わりに NumberFormatter::formatCurrency を使いましょう。

戻り値

フォーマットした値を文字列で返します。 エラー時には false を返します。

例1 numfmt_format の例

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
$data = numfmt_format($fmt, 1234567.891234567890000);
var_dump($data);
?>

例2 オブジェクト指向の例

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
$data = $fmt->format(1234567.891234567890000);
var_dump($data);
?>

上の例の出力は以下となります。

string(13) "1.234.567,891"

注意

注意:

このメソッドで実現可能なフォーマットでは、 ICU ライブラリが持つ機能をすべて使えません。 たとえば、短い通貨記号を使ってフォーマットする場合です。

ICU ライブラリが持つ機能をすべて使うには、 msgfmt_format_message を使います。

参考

  • numfmt_get_error_code
  • numfmt_format_currency
  • numfmt_parse
  • msgfmt_format_message