Edit Report a Bug

NumberFormatter::setPattern

numfmt_set_pattern

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)

NumberFormatter::setPattern -- numfmt_set_pattern — フォーマッタのパターンを設定する

説明

オブジェクト指向型

public NumberFormatter::setPattern(string $pattern): bool

手続き型

numfmt_set_pattern(NumberFormatter $formatter, string $pattern): bool

フォーマッタが使用するパターンを設定します。ルールベースのフォーマッタでは使用できません。

パラメータ

formatter: NumberFormatter オブジェクト。
pattern: » ICU DecimalFormat ドキュメントで述べられている構文によるパターン。

戻り値

成功した場合に true を、失敗した場合に false を返します。

例

例1 numfmt_set_pattern() の例

<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
echo "Pattern: ".numfmt_get_pattern($fmt)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
numfmt_set_pattern($fmt, "#0.# kg");
echo "Pattern: ".numfmt_get_pattern($fmt)."\n";
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
?>

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

<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
echo "Pattern: ".$fmt->getPattern()."\n";
echo $fmt->format(1234567.891234567890000)."\n";
$fmt->setPattern("#0.# kg");
echo "Pattern: ".$fmt->getPattern()."\n";
echo $fmt->format(1234567.891234567890000)."\n";
?>

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

Pattern: #,##0.###
1.234.567,891
Pattern: #0.# kg
1234567,9 kg

参考

numfmt_get_error_code() - フォーマッタの直近のエラーコードを取得する
numfmt_create() - 数値フォーマッタを作成する
numfmt_get_pattern() - フォーマッタのパターンを取得する

add a note

User Contributed Notes 2 notes

down

Crash ¶

4 years ago


If you're looking for the pattern syntax, their documentation is here: http://unicode.org/reports/tr35/tr35-numbers.html#Number_Format_Patterns

down

-1

Anonymous ¶

5 years ago


setPattern appears to influence only the behavior of the format method, not the parse method of the NumberFormatter object. 

$pattern = '#,##0';
$frmtr = NumberFormatter::create('en-US', NumberFormatter::DECIMAL);
$frmtr->setPattern($pattern);
echo $frmtr->parse('12.345');

// returns 12

add a note