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