Spec-Zone.ru › CakePHP 3.2

Класс 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

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

Исключение

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

Возвращаемое значение

смешанное
Значение конфигурации, которое читается, или сам объект при операциях записи.

Исключение

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–2016 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.
http://api.cakephp.org/3.2/class-Cake.Log.Engine.BaseLog.html

Spec-Zone.ru

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