Spec-Zone.ru › CakePHP 4.3

Класс NumberHelper

Библиотека для работы с числами.

Методы для повышения читаемости чисел.

Пространство имен: Cake\View\Helper
См.: \Cake\I18n\Number
Ссылка: https://book.cakephp.org/4/ru/views/helpers/number.html

Краткое описание свойств

  • $_View protected
    Cake\View\View

    Экземпляр View, к которому прикреплён этот помощник

  • $_config protected
    array<string, mixed>

    Конфигурация выполнения

  • $_configInitialized protected
    bool

    Указывает, была ли конфигурация уже настроена по умолчанию

  • $_defaultConfig protected
    array<string, mixed>

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

  • $_engine protected
    Cake\I18n\Number

    Экземпляр Cake\I18n\Number

  • $_helperMap protected
    array<string, array>

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

  • $helpers protected
    array

    Список помощников, используемых этим помощником

Краткое описание методов

  • __call() public

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

  • __construct() public

    Конструктор по умолчанию

  • __debugInfo() public

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

  • __get() public

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

  • _configDelete() protected

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

  • _configRead() protected

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

  • _configWrite() protected

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

  • _confirm() protected

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

  • addClass() public

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

  • configShallow() public

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

  • currency() public

    Форматирует число в формате валюты.

  • defaultCurrency() public deprecated

    Геттер/сеттер для валюты по умолчанию

  • format() public

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

  • formatDelta() public

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

  • getConfig() public

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

  • getConfigOrFail() public

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

  • getView() public

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

  • implementedEvents() public

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

  • initialize() public

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

  • ordinal() public

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

  • precision() public

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

  • setConfig() public

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

  • toPercentage() public

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

  • toReadableSize() public

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

END_OF_DOCUMENT_MARKER

Подробное описание методов

__call() public 

__call(string $method, array $params): mixed

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

Параметры

string $method

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

array $params

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

Возвращает

mixed

__construct() public 

__construct(Cake\View\View $view, array<string, mixed> $config = [])

Конструктор по умолчанию

Настройки:

  • engine Имя класса для замены функциональности Cake\I18n\Number. Класс должен быть размещён в каталоге Utility.

Параметры

Cake\View\View $view

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

array<string, mixed> $config необязательно

Настройки помощника

Выбрасывает

Cake\Core\Exception\CakeException
При невозможности найти класс движка.

__debugInfo() public 

__debugInfo(): array<string, mixed>

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

Возвращает

array<string, mixed>

__get() public 

__get(string $name): Cake\View\Helper|null|void

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

Параметры

string $name

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

Возвращает

Cake\View\Helper|null|void

_configDelete() protected 

_configDelete(string $key): void

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

Параметры

string $key

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

Возвращает

void

Выбрасывает

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

_configRead() protected 

_configRead(string|null $key): mixed

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

Параметры

string|null $key

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

Возвращает

mixed

_configWrite() protected 

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

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

Параметры

array<string, mixed>|string $key

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

mixed $value

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

string|bool $merge необязательно

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

Возвращает

void

Выбрасывает

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

_confirm() protected 

_confirm(string $okCode, string $cancelCode): string

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

Параметры

string $okCode

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

string $cancelCode

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

Возвращает

string

addClass() public 

addClass(array<string, mixed> $options, string $class, string $key = 'class'): array<string, mixed>

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

Параметры

array<string, mixed> $options

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

string $class

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

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

ключ для использования для класса. По умолчанию 'class'.

Возвращает

array<string, mixed>

configShallow() public 

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

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

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

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

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

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

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

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

Параметры

array<string, mixed>|string $key

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

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

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

Возвращает

$this

currency() public 

currency(string|float $number, string|null $currency = null, array<string, mixed> $options = []): string

Форматирует число в формате валюты.

