Класс 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 - Экземпляр форматировщика чисел.
- массив
$optionsдополнительно [] - См. Number::formatter() для возможных опций.
Возвращает
NumberFormatterconfig()source public static
config( string $locale , integer $type = Cake\I18n\NumberFormatter::DECIMAL , array $options = [] )
Настройка форматировщиков.
Параметры
- строка
$locale - Имя локали для форматирования числа, например, fr_FR
- целое число
$typeдополнительно Cake\I18n\NumberFormatter::DECIMAL - Тип форматировщика для создания. По умолчанию NumberFormatter::DECIMAL.
- массив
$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 - Значение для форматирования.
- строка|null
$currencyдополнительно null - Международное название валюты, например, 'USD', 'EUR', 'JPY', 'CAD'
- массив
$optionsдополнительно [] - Список опций.
Возвращает
строкаЧисло, отформатированное как валюта.
defaultCurrency()source public static
defaultCurrency( string|boolean|null $currency = null )
Получение/установка валюты по умолчанию
Параметры
- строка|логическое|null
$currencyдополнительно null Строка валюты по умолчанию, которая будет использоваться в currency(), если аргумент $currency не указан. Если передано логическое значение false, текущее значение будет очищено
Возвращает
строка|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 - Число с плавающей точкой.
- массив
$optionsдополнительно [] - Массив с опциями.
Возвращает
строкаОтформатированное число
formatDelta()source public static
formatDelta( float $value , array $options = [] )
Форматирование числа в соответствии с локалью для отображения разниц (знаковых различий в значении).
Опции
-
places- Минимальное количество десятичных знаков. Пример: 0 -
precision- Максимальное количество десятичных знаков. Пример: 2 -
locale- Имя локали для форматирования числа, например, fr_FR -
before- Строка, которая должна быть добавлена перед целой частью числа, например, '[' -
after- Строка, которая должна быть добавлена после дробной части числа, например, ']'
Параметры
- float
$value - Число с плавающей точкой
- массив
$optionsдополнительно [] - Список опций.
Возвращает
строкаОтформатированная разница
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 = [] )
Форматирует число с заданной точностью.
Параметры:
- %%%CODE_BLOCK_71%%: Имя региона для форматирования числа, например, 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.8/class-Cake.I18n.Number.html