Класс Number

Библиотека для работы с числами.

Методы для улучшения удобочитаемости чисел.

Пространство имён: Cake\I18n
Ссылка: https://book.cakephp.org/4/ru/core-libraries/number.html

Константы

int

CURRENCY_ACCOUNTING
```
12
```
Константа ICU для бухгалтерского формата; пока не широко поддерживается библиотекой INTL. Это станет возможным после того, как минимальная версия PHP для CakePHP станет 7.4.1 или выше. См. UNUM_CURRENCY_ACCOUNTING в https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/unum_8h.html
string

DEFAULT_LOCALE
```
'en_US'
```
Локаль по умолчанию
string

FORMAT_CURRENCY
```
'currency'
```
Тип формата для отображения валюты
string

FORMAT_CURRENCY_ACCOUNTING
```
'currency_accounting'
```
Тип формата для отображения валюты в бухгалтерском стиле (отрицательные числа в скобках)

Резюме свойств

$_defaultCurrency protected static

string|null

Валюта по умолчанию, используемая в Number::currency()
$_defaultCurrencyFormat protected static

string|null

Формат валюты по умолчанию, используемый в Number::currency()
$_formatters protected static

array<string, array<int, mixed>>

Список форматирователей чисел, индексированных по локали и типу

Резюме методов

_setAttributes() protected static

Устанавливает атрибуты форматирования
config() public static

Настраивает форматирователи.
currency() public static

Форматирует число в формате валюты.
defaultCurrency() public static deprecated

Получение/установка валюты по умолчанию. Данное поведение устарело и будет удалено в будущих версиях CakePHP.
format() public static

Форматирует число в соответствии с локалью.
formatDelta() public static

Форматирует число в соответствии с локалью для отображения разницы (знакового различия в значении).
formatter() public static

Возвращает объект форматирования, который можно повторно использовать для аналогичных задач форматирования в той же локали и с теми же опциями. Это часто более быстрый вариант, чем использование других методов в этом классе, поскольку необходимо создать только один объект форматирования.
getDefaultCurrency() public static

Получение валюты по умолчанию
getDefaultCurrencyFormat() public static

Получение формата валюты по умолчанию
ordinal() public static

Возвращает отформатированное целое число как строку порядкового номера (например, 1-е, 2-е, 3-е, 4-е, ...)
parseFloat() public static

Разбирает локализованную строку с числом и преобразует её в число с плавающей запятой
precision() public static

Форматирует число с заданной точностью.
setDefaultCurrency() public static

Установка валюты по умолчанию
setDefaultCurrencyFormat() public static

Установка формата валюты по умолчанию
toPercentage() public static

Форматирует число в процентный формат.
toReadableSize() public static

Возвращает размер файла в удобочитаемом формате.

END_OF_DOCUMENT_MARKER

Подробное описание методов

_setAttributes() protected static

_setAttributes(NumberFormatter $formatter, array<string, mixed> $options = []): NumberFormatter

Установка атрибутов форматирования

Параметры

NumberFormatter $formatter: Экземпляр форматировщика чисел.
array<string, mixed> $options optional: См. Number::formatter() для возможных параметров.

Возвращает

NumberFormatter

config() public static

config(string $locale, int $type = NumberFormatter::DECIMAL, array<string, mixed> $options = []): void

Настройка форматировщиков.

Параметры

string $locale: Имя локали, используемой для форматирования числа, например, fr_FR
int $type optional: Тип форматировщика для создания. По умолчанию NumberFormatter::DECIMAL.
array<string, mixed> $options optional: См. Number::formatter() для возможных параметров.

Возвращает

void

currency() public static

currency(string|float $value, string|null $currency = null, array<string, mixed> $options = []): string

Форматирует число в валютном формате.

Параметры

locale - Имя локали, используемой для форматирования числа, например, fr_FR
fractionSymbol - Символ валюты для использования с дробными числами.
fractionPosition - Позиция, в которой должен быть размещен символ дроби; допустимые значения: 'before' и 'after'.
before - Текст для отображения перед отформатированным числом
after - Текст для отображения после отформатированного числа
zero - Текст для использования с нулевыми значениями; может быть строкой или числом. Например, 0, 'Free!'
places - Количество десятичных знаков для использования. Например, 2
precision - Максимальное количество десятичных знаков для использования. Например, 2
pattern - Шаблон числа ICU для использования при форматировании числа. Например, #,##0.00
useIntlCode - Заменять ли символ валюты на международный код валюты.

