php8.5
Home/ Manual/ intl / numberformatter/ NumberFormatter::getPattern

NumberFormatter::getPattern

PHP function Edit on GitHub ✎

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

Get formatter pattern

Description

Oop

NumberFormatter::getPattern(): string|false

Procedural

numfmt_get_pattern(NumberFormatter $formatter): string|false

Extract pattern used by the formatter.

Parameters

formatter

NumberFormatter object.

Return Values

Pattern string that is used by the formatter, or false if an error happens.

Examples

numfmt_get_pattern() example

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

The above example will output:

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

See Also

Source: reference/intl/numberformatter/get-pattern.xml · from the official PHP manual (php/doc-en)