Класс CakeNumber
Библиотека для работы с числами.
Методы для улучшения удобочитаемости чисел.
Ссылка: https://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html
Авторские права: Авторские права (с) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение: Cake/Utility/CakeNumber.php
Краткое описание свойств
-
arrayПоддерживаемые валюты в помощнике. Вы можете добавить дополнительные форматы валют с помощью CakeNumber::addFormat
- Основные параметры для форматов валют
array - По умолчанию используется валюта в CakeNumber::currency()
string - Если необходимо использовать встроенную функцию number_format(). Если >= PHP5.4
boolean
Краткое описание методов
- Альтернативная функция number_format() для поддержки многобайтовых десятичных знаков и разделителей тысяч в версиях PHP < 5.4
-
Добавляет формат валюты в помощник Number. Упрощает повторное использование форматов валют.
- Форматирует число в формате валюты.
- Получение/установка значения валюты по умолчанию
- Форматирует число в формате валюты.
- Форматирует число в формате валюты для отображения разниц (знаковых различий в значениях).
- Преобразует размер файла из удобочитаемой строки в байты
- Форматирует число с заданной точностью.
- Форматирует число в строку процента.
- Возвращает размер файла, отформатированный для отображения человеку.
Подробное описание методов
_numberFormat()source protected static
_numberFormat( float $value , integer $places 0 , string $decimals '.' , string $thousands ',' )
Альтернативная функция number_format() для поддержки многобайтовых десятичных знаков и разделителей тысяч в версиях PHP < 5.4
Параметры
- float
$value - Значение для форматирования.
- integer
$placesoptional 0 - Десятичные знаки для использования.
- string
$decimalsoptional '.' - Разделитель десятичных знаков.
- string
$thousandsoptional ',' - Разделитель тысяч.
Возвращаемое значение
stringaddFormat()source public static
addFormat( string $formatName , array $options )
Добавляет формат валюты в помощник Number. Упрощает повторное использование форматов валют.
$number->addFormat('NOK', array('before' => 'Kr. ')); ```
You can now use `NOK` as a shortform when formatting currency amounts. $number->currency($value, 'NOK'); ```
Добавленные форматы объединяются с параметрами по умолчанию, определёнными в CakeNumber::$_currencyDefaults. См. CakeNumber::currency() для получения дополнительной информации о различных параметрах и их функциях.
Параметры
- string
$formatName - Название формата для использования в будущем.
- array
$options - Массив параметров для этого формата.
См. также
NumberHelper::currency()Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::addFormatcurrency()source public static
currency( float $value , string $currency null , array $options array() )
Форматирует число в формате валюты.
Параметры
-
wholeSymbol- Символ валюты для целых чисел, больших 1 или меньших -1. -
wholePosition- Позиция, в которой должен быть размещен целое число. Допустимые значения: 'перед' и 'после'. -
fractionSymbol- Символ валюты для дробной части. -
fractionPosition- Позиция, в которой должен быть размещен знак дробной части. Допустимые значения: 'перед' и 'после'. -
before- Символ валюты для размещения перед целой частью (например, '$').beforeявляется псевдонимом дляwholeSymbol. -
after- Символ валюты для размещения после дробной части (например, 'c'). Установите в значение false для вывода без символа дробной части. Пример: 0.35 → $0.35.afterявляется псевдонимом дляfractionSymbol. -
zero- Текст для использования для нулевых значений (строка или число). Пример: 0, 'Бесплатно!' -
places- Количество десятичных знаков. Пример: 2 -
fractionExponent- Показатель степени для дробной части этой валюты. По умолчанию 2. -
thousands- Разделитель тысяч (например, ','). -
decimals- Разделитель десятичных знаков (например, '.'). -
negative- Символ для отрицательных чисел. Если равно '()', число будет заключено в скобки ( и ). -
escape- Требуется ли экранирование символов для HTML. Значение по умолчанию контролируется настройками валюты. По умолчанию все валюты содержат символы UTF-8 и не требуют изменения. Если вам требуются символы без кодирования HTML, вам необходимо обновить настройки с правильными байтами.
Параметры
- float
$value - Значение для форматирования.
- string
$currencyoptional null Сокращенное значение параметров по умолчанию. Допустимые значения: 'USD', 'EUR', 'GBP', в противном случае необходимо задать хотя бы параметры 'перед' и 'после'.
- array
$optionsoptional array() - Список параметров.
Возвращаемое значение
stringОтформатированное число в виде валюты.
Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::currencydefaultCurrency()source public static
defaultCurrency( string $currency null )
Получение/установка значения валюты по умолчанию
Параметры
- string
$currencyoptional null - Строка валюты по умолчанию, используемая методом currency() если аргумент $currency не передан
Возвращаемое значение
stringВалюта
Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::defaultCurrencyformat()source public static
format( float $value , integer $options false )
Форматирует число в формате валюты.
Параметры
- float
$value - Число с плавающей точкой
- integer
$optionsoptional false Если целое число, то количество знаков после запятой; если строка, то позиция перед числом; если (,.-) — то используется соответствующий символ или массив с ключами places и before
Возвращаемое значение
stringотформатированное число
Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::formatformatDelta()source public static
formatDelta( float $value , array $options array() )
Форматирует число в формате валюты для отображения разницы (знаковых различий в значении).
Параметры
-
places- Количество десятичных знаков для использования. Пример: 2 -
fractionExponent- Экспонента дроби для этой конкретной валюты. По умолчанию 2. -
before- Строка, которая ставится перед целыми числами. Пример: '[' -
after- Строка, которая ставится после десятичных чисел. Пример: ']' -
thousands- Разделитель тысяч, например ', ' -
decimals- Разделитель десятичных знаков, например '.'
Параметры
- float
$value - Число с плавающей запятой
- массив
$optionsнеобязательно массив() - Список параметров.
Возвращает
строкаотформатированная разница
Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::formatDeltafromReadableSize()source public static
fromReadableSize( string $size , mixed $default false )
Преобразует размер файла из читаемой человеком строки в байты
Параметры
- строка
$size - Размер в читаемой человеком строке, например, '5MB', '5M', '500B', '50kb' и т. д.
- смешанное
$defaultнеобязательно false - Значение, возвращаемое при использовании недопустимого размера, например, 'Неизвестный тип'
Возвращает
смешанноеКоличество байтов в виде целого числа при успехе,
$default при ошибке, если не falseВыбрасывает
CakeExceptionПри недопустимом типе единицы.
Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::fromReadableSizeprecision()source public static
precision( float $value , integer $precision 3 )
Форматирует число с заданной точностью.
Параметры
- float
$value - Число с плавающей запятой.
- целое число
$precisionнеобязательно 3 - Точность возвращаемого числа.
Возвращает
floatОтформатированное число с плавающей запятой.
Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::precisiontoPercentage()source public static
toPercentage( float $value , integer $precision 2 , array $options array() )
Форматирует число в строку процента.
Параметры:
-
multiply: Умножает входное значение на 100 для десятичных процентов.
Параметры
- float
$value - Число с плавающей запятой
- целое число
$precisionнеобязательно 2 - Точность возвращаемого числа
- массив
$optionsнеобязательно массив() - Параметры
Возвращает
строкаСтрока процента
Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::toPercentagetoReadableSize()source public static
toReadableSize( integer $size )
Возвращает размер файла в формате, удобном для восприятия человеком.
Параметры
- целое число
$size - Размер в байтах
Возвращает
строкаРазмер, удобный для восприятия человеком
Ссылка
https://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::toReadableSizeПодробное описание свойств
$_currenciessource
protected static массив
Поддерживаемые помощником валюты. Вы можете добавить дополнительные форматы валюты с помощью CakeNumber::addFormat
array(
'AUD' => array(
'wholeSymbol' => '$', 'wholePosition' => 'before', 'fractionSymbol' => 'c', 'fractionPosition' => 'after',
'zero' => 0, 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,
'fractionExponent' => 2
),
'CAD' => array(
'wholeSymbol' => '$', 'wholePosition' => 'before', 'fractionSymbol' => 'c', 'fractionPosition' => 'after',
'zero' => 0, 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,
'fractionExponent' => 2
),
'USD' => array(
'wholeSymbol' => '$', 'wholePosition' => 'before', 'fractionSymbol' => 'c', 'fractionPosition' => 'after',
'zero' => 0, 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,
'fractionExponent' => 2
),
'EUR' => array(
'wholeSymbol' => '€', 'wholePosition' => 'before', 'fractionSymbol' => false, 'fractionPosition' => 'after',
'zero' => 0, 'places' => 2, 'thousands' => '.', 'decimals' => ',', 'negative' => '()', 'escape' => true,
'fractionExponent' => 0
),
'GBP' => array(
'wholeSymbol' => '£', 'wholePosition' => 'before', 'fractionSymbol' => 'p', 'fractionPosition' => 'after',
'zero' => 0, 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,
'fractionExponent' => 2
),
'JPY' => array(
'wholeSymbol' => '¥', 'wholePosition' => 'before', 'fractionSymbol' => false, 'fractionPosition' => 'after',
'zero' => 0, 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,
'fractionExponent' => 0
),
) $_currencyDefaultssource
protected static массив
Параметры по умолчанию для форматов валют
array(
'wholeSymbol' => '', 'wholePosition' => 'before', 'fractionSymbol' => false, 'fractionPosition' => 'after',
'zero' => '0', 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,
'fractionExponent' => 2
) $_defaultCurrencysource
protected static строка
Валюта по умолчанию, используемая CakeNumber::currency()
'USD'
$_numberFormatSupportsource
protected static логическое
Использовать ли встроенную функцию number_format(). Если >= PHP5.4
null
© 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/2.10/class-CakeNumber.html