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

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
Значение считываемой конфигурации.

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