Spec-Zone.ru › CakePHP 3.7

Класс BaseLog

Базовый класс логирования.

Psr\Log\AbstractLogger
Extended by Cake\Log\Engine\BaseLog использует Cake\Core\InstanceConfigTrait

Непосредственные подклассы

  • Cake\Log\Engine\ConsoleLog
  • Cake\Log\Engine\FileLog
  • Cake\Log\Engine\SyslogLog
Абстрактный
Пространство имён: Cake\Log\Engine
Расположение: Log/Engine/BaseLog.php

Краткое описание свойств

  • $_defaultConfig protected
    array
    Конфигурация по умолчанию для этого класса

Унаследованные свойства

  • _config, _configInitialized

Краткое описание методов

  • __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

Истинно для рекурсивного слияния, «плоское» для простого слияния, ложно для перезаписи, по умолчанию ложно.

Возможные исключения

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

Устаревшее

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
Значение по умолчанию при отсутствии ключа.

Возвращает

смешанный
Значение считанной конфигурации.

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.7/class-Cake.Log.Engine.BaseLog.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API