Класс CakeNumber
Библиотека для работы с числами.
Методы для повышения удобочитаемости чисел.
Ссылка: http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Utility/CakeNumber.php
Краткое описание свойств
-
arrayВалюты, поддерживаемые помощником. Вы можете добавить дополнительные форматы валют с помощью CakeNumber::addFormat
- По умолчанию параметры для форматов валют
array - Валюта по умолчанию, используемая в CakeNumber::currency()
string - Использовать ли встроенную функцию number_format(). Если >= PHP5.4
boolean
Краткое описание методов
- Альтернативная функция number_format() для поддержки многобайтовых десятичных знаков и разделителей тысяч в PHP < PHP 5.4
-
Добавляет формат валюты к помощнику Number. Упрощает повторное использование форматов валют.
- Форматирует число в формате валюты.
- Получение/установка валюты по умолчанию
- Форматирует число в формате валюты.
- Форматирует число в формате валюты, чтобы показать разницы (знаковые разницы в значении).
- Преобразует размер файла из удобочитаемой строки в байты
- Форматирует число с заданной точностью.
- Форматирует число в процентную строку.
- Возвращает размер файла, отформатированный для удобочитаемости.
Подробное описание методов
_numberFormat()source protected static
_numberFormat( float $value , integer $places 0 , string $decimals '.' , string $thousands ',' )
Альтернативная функция number_format() для поддержки многобайтовых десятичных знаков и разделителей тысяч в PHP < 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()Ссылка
http://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- Позиция символа валюты для целой части, допустимые значения 'before' & 'after'. -
fractionSymbol- Символ валюты для дробной части. -
fractionPosition- Позиция символа валюты для дробной части, допустимые значения 'before' & 'after'. -
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', в противном случае установите по крайней мере параметры 'before' и 'after'.
- array
$optionsoptional array() - Список параметров.
Возвращает
stringОтформатированное число в виде валюты.
Ссылка
http://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Валюта
Ссылка
http://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Отформатированное число
Ссылка
http://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необязательно массив() - Список параметров.
Возвращаемое значение
строкаотформатированная разница
Ссылка
http://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При некорректном типе единиц измерения.
Ссылка
http://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Отформатированное число с плавающей точкой.
Ссылка
http://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необязательно массив() - Параметры
Возвращаемое значение
строкаСтрока процентов
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::toPercentagetoReadableSize()source public static
toReadableSize( integer $size )
Возвращает размер файла, отформатированный для человека.
Параметры
- целое число
$size - Размер в байтах
Возвращаемое значение
строкаУдобочитаемый размер
Ссылка
http://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 boolean
Если должна использоваться функция number_format(). Если PHP >= 5.4
null
© 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/2.8/class-CakeNumber.html