Class ConsoleLog

Ведение журнала в консоль. Записывает логи в вывод консоли.

Пространство имён: Cake\Log\Engine

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

$_config protected

array

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

bool

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

array

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

Cake\Console\ConsoleOutput

Поток вывода

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

__construct() public

Создаёт новый логгер консоли.
_configDelete() protected

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

Считывает значение ключа конфигурации.
_configWrite() protected

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

Форматирует сообщение для записи в журнал.
_getFormattedDate() protected

Возвращает дату, отформатированную в соответствии с заданным форматом опции dateFormat.
alert() public

Необходимо немедленно принять меры.
configShallow() public

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

Критические условия.
debug() public

Подробная отладочная информация.
emergency() public

Система непригодна для использования.
error() public

Ошибки выполнения, которые не требуют немедленных действий, но обычно должны быть записаны в журнал и отслеживаются.
getConfig() public

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

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

Интересные события.
levels() public

Получение уровней, в которых заинтересован этот логгер.
log() public

Реализует запись в консоль.
notice() public

Обычные, но важные события.
scopes() public

Получение областей, в которых заинтересован этот логгер.
setConfig() public

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

Исключительные случаи, которые не являются ошибками.

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

__construct() public

__construct(array $config = [])

Создаёт новый логгер консоли.

Конфигурация

levels строка или массив, уровни, которые интересуют движок
scopes строка или массив, области, которые интересуют движок
stream путь для сохранения логов.
outputAs целое число или ConsoleOutput::[RAW|PLAIN|COLOR]
dateFormat формат PHP date().

Параметры

array $config optional: Параметры для FileLog, см. выше.

Исключения

InvalidArgumentException

_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(string|array $key, mixed $value, bool|string $merge = false): void

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

Параметры

string|array $key: Ключ для записи.
mixed $value: Значение для записи.
bool|string $merge optional: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

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

void

Исключения

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

_format() protected

_format(string $message, array $context = []): string

Форматирует сообщение для логирования.

Контекст может опционально использоваться лог-движками для интерполяции переменных или добавления дополнительной информации к логгируемому сообщению.

Параметры

string $message: Сообщение для форматирования.
array $context optional: Дополнительная информация для сообщения.

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

string

_getFormattedDate() protected

_getFormattedDate(): string

Возвращает дату, отформатированную согласно заданному формату параметра dateFormat .

Эта функция влияет на FileLog или ConsoleLog формат информации о дате и времени.

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

string

alert() public

alert(string $message, mixed[] $context = array()): void

Необходимо немедленное действие.

Пример: Веб-сайт полностью недоступен, база данных недоступна и т.д. Это должно вызвать SMS-оповещения и разбудить вас.

Параметры

string $message
mixed[] $context optional

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

void

configShallow() public

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

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

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

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

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

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

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

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

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.

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

$this

critical() public

critical(string $message, mixed[] $context = array()): void

Критические условия.

Пример: Компонент приложения недоступен, неожиданное исключение.

Параметры

string $message
mixed[] $context optional

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

void

debug() public

debug(string $message, mixed[] $context = array()): void

Подробная информация об отладке.

Параметры

string $message
mixed[] $context optional

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

void

emergency() public

emergency(string $message, mixed[] $context = array()): void

Система неработоспособна.

Параметры

string $message
mixed[] $context optional

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

void

error() public

error(string $message, mixed[] $context = array()): void

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

Параметры

string $message
mixed[] $context optional

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

void

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 optional: Ключ для получения или null для всей конфигурации.
mixed $default optional: Возвращаемое значение, когда ключ не существует.

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

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

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

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

Параметры

string $key: Ключ для получения.

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

mixed

Исключения

InvalidArgumentException

info() public

info(string $message, mixed[] $context = array()): void

Интересные события.

Пример: Пользователь вошёл в систему, логи SQL.

Параметры

string $message
mixed[] $context optional

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

void

levels() public

levels(): array

Получает уровни, которые интересуют этот логгер.

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

array

log() public

log(mixed $level, string $message, mixed[] $context = []): void

Реализует запись в консоль.

Параметры

mixed $level: Уровень серьезности лога, который вы создаёте.
string $message: Сообщение, которое вы хотите залогировать.
mixed[] $context optional: Дополнительная информация о залогированном сообщении

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

void

См. также

Cake\Log\Log::$_levels

notice() public

notice(string $message, mixed[] $context = array()): void

Обычные, но значимые события.

Параметры

string $message
mixed[] $context optional

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

void

scopes() public

scopes(): array|false

Получить области, в которых заинтересован этот логгер.

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

array|false

setConfig() public

setConfig(string|array $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']);

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value необязательно: Значение для установки.
bool $merge необязательно: Выполнять рекурсивное объединение или перезаписывать существующую конфигурацию, по умолчанию true.

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

$this

Исключения

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

warning() public

warning(string $message, mixed[] $context = array()): void

Исключительные случаи, которые не являются ошибками.

Пример: использование устаревших API, ненадлежащее использование API, нежелательные действия, которые не обязательно являются ошибками.

Параметры

string $message
mixed[] $context необязательно

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

void

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

`$_config` защищенное

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

Тип

array

`$_configInitialized` защищенное

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

Тип

bool

`$_defaultConfig` защищенное

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

Тип

array

`$_output` защищенное

Поток вывода

Тип

Cake\Console\ConsoleOutput

© 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.2/class-Cake.Log.Engine.ConsoleLog.html