Класс NumberHelper

__call()source public

__call( string $method , array $params )

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

Параметры

строка $method

Вызываемый метод

массив $params

Массив параметров для метода.

Возвращает

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

Параметры

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

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

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

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

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

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

Возвращает

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

defaultCurrency()source public

defaultCurrency( string|boolean $currency )

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

Параметры

строка|boolean $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 = [] )

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

Параметры

целое число|число с плавающей точкой $value

Целое число

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

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

Возвращает

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

precision()source public

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

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

Параметры

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

Параметры

float $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'

Ключ, используемый для класса.

Возвращает

массив
Массив параметров со свойством $key.

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

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

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

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Выбрасывает

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() вместо этого.

Параметры

строка|массив|null $key необязательно null

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

смешанный|null $value необязательно null

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

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

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

Возвращает

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

Выбрасывает

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
Данные конфигурации по указанному ключу или null, если ключ не существует.

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