Класс NumberHelper

__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 $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 для форматирования числа. Например #,##0.00
• useIntlCode - Заменять ли символ валюты международным кодом валюты.
• escape - Экранировать HTML в результирующей строке или нет

Параметры

float $number

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

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

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

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

Список параметров.

Возвращает

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

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

Возвращает

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

Ссылка

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, чтобы предотвратить экранирование

Параметры

float $value

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

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

Список параметров.

Возвращает

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

implementedEvents()source public

implementedEvents( )

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

Возвращает

array

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

Cake\View\Helper::implementedEvents()

ordinal()source public

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

Форматирует число в соответствии с порядковым суффиксом, специфичным для локали.

Параметры

целое число|вещественное число $value

Целое число

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

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

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

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

precision()source public

precision( float $number , integer $precision = 3 )

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

Параметры

вещественное число $number

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

целое число $precision необязательно 3

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

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

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

См. также

\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 для десятичных процентов.

Параметры

вещественное число $number

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

целое число $precision необязательно 2

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

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

Параметры

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

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

См. также

\Cake\I18n\Number::toPercentage()

Ссылка

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

toReadableSize()source public

toReadableSize( integer $size )

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

Параметры

целое число $size

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

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

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

См. также

\Cake\I18n\Number::toReadableSize()

Ссылка

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

__debugInfo()source public

__debugInfo( )

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

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

массив

__get()source public

__get( string $name )

Ленизагружает помощники.

Параметры

строка $name

Имя свойства, к которому осуществляется доступ.

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

Cake\View\Helper|null
Экземпляр помощника, если помощник с указанным именем существует

__set()source public

__set( string $name , mixed $value )

Магический установщик для удаленных свойств.

Параметры

строка $name

Имя свойства.

смешанный $value

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

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

Возвращает строку, предназначенную для использования в confirm()

Параметры

строка $message

Сообщение для очистки

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

смешанный

_confirm()source protected

_confirm( string $message , string $okCode , string $cancelCode = '' , array $options = [] )

Возвращает строку, предназначенную для использования в качестве обработчика onclick для диалогов подтверждения.

Параметры

строка $message

Сообщение, которое должно быть отображено

строка $okCode

Код, который должен быть выполнен после выбора пользователем «ОК»

строка $cancelCode необязательно ''

Код, который должен быть выполнен после выбора пользователем «Отмена»

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

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

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

строка
JS-код onclick

addClass()source public

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

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

Параметры

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

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

строка|null $class необязательно null

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

строка $key необязательно 'class'

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

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

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

getView()source public

getView( )

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

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

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

initialize()source public

initialize( array $config )

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

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

Параметры

массив $config

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

_configDelete()source protected

_configDelete( string $key )

Удаляет отдельный ключ конфигурации.

Параметры

строка $key

Ключ для удаления.

Исключения

Cake\Core\Exception\Exception
при попытке переопределения существующей конфигурации

_configRead()source protected

_configRead( string|null $key )

Считывает ключ конфигурации.

Параметры

строка|null $key

Ключ для чтения.

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

смешанный

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Записывает ключ конфигурации.

Параметры

строка|массив $key

Ключ для записи.

смешанный $value

Значение для записи.

булево|строка $merge необязательно false

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

Исключения

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

Устаревшее

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

Параметры

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