Класс 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 для форматирования числа. Например, #,###.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 необязательно []

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

Возвращает

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

Ссылка

http://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

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

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

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

См. также

\Cake\I18n\Number::precision()

Ссылка

http://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()

Ссылка

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

toReadableSize()source public

toReadableSize( integer $size )

Возвращает размер файла в удобочитаемом формате.

Параметры

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

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

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

строка
Удобный для восприятия размер

См. также

\Cake\I18n\Number::toReadableSize()

Ссылка

http://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
Экземпляр помощника, если помощник с заданным именем существует

_confirm()source protected

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

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

Параметры

строка $message

Сообщение, которое будет отображено

строка $okCode

Код, который будет выполнен после выбора пользователем 'OK'

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

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

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

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

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

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

addClass()source public

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

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

Параметры

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

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

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

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

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

Ключ, который нужно использовать для класса.

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

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

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

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

Параметры

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

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

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

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

логическое значение $merge необязательно true

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

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

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

Исключения

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

Параметры

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

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

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

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

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

$this Объект самого себя.

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

null