Класс NumberHelper
Библиотека для работы с числами.
Методы для улучшения удобочитаемости чисел.
- Cake\View\Helper implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
-
Cake\View\Helper\NumberHelper
Ссылка: http://book.cakephp.org/3.0/ru/views/helpers/number.html
См.:
Cake\I18n\NumberРасположение: View/Helper/NumberHelper.php
Краткое описание свойств
-
$_defaultConfigprotectedЗначения по умолчанию для этого классаarray - Экземпляр Cake\I18n\LocalizedNumber
$_engineprotected
Наследованные свойства
Краткое описание методов
- __call() publicВызов методов из утилиты Cake\I18n\Number
- __construct() publicКонструктор по умолчанию
- currency() publicФорматирует число в формате валюты.
- defaultCurrency() publicПолучение/установка значения валюты по умолчанию
- format() publicФорматирует число в соответствии с локалью
- formatDelta() publicФорматирует число в соответствии с локалью для отображения разницы (знаковых различий в значении).
- implementedEvents() publicОбработчики событий.
- ordinal() publicФорматирует число в соответствии с порядковым суффиксом локали.
- precision() publicФорматирует число с заданной точностью.
- toPercentage() publicФорматирует число в процентном формате.
- toReadableSize() publicВозвращает размер файла в удобочитаемом формате.
Подробное описание методов
__call()source public
__call( string $method , array $params )
Вызов методов из утилиты Cake\I18n\Number
Параметры
- string
$method - Метод для вызова
- array
$params - Массив параметров для метода.
Возвращает
mixedРезультат вызова метода или false при ошибке
Переопределяет
Cake\View\Helper::__call() __construct()source public
__construct( Cake\View\View $View , array $config [] )
Конструктор по умолчанию
Настройки:
-
engineИмя класса, используемого для замены функциональности Cake\I18n\Number. Класс должен быть размещён в каталогеUtility.
Параметры
-
Cake\View\View$View - Представление, к которому подключается помощник.
- array
$configoptional [] - Настройки помощника
Исключения
Cake\Core\Exception\ExceptionЕсли класс движка не найден.
Переопределяет
Cake\View\Helper::__construct() currency()source public
currency( float $number , string|null $currency null , array $options [] )
Форматирует число в формате валюты.
Параметры
-
locale- Имя локали для форматирования числа, например fr_FR -
fractionSymbol- Символ валюты для дробных чисел. -
fractionPosition- Позиция, в которой должен быть размещён символ дроби, допустимые значения 'перед' и 'после'. -
before- Текст, отображаемый перед отрендеренным числом -
after- Текст, отображаемый после отрендеренного числа -
zero- Текст для отображения нулевых значений, может быть строкой или числом. Например 0, 'Бесплатно!' -
places- Количество знаков после запятой. Например 2 -
precision- Максимальное количество знаков после запятой. Например 2 -
pattern- Шаблон ICU для форматирования числа. Например #,###.00 -
useIntlCode- Заменять ли символ валюты международным кодом валюты. -
escape- Экранировать HTML в результирующей строке
Параметры
- float
$number - Значение для форматирования.
- string|null
$currencyoptional null - Международное наименование валюты, например 'USD', 'EUR', 'JPY', 'CAD'
- array
$optionsoptional [] - Список параметров.
Возвращает
stringЧисло, отформатированное как валюта.
defaultCurrency()source public
defaultCurrency( string|boolean $currency )
Получение/установка значения валюты по умолчанию
Параметры
- string|boolean
$currency Строка валюты по умолчанию, используемая currency(), если аргумент $currency не предоставлен. Если передано boolean false, текущее значение будет очищено.
Возвращает
stringВалюта
format()source public
format( float $number , array $options [] )
Форматирует число в соответствии с локалью
Параметры:
-
places- Минимальное количество знаков после запятой, например 0 -
precision- Максимальное количество знаков после запятой, например 2 -
locale- Имя локали для форматирования числа, например fr_FR -
before- Строка, размещаемая перед целыми числами, например '[' -
after- Строка, размещаемая после дробных чисел, например ']' -
escape- Экранировать ли HTML в результирующей строке
Параметры
- float
$number - Число с плавающей точкой.
- array
$optionsoptional [] - Массив с параметрами.
Возвращает
stringОтформатированное число
Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/number.html#formatting-numbersformatDelta()source public
formatDelta( float $value , array $options [] )
Форматирует число в соответствии с локалью для отображения разницы (знаковых различий в значении).
Параметры
-
places- Минимальное количество знаков после запятой, например 0 -
precision- Максимальное количество знаков после запятой, например 2 -
locale- Имя локали для форматирования числа, например fr_FR -
before- Строка, размещаемая перед целыми числами, например '[' -
after- Строка, размещаемая после дробных чисел, например ']' -
escape- Установить в false, чтобы предотвратить экранирование
Параметры
- float
$value - Число с плавающей точкой
- array
$optionsoptional [] - Список параметров.
Возвращает
stringОтформатированная разница
implementedEvents()source public
implementedEvents( )
Обработчики событий.
Возвращает
arrayПереопределяет
Cake\View\Helper::implementedEvents() ordinal()source public
ordinal( integer|float $value , array $options [] )
Форматирует число с суффиксом порядкового номера, соответствующим локали.
Параметры
- integer|float
$value - Целое число
- array
$optionsнеобязательно [] - Массив с параметрами.
Возвращаемое значение
stringотформатированное число
precision()source public
precision( float $number , integer $precision 3 )
Форматирует число с заданной точностью.
Параметры
- float
$number - Число с плавающей точкой.
- integer
$precisionнеобязательно 3 - Точность возвращаемого числа.
Возвращаемое значение
floatОтформатированное число с плавающей точкой.
См. также
\Cake\I18n\Number::precision()Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/number.html#formatting-floating-point-numberstoPercentage()source public
toPercentage( float $number , integer $precision 2 , array $options [] )
Форматирует число в виде процента.
Параметры:
-
multiply: Умножает входное значение на 100 для десятичных процентов.
Параметры
- float
$number - Число с плавающей точкой
- integer
$precisionнеобязательно 2 - Точность возвращаемого числа
- array
$optionsнеобязательно [] - Параметры
Возвращаемое значение
stringСтрока процента
См. также
\Cake\I18n\Number::toPercentage()Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/number.html#formatting-percentagestoReadableSize()source public
toReadableSize( integer $size )
Возвращает размер файла в удобочитаемом формате.
Параметры
- integer
$size - Размер в байтах
Возвращаемое значение
stringУдобочитаемый размер
См. также
\Cake\I18n\Number::toReadableSize()Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/number.html#interacting-with-human-readable-valuesМетоды, унаследованные от Cake\View\Helper
__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращаемое значение
array__get()source public
__get( string $name )
Лениво загружает помощники.
Параметры
- string
$name - Имя свойства, к которому осуществляется доступ.
Возвращаемое значение
Cake\View\Helper|nullЭкземпляр помощника, если помощник с указанным именем существует
_confirm()source protected
_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )
Возвращает строку, используемую в качестве обработчика onclick для диалоговых окон подтверждения.
Параметры
- string
$message - Сообщение, которое должно быть отображено
- string
$okCode - Код, который будет выполнен после выбора пользователем «ОК»
- string
$cancelCodeнеобязательно '' - Код, который будет выполнен после выбора пользователем «Отмена»
- array
$optionsнеобязательно [] - Массив параметров
Возвращаемое значение
stringJS-код onclick
addClass()source public
addClass( array $options [] , string|null $class null , string $key 'class' )
Добавляет указанный класс к параметрам элемента.
Параметры
- array
$optionsнеобязательно [] - Массив параметров/атрибутов для добавления класса
- string|null
$classнеобязательно null - Имя добавляемого класса.
- string
$keyнеобязательно 'class' - ключ для использования в классе.
Возвращаемое значение
arrayМассив параметров со значением $key.
initialize()source public
initialize( array $config )
Метод хука конструктора.
Реализуйте этот метод, чтобы избежать необходимости перезаписывать конструктор и вызывать родительский.
Параметры
- array
$config - Настройки конфигурации, предоставленные этому помощнику.
Методы, используемые из Cake\Core\InstanceConfigTrait
_configDelete()source protected
_configDelete( string $key )
Удаляет один ключ конфигурации
Параметры
- string
$key - Ключ для удаления.
Исключения
Cake\Core\Exception\Exceptionпри попытке перезаписать существующую конфигурацию
_configRead()source protected
_configRead( string|null $key )
Считывает переменную конфигурации
Параметры
- string|null
$key - Ключ для считывания.
Возвращаемое значение
mixed_configWrite()source protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Записывает переменную конфигурации
Параметры
- string|array
$key - Ключ для записи.
- mixed
$value - Значение для записи.
- boolean|string
$mergeнеобязательно false True для рекурсивного слияния, «shallow» для простого слияния, false для перезаписи, по умолчанию false.
Исключения
Cake\Core\Exception\Exceptionпри попытке перезаписи существующей конфигурации
config()source public
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Использование
Чтение всей конфигурации:
$this->config();
Чтение определенного значения:
$this->config('key'); Чтение вложенного значения:
$this->config('some.nested.key'); Установка определенного значения:
$this->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких параметров конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Параметры
- string|array|null
$keyнеобязательно null - Ключ для получения/установки или полный массив конфигураций.
- mixed|null
$valueнеобязательно null - Значение для установки.
- boolean
$mergeнеобязательно true - Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.
Возвращаемое значение
mixedЗначение конфигурации, которое считывается, или сам объект при операциях записи.
Исключения
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
configShallow()source public
configShallow( string|array $key , mixed|null $value null )
Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которое выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
Установка определенного значения:
$this->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких параметров конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Параметры
- string|array
$key - Ключ для установки или полный массив конфигураций.
- mixed|null
$valueнеобязательно null - Значение для установки.
Возвращаемое значение
$this Объект сам по себе.
Подробности свойств
$_defaultConfigsource
protected массив
Значения конфигурации по умолчанию для данного класса
[
'engine' => 'Cake\I18n\Number'
]
© 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/3.2/class-Cake.View.Helper.NumberHelper.html