NumberFormatter::setPattern

numfmt_set_pattern

Set formatter pattern

&reftitle.description;

&style.oop;

public `bool` `NumberFormatter::setPattern` `string` `pattern`

&style.procedural;

`bool` `numfmt_set_pattern` `NumberFormatter` `formatter` `string` `pattern`

Set the pattern used by the formatter. Can not be used on a rule-based formatter.

&reftitle.parameters;

`formatter`

- `NumberFormatter` object.

`pattern`

- Pattern in syntax described in ICU DecimalFormat documentation.

&reftitle.returnvalues;

&return.success;

&reftitle.examples;

### `numfmt_set_pattern` example

    <?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";
    ?>

### OO example

    <?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";
    ?>

&example.outputs;

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

&reftitle.seealso;

- `numfmt_get_error_code`
- `numfmt_create`
- `numfmt_get_pattern`