Spec-Zone.ru › CakePHP 2.7

Класс CakeNumber

Библиотека помощников для чисел.

Методы для улучшения читабельности чисел.

Пакет: Cake\Utility
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Ссылка: http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html
Расположение: Cake/Utility/CakeNumber.php

Подробное описание методов

_numberFormatисходный код защищенный статический

_numberFormat( float $value , integer $places 0 , string $decimals '.' , string $thousands ',' )

Альтернативная функция number_format() для поддержки многобайтовых десятичных знаков и разделителей тысяч в PHP < 5.4

Параметры

float $value
Значение для форматирования.
целое число $places необязательно 0
Количество десятичных знаков.
строка $decimals необязательно '.'
Строка для разделителя десятичных знаков.
строка $thousands необязательно ','
Строка для разделителя тысяч.

Возвращает

string
строка

addFormatисходный код публичный статический

addFormat( string $formatName , array $options )

Добавляет формат валюты в помощник Number. Упрощает повторное использование форматов валюты.

$number->addFormat('NOK', array('before' => 'Kr. '));

Теперь вы можете использовать NOK в качестве сокращения при форматировании денежных сумм.

$number->currency($value, 'NOK');

Добавленные форматы объединяются со значениями по умолчанию, определёнными в CakeNumber::$_currencyDefaults. См. CakeNumber::currency() для получения дополнительной информации о различных параметрах и их функциях.

Параметры

строка $formatName
Имя формата, которое будет использоваться в будущем.
массив $options
Массив опций для данного формата.

См. также

NumberHelper::currency()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::addFormat

currencyисходный код публичный статический

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
Значение для форматирования.
строка $currency необязательно null
Сокращённое обозначение опций по умолчанию. Допустимые значения 'USD', 'EUR', 'GBP', в противном случае необходимо установить хотя бы опции 'перед' и 'после'.
массив $options необязательно array()
Список опций.

Возвращает

string
Число, отформатированное как валюта.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::currency

defaultCurrencyисходный код публичный статический

defaultCurrency( string $currency null )

Получение/установка значения валюты по умолчанию

Параметры

строка $currency необязательно null
Строка валюты по умолчанию, используемая функцией currency(), если аргумент $currency не указан

Возвращает

string
Валюта

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::defaultCurrency

formatисходный код публичный статический

format( float $value , integer $options false )

Форматирует число в определенном формате.

Параметры

float $value
Число с плавающей точкой
целое число $options необязательно false
Если целое число, то количество десятичных знаков, если строка, то позиция, если (,.-), то используется оно или массив с ключами places и before

Возвращает

string
отформатированное число

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::format

formatDeltaисходный код публичный статический

formatDelta( float $value , array $options array() )

Форматирует число в формате валюты для отображения разниц (знаковых разниц в значении).

Опции

  • places - Количество десятичных знаков. Например, 2
  • fractionExponent - Показатель степени для дробной части этой валюты. По умолчанию 2.
  • before - Строка, помещаемая перед целой частью. Например, '['
  • after - Строка, помещаемая после дробной части. Например, ']'
  • thousands - Разделитель тысяч (например, ',').
  • decimals - Разделитель десятичных знаков (например, '.').

Параметры

float $value
Число с плавающей точкой
массив $options необязательно array()
Список опций.

Возвращает

string
Отформатированная разница.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::formatDelta

fromReadableSizeисходный код публичный статический

fromReadableSize( string $size , mixed $default false )

Преобразует размер файла из удобочитаемой строки в байты

Параметры

строка $size
Размер в удобочитаемой строке, например, '5МБ', '5М', '500Б', '50кб' и т.д.
смешанный $default необязательно false
Значение, возвращаемое при использовании недопустимого размера, например, 'Неизвестный тип'

Возвращает

mixed
Количество байтов как целое число при успехе, $default при ошибке, если не false

Исключения

CakeException
При недопустимом типе единицы измерения.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::fromReadableSize

precisionисходный код публичный статический

precision( float $value , integer $precision 3 )

Форматирует число с заданной точностью.

Параметры

float $value
Число с плавающей точкой.
целое число $precision необязательно 3
Точность возвращаемого числа.

Возвращает

float
Отформатированное число с плавающей точкой.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::precision

toPercentagesource public static

toPercentage( float $value , integer $precision 2 , array $options array() )

Форматирует число в строку процентов.

Параметры:

  • multiply: Умножает входное значение на 100 для десятичных процентов.

Параметры

float $value
Число с плавающей точкой
integer $precision необязательно 2
Точность возвращаемого числа
array $options необязательно array()
Параметры

Возвращает

string
Строка процентов

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::toPercentage

toReadableSizesource public static

toReadableSize( integer $size )

Возвращает размер файла в формате, удобном для восприятия человеком.

Параметры

integer $size
Размер в байтах

Возвращает

string
Размер в читаемом формате

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::toReadableSize

Краткое описание свойств

$_currenciessource

protected static array

Поддерживаемые помощником валюты. Вы можете добавить дополнительные форматы валюты с помощью 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

Параметры по умолчанию для форматов валют

array(
    'wholeSymbol' => '', 'wholePosition' => 'before', 'fractionSymbol' => false, 'fractionPosition' => 'after',
    'zero' => '0', 'places' => 2, 'thousands' => ',', 'decimals' => '.', 'negative' => '()', 'escape' => true,
    'fractionExponent' => 2
)

$_defaultCurrencysource

protected static string

Валюта по умолчанию, используемая CakeNumber::currency()

'USD'

$_numberFormatSupportsource

protected static boolean

Если использовать встроенную функцию number_format(). Если PHP5.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.7/class-CakeNumber.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API