Spec-Zone.ru › CakePHP 4.3

Класс FileLog

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

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

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

  • $_config protected
    array<string, mixed>

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

  • $_configInitialized protected
    bool

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

  • $_defaultConfig protected
    array<string, mixed>

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

  • $_file protected
    string|null

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

  • $_path protected
    string

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

  • $_size protected
    int|null

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

  • $formatter protected
    Cake\Log\Formatter\AbstractFormatter

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

  • __construct() public

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

  • _configDelete() protected

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

  • _configRead() protected

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

  • _configWrite() protected

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

  • _format() protected deprecated

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

  • _getFilename() protected

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

  • _rotateFile() protected

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

  • alert() public

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

  • configShallow() public

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

  • critical() public

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

  • debug() public

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

  • emergency() public

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

  • error() public

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

  • getConfig() public

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

  • getConfigOrFail() public

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

  • info() public

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

  • interpolate() protected

    Заменяет плейсхолдеры в строке сообщения значениями контекста.

  • levels() public

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

  • log() public

    Реализует запись в лог-файлы.

  • notice() public

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

  • scopes() public

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

  • setConfig() public

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

  • warning() public

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

END_OF_DOCUMENT_MARKER

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

__construct() public 

__construct(array<string, mixed> $config = [])

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

Параметры

array<string, mixed> $config опционально

Массив конфигурации

_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(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

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

Параметры

array<string, mixed>|string $key

Ключ для записи.

mixed $value

Значение для записи.

string|bool $merge опционально

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

Возвращает

void

Выбрасывает

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

_format() protected 

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

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

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

Параметры

string $message

Сообщение для форматирования.

array $context опционально

Дополнительная информация о логировании для сообщения.

Возвращает

string

_getFilename() protected 

_getFilename(string $level): string

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

Параметры

string $level

Уровень логирования.

Возвращает

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 опционально

Возвращает

void

configShallow() public 

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

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

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

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

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

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

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

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

Параметры

array<string, mixed>|string $key

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

mixed|null $value опционально

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

Возвращает

$this

critical() public 

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

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

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

Параметры

string $message
mixed[] $context опционально

Возвращает

void

debug() public 

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

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

Параметры

string $message
mixed[] $context опционально

Возвращает

void

emergency() public 

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

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

Параметры

string $message
mixed[] $context опционально

Возвращает

void

error() public 

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

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

Параметры

string $message
mixed[] $context опционально

Возвращает

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 опционально

Ключ для получения или null для всей конфигурации.

mixed $default опционально

Возвращаемое значение, если ключ не существует.

Возвращает

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 опционально

Возвращает

void

interpolate() protected 

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

Заменяет плейсхолдеры в строке сообщения значениями контекста.

Параметры

string $message

Отформатированная строка

array $context опционально

Контекст для значений плейсхолдеров.

Возвращает

string

levels() public 

levels(): array<string>

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

Возвращает

array<string>

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 optional

Возвращает

void

scopes() public 

scopes(): array<string>|false

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

Возвращает

array<string>|false

setConfig() public 

setConfig(array<string, mixed>|string $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']);

Параметры

array<string, mixed>|string $key

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

mixed|null $value optional

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

bool $merge optional

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

Возвращает

$this

Исключения

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

warning() public 

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

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

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

Параметры

string $message
mixed[] $context optional

Возвращает

void

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

$_config protected

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

Тип

array<string, mixed>

$_configInitialized protected

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

Тип

bool

$_defaultConfig protected

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

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

Тип

array<string, mixed>

$_file protected

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

Тип

string|null

$_path protected

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

Тип

string

$_size protected

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

Тип

int|null

$formatter protected

Тип

Cake\Log\Formatter\AbstractFormatter

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

Spec-Zone.ru

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