Класс FileLog

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

Пространство имён: Cake\Log\Engine

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

$_config protected

array

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

bool

Указание того, была ли конфигурация уже настроена по умолчанию
$_defaultConfig protected

array

Конфигурация по умолчанию для этого класса
$_file protected

string|null

Имя файла для сохранения журналов.
$_path protected

string

Путь для сохранения файлов журналов.
$_size protected

int|null

Максимальный размер файла, используемый для вращения файлов журнала.

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

__construct() public

Устанавливает защищённые свойства на основе предоставленной конфигурации
_configDelete() protected

Удаляет один ключ конфигурации.
_configRead() protected

Считывает ключ конфигурации.
_configWrite() protected

Записывает ключ конфигурации.
_format() protected

Форматирует сообщение для записи в журнал.
_getFilename() protected

Получить имя файла
_getFormattedDate() protected

Возвращает отформатированную дату в соответствии с форматом параметра dateFormat.
_rotateFile() protected

Вращает файл журнала, если размер, указанный в конфигурации, достигнут. Также, если достигнуто количество rotate, удаляется самый старый файл.
alert() public

Необходимо немедленно принять меры.
configShallow() public

Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
critical() public

Критические условия.
debug() public

Подробная отладочная информация.
emergency() public

Система непригодна для использования.
error() public

Ошибки во время выполнения, которые не требуют немедленного действия, но обычно должны быть записаны в журнал и отслеживаться.
getConfig() public

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для конкретного ключа.
info() public

Интересные события.
levels() public

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

Реализует запись в файлы журнала.
notice() public

Нормальные, но значимые события.
scopes() public

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

Устанавливает конфигурацию.
warning() public

Исключительные случаи, которые не являются ошибками.

END_OF_DOCUMENT_MARKER

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

__construct() public

__construct(array $config = [])

Устанавливает защищённые свойства на основе предоставленной конфигурации

Параметры

array $config optional: Массив конфигурации

_configDelete() protected

_configDelete(string $key): void

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

Параметры

string $key: Ключ для удаления.

Возвращает

void

Выбрасывает

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

_configRead() protected

_configRead(string|null $key): mixed

Считывает ключ конфигурации.

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Записывает ключ конфигурации.

Параметры

string|array $key: Ключ для записи.
mixed $value: Значение для записи.
bool|string $merge optional: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Выбрасывает

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

_format() protected

_format(string $message, array $context = []): string

Форматирует сообщение для записи в журнал.

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

Параметры

string $message: Сообщение для форматирования.
array $context optional: Дополнительная информация для записи в журнал.

Возвращает

string

_getFilename() protected

_getFilename(string $level): string

Получить имя файла

Параметры

string $level: Уровень лога.

Возвращает

string

_getFormattedDate() protected

_getFormattedDate(): string

Возвращает отформатированную дату в соответствии с заданным форматом опции dateFormat.

Эта функция влияет на формат информации о дате и времени FileLog илиConsoleLog.

Возвращает

string

_rotateFile() protected

_rotateFile(string $filename): bool|null

Поворачивает файл журнала, если размер, указанный в конфигурации, достигнут. Также, если достигнуто количество rotate, самый старый файл удаляется.

Параметры

string $filename: Имя файла журнала

Возвращает

bool|null

alert() public

alert(string $message, mixed[] $context = array()): void

Необходимо немедленное действие.

Пример: Весь сайт отключен, база данных недоступна и т.д. Это должно сработать SMS-уведомления и разбудить вас.

Параметры

string $message
mixed[] $context optional

Возвращает

void

configShallow() public

configShallow(string|array $key, mixed|null $value = null): $this

Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определенного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.

Возвращает

$this

critical() public

critical(string $message, mixed[] $context = array()): void

Критические условия.

Пример: Компонент приложения недоступен, непредвиденное исключение.

Параметры

string $message
mixed[] $context optional

Возвращает

void

debug() public

debug(string $message, mixed[] $context = array()): void

Подробная отладочная информация.

Параметры

string $message
mixed[] $context optional

Возвращает

void

emergency() public

emergency(string $message, mixed[] $context = array()): void

Система непригодна к использованию.

Параметры

string $message
mixed[] $context optional

Возвращает

void

error() public

error(string $message, mixed[] $context = array()): void

Ошибки выполнения, которые не требуют немедленных действий, но обычно должны быть записаны в журнал и отслеживаться.

Параметры

string $message
mixed[] $context optional

Возвращает

void

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

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

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для данного ключа.

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Выбрасывает

InvalidArgumentException

info() public

info(string $message, mixed[] $context = array()): void

Интересные события.

Пример: Пользователь вошел в систему, логи SQL.

Параметры

string $message
mixed[] $context optional

Возвращает

void

levels() public

levels(): array

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

Возвращает

array

log() public

log(mixed $level, string $message, mixed[] $context = []): void

Реализует запись в файлы журнала.

Параметры

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

Возвращает

void

См. также

Cake\Log\Log::$_levels

notice() public

notice(string $message, mixed[] $context = array()): void

Обычные, но значимые события.

Параметры

string $message
mixed[] $context необязательно

Возвращает

void

scopes() public

scopes(): array|false

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

Возвращает

array|false

setConfig() public

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Использование

Установка определенного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

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

Возвращает

$this

Исключения

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

warning() public

warning(string $message, mixed[] $context = array()): void

Исключительные случаи, которые не являются ошибками.

Пример: Использование устаревших API, неправильное использование API, нежелательные действия, которые не обязательно являются ошибками.

Параметры

string $message
mixed[] $context необязательно

Возвращает

void

Подробности свойств

`$_config` protected

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

Тип

array

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

Конфигурация по умолчанию для этого класса

levels строка или массив, уровни, которые интересуют движок
scopes строка или массив, области, которые интересуют движок
file Имя файла журнала
path Путь для сохранения журналов.
size Используется для реализации базовой ротации файлов журнала. Если размер файла журнала достигает указанного размера, существующий файл переименовывается путем добавления отметки времени к имени файла, и создается новый файл журнала. Может быть целым числом (байты) или строкой, отображающей удобочитаемые значения, например, '10MB', '100KB' и т.д.
rotate Файлы журнала поворачиваются заданное количество раз, прежде чем будут удалены. Если значение равно 0, старые версии удаляются, а не поворачиваются.
mask При создании файлов журналов применяется маска. Если поле пусто, chmod не выполняется.
dateFormat Формат даты PHP date().

Тип

array

`$_file` protected

Имя файла для сохранения журналов.

Тип

string|null

`$_path` protected

Путь для сохранения файлов журналов.

Тип

string

`$_size` protected

Максимальный размер файла, используется для ротации файлов журнала.

Тип

int|null

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