Spec-Zone.ru › CakePHP 4.3

Класс ConsoleLog

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

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

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

  • $_config protected
    array<string, mixed>

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

  • $_configInitialized protected
    bool

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

  • $_defaultConfig protected
    array<string, mixed>

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

  • $_output protected
    Cake\Console\ConsoleOutput

    Поток вывода

  • $formatter protected
    Cake\Log\Formatter\AbstractFormatter

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

  • __construct() public

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

  • _configDelete() protected

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

  • _configRead() protected

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

  • _configWrite() protected

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

  • _format() protected deprecated

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

  • alert() public

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

  • configShallow() public

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

  • critical() public

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

  • debug() public

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

  • emergency() public

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

  • error() public

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

  • getConfig() public

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

  • getConfigOrFail() public

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

  • info() public

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

  • interpolate() protected

    Заменяет заполнитель в строке сообщения значениями контекста.

  • levels() public

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

  • log() public

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

  • notice() public

    Нормальные, но важные события.

  • scopes() public

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

  • setConfig() public

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

  • warning() public

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

END_OF_DOCUMENT_MARKER

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

__construct() public 

__construct(array<string, mixed> $config = [])

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

Настройка

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

Параметры

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

Параметры для 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(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
при попытке перезаписи существующей конфигурации

_format() protected 

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

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

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

Параметры

string $message

Сообщения для форматирования.

array $context необязательно

Дополнительная информация для сообщения.

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

string

alert() public 

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

Немедленные действия обязательны.

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

Параметры

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

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

void

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

critical() public 

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

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

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

Параметры

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

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

void

debug() public 

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

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

Параметры

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

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

void

emergency() public 

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

Система непригодна к использованию.

Параметры

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

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

void

error() public 

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

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

Параметры

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

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

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 необязательно

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

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

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

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

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 необязательно

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

void

interpolate() protected 

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

Заменяет плейсхолдеры в строке сообщения значениями контекста.

Параметры

string $message

Отформатированная строка

array $context необязательно

Контекст для значений плейсхолдеров.

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

string

levels() public 

levels(): array<string>

Получить уровни, интересующие этот логгер.

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

array<string>

log() public 

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

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

Параметры

mixed $level

Уровень критичности лога.

string $message

Сообщение, которое нужно записать в лог.

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

Дополнительная информация о записанном сообщении

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

void

См. также

\Cake\Log\Log::$_levels

notice() public 

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

Нормальные, но важные события.

Параметры

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

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

void

scopes() public 

scopes(): array<string>|false

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

Возвращает

array<string>|false

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
При попытке установить некорректный ключ.

warning() public 

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

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

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

Параметры

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

Возвращает

void

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

$_config protected

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

Тип

array<string, mixed>

$_configInitialized protected

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

Тип

bool

$_defaultConfig protected

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

Тип

array<string, mixed>

$_output protected

Поток вывода

Тип

Cake\Console\ConsoleOutput

$formatter protected

Тип

Cake\Log\Formatter\AbstractFormatter

© 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.Log.Engine.ConsoleLog.html

Spec-Zone.ru

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