Spec-Zone.ru › CakePHP 2.9

Класс CakeNumber

Библиотека для работы с числами.

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

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

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

  • $_currencies protected static
    array

    Поддерживаемые форматы валют. Добавьте дополнительные форматы с помощью CakeNumber::addFormat

  • $_currencyDefaults protected static
    array
    По умолчанию используется форматы валют
  • $_defaultCurrency protected static
    string
    По умолчанию валюта используемая CakeNumber::currency()
  • $_numberFormatSupport protected static
    boolean
    Использовать ли native number_format(). Если >= PHP5.4

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

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

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

  • currency() public static
    Форматирование числа в формате валюты.
  • defaultCurrency() public static
    Получение/установка значения валюты по умолчанию
  • format() public static
    Форматирование числа в формате валюты.
  • formatDelta() public static
    Форматирование числа в формате валюты для отображения разниц (знаковых различий в значении).
  • fromReadableSize() public static
    Преобразование размера файла из удобочитаемой строки в байты
  • precision() public static
    Форматирование числа с заданной точностью.
  • toPercentage() public static
    Форматирование числа в строку процента.
  • toReadableSize() public static
    Возвращает размер файла, отформатированный для человека.

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

_numberFormat()source protected static

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

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

Параметры

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

Возвращает

строка

addFormat()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::addFormat

currency()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 $currency optional null

Псевдоним для параметров по умолчанию. Допустимые значения 'USD', 'EUR', 'GBP', иначе задайте хотя бы параметры 'перед' и 'после'.

array $options optional array()
Список параметров.

Возвращает

строка
Отформатированное число в виде валюты.

Ссылка

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

defaultCurrency()source public static

defaultCurrency( string $currency null )

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

Параметры

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

Возвращает

строка
Валюта

Ссылка

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

format()source public static

format( float $value , integer $options false )

Форматирование числа в формате валюты.

Параметры

float $value
Число с плавающей точкой
integer $options optional false

Если целое число, то места, если строка, то перед, если (,.-), то использовать или массив с местами и перед ключами

Возвращает

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

Ссылка

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

formatDelta()source public static

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

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

Параметры

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

Параметры

float $value
Число с плавающей точкой
array $options optional array()
Список параметров.

Возвращаемое значение

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

Ссылка

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

fromReadableSize()source public static

fromReadableSize( string $size , mixed $default false )

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

Параметры

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

Возвращаемое значение

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

Исключения

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

Ссылка

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

precision()source public static

precision( float $value , integer $precision 3 )

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

Параметры

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

Возвращаемое значение

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

Ссылка

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

toPercentage()source public static

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

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

Параметры:

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

Параметры

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

Возвращаемое значение

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

Ссылка

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

toReadableSize()source 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.
https://api.cakephp.org/2.9/class-CakeNumber.html

Spec-Zone.ru

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