Класс Helper
Базовый класс для Helpers.
Консольные Helpers позволяют упаковать переиспользуемые блоки логики вывода в консоль. Например, создание таблиц, полосок прогресса или ASCII-арт.
Краткое описание свойств
- $_config защищенное
array<string, mixed>Конфигурация во время выполнения
- $_configInitialized защищенное
boolУказывает, была ли конфигурация уже настроена с значениями по умолчанию
- $_defaultConfig защищенное
array<string, mixed>Конфигурация по умолчанию для этого помощника.
- $_io защищенное
Cake\Console\ConsoleIoЭкземпляр ConsoleIo.
Краткое описание методов
-
__construct() публичный
Конструктор.
-
_configDelete() защищенное
Удаляет один ключ конфигурации.
-
_configRead() защищенное
Читает ключ конфигурации.
-
_configWrite() защищенное
Записывает ключ конфигурации.
-
configShallow() публичный
Объединяет предоставленную конфигурацию с существующей. В отличие от
config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение. -
getConfig() публичный
Возвращает конфигурацию.
-
getConfigOrFail() публичный
Возвращает конфигурацию для данного ключа.
-
output() абстрактный публичный
Этот метод должен выводить содержимое, используя
$this->_io. -
setConfig() публичный
Устанавливает конфигурацию.
Подробное описание методов
__construct() публичный
__construct(Cake\Console\ConsoleIo $io, array<string, mixed> $config = [])
Конструктор.
Параметры
-
Cake\Console\ConsoleIo$io Экземпляр ConsoleIo для использования.
-
array<string, mixed>$config необязательный Настройки для данного помощника.
_configDelete() защищенное
_configDelete(string $key): void
Удаляет один ключ конфигурации.
Параметры
-
string$key Ключ для удаления.
Возвращает
voidИсключения
Cake\Core\Exception\CakeExceptionпри попытке перезаписать существующую конфигурацию
_configRead() защищенное
_configRead(string|null $key): mixed
Читает ключ конфигурации.
Параметры
-
string|null$key Ключ для чтения.
Возвращает
mixed_configWrite() защищенное
_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при попытке перезаписать существующую конфигурацию
configShallow() публичный
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 необязательный Значение для установки.
Возвращает
$thisgetConfig() публичный
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 необязательный Возвращаемое значение, если ключ не существует.
Возвращает
mixedgetConfigOrFail() публичный
getConfigOrFail(string $key): mixed
Возвращает конфигурацию для данного ключа.
Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.
Параметры
-
string$key Ключ для получения.
Возвращает
mixedИсключения
InvalidArgumentExceptionoutput() абстрактный публичный
output(array $args): void
Этот метод должен выводить содержимое, используя $this->_io.
Параметры
-
array$args Аргументы для помощника.
Возвращает
voidsetConfig() публичный
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При попытке установить неверный ключ.
Подробное описание свойств
$_config защищенное
Конфигурация во время выполнения
Тип
array<string, mixed>$_configInitialized защищенное
Указывает, была ли конфигурация уже настроена с значениями по умолчанию
Тип
bool$_defaultConfig защищенное
Конфигурация по умолчанию для этого помощника.
Тип
array<string, mixed>$_io защищенное
Экземпляр ConsoleIo.
Тип
Cake\Console\ConsoleIo
© 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.Console.Helper.html
