Spec-Zone.ru › CakePHP 3.6

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

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

  • $_defaultConfig protected
    array
    Конфигурация по умолчанию для этого класса
  • $_levelMap protected
    int[]
    Используется для сопоставления строковых имён с константами LOG_*
  • $_open protected
    boolean
    Соединение логгера открыто или нет

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

  • _config, _configInitialized

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

  • __destruct() public
    Закрывает соединение логгера
  • _open() protected

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

  • _write() protected

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

  • log() public
    Записывает сообщение в syslog

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

__destruct()source public

__destruct( )

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

_open()source protected

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

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

Параметры

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

_write()source protected

_write( integer $priority , string $message )

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

Параметры

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

Возвращает

boolean

log()source public

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

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

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

Параметры

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

Возвращает

boolean
Успешность записи.

Методы, унаследованные от Cake\Log\Engine\BaseLog

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

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

Возбуждает

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

config()source public deprecated

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

Возвращает

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

Возбуждает

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

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

Параметры

string|array $key
Ключ для установки или полный массив настроек.
mixed|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');

Параметры

string|null $key необязательно null
Ключ для получения или null для всей конфигурации.
mixed $default необязательно null
Возвращаемое значение, когда ключ не существует.

Возвращает

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

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

Параметры

string|array $key
Ключ для установки или полный массив настроек.
mixed|null $value необязательно null
Значение для установки.
boolean $merge необязательно true
Выполнять рекурсивное объединение или перезапись существующей конфигурации, по умолчанию true.

Возвращает


$this

Выбрасывает

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

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

$_defaultConfigsource

protected array

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

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

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

Если вы хотите добавить префикс ко всем сообщениям, например, для идентификации приложения или веб-сервера, используйте опцию префикса. Имейте в виду, что префикс общий для всех потоков, использующих 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 int[]

Используется для сопоставления строковых имен с их константами 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 boolean

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

false

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

Spec-Zone.ru

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