Класс Log

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

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

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

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

_initsource protected static

_init( )

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

_loadConfigsource protected static

_loadConfig( )

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

alertsource public static

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

Удобный метод для регистрации сообщений об ошибках

Параметры

строка $message

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

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

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

Возвращает

boolean
Успех

configsource public static

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

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

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

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

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

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

Log::config('default');

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

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

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

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

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

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

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

Log::config($arrayOfConfig);

Параметры

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

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

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

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

Возвращает

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

Выбрасывает

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

criticalsource public static

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

Удобный метод для регистрации критических сообщений

Параметры

строка $message

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

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

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

Возвращает

boolean
Успех

debugsource public static

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

Удобный метод для регистрации сообщений отладки

Параметры

строка $message

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

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

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

Возвращает

boolean
Успех

emergencysource public static

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

Удобный метод для регистрации критических сообщений

Параметры

строка $message

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

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

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

Возвращает

boolean
Успех

enginesource public static

engine( string $name )

Получить движок логирования.

Параметры

строка $name

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

Возвращает

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

errorsource public static

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

Удобный метод для регистрации сообщений об ошибках

Параметры

строка $message

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

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

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

Возвращает

boolean
Успех

infosource public static

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

Удобный метод для регистрации информационных сообщений

Параметры

строка $message

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

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

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

Возвращает

boolean
Успех

levelssource public static

levels( )

Получает уровни логов

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

Возвращает

array
активные уровни логов

noticesource public static

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

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

Параметры

string $message

сообщение лога

string|array $context optional []

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

Возвращает

boolean
Успех

resetsource public static

reset( )

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

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

warningsource public static

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

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

Параметры

string $message

сообщение лога

string|array $context optional []

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

Возвращает

boolean
Успех

writesource public static

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

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

Уровни:

• LOG_EMERG => 'экстренный',
• LOG_ALERT => 'сигнал тревоги',
• LOG_CRIT => 'критический',
• LOG_ERR => 'ошибка',
• LOG_WARNING => 'предупреждение',
• LOG_NOTICE => 'событие',
• LOG_INFO => 'информация',
• LOG_DEBUG => 'отладка',

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

Записать сообщение 'предупреждение' в логах:

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

Использование пространств имён

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

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

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

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

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

Параметры

integer|string $level

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

mixed $message

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

string|array $context optional []

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

Возвращает

boolean
Успех

Использует

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

_configsource protected static

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

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

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

Адаптеры не будут созданы до первого выполнения операции.

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

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

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

Cache::config('default');

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

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

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

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

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

Cache::config($arrayOfConfig);

Параметры

string|array $key

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

array $config optional null

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

Возвращает

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

Использует

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

configuredsource public static

configured( )

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

Возвращает

array
Массив конфигураций.

dropsource public static

drop( string $config )

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

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

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

Параметры

string $config

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

Возвращает

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

dsnClassMapsource public static

dsnClassMap( array $map null )

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

Параметры

array $map optional null

Дополнения/изменения в карте классов, которые необходимо применить

Возвращает

array
массив

parseDsnsource 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, если не задано иное.

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

Параметры

string $dsn

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

Возвращает

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

Использует

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

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

[]