Класс 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необязательный [] - Дополнительная информация о логе для сообщения.
Возвращает
строкаlevels()source public
levels( )
Получить уровни логов, к которым чувствителен этот логгер.
Возвращает
массивscopes()source public
scopes( )
Получить области логов, к которым чувствителен этот логгер.
Возвращает
массивМетоды, используемые из 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 True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.
Исключения
Cake\Core\Exception\Exceptionесли пытаетесь перезаписать существующую конфигурацию
config()source public
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']);
Параметры
- строка|массив|null
$keyнеобязательный null - Ключ для получения/установки, или весь массив конфигурации.
- смешанный|null
$valueнеобязательный null - Значение для установки.
- булево
$mergeнеобязательный true - Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.
Возвращает
смешанныйЗначение конфигурации, которое читается, или сам объект при операциях записи.
Исключения
Cake\Core\Exception\ExceptionПри попытке установить неверный ключ.
configShallow()source public
configShallow( string|array $key , mixed|null $value null )
Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которое выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.
Установка определенного значения:
$this->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки, или весь массив конфигурации.
- смешанный|null
$valueнеобязательный null - Значение для установки.
Возвращает
$this Сам объект.
Подробное описание свойств
$_defaultConfigsource
protected массив
Значения конфигурации по умолчанию для этого класса
[
'levels' => [],
'scopes' => []
]
© 2005–2017 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.3/class-Cake.Log.Engine.BaseLog.html