Класс 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- Текст, отображаемый после отформатированного числа -
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- Минимальное количество знаков после запятой -
precision- Максимальное количество знаков после запятой -
pattern- Шаблон ICU для форматирования числа -
locale- Имя локали для форматирования числа -
before- Строка, добавляемая перед целой частью числа -
after- Строка, добавляемая после дробной части числа
Параметры
- float
$value - Число с плавающей точкой.
- array
$optionsопционально [] - Массив с опциями.
Возвращаемое значение
stringОтформатированное число
formatDelta()source public static
formatDelta( float $value , array $options [] )
Форматирует число в соответствии с локалью для отображения разницы (знаковых разностей в значении).
Опции
-
places- Минимальное количество знаков после запятой -
precision- Максимальное количество знаков после запятой -
locale- Имя локали для форматирования числа -
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/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необязательно [] - Параметры
Возвращаемое значение
строкаСтрока процента
Ссылка
http://book.cakephp.org/3.0/ru/core-libraries/number.html#formatting-percentagestoReadableSize()source public static
toReadableSize( integer $size )
Возвращает размер файла в формате, понятном человеку.
Параметры
- целое число
$size - Размер в байтах
Возвращаемое значение
строкаЧеловекопонятный размер
Ссылка
http://book.cakephp.org/3.0/ru/core-libraries/number.html#interacting-with-human-readable-valuesПодробное описание свойств
$_defaultCurrencysource
protected static строка
По умолчанию валюта, используемая 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.3/class-Cake.I18n.Number.html