Класс SyslogLog

__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
Результат записи.

__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( )

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

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

массив

_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

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

Исключения

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
При попытке установить недопустимый ключ.

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
Данные конфигурации по указанному ключу или 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']);

Параметры

string|array $key

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

mixed|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Выполнять рекурсивное объединение или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

$this

Исключения

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

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
]

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

false