Класс QueryLogger

Этот класс служит мостом для записи объектов LoggedQuery в реальный журнал. По умолчанию этот класс использует встроенный класс CakePHP Log для этого.

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

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

$_config protected

array

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

bool

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

array

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

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

__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 = [])

Конструктор.

Параметры

array $config optional: Массив конфигурации

_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

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` protected

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

Тип

array

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` 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.2/class-Cake.Database.Log.QueryLogger.html