Spec-Zone.ru › CakePHP 3.1

Класс SyslogLog

Поток Syslog для ведения журнала. Записывает логи в системный логгер

Psr\Log\AbstractLogger
Extended by Cake\Log\Engine\BaseLog использует Cake\Core\InstanceConfigTrait
Extended by Cake\Log\Engine\SyslogLog
Пространство имён: Cake\Log\Engine
Расположено в Log/Engine/SyslogLog.php

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

__destructsource public

__destruct( )

Закрывает соединение с логгером

_opensource protected

_open( string $ident , integer $options , integer $facility )

Извлекает вызов openlog() для выполнения юнит-тестов. Эта функция инициализирует соединение с системным логгером

Параметры

строка $ident
префикс, добавляемый ко всем записываемым сообщениям
целое число $options
флаги опций, используемые для записываемых сообщений
целое число $facility
поток или средство для записи в лог

_writesource protected

_write( integer $priority , string $message )

Извлекает вызов syslog() для выполнения юнит-тестов. Эта функция выполняет фактическую запись в системный логгер

Параметры

целое число $priority
Приоритет сообщения.
строка $message
Сообщение для записи.

Возвращает

boolean
bool

logsource public

log( string $level , string $message , array $context [] )

Записывает сообщение в syslog

Преобразует $level в значение LOG_, разбивает многострочные сообщения на несколько сообщений в логе, пропускает все сообщения через формат, определённый в конфигурации

Параметры

строка $level
Уровень серьезности создаваемого вами лога.
строка $message
Сообщение, которое вы хотите записать в лог.
массив $context необязательно []
Дополнительная информация о записанном сообщении

Возвращает

boolean
успех записи.

Наследуемые методы из Cake\Log\Engine\BaseLog

__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
Значение для записи.
boolean|строка $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
Значение для установки.
boolean $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 массив

Настройки по умолчанию для этого класса

По умолчанию сообщения форматируются как: уровень: сообщение

Чтобы переопределить формат лога (например, добавить собственную информацию), определите ключ формата при настройке этого логгера

Если вы хотите добавить префикс ко всем сообщениям, например, для идентификации приложения или веб-сервера, используйте опцию префикса. Имейте в виду, что префикс общий для всех потоков, использующих syslog, так как он зависит от работающего процесса. Для локального префикса, который будет использоваться только одним потоком, вы можете использовать ключ формата.

Пример:

Log::config('error', ]
    'engine' => 'Syslog',
    'levels' => ['emergency', 'alert', 'critical', 'error'],
    'format' => "%s: My-App - %s",
    'prefix' => 'Web Server 01'
]);
[
    'levels' => [],
    'scopes' => [],
    'format' => '%s: %s',
    'flag' => LOG_ODELAY,
    'prefix' => '',
    'facility' => LOG_USER
]

$_levelMapsource

protected массив

Используется для сопоставления строковых имен со значениями констант LOG_*

[
    'emergency' => LOG_EMERG,
    'alert' => LOG_ALERT,
    'critical' => LOG_CRIT,
    'error' => LOG_ERR,
    'warning' => LOG_WARNING,
    'notice' => LOG_NOTICE,
    'info' => LOG_INFO,
    'debug' => LOG_DEBUG
]

$_opensource

protected логический

Открыто ли подключение логгера

false

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

$_configsource

protected массив

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

[]

$_configInitializedsource

protected логический

Настроена ли конфигурация свойством по умолчанию

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.SyslogLog.html

Spec-Zone.ru

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