Класс Log

Log::setConfig('my_log', ['className' => 'FileLog']);

Log::setConfig('default', [
    'className' => 'File',
    'path' => LOGS,
    'levels' => ['error', 'critical', 'alert', 'emergency']
]);

Log::setConfig('payments', [
    'className' => 'File',
    'scopes' => ['payment', 'order']
]);

Log::error('Something horrible happened');
Log::write(LOG_ERR, 'Something horrible happened');

_init()source protected static

_init( )

Инициализирует реестр и конфигурации

_loadConfig()source protected static

_loadConfig( )

Загружает определённую конфигурацию и создаёт все определённые адаптеры логирования.

alert()source public static

alert( string $message , string|array $context = [] )

Метод для удобного логирования сообщений об опасности

Параметры

строка $message

сообщение журнала

строка|массив $context необязательно []

Дополнительные данные, используемые для записи сообщения в журнал. Специальный ключ scope можно передать для дальнейшего фильтрации движков логов, которые будут использоваться. Если передаётся строка или массив с числовыми индексами, он будет интерпретироваться как ключ scope. См. Cake\Log\Log::setConfig() для получения дополнительной информации о областях логирования.

Возвращает

boolean
Успех

critical()source public static

critical( string $message , string|array $context = [] )

Метод для удобного логирования критических сообщений

Параметры

строка $message

сообщение журнала

строка|массив $context необязательно []

Дополнительные данные, используемые для записи сообщения в журнал. Специальный ключ scope можно передать для дальнейшего фильтрации движков логов, которые будут использоваться. Если передаётся строка или массив с числовыми индексами, он будет интерпретироваться как ключ scope. См. Cake\Log\Log::setConfig() для получения дополнительной информации о областях логирования.

Возвращает

boolean
Успех

debug()source public static

debug( string $message , string|array $context = [] )

Метод для удобного логирования сообщений отладки

Параметры

строка $message

сообщение журнала

строка|массив $context необязательно []

Дополнительные данные, используемые для записи сообщения в журнал. Специальный ключ scope можно передать для дальнейшего фильтрации движков логов, которые будут использоваться. Если передаётся строка или массив с числовыми индексами, он будет интерпретироваться как ключ scope. См. Cake\Log\Log::setConfig() для получения дополнительной информации о областях логирования.

Возвращает

boolean
Успех

emergency()source public static

emergency( string $message , string|array $context = [] )

Метод для записи сообщений об аварийных ситуациях

Параметры

строка $message

сообщение журнала

строка|массив $context необязательно []

Дополнительные данные для записи сообщения. Специальный ключ scope может быть передан для дальнейшей фильтрации используемых механизмов журналов. Если передается строка или массив с числовыми индексами, он будет интерпретирован как ключ scope. Дополнительную информацию о разделах логирования см. в Cake\Log\Log::setConfig().

Возвращает

boolean
Успех

engine()source public static

engine( string $name )

Получение механизма логирования.

Параметры

строка $name

Имя ключа настроенного адаптера для получения.

Возвращает

Cake\Log\Engine\BaseLog|false
Экземпляр BaseLog или false, если не найден

error()source public static

error( string $message , string|array $context = [] )

Метод для записи сообщений об ошибках

Параметры

строка $message

сообщение журнала

строка|массив $context необязательно []

Дополнительные данные для записи сообщения. Специальный ключ scope может быть передан для дальнейшей фильтрации используемых механизмов журналов. Если передается строка или массив с числовыми индексами, он будет интерпретирован как ключ scope. Дополнительную информацию о разделах логирования см. в Cake\Log\Log::setConfig().

Возвращает

boolean
Успех

info()source public static

info( string $message , string|array $context = [] )

Метод для записи информационных сообщений

Параметры

строка $message

сообщение журнала

строка|массив $context необязательно []

Дополнительные данные для записи сообщения. Специальный ключ scope может быть передан для дальнейшей фильтрации используемых механизмов журналов. Если передается строка или массив с числовыми индексами, он будет интерпретирован как ключ scope. Дополнительную информацию о разделах логирования см. в Cake\Log\Log::setConfig().

