Класс Number
Библиотека для работы с числами.
Методы для повышения удобочитаемости чисел.
Ссылка: https://book.cakephp.org/3.0/ru/core-libraries/number.html
Расположение: I18n/Number.php
Краткое описание констант
-
stringDEFAULT_LOCALE'en_US' -
stringFORMAT_CURRENCY'currency'
Краткое описание свойств
- По умолчанию используемая валюта в Number::currency()
string|null - Список форматировщиков чисел, индексированных по языку и типу
array
Краткое описание методов
- Установка атрибутов форматировщика
- Настройка форматировщиков.
- Форматирует число в формате валюты.
- Получение/установка валюты по умолчанию
- Форматирует число в соответствии с форматом текущего языка.
- Форматирует число в соответствии с форматом текущего языка, отображая приращения (знаковые разницы в значениях).
-
Возвращает объект форматировщика, который можно повторно использовать для аналогичных задач форматирования в рамках одного языка и настроек. Это часто более быстрый вариант по сравнению с использованием других методов в этом классе, так как необходимо создать только один объект форматировщика.
- Возвращает отформатированное целое число как строку порядкового номера (например, 1-й, 2-й, 3-й, 4-й, [...])
- Парсинг локализованной числовой строки и преобразование её в число с плавающей точкой
- Форматирует число с заданной точностью.
- Форматирует число в строку процента.
- Возвращает размер файла в удобочитаемом формате.
Подробное описание методов
_setAttributes()source protected static
_setAttributes( NumberFormatter $formatter , array $options = [] )
Установка атрибутов форматировщика
Параметры
- NumberFormatter
$formatter - Экземпляр форматировщика чисел.
- array
$optionsнеобязательно [] - См. Number::formatter() для возможных опций.
Возвращаемое значение
NumberFormatterconfig()source public static
config( string $locale , integer $type = Cake\I18n\NumberFormatter::DECIMAL , array $options = [] )
Настройка форматировщиков.
Параметры
- string
$locale - Имя языка для форматирования числа, например fr_FR
- integer
$typeнеобязательно Cake\I18n\NumberFormatter::DECIMAL - Тип форматировщика для создания. По умолчанию NumberFormatter::DECIMAL.
- array
$optionsнеобязательно [] - См. Number::formatter() для возможных опций.
currency()source public static
currency( float $value , string|null $currency = null , array $options = [] )
Форматирует число в формате валюты.
Опции
-
locale- Имя языка для форматирования числа, например fr_FR -
fractionSymbol- Символ валюты для дробных чисел. -
fractionPosition- Позиция, в которой должен быть размещён символ дроби. Допустимые значения: 'before' & 'after'. -
before- Текст, отображаемый перед отформатированным числом -
after- Текст, отображаемый после отформатированного числа -
zero- Текст для отображения нулевых значений, может быть строкой или числом. Например, 0, 'Бесплатно!' -
places- Количество десятичных знаков. Например, 2 -
precision- Максимальное количество десятичных знаков. Например, 2 -
pattern- Шаблон ICU для форматирования числа. Например, #,##0.00 -
useIntlCode- Заменить ли символ валюты на международный код валюты.
Параметры
- float
$value - Значение для форматирования.
- string|null
$currencyнеобязательно null - Международное название валюты, например 'USD', 'EUR', 'JPY', 'CAD'
- array
$optionsнеобязательно [] - Список опций.
Возвращаемое значение
stringОтформатированное число в формате валюты.
defaultCurrency()source public static
defaultCurrency( string|boolean|null $currency = null )
Получение/установка валюты по умолчанию
Параметры
- string|boolean|null
$currencyнеобязательно null Строка валюты по умолчанию, используемая методом currency(), если аргумент $currency не указан. Если передано значение false, текущее сохранённое значение будет очищено.
Возвращаемое значение
string|nullВалюта
format()source public static
format( float $value , array $options = [] )
Форматирует число в соответствии с форматом текущего языка
Опции:
-
places- Минимальное количество десятичных знаков, например 0 -
precision- Максимальное количество десятичных знаков, например 2 -
pattern- Шаблон ICU для форматирования числа. Например, #,##0.00 -
locale- Имя языка для форматирования числа, например fr_FR -
before- Строка, размещаемая перед целой частью числа, например '[' -
after- Строка, размещаемая после дробной части числа, например ']'
Параметры
- float
$value - Число с плавающей точкой.
- array
$optionsнеобязательно [] - Массив с опциями.
Возвращаемое значение
stringОтформатированное число
formatDelta()source public static
formatDelta( float $value , array $options = [] )
Форматирует число в соответствии с форматом текущего языка, отображая приращения (знаковые разницы в значениях).
Опции
-
places- Минимальное количество десятичных знаков, например 0 -
precision- Максимальное количество десятичных знаков, например 2 -
locale- Имя языка для форматирования числа, например fr_FR -
before- Строка, размещаемая перед целой частью числа, например '[' -
after- Строка, размещаемая после дробной части числа, например ']'
Параметры
- float
$value - Число с плавающей точкой
- array
$optionsнеобязательно [] - Список опций.
Возвращаемое значение
stringОтформатированное приращение
formatter()source public static
formatter( array $options = [] )
Возвращает объект форматировщика, который можно повторно использовать для аналогичных задач форматирования в рамках одного регионального формата и параметров. Это часто более быстрый вариант, чем использование других методов в этом классе, поскольку необходимо создать только один объект форматировщика.
Параметры
-
locale- Имя регионального формата, используемого для форматирования числа, например, fr_FR -
type- Тип форматировщика для создания, установите значениеcurrency, если необходимо форматировать числа, представляющие деньги, или константу NumberFormatter. -
places- Количество десятичных знаков для использования. Например, 2 -
precision- Максимальное количество десятичных знаков для использования, например, 2 -
pattern- Шаблон ICU для форматирования числа. Например, #,##0.00 -
useIntlCode- Нужно ли заменять символ валюты международным кодом валюты.
Параметры
- массив
$optionsнеобязательно [] - Массив с параметрами.
Возвращает
NumberFormatterНастроенный экземпляр форматировщика
ordinal()source public static
ordinal( integer|float $value , array $options = [] )
Возвращает отформатированное целое число в виде строки порядкового номера (например, 1-е, 2-е, 3-е, 4-е, [...])
Параметры
-
type- Тип форматировщика для создания, установите значениеcurrency, если необходимо форматировать числа, представляющие деньги, или константу NumberFormatter.
Все остальные параметры см. в formatter().
Параметры
- целое число/число с плавающей запятой
$value - Целое число
- массив
$optionsнеобязательно [] - Массив с параметрами.
Возвращает
строкаparseFloat()source public static
parseFloat( string $value , array $options = [] )
Разбирает локализованную строку с числом и преобразует ее в число с плавающей точкой
Параметры:
-
locale- Имя регионального формата, используемого для разбора числа, например, fr_FR -
type- Тип форматировщика для создания, установите значениеcurrency, если необходимо разобрать числа, представляющие деньги.
Параметры
- строка
$value - Строка с числом.
- массив
$optionsнеобязательно [] - Массив с параметрами.
Возвращает
число с плавающей точкойчисло с плавающей точкой
precision()source public static
precision( float $value , integer $precision = 3 , array $options = [] )
Форматирует число с заданной точностью.
Параметры:
-
locale: Имя регионального формата, используемого для форматирования числа, например, fr_FR
Параметры
- число с плавающей точкой
$value - Число с плавающей точкой.
- целое число
$precisionнеобязательно 3 - Точность возвращаемого числа.
- массив
$optionsнеобязательно [] - Дополнительные параметры
Возвращает
строкаОтформатированное число с плавающей точкой.
Ссылка
https://book.cakephp.org/3.0/ru/core-libraries/number.html#formatting-floating-point-numberstoPercentage()source public static
toPercentage( float $value , integer $precision = 2 , array $options = [] )
Форматирует число в строку процента.
Параметры:
-
multiply: Умножает входное значение на 100 для десятичных процентов. -
locale: Имя регионального формата, используемого для форматирования числа, например, fr_FR
Параметры
- число с плавающей точкой
$value - Число с плавающей точкой
- целое число
$precisionнеобязательно 2 - Точность возвращаемого числа
- массив
$optionsнеобязательно [] - Параметры
Возвращает
строкаСтрока процента
Ссылка
https://book.cakephp.org/3.0/ru/core-libraries/number.html#formatting-percentagestoReadableSize()source public static
toReadableSize( integer $size )
Возвращает размер файла, отформатированный для удобного восприятия.
Параметры
- целое число
$size - Размер в байтах
Возвращает
строкаРазмер, понятный человеку
Ссылка
https://book.cakephp.org/3.0/ru/core-libraries/number.html#interacting-with-human-readable-valuesПодробное описание свойств
$_defaultCurrencysource
protected static строка|null
По умолчанию валюта, используемая в Number::currency()
$_formatterssource
protected static массив
Список форматировщиков чисел, индексированных по региональному формату и типу
[]
© 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/3.7/class-Cake.I18n.Number.html