Spec-Zone.ru › CakePHP 3.5

Класс 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
Смешение: \Cake\Core\InstanceConfigTrait
Расположение: 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

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

Устарело

3.4.0 использовать setConfig()/getConfig() вместо этого.

Параметры

строка|массив|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->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
Производить рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает


$this

Выбрасывает

Cake\Core\Exception\Exception
При попытке установки недействительного ключа.

Подробное описание свойств

$_defaultConfigsource

protected массив

Значения по умолчанию для этого класса

[
    'levels' => [],
    'scopes' => []
]

© 2005–2018 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.5/class-Cake.Log.Engine.BaseLog.html

Spec-Zone.ru

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