Возвращает

boolean
Успех

levels()source public static

levels( )

Получение уровней журнала

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

Возвращает

массив
активные уровни журналов

notice()source public static

notice( string $message , string|array $context = [] )

Метод для записи сообщений о замечаниях

Параметры

строка $message

сообщение журнала

строка|массив $context необязательно []

Дополнительные данные для записи сообщения. Специальный ключ scope может быть передан для дальнейшей фильтрации используемых механизмов журналов. Если передается строка или массив с числовыми индексами, он будет интерпретирован как ключ scope. Дополнительную информацию о разделах логирования см. в Cake\Log\Log::setConfig().

Возвращает

boolean
Успех

reset()source public static

reset( )

Сбросить все подключенные логгеры. Это полезно при изменении конфигурации логирования или при тестировании, когда необходимо сбросить внутреннее состояние класса Log.

Сбрасывает настроенные адаптеры логирования, а также любые пользовательские уровни логирования. Это также очистит данные конфигурации.

setConfig()source public static

setConfig( string|array $key , array|null $config = null )

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

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

Логгеры не будут созданы до записи первого сообщения в журнал.

Использование

Настройка кеша.

Log::setConfig('default', $settings);

Ввод уже созданного адаптера:

Log::setConfig('default', $instance);

Использование функции-фабрики для получения адаптера:

Log::setConfig('default', function () { return new FileLog(); });

Настройка нескольких адаптеров одновременно:

Log::setConfig($arrayOfConfig);

Параметры

строка|массив $key

Название конфигурации логгера или массив нескольких конфигураций.

массив|null $config необязательно null

Массив данных имени => конфигурация для адаптера.

Возбуждает

BadMethodCallException
При попытке модифицировать существующую конфигурацию.

warning()source public static

warning( string $message , string|array $context = [] )

Метод для записи предупреждающих сообщений

Параметры

строка $message

сообщение журнала

строка|массив $context необязательно []

Дополнительные данные для записи сообщения. Специальный ключ scope может быть передан для дальнейшей фильтрации используемых механизмов журналов. Если передается строка или массив с числовыми индексами, он будет интерпретирован как ключ scope. Дополнительную информацию о разделах логирования см. в Cake\Log\Log::setConfig().

Возвращает

boolean
Успех

write()source public static

write( integer|string $level , mixed $message , string|array $context = [] )

Записывает данное сообщение и тип во все настроенные адаптеры журналов. Настроенные адаптеры получают как $level, так и $message. $level — одна из следующих строк/значений.

Уровни:

• LOG_EMERG => 'emergency',
• LOG_ALERT => 'alert',
• LOG_CRIT => 'critical',
• LOG_ERR => 'error',
• LOG_WARNING => 'warning',
• LOG_NOTICE => 'notice',
• LOG_INFO => 'info',
• LOG_DEBUG => 'debug',

Основное использование

Запись предупреждения в журнал:

Log::write('warning', 'Stuff is broken here');

Использование разделов

При записи сообщения в журнал можно определить один или несколько разделов для сообщения. Это позволяет обрабатывать сообщения по-разному в зависимости от раздела/функции приложения.

Log::write('warning', 'Payment failed', ['scope' => 'payment']);

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

Необработанные сообщения в журнале

Если ни один из настроенных логгеров не может обработать сообщение в журнале (из-за ограничений по уровню или разделу), то сообщение в журнале будет проигнорировано и бесшумно отброшено. Вы можете проверить, произошло ли это, просмотрев возврат write(). Если false, сообщение не было обработано.

Параметры

целое число|строка $level

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

mixed $message

Содержание сообщения для записи в журнал

строка|массив $context необязательно []

Дополнительные данные для записи сообщения. Специальный ключ scope может быть передан для дальнейшей фильтрации используемых механизмов журналов. Если передается строка или массив с числовыми индексами, он будет интерпретирован как ключ scope. Дополнительную информацию о разделах логирования см. в Cake\Log\Log::setConfig().

Возвращает

boolean
Успех

Возбуждает

