Класс BaseLog
Базовый класс логгера.
- Psr\Log\AbstractLogger
-
Cake\Log\Engine\BaseLog использует Cake\Core\InstanceConfigTrait
Прямые подклассы
Краткое описание свойств
-
$_defaultConfigprotectedЗначения конфигурации по умолчанию для этого классаarray
Унаследованные свойства
Краткое описание методов
- __construct() publicМетод __construct
- _format() protected
Преобразует предоставленные данные в строку для записи в журнал. Контекст может быть использован движками логов для интерполяции переменных или добавления дополнительной информации в сообщение журнала.
- levels() publicВозвращает уровни, к которым относится логгер.
- scopes() publicВозвращает области, к которым относится логгер.
Подробное описание методов
__construct()source public
__construct( array $config = [] )
Метод __construct
Параметры
- массив
$configнеобязательный [] - Массив конфигурации
_format()source protected
_format( mixed $data , array $context = [] )
Преобразует предоставленные данные в строку для записи в журнал. Контекст может быть использован движками логов для интерполяции переменных или добавления дополнительной информации в сообщение журнала.
Параметры
- смешанный
$data - Данные, которые нужно преобразовать в строку для записи в журнал.
- массив
$contextнеобязательный [] - Дополнительная информация для записи в журнал.
Возвращает
строкаМетоды, используемые из Cake\Core\InstanceConfigTrait
_configDelete()source protected
_configDelete( string $key )
Удаляет отдельный ключ конфигурации.
Параметры
- строка
$key - Ключ для удаления.
Выбрасывает
Cake\Core\Exception\Exceptionесли пытаетесь перезаписать существующую конфигурацию
_configRead()source protected
_configRead( string|null $key )
Читает ключ конфигурации.
Параметры
- строка|null
$key - Ключ для чтения.
Возвращает
смешанный_configWrite()source protected
_configWrite( string|array $key , mixed $value , boolean|string $merge = false )
Записывает ключ конфигурации.
Параметры
- строка|массив
$key - Ключ для записи.
- смешанный
$value - Значение для записи.
- булево|строка
$mergeнеобязательный false Истинно для рекурсивного слияния, 'shallow' для простого слияния, ложно для перезаписи, по умолчанию ложно.
Выбрасывает
Cake\Core\Exception\Exceptionесли пытаетесь перезаписать существующую конфигурацию
config()source public deprecated
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 public
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 public
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 - Возвращаемое значение, если ключ не существует.
Возвращает
смешанныйДанные конфигурации по указанному ключу или null, если ключ не существует.
setConfig()source public
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
protected массив
Значения конфигурации по умолчанию для этого класса
[
'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.8/class-Cake.Log.Engine.BaseLog.html