Параметры

string|float $value: Значение для форматирования.
string|null $currency optional: Международное название валюты, например, 'USD', 'EUR', 'JPY', 'CAD'
array<string, mixed> $options optional: Список параметров.

Возвращает

string

defaultCurrency() public static

defaultCurrency(string|false|null $currency = null): string|null

Геттер/сеттер для валюты по умолчанию. Это поведение устарело и будет удалено в будущих версиях CakePHP.

Параметры

string|false|null $currency optional: Строка валюты по умолчанию, которая будет использоваться {@link currency()}, если аргумент $currency не указан. Если передано логическое значение false, текущее сохраненное значение будет очищено.

Возвращает

string|null

format() public static

format(string|int|float $value, array<string, mixed> $options = []): string

Форматирует число в соответствии с локалью.

Параметры:

places - Минимальное количество десятичных знаков, например 0
precision - Максимальное количество десятичных знаков, например 2
pattern - Шаблон числа ICU для использования при форматировании числа. Например, #,##0.00
locale - Имя локали, используемой для форматирования числа, например, fr_FR
before - Строка, которая должна быть размещена перед целыми числами, например, '['
after - Строка, которая должна быть размещена после десятичных чисел, например, ']'

Параметры

string|int|float $value: Число с плавающей точкой.
array<string, mixed> $options optional: Массив с параметрами.

Возвращает

string

formatDelta() public static

formatDelta(string|float $value, array<string, mixed> $options = []): string

Форматирует число в соответствии с локалью для отображения дельт (знаковых различий в значении).

Параметры

places - Минимальное количество десятичных знаков, например 0
precision - Максимальное количество десятичных знаков, например 2
locale - Имя локали, используемой для форматирования числа, например, fr_FR
before - Строка, которая должна быть размещена перед целыми числами, например, '['
after - Строка, которая должна быть размещена после десятичных чисел, например, ']'

Параметры

string|float $value: Число с плавающей точкой
array<string, mixed> $options optional: Список параметров.

Возвращает

string

formatter() public static

formatter(array<string, mixed> $options = []): NumberFormatter

Возвращает объект форматировщика, который может быть повторно использован для аналогичных задач форматирования в той же локали и с теми же параметрами. Это часто более быстрая альтернатива использованию других методов в этом классе, так как необходимо создать только один объект форматировщика.

Параметры

locale - Имя локали, используемой для форматирования числа, например, fr_FR
type - Тип форматировщика для создания; установите его в currency если вам нужно форматировать числа, представляющие деньги, или константу NumberFormatter.
places - Количество десятичных знаков для использования. Например, 2
precision - Максимальное количество десятичных знаков для использования. Например, 2
pattern - Шаблон числа ICU для использования при форматировании числа. Например, #,##0.00
useIntlCode - Заменять ли символ валюты на международный код валюты.

Параметры

array<string, mixed> $options optional: Массив с параметрами.

Возвращает

NumberFormatter

getDefaultCurrency() public static

getDefaultCurrency(): string

Геттер для валюты по умолчанию

Возвращает

string

getDefaultCurrencyFormat() public static

getDefaultCurrencyFormat(): string

Геттер для формата валюты по умолчанию

Возвращает

string

ordinal() public static

ordinal(float|int $value, array<string, mixed> $options = []): string

Возвращает отформатированное целое число в виде порядкового номера (например, 1-й, 2-й, 3-й, 4-й, [...])

Параметры

type - Тип форматировщика для создания; установите его в currency если вам нужно форматировать числа, представляющие деньги, или константу NumberFormatter.

Для всех остальных параметров см. formatter().

Параметры

float|int $value: Целое число
array<string, mixed> $options optional: Массив с параметрами.

Возвращает

string

parseFloat() public static

parseFloat(string $value, array<string, mixed> $options = []): float

Разбирает локализованную числовую строку и преобразует её в число с плавающей точкой

Параметры:

locale - Имя локали, используемой для разбора числа, например, fr_FR
type - Тип форматировщика для создания; установите его в currency если вам нужно разобрать числа, представляющие деньги.

Параметры

string $value: Числовая строка.
array<string, mixed> $options optional: Массив с параметрами.

