Класс BaseLog
Базовый класс двигателя логирования.
- Psr\Log\AbstractLogger
-
Cake\Log\Engine\BaseLog использует Cake\Core\InstanceConfigTrait
Непосредственные подклассы
Пространство имён: Cake\Log\Engine
Смесь: \Cake\Core\InstanceConfigTrait
Расположение: Log/Engine/BaseLog.php
Краткое описание свойств
-
$_defaultConfigзащищенноеЗначение конфигурации по умолчанию для этого классаarray
Наследованные свойства
Краткое описание методов
- __construct() публичныйМетод __construct
- _format() защищенное
Преобразует предоставленные данные в строку для записи в журнал. Контекст может быть использован движками логирования для интерполяции переменных или добавления дополнительной информации к сообщению в журнале.
- levels() публичныйПолучить уровни, которые интересуют данного логгера.
- scopes() публичныйПолучить области, которые интересуют данного логгера.
Подробное описание методов
__construct()source публичный
__construct( array $config = [] )
Метод __construct
Параметры
- массив
$configнеобязательный [] - Массив конфигурации
_format()source защищенное
_format( mixed $data , array $context = [] )
Преобразует предоставленные данные в строку для записи в журнал. Контекст может быть использован движками логирования для интерполяции переменных или добавления дополнительной информации к сообщению в журнале.
Параметры
- смешанное
$data - Данные, которые необходимо преобразовать в строку и записать в журнал.
- массив
$contextнеобязательный [] - Дополнительная информация о логировании для сообщения.
Возвращает
строкаlevels()source публичный
levels( )
Получить уровни, которые интересуют данного логгера.
Возвращает
массивscopes()source публичный
scopes( )
Получить области, которые интересуют данного логгера.
Возвращает
массивМетоды, используемые из Cake\Core\InstanceConfigTrait
_configDelete()source защищенное
_configDelete( string $key )
Удаляет ключ конфигурации.
Параметры
- строка
$key - Ключ для удаления.
Выбрасывает
Cake\Core\Exception\Exceptionесли происходит попытка перезаписи существующей конфигурации
_configRead()source защищенное
_configRead( string|null $key )
Читает ключ конфигурации.
Параметры
- строка|null
$key - Ключ для чтения.
Возвращает
смешанное_configWrite()source защищенное
_configWrite( string|array $key , mixed $value , boolean|string $merge = false )
Записывает ключ конфигурации.
Параметры
- строка|массив
$key - Ключ для записи.
- смешанное
$value - Значение для записи.
- булево|строка
$mergeнеобязательный false Истинно для рекурсивного слияния, 'shallow' для простого слияния, ложно для перезаписи, по умолчанию ложно.
Выбрасывает
Cake\Core\Exception\Exceptionесли происходит попытка перезаписи существующей конфигурации
config()source публичный устаревший
config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )
Получает/устанавливает конфигурацию.
Использование
Чтение всей конфигурации:
$this->config();
Чтение определенного значения:
$this->config('key'); Чтение вложенного значения:
$this->config('some.nested.key'); Установка определенного значения:
$this->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Устарело
3.4.0 используйте setConfig()/getConfig() вместо этого.Параметры
- строка|массив|null
$keyнеобязательный null - Ключ для получения/установки или полный массив конфигураций.
- смешанное|null
$valueнеобязательный null - Значение для установки.
- булево
$mergeнеобязательный true - Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию истинно.
Возвращает
смешанноеЗначение конфигурации, которое читается, или сам объект при операциях записи.
Выбрасывает
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
configShallow()source публичный
configShallow( string|array $key , mixed|null $value = null )
Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
Установка определенного значения:
$this->configShallow('key', $value); Установка вложенного значения:
$this->configShallow('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->configShallow(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или полный массив конфигураций.
- смешанное|null
$valueнеобязательный null - Значение для установки.
Возвращает
$this
getConfig()source публичный
getConfig( string|null $key = null , mixed $default = null )
Возвращает конфигурацию.
Использование
Чтение всей конфигурации:
$this->getConfig();
Чтение определенного значения:
$this->getConfig('key'); Чтение вложенного значения:
$this->getConfig('some.nested.key'); Чтение со значением по умолчанию:
$this->getConfig('some-key', 'default-value'); Параметры
- строка|null
$keyнеобязательный null - Ключ для получения или null для всей конфигурации.
- смешанное
$defaultнеобязательный null - Возвращаемое значение, когда ключ не существует.
Возвращает
смешанноеЗначение конфигурации, которое читается.
setConfig()source публичный
setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )
Устанавливает конфигурацию.
Использование
Установка определенного значения:
$this->setConfig('key', $value); Установка вложенного значения:
$this->setConfig('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->setConfig(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или полный массив конфигураций.
- смешанное|null
$valueнеобязательный null - Значение для установки.
- булево
$mergeнеобязательный true - Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию истинно.
Возвращает
$this
Выбрасывает
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
Подробное описание свойств
$_defaultConfigsource
защищенное массив
Значение конфигурации по умолчанию для этого класса
[
'levels' => [],
'scopes' => []
]
© 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/3.6/class-Cake.Log.Engine.BaseLog.html