Spec-Zone.ru › CakePHP 3.7

Класс Number

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

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

Пространство имён: Cake\I18n
Ссылка: https://book.cakephp.org/3.0/ru/core-libraries/number.html
Расположение: I18n/Number.php

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

  • string

    DEFAULT_LOCALE
    'en_US'
  • string

    FORMAT_CURRENCY
    'currency'

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

  • $_defaultCurrency protected static
    string|null
    По умолчанию используемая валюта в Number::currency()
  • $_formatters protected static
    array
    Список форматировщиков чисел, индексированных по языку и типу

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

  • _setAttributes() protected static
    Установка атрибутов форматировщика
  • config() public static
    Настройка форматировщиков.
  • currency() public static
    Форматирует число в формате валюты.
  • defaultCurrency() public static
    Получение/установка валюты по умолчанию
  • format() public static
    Форматирует число в соответствии с форматом текущего языка.
  • formatDelta() public static
    Форматирует число в соответствии с форматом текущего языка, отображая приращения (знаковые разницы в значениях).
  • formatter() public static

    Возвращает объект форматировщика, который можно повторно использовать для аналогичных задач форматирования в рамках одного языка и настроек. Это часто более быстрый вариант по сравнению с использованием других методов в этом классе, так как необходимо создать только один объект форматировщика.

  • ordinal() public static
    Возвращает отформатированное целое число как строку порядкового номера (например, 1-й, 2-й, 3-й, 4-й, [...])
  • parseFloat() public static
    Парсинг локализованной числовой строки и преобразование её в число с плавающей точкой
  • precision() public static
    Форматирует число с заданной точностью.
  • toPercentage() public static
    Форматирует число в строку процента.
  • toReadableSize() public static
    Возвращает размер файла в удобочитаемом формате.

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

_setAttributes()source protected static

_setAttributes( NumberFormatter $formatter , array $options = [] )

Установка атрибутов форматировщика

Параметры

NumberFormatter $formatter
Экземпляр форматировщика чисел.
array $options необязательно []
См. Number::formatter() для возможных опций.

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

NumberFormatter

config()source public static

config( string $locale , integer $type = Cake\I18n\NumberFormatter::DECIMAL , array $options = [] )

Настройка форматировщиков.

Параметры

string $locale
Имя языка для форматирования числа, например fr_FR
integer $type необязательно Cake\I18n\NumberFormatter::DECIMAL
Тип форматировщика для создания. По умолчанию NumberFormatter::DECIMAL.
array $options необязательно []
См. Number::formatter() для возможных опций.

currency()source public static

currency( float $value , string|null $currency = null , array $options = [] )

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

Опции

  • locale - Имя языка для форматирования числа, например fr_FR
  • fractionSymbol - Символ валюты для дробных чисел.
  • fractionPosition - Позиция, в которой должен быть размещён символ дроби. Допустимые значения: 'before' & 'after'.
  • before - Текст, отображаемый перед отформатированным числом
  • after - Текст, отображаемый после отформатированного числа
  • zero - Текст для отображения нулевых значений, может быть строкой или числом. Например, 0, 'Бесплатно!'
  • places - Количество десятичных знаков. Например, 2
  • precision - Максимальное количество десятичных знаков. Например, 2
  • pattern - Шаблон ICU для форматирования числа. Например, #,##0.00
  • useIntlCode - Заменить ли символ валюты на международный код валюты.

Параметры

float $value
Значение для форматирования.
string|null $currency необязательно null
Международное название валюты, например 'USD', 'EUR', 'JPY', 'CAD'
array $options необязательно []
Список опций.

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

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

defaultCurrency()source public static

defaultCurrency( string|boolean|null $currency = null )

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

Параметры

string|boolean|null $currency необязательно null

Строка валюты по умолчанию, используемая методом currency(), если аргумент $currency не указан. Если передано значение false, текущее сохранённое значение будет очищено.

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

string|null
Валюта

format()source public static

format( float $value , array $options = [] )

Форматирует число в соответствии с форматом текущего языка

