フォーマッタのパターンを取得する

# NumberFormatter::getPattern

# numfmt_get_pattern

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

NumberFormatter::getPattern -- numfmt_get_pattern — フォーマッタのパターンを取得する

### 説明

オブジェクト指向型

public function NumberFormatter::getPattern(): string|false

手続き型

function numfmt_get_pattern(NumberFormatter `$formatter`): string|false

フォーマッタが使用するパターンを取り出します。

### パラメータ

`formatter`

  NumberFormatter オブジェクト。

### 戻り値

このフォーマッタが使用するパターン文字列、 あるいはエラー発生時に `false` を返します。

### 例

例1 numfmt_get_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_set_pattern() - フォーマッタのパターンを設定する
- numfmt_create() - 数値フォーマッタを作成する

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open