フォーマッタのパターンを設定する

# NumberFormatter::setPattern

# numfmt_set_pattern

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

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

### 説明

オブジェクト指向型

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

手続き型

numfmt_set_pattern ( NumberFormatter `$fmt` , string `$pattern` ) : bool

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

### パラメータ

`fmt`

  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() - フォーマッタのパターンを取得する