InvalidArgumentException
Если передан недопустимый уровень.

config()source public static deprecated

config( string|array $key , array|null $config = null )

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

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

Адаптеры не будут построены до тех пор, пока не будет выполнена первая операция.

Использование

Предполагая, что имя класса — Cache, поддерживаются следующие сценарии:

Чтение данных конфигурации:

Cache::config('default');

Настройка движка кэша.

Cache::config('default', $settings);

Вставка построенного адаптера:

Cache::config('default', $instance);

Настройка нескольких адаптеров одновременно:

Cache::config($arrayOfConfig);

Устаревший

3.4.0 Используйте setConfig()/getConfig() вместо этого.

Параметры

string|array $key

Имя конфигурации или массив нескольких конфигураций.

array|null $config необязательно null

Массив пар имя => данные конфигурации для адаптера.

Возвращает

array|null
Null при добавлении конфигурации или массив данных конфигурации при чтении.

Вызывает исключение

BadMethodCallException
При попытке изменить существующую конфигурацию.

configured()source public static

configured( )

Возвращает массив, содержащий указанные конфигурации

Возвращает

string[]
Массив конфигураций.

drop()source public static

drop( string $config )

Удаляет построенный адаптер.

Если вы хотите изменить существующую конфигурацию, вы должны удалить её, изменить конфигурацию, а затем добавить её заново.

Если реализуемые объекты поддерживают объект $_registry, имя конфигурации также будет выгружено из реестра.

Параметры

string $config

Существующая конфигурация, которую вы хотите удалить.

Возвращает

boolean
Успешность удаления, возвращает false, если конфигурация не существует.

dsnClassMap()source public static deprecated

dsnClassMap( array $map = null )

Возвращает или обновляет карту классов DSN для этого класса.

Устаревший

3.4.0 Используйте setDsnClassMap()/getDsnClassMap() вместо этого.

Параметры

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

Дополнения/изменения в карте классов для применения.

Возвращает

array

getConfig()source public static

getConfig( string $key )

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

Параметры

string $key

Имя конфигурации.

Возвращает

array|null
Массив данных конфигурации.

getDsnClassMap()source public static

getDsnClassMap( )

Возвращает карту классов DSN для этого класса.

Возвращает

array

parseDsn()source public static

parseDsn( string $dsn )

Парсит DSN в корректную конфигурацию подключения.

Этот метод позволяет установить DSN с использованием форматирования, аналогичного используемому в PEAR::DB. Вот пример его использования:

$dsn = 'mysql://user:pass@localhost/database?';
$config = ConnectionManager::parseDsn($dsn);

$dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS';
$config = Log::parseDsn($dsn);

$dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null';
$config = Email::parseDsn($dsn);

$dsn = 'file:///?className=\My\Cache\Engine\FileEngine';
$config = Cache::parseDsn($dsn);

$dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/';
$config = Cache::parseDsn($dsn);

Для всех классов значение scheme устанавливается как значение className, если явно не указано иное.

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

Параметры

string $dsn

Строка DSN, которая должна быть преобразована в массив конфигурации

Возвращает

array
Массив конфигурации для хранения после разбора DSN

Вызывает исключение

InvalidArgumentException
Если не передана строка или передана некорректная строка

setDsnClassMap()source public static

setDsnClassMap( array $map )

Обновляет карту классов DSN для этого класса.

Параметры

array $map

Дополнения/изменения в карте классов для применения.

false

[
    'console' => 'Cake\Log\Engine\ConsoleLog',
    'file' => 'Cake\Log\Engine\FileLog',
    'syslog' => 'Cake\Log\Engine\SyslogLog',
]

[
    'emergency' => LOG_EMERG,
    'alert' => LOG_ALERT,
    'critical' => LOG_CRIT,
    'error' => LOG_ERR,
    'warning' => LOG_WARNING,
    'notice' => LOG_NOTICE,
    'info' => LOG_INFO,
    'debug' => LOG_DEBUG,
]

[
    'emergency',
    'alert',
    'critical',
    'error',
    'warning',
    'notice',
    'info',
    'debug'
]