Класс QueryLogger

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

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

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

$_config protected

array<string, mixed>

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

bool

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

array<string, mixed>

Конфигурация по умолчанию для этого класса
$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 = [])

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

Parameters

array<string, mixed> $config optional: Массив конфигурации

_configDelete() protected

_configDelete(string $key): void

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

Parameters

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

Returns

void

Throws

Cake\Core\Exception\CakeException
if attempting to clobber existing config

_configRead() protected

_configRead(string|null $key): mixed

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

Parameters

string|null $key: Ключ для чтения.

Returns

mixed

_configWrite() protected

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

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

Parameters

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

Returns

void

Throws

Cake\Core\Exception\CakeException
if attempting to clobber existing config

_format() protected

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

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

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

Parameters

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

Returns

string

alert() public

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

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

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

Parameters

string $message
mixed[] $context optional

Returns

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']);

Parameters

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

Returns

$this

critical() public

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

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

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

Parameters

string $message
mixed[] $context optional

Returns

void

debug() public

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

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

Parameters

string $message
mixed[] $context optional

Returns

void

emergency() public

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

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

Parameters

string $message
mixed[] $context optional

Returns

void

error() public

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

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

Parameters

string $message
mixed[] $context optional

Returns

void

getConfig() public

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

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

Usage

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

$this->getConfig();

Чтение конкретного значения:

$this->getConfig('key');

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

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

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

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

Parameters

string|null $key optional: Ключ для получения или null для всей конфигурации.
mixed $default optional: Возвращаемое значение, когда ключ не существует.

Returns

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

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

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

Parameters

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

Returns

mixed

Throws

InvalidArgumentException

info() public

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

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

Пример: Пользователь вошел в систему, журналы SQL.

Parameters

string $message
mixed[] $context optional

Returns

void

interpolate() protected

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

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

Parameters

string $message: Отформатированная строка
array $context optional: Контекст для значений заполнителей.

Returns

string

levels() public

levels(): array<string>

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

Returns

array<string>

log() public

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

Регистрирует с произвольным уровнем.

Parameters

mixed $level
string $message
mixed[] $context optional

Returns

void

notice() public

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

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

Parameters

string $message
mixed[] $context optional

Returns

void

scopes() public

scopes(): array<string>|false

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

Returns

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 optional: Значение для установки.
bool $merge optional: Флаг для рекурсивного слияния или перезаписи существующей конфигурации, по умолчанию true.

Возвращает

$this

Исключения

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

warning() public

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

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

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

Параметры

string $message
mixed[] $context optional

Возвращает

void

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

`$_config` protected

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

Тип

array<string, mixed>

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

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

Тип

array<string, mixed>

`$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.Database.Log.QueryLogger.html

Класс QueryLogger

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

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

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

_format() protected deprecated

alert() public

configShallow() public

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

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

__construct() public

Parameters

_configDelete() protected

Parameters

Returns

Throws

_configRead() protected

Parameters

Returns

_configWrite() protected

Parameters

Returns

Throws

_format() protected

Parameters

Returns

alert() public

Parameters

Returns

configShallow() public

Parameters

Returns

critical() public

Parameters

Returns

debug() public

Parameters

Returns

emergency() public

Parameters

Returns

error() public

Parameters

Returns

getConfig() public

Usage

Parameters

Returns

getConfigOrFail() public

Parameters

Returns

Throws

info() public

Parameters

Returns

interpolate() protected

Parameters

Returns

levels() public

Returns

log() public

Parameters

Returns

notice() public

Parameters

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected

`$formatter` protected