Опции:

  • places - Минимальное количество десятичных знаков, например 0
  • precision - Максимальное количество десятичных знаков, например 2
  • pattern - Шаблон ICU для форматирования числа. Например, #,##0.00
  • locale - Имя языка для форматирования числа, например fr_FR
  • before - Строка, размещаемая перед целой частью числа, например '['
  • after - Строка, размещаемая после дробной части числа, например ']'

Параметры

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

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

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

formatDelta()source public static

formatDelta( float $value , array $options = [] )

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

Опции

  • places - Минимальное количество десятичных знаков, например 0
  • precision - Максимальное количество десятичных знаков, например 2
  • locale - Имя языка для форматирования числа, например fr_FR
  • before - Строка, размещаемая перед целой частью числа, например '['
  • after - Строка, размещаемая после дробной части числа, например ']'

Параметры

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

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

string
Отформатированное приращение
END_OF_DOCUMENT_MARKER

formatter()source public static

formatter( array $options = [] )

Возвращает объект форматировщика, который можно повторно использовать для аналогичных задач форматирования в рамках одного регионального формата и параметров. Это часто более быстрый вариант, чем использование других методов в этом классе, поскольку необходимо создать только один объект форматировщика.

Параметры

  • locale - Имя регионального формата, используемого для форматирования числа, например, fr_FR
  • type - Тип форматировщика для создания, установите значение currency , если необходимо форматировать числа, представляющие деньги, или константу NumberFormatter.
  • places - Количество десятичных знаков для использования. Например, 2
  • precision - Максимальное количество десятичных знаков для использования, например, 2
  • pattern - Шаблон ICU для форматирования числа. Например, #,##0.00
  • useIntlCode - Нужно ли заменять символ валюты международным кодом валюты.

Параметры

массив $options необязательно []
Массив с параметрами.

Возвращает

NumberFormatter
Настроенный экземпляр форматировщика

ordinal()source public static

ordinal( integer|float $value , array $options = [] )

Возвращает отформатированное целое число в виде строки порядкового номера (например, 1-е, 2-е, 3-е, 4-е, [...])

Параметры

  • type - Тип форматировщика для создания, установите значение currency , если необходимо форматировать числа, представляющие деньги, или константу NumberFormatter.

Все остальные параметры см. в formatter().

Параметры

целое число/число с плавающей запятой $value
Целое число
массив $options необязательно []
Массив с параметрами.

Возвращает

строка

parseFloat()source public static

parseFloat( string $value , array $options = [] )

Разбирает локализованную строку с числом и преобразует ее в число с плавающей точкой

Параметры:

  • locale - Имя регионального формата, используемого для разбора числа, например, fr_FR
  • type - Тип форматировщика для создания, установите значение currency , если необходимо разобрать числа, представляющие деньги.

Параметры

строка $value
Строка с числом.
массив $options необязательно []
Массив с параметрами.

Возвращает

число с плавающей точкой
число с плавающей точкой

precision()source public static

precision( float $value , integer $precision = 3 , array $options = [] )

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

Параметры:

  • locale: Имя регионального формата, используемого для форматирования числа, например, fr_FR

Параметры

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

Возвращает

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

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/number.html#formatting-floating-point-numbers

toPercentage()source public static

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

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

Параметры:

  • multiply: Умножает входное значение на 100 для десятичных процентов.
  • locale: Имя регионального формата, используемого для форматирования числа, например, fr_FR

Параметры

число с плавающей точкой $value
Число с плавающей точкой
целое число $precision необязательно 2
Точность возвращаемого числа
массив $options необязательно []
Параметры

Возвращает

строка
Строка процента

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/number.html#formatting-percentages

toReadableSize()source public static

toReadableSize( integer $size )

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

Параметры

целое число $size
Размер в байтах

Возвращает

строка
Размер, понятный человеку

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/number.html#interacting-with-human-readable-values

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

$_defaultCurrencysource

protected static строка|null

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

$_formatterssource

protected static массив

Список форматировщиков чисел, индексированных по региональному формату и типу

[]

© 2005–present 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/3.7/class-Cake.I18n.Number.html

Spec-Zone.ru

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