Класс NumberHelper
Библиотека для работы с числами.
Методы для улучшения читаемости чисел.
- Cake\View\Helper implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
-
Cake\View\Helper\NumberHelper
См.:
Cake\I18n\NumberСсылка: http://book.cakephp.org/3.0/ru/views/helpers/number.html
Расположение: View/Helper/NumberHelper.php
Подробное описание методов
__callsource public
__call( string $method , array $params )
Вызов методов из класса утилиты Cake\I18n\Number
Параметры
- string
$method - Метод для вызова
- array
$params - Массив параметров для метода.
Возвращает
mixedРезультат вызываемого метода или false при ошибке
Переопределяет
Cake\View\Helper::__call() __constructsource public
__construct( Cake\View\View $View , array $config [] )
Конструктор по умолчанию
Настройки:
-
engineИмя класса для замены функциональности Cake\I18n\Number. Класс должен быть размещён в каталогеUtility.
Параметры
-
Cake\View\View$View - Представление, к которому прикреплён данный помощник.
- array
$configнеобязательно [] - Настройки помощника
Выбрасывает
Cake\Core\Exception\ExceptionЕсли класс движка не найден.
Переопределяет
Cake\View\Helper::__construct() currencysource public
currency( float $number , string $currency null , array $options [] )
Форматирует число в формате валюты.
Параметры
-
locale- Имя локали для форматирования числа, например fr_FR -
fractionSymbol- Символ валюты для дробных чисел. -
fractionPosition- Позиция символа дроби, допустимые значения 'before' и 'after'. -
before- Текст перед отрендеренным числом -
after- Текст после отрендеренного числа -
zero- Текст для нулевых значений, может быть строкой или числом. Например, 0, 'Бесплатно!' -
places- Количество десятичных знаков. Например, 2 -
precision- Максимальное количество десятичных знаков. Например, 2 -
pattern- Шаблон ICU для форматирования числа. Например, #,###.00 -
useIntlCode- Заменять ли символ валюты международным кодом валюты. -
escape- Экранировать ли HTML в результирующей строке
Параметры
- float
$number - Значение для форматирования.
- string
$currencyнеобязательно null - Международное название валюты, например 'USD', 'EUR', 'JPY', 'CAD'
- array
$optionsнеобязательно [] - Список параметров.
Возвращает
stringЧисло, отформатированное как валюта.
defaultCurrencysource public
defaultCurrency( string|boolean $currency )
Получение/установка значения по умолчанию для валюты
Параметры
- string|boolean
$currency - Строка валюты по умолчанию, которая будет использоваться в методе currency(), если параметр $currency не указан. Если передано значение false, текущее сохранённое значение будет очищено.
Возвращает
stringВалюта
formatsource public
format( float $number , array $options [] )
Форматирует число в соответствии с правилом локализации
Параметры:
-
places- Минимальное количество десятичных знаков, например 0 -
precision- Максимальное количество десятичных знаков, например 2 -
locale- Имя локали для форматирования числа, например fr_FR -
before- Строка, размещаемая перед целыми числами, например '[' -
after- Строка, размещаемая после десятичных чисел, например ']' -
escape- Экранировать ли HTML в результирующей строке
Параметры
- float
$number - Число с плавающей запятой.
- array
$optionsнеобязательно [] - Массив с параметрами.
Возвращает
stringОтформатированное число
Ссылка
http://book.cakephp.org/3.0/ru/views/helpers/number.html#formatting-numbersformatDeltasource public
formatDelta( float $value , array $options [] )
Форматирует число в соответствии с правилом локализации для отображения разниц (знаковых разниц в значении).
Параметры
-
places- Минимальное количество десятичных знаков, например 0 -
precision- Максимальное количество десятичных знаков, например 2 -
locale- Имя локали для форматирования числа, например fr_FR -
before- Строка, размещаемая перед целыми числами, например '[' -
after- Строка, размещаемая после десятичных чисел, например ']' -
escape- Установить в false, чтобы предотвратить экранирование
Параметры
- float
$value - Число с плавающей запятой
- array
$optionsнеобязательно [] - Список параметров.
Возвращает
stringОтформатированная разница
implementedEventssource public
implementedEvents( )
Обработчики событий.
Возвращает
arrayМассив
Переопределяет
Cake\View\Helper::implementedEvents() ordinalsource public
ordinal( integer|float $value , array $options [] )
Форматирует число в соответствии с порядковым суффиксом локали.
Параметры
- integer|float
$value - Целое число
- array
$optionsнеобязательно [] - Массив с параметрами.
Возвращает
stringОтформатированное число
precisionsource 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-numberstoPercentagesource 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-percentagestoReadableSizesource public
toReadableSize( integer $size )
Возвращает размер файла в формате, понятном человеку.
Параметры
- целое число
$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
__debugInfosource public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
arrayмассив
__getsource public
__get( string $name )
Лениво загружает помощники.
Параметры
- строка
$name - Имя свойства, к которому осуществляется доступ.
Возвращает
Cake\View\Helper|nullЭкземпляр помощника, если помощник с указанным именем существует
_confirmsource protected
_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )
Возвращает строку, которая будет использоваться в качестве обработчика onclick для диалоговых окон подтверждения.
Параметры
- строка
$message - Сообщение, которое будет отображено
- строка
$okCode - Код, который будет выполнен после того, как пользователь выбрал «ОК»
- строка
$cancelCodeнеобязательно '' - Код, который будет выполнен после того, как пользователь выбрал «Отмена»
- массив
$optionsнеобязательно [] - Массив опций
Возвращает
stringJS-код onclick
addClasssource public
addClass( array $options [] , string $class null , string $key 'class' )
Добавляет заданный класс к параметрам элемента.
Параметры
- массив
$optionsнеобязательно [] - Массив опций/атрибутов, к которому нужно добавить класс
- строка
$classнеобязательно null - Имя добавляемого класса.
- строка
$keyнеобязательно 'class' - Ключ, используемый для класса.
Возвращает
arrayМассив опций с установленным ключом.
Методы, используемые из Cake\Core\InstanceConfigTrait
_configDeletesource protected
_configDelete( string $key )
Удаление одного ключа конфигурации.
Параметры
- строка
$key - Ключ для удаления.
Исключения
Cake\Core\Exception\Exceptionесли попытка перезаписать существующую конфигурацию
_configReadsource protected
_configRead( string|null $key )
Чтение переменной конфигурации.
Параметры
- строка|null
$key - Ключ для чтения.
Возвращает
mixedсмешанный тип
_configWritesource protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Запись переменной конфигурации.
Параметры
- строка|массив
$key - Ключ для записи.
- смешанный тип
$value - Значение для записи.
- boolean|строка
$mergeнеобязательно false - True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.
Исключения
Cake\Core\Exception\Exceptionесли попытка перезаписи существующей конфигурации
configsource 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']);
Параметры
- строка|массив|null
$keyнеобязательно null - Ключ для получения/установки или весь массив конфигураций.
- смешанный тип|null
$valueнеобязательно null - Значение для установки.
- boolean
$mergeнеобязательно true - Выполнять ли рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.
Возвращает
mixedЗначение конфигурации, которое читается, или сам объект при операциях записи.
Исключения
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
configShallowsource 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']);
Параметры
- строка|массив
$key - Ключ для установки или весь массив конфигураций.
- смешанный тип|null
$valueнеобязательно null - Значение для установки.
Возвращает
mixedСам объект.
Сводка свойств
Свойства, унаследованные от Cake\View\Helper
$_helperMapsource
protected array
Таблица поиска помощников, используемая для ленивой загрузки объектов помощников.
[]
$fieldsetsource
public array
Содержит поля ['имя_поля' => ['тип' => 'строка', 'длина' => 100]], первичный ключ и валидацию ['имя_поля']
[]
Свойства, используемые из Cake\Core\InstanceConfigTrait
$_configInitializedsource
protected boolean
Указывает, была ли конфигурация уже настроена значениями по умолчанию
false
© 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.1/class-Cake.View.Helper.NumberHelper.html