Класс Number
Библиотека для работы с числами.
Методы для улучшения читаемости чисел.
Ссылка: http://book.cakephp.org/3.0/ru/core-libraries/number.html
Расположение: I18n/Number.php
Краткое описание констант
-
string'en_US' -
string'currency'
Краткое описание свойств
- Базовая валюта, используемая методом Number::currency()
string - Список форматировщиков чисел, индексированных по локали и типу
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 для форматирования числа. Пример: #,###.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Валюта
format()source public static
format( float $value , array $options [] )
Форматирование числа в соответствии с локалью
Опции:
-
places- Минимальное количество знаков после запятой (например, 0) -
precision- Максимальное количество знаков после запятой (например, 2) -
pattern- Шаблон ICU для форматирования числа (например, #,###.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 для форматирования числа. Например, #,###.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необязательно [] - Дополнительные параметры
Возвращает
строкаОтформатированное число с плавающей запятой.
Ссылка
http://book.cakephp.org/3.0/en/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необязательно [] - Параметры
Возвращает
строкаСтрока процента
Ссылка
http://book.cakephp.org/3.0/en/core-libraries/number.html#formatting-percentagestoReadableSize()source public static
toReadableSize( integer $size )
Возвращает отформатированный размер файла для человеческого восприятия.
Параметры
- целое число
$size - Размер в байтах
Возвращает
строкаЧеловекопонятный размер
Ссылка
http://book.cakephp.org/3.0/en/core-libraries/number.html#interacting-with-human-readable-valuesПодробное описание свойств
$_defaultCurrencysource
protected static строка
Валюта по умолчанию, используемая Number::currency()
$_formatterssource
protected static массив
Список форматировщиков чисел, индексированных по региональным настройкам и типу
[]
© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.I18n.Number.html