Опции

  • locale - Имя локали для форматирования числа, например, fr_FR
  • fractionSymbol - Символ валюты для дробных чисел.
  • fractionPosition - Положение, в котором должен быть размещен символ дроби, допустимые значения 'before' & 'after'.
  • before - Текст, отображаемый перед отрендеренным числом
  • after - Текст, отображаемый после отрендеренного числа
  • zero - Текст для отображения нулевых значений, может быть строкой или числом. Например, 0, 'Бесплатно!'
  • places - Количество десятичных знаков. Например, 2
  • precision - Максимальное количество десятичных знаков. Например, 2
  • pattern - Шаблон ICU для форматирования числа. Например, #,##0.00
  • useIntlCode - Заменять ли символ валюты международным кодом валюты.
  • escape - Экранировать ли html в результирующей строке

Параметры

string|float $number

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

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

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

array<string, mixed> $options необязательно

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

Возвращает

string

defaultCurrency() public 

defaultCurrency(string|false|null $currency): string|null

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

Параметры

string|false|null $currency

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

Возвращает

string|null

format() public 

format(string|int|float $number, array<string, mixed> $options = []): string

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

Опции:

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

Параметры

string|int|float $number

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

array<string, mixed> $options необязательно

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

Возвращает

string

Ссылки

https://book.cakephp.org/4/en/views/helpers/number.html#formatting-numbers

formatDelta() public 

formatDelta(string|float $value, array<string, mixed> $options = []): string

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

Опции

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

Параметры

string|float $value

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

array<string, mixed> $options необязательно

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

Возвращает

string

getConfig() public 

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

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

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

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

$this->getConfig();

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

$this->getConfig('key');

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

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

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

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

Параметры

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

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

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

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

Возвращает

mixed

getConfigOrFail() public 

getConfigOrFail(string $key): mixed

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

Значение конфигурации для данного ключа должно существовать, оно никогда не может быть null.

Параметры

string $key

Ключ для получения.

Возвращает

mixed

Исключение

InvalidArgumentException

getView() public 

getView(): Cake\View\View

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

Возвращает

Cake\View\View

implementedEvents() public 

implementedEvents(): array<string, mixed>

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

Определяя один из методов обратного вызова, предполагается, что помощник заинтересован в соответствующем событии.

Переопределите этот метод, если вам нужно добавить нестандартных обработчиков событий. Или если вы хотите, чтобы помощники слушали нестандартные события.

Возвращает

array<string, mixed>

initialize() public 

initialize(array<string, mixed> $config): void

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

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

Параметры

array<string, mixed> $config

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

Возвращает

void

ordinal() public 

ordinal(float|int $value, array<string, mixed> $options = []): string

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

Параметры

float|int $value

Целое число

array<string, mixed> $options необязательно

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

Возвращает

string

precision() public 

precision(string|float $number, int $precision = 3, array<string, mixed> $options = []): string

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

Параметры

string|float $number

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

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

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

array<string, mixed> $options необязательно

Дополнительные опции.

Возвращает

string

См. также

\Cake\I18n\Number::precision()

Ссылки

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

setConfig() public 

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

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

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

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

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

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

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

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

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

Параметры

array<string, mixed>|string $key

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

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

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

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

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

Возвращает

$this

Исключение

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

toPercentage() public 

toPercentage(string|float $number, int $precision = 2, array<string, mixed> $options = []): string

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

Опции:

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

Параметры

string|float $number

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

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

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

array<string, mixed> $options необязательно

Опции

Возвращает

string

См. также

\Cake\I18n\Number::toPercentage()

Ссылки

https://book.cakephp.org/4/en/views/helpers/number.html#formatting-percentages

toReadableSize() public 

toReadableSize(string|int $size): string

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

Параметры

string|int $size

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

Возвращает

string

См. также

\Cake\I18n\Number::toReadableSize()

Ссылки

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

Подробное описание свойств

$_View protected

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

Тип

Cake\View\View

$_config protected

Конфигурация во время выполнения

Тип

array<string, mixed>

$_configInitialized protected

Установлено ли свойство config с значениями по умолчанию

Тип

bool

$_defaultConfig protected

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

Тип

array<string, mixed>

$_engine protected

Экземпляр Cake\I18n\Number

Тип

Cake\I18n\Number

$_helperMap protected

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

Тип

array<string, array>

$helpers protected

Список помощников, используемых этим помощником

Тип

array

© 2005–present 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.
https://api.cakephp.org/4.3/class-Cake.View.Helper.NumberHelper.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API