Spec-Zone.ru › CakePHP 3.1

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

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

__constructsource public

__construct( array $config [] )

Метод __construct

Параметры

массив $config необязательно []
Массив конфигурации

_formatsource protected

_format( mixed $data , array $context [] )

Преобразует предоставленные данные в строку для записи в журнал. Контекст может быть использован движками логов для интерполяции переменных или добавления дополнительной информации к сообщению.

Параметры

смешанный $data
Данные, которые будут преобразованы в строку и записаны в журнал.
массив $context необязательно []
Дополнительная информация для лог-сообщения.

Возвращает

string
строка

levelssource public

levels( )

Получить уровни, которые интересуют этот логгер.

Возвращает

array
массив

scopessource public

scopes( )

Получить области, которые интересуют этого логгера.

Возвращает

array
массив

Методы, используемые из Cake\Core\InstanceConfigTrait

_configDeletesource protected

_configDelete( string $key )

Удалить ключ конфигурации

Параметры

строка $key
Ключ для удаления.

Выбрасывает

Cake\Core\Exception\Exception
при попытке перезаписи существующей конфигурации

_configReadsource protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка|null $key
Ключ для чтения.

Возвращает

mixed
смешанный

_configWritesource protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись переменной конфигурации

Параметры

строка|массив $key
Ключ для записи.
смешанный $value
Значение для записи.
булево|строка $merge необязательно false
Истина для рекурсивного объединения, 'shallow' для простого объединения, ложь для перезаписи, по умолчанию ложь.

Выбрасывает

Cake\Core\Exception\Exception
при попытке перезаписи существующей конфигурации

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

Возвращает

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

Выбрасывает

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

configShallowsource 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
Значение для установки.

Возвращает

mixed
$this Сам объект.

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

$_defaultConfigsource

protected массив

Значения конфигурации по умолчанию для данного класса

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

Свойства, используемые из Cake\Core\InstanceConfigTrait

$_configsource

protected массив

Конфигурация во время выполнения

[]

$_configInitializedsource

protected булево

Содержит ли свойство config уже настроенные значения по умолчанию

false

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

Spec-Zone.ru

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