Класс FileLog
Поток хранения файлов для ведения журнала. Записывает журналы в разные файлы в зависимости от уровня журнала.
- Psr\Log\AbstractLogger
-
Cake\Log\Engine\BaseLog использует Cake\Core\InstanceConfigTrait -
Cake\Log\Engine\FileLog
Краткое описание свойств
-
$_defaultConfigprotectedЗначение по умолчанию конфигурации для этого классаarray -
$_fileprotectedИмя файла для сохранения логов.string -
$_pathprotectedПуть для сохранения файлов логов.string -
$_sizeprotectedМаксимальный размер файла, используемый для вращения файла журнала.integer
Унаследованные свойства
Краткое описание методов
- __construct() publicУстанавливает защищённые свойства на основе предоставленной конфигурации
- _getFilename() protectedПолучение имени файла
- _rotateFile() protected
Вращение файла журнала, если размер, указанный в конфигурации, достигнут. Также, если
rotateсчётчик достигнут, самый старый файл удаляется. - log() publicРеализует запись в файлы журнала.
Подробное описание методов
__construct()source public
__construct( array $config [] )
Устанавливает защищённые свойства на основе предоставленной конфигурации
Параметры
- массив
$configнеобязательно [] - Массив конфигурации
Переопределяет
Cake\Log\Engine\BaseLog::__construct() _getFilename()source protected
_getFilename( string $level )
Получение имени файла
Параметры
- строка
$level - Уровень журнала.
Возвращает
строкаИмя файла
_rotateFile()source protected
_rotateFile( string $filename )
Вращение файла журнала, если размер, указанный в конфигурации, достигнут. Также, если rotate счётчик достигнут, самый старый файл удаляется.
Параметры
- строка
$filename - Имя файла журнала
Возвращает
логическое значение|nullTrue, если вращение прошло успешно, или false в случае ошибки. Null, если файл не нуждается в вращении.
log()source public
log( string $level , string $message , array $context [] )
Реализует запись в файлы журнала.
Параметры
- строка
$level Уровень серьезности сообщения, записываемого. См. Cake\Log\Log::$_levels для списка возможных уровней.
- строка
$message - Сообщение, которое вы хотите записать в журнал.
- массив
$contextнеобязательно [] - Дополнительная информация о записываемом сообщении
Возвращает
логическое значениеУспешность записи.
Методы, унаследованные от Cake\Log\Engine\BaseLog
_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 - Значение для записи.
- логическое значение|строка
$mergeнеобязательно false True для рекурсивной слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.
Выбрасывает
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']);
Параметры
- строка|массив|null
$keyнеобязательно null - Ключ для получения/установки или полный массив конфигураций.
- смешанное значение|null
$valueнеобязательно null - Значение для установки.
- логическое значение
$mergeнеобязательно true - Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.
Возвращает
смешанное значениеЗначение конфигурации, которое читается, или сам объект при операциях записи.
Выбрасывает
Cake\Core\Exception\ExceptionПри попытке установить некорректный ключ.
configShallow()source public
configShallow( string|array $key , mixed|null $value null )
Объединение предоставленной конфигурации с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.
Установка определённого значения:
$this->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или полный массив конфигураций.
- смешанное значение|null
$valueнеобязательно null - Значение для установки.
Возвращает
$this Объект сам.
Подробное описание свойств
$_defaultConfigsource
protected array
Конфигурация по умолчанию для этого класса
-
levelsстрока или массив, уровни, которые интересуют движок -
scopesстрока или массив, области, которые интересуют движок -
fileИмя файла журнала -
pathПуть для сохранения журналов. -
sizeИспользуется для реализации базовой ротации файлов журналов. Если размер файла журнала достигает указанного значения, существующий файл переименовывается путем добавления отметки времени к имени файла, и создается новый файл журнала. Может быть целым числом в байтах или строкой в удобочитаемом формате, например '10MB', '100KB' и т.д. -
rotateФайлы журнала поворачиваются указанное количество раз перед удалением. Если значение равно 0, старые версии удаляются, а не поворачиваются. -
maskМаска применяется при создании файлов журналов. Если поле пустое, chmod не выполняется.
[
'path' => null,
'file' => null,
'types' => null,
'levels' => [],
'scopes' => [],
'rotate' => 10,
'size' => 10485760, // 10MB
'mask' => null,
] $_sizesource
protected integer
Максимальный размер файла, используемый для ротации файлов журналов.
null
© 2005–2017 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.3/class-Cake.Log.Engine.FileLog.html