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