Класс NumberHelper

__call()source public

__call( string $method , array $params )

Вызов методов из утилиты Cake\I18n\Number

Параметры

строка $method

Метод для вызова

массив $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

Представление, к которому прикреплён помощник.

массив $config опционально []

Параметры конфигурации помощника

Исключения

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'.
• before - Текст, который должен быть показан перед отформатированным числом
• after - Текст, который должен быть показан после отформатированного числа
• zero - Текст для отображения нулевых значений, может быть строкой или числом, например, 0, 'Бесплатно!'
• places - Количество десятичных знаков. Например, 2
• precision - Максимальное количество десятичных знаков. Например, 2
• pattern - Шаблон ICU для форматирования числа, например #,###.00
• useIntlCode - Заменять ли символ валюты на международный код валюты.
• escape - Экранировать ли HTML в результирующей строке

Параметры

число с плавающей запятой $number

Значение для форматирования.

строка|null $currency опционально null

Международное название валюты, например 'USD', 'EUR', 'JPY', 'CAD'

массив $options опционально []

Список опций.

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

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

defaultCurrency()source public

defaultCurrency( string|boolean $currency )

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

Параметры

строка|логическое $currency

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

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

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

format()source public

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

Форматирует число в соответствии с локальными настройками

Опции:

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

Параметры

число с плавающей запятой $number

Число с плавающей запятой.

массив $options опционально []

Массив с опциями.

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

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

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/number.html#formatting-numbers

formatDelta()source public

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

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

Опции

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

Параметры

число с плавающей запятой $value

Число с плавающей запятой

массив $options опционально []

Список опций.

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

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

implementedEvents()source public

implementedEvents( )

Обработчики событий.

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

массив

Переопределяет

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

Точность возвращаемого числа.

Возвращает

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

См. также

\Cake\I18n\Number::precision()

Ссылка

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

toPercentage()source public

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

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

Параметры:

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

Параметры

float $number

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

integer $precision необязательно 2

Точность возвращаемого числа

array $options необязательно []

Параметры

Возвращает

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

См. также

\Cake\I18n\Number::toPercentage()

Ссылка

https://book.cakephp.org/3.0/ru/views/helpers/number.html#formatting-percentages

toReadableSize()source public

toReadableSize( integer $size )

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

Параметры

integer $size

Размер в байтах

Возвращает

string
Человекопонятный размер

См. также

\Cake\I18n\Number::toReadableSize()

Ссылка

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

__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 необязательно []

Массив параметров

Возвращает

string
JS код onclick

addClass()source public

addClass( array $options = [] , string|null $class = null , string $key = 'class' )

Добавляет указанный класс к параметрам элемента.

Параметры

array $options необязательно []

Массив параметров/атрибутов, к которому нужно добавить класс

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

Имя добавляемого класса.

string $key необязательно 'class'

Ключ для использования класса.

Возвращает

array
Массив параметров с установленным ключом.

getView()source public

getView( )

Получить экземпляр представления, к которому привязан этот помощник.

Возвращает

Cake\View\View
Экземпляр привязанного представления.

initialize()source public

initialize( array $config )

Метод обработки конструктора.

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

Параметры

array $config

Параметры конфигурации, предоставленные этому помощнику.

_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

Истина для рекурсивного слияния, «shallow» для простого слияния, ложь для перезаписи, по умолчанию ложь.

Исключения

Cake\Core\Exception\Exception
при попытке перезаписать существующую конфигурацию

config()source public deprecated

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']);

Устарело

3.4.0 использовать setConfig()/getConfig() вместо этого.

Параметры

string|array|null $key необязательно null

Ключ для получения/установки или весь массив конфигураций.

mixed|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Рекурсивное слияние или перезапись существующей конфигурации, по умолчанию — истина.

Возвращает

mixed
Значение конфигурации, которое читается или сам объект при операциях записи.

Исключения

Cake\Core\Exception\Exception
При попытке установить недействительный ключ.

configShallow()source public

configShallow( string|array $key , mixed|null $value = null )

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

Установка конкретного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

Ключ для установки или полный массив настроек.

mixed|null $value необязательно null

Значение для установки.

Возвращает

$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

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

Ключ для получения или null для всей конфигурации.

mixed $default необязательно null

Возвращаемое значение, когда ключ не существует.

Возвращает

mixed
Значение считываемой конфигурации.

setConfig()source public

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

Устанавливает конфигурацию.

Использование

Установка конкретного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

Ключ для установки или полный массив настроек.

mixed|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

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

Возвращает

$this

Возбуждает

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

[
    'engine' => 'Cake\I18n\Number'
]