Возвращает

float

precision() public static

precision(string|float $value, int $precision = 3, array<string, mixed> $options = []): string

Форматирует число с заданным уровнем точности.

Параметры:

locale: Имя локали, используемой для форматирования числа, например, fr_FR

Параметры

string|float $value: Число с плавающей точкой.
int $precision optional: Точность возвращаемого числа.
array<string, mixed> $options optional: Дополнительные параметры

Возвращает

string

Ссылки

https://book.cakephp.org/4/en/core-libraries/number.html#formatting-floating-point-numbers

setDefaultCurrency() public static

setDefaultCurrency(string|null $currency = null): void

Установка значения по умолчанию для валюты

Параметры

string|null $currency опционально: Строка валюты по умолчанию, используемая методом {@link currency()}, если аргумент $currency не указан. Если передано значение null, текущее сохранённое значение будет очищено.

Возвращаемое значение

void

setDefaultCurrencyFormat() public static

setDefaultCurrencyFormat(string|null $currencyFormat = null): void

Установка формата валюты по умолчанию

Параметры

string|null $currencyFormat опционально: Формат валюты по умолчанию, используемый методом currency(), если аргумент $currencyFormat не указан. Если передано значение null, текущее сохранённое значение будет очищено.

Возвращаемое значение

void

toPercentage() public static

toPercentage(string|float $value, int $precision = 2, array<string, mixed> $options = []): string

Форматирует число в строку процента.

Опции:

multiply: Умножает входное значение на 100 для десятичных процентов.
locale: Имя локали для форматирования числа, например fr_FR

Параметры

string|float $value: Число с плавающей точкой
int $precision опционально: Точность возвращаемого числа
array<string, mixed> $options опционально: Опции

Возвращаемое значение

string

Ссылки

https://book.cakephp.org/4/ru/core-libraries/number.html#formatting-percentages

toReadableSize() public static

toReadableSize(string|int $size): string

Возвращает размер файла в читаемом для человека формате.

Параметры

string|int $size: Размер в байтах

Возвращаемое значение

string

Ссылки

https://book.cakephp.org/4/ru/core-libraries/number.html#interacting-with-human-readable-values

Подробности свойств

`$_defaultCurrency` protected static

Валюта по умолчанию, используемая методом Number::currency()

Тип

string|null

`$_defaultCurrencyFormat` protected static

Формат валюты по умолчанию, используемый методом Number::currency()

Тип

string|null

`$_formatters` protected static

Список форматировщиков чисел, индексированных по локали и типу

Тип

array<string, array<int, mixed>>

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.3/class-Cake.I18n.Number.html

Класс Number

Константы

Резюме свойств

Резюме методов

_setAttributes() protected static

config() public static

currency() public static

defaultCurrency() public static deprecated

format() public static

formatDelta() public static

formatter() public static

getDefaultCurrency() public static

getDefaultCurrencyFormat() public static

ordinal() public static

parseFloat() public static

precision() public static

setDefaultCurrency() public static

setDefaultCurrencyFormat() public static

toPercentage() public static

toReadableSize() public static

Подробное описание методов

_setAttributes() protected static

Параметры

Возвращает

config() public static

Параметры

Возвращает

currency() public static

Параметры

Параметры

Возвращает

defaultCurrency() public static

Параметры

Возвращает

format() public static

Параметры

Возвращает

formatDelta() public static

Параметры

Параметры

Возвращает

formatter() public static

Параметры

Параметры

Возвращает

getDefaultCurrency() public static

Возвращает

getDefaultCurrencyFormat() public static

Возвращает

ordinal() public static

Параметры

Параметры

Возвращает

parseFloat() public static

Параметры

Возвращает

precision() public static

Параметры

Возвращает

Ссылки

setDefaultCurrency() public static

Параметры

Возвращаемое значение

setDefaultCurrencyFormat() public static

Параметры

Возвращаемое значение

toPercentage() public static

Параметры

Возвращаемое значение

Ссылки

toReadableSize() public static

Параметры

Возвращаемое значение

Ссылки

Подробности свойств

$_defaultCurrency protected static

Тип

$_defaultCurrencyFormat protected static

Тип

$_formatters protected static

`$_defaultCurrency` protected static

`$_defaultCurrencyFormat` protected static

`$_formatters` protected static