Класс FileLog
Поток для хранения файлов журналов. Записывает журналы в разные файлы в зависимости от типа журнала.
- BaseLog реализует CakeLogInterface
-
FileLog
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Log/Engine/FileLog.php
Краткое описание свойств
-
$_defaultsprotectedЗначения по умолчанию конфигурацииarray -
$_fileprotectedИмя файла журналаstring -
$_pathprotectedПуть для сохранения файлов журналов.string -
$_sizeprotectedМаксимальный размер файла, используется для вращения файлов журнала.integer
Унаследованные свойства
Краткое описание методов
- __construct() publicСоздает новый логгер файлов.
- _getFilename() protectedПолучить имя файла
- _rotateFile() protected
Вращает файл журнала, если размер, указанный в конфигурации, достигнут. Также, если
rotateколичество достигнуто, удаляется самый старый файл. - config() publicУстанавливает защищенные свойства на основе предоставленной конфигурации
- write() publicРеализует запись в файлы журналов.
Подробное описание методов
__construct()source public
__construct( array $config array() )
Создает новый логгер файлов.
Конфигурация
-
typesстрока или массив, уровни, которые интересуют движок -
scopesстрока или массив, области, которые интересуют движок -
fileИмя файла журнала -
pathПуть для сохранения журналов. -
sizeИспользуется для реализации базового вращения файлов журнала. Если размер файла журнала достигает указанного размера, существующий файл переименовывается путем добавления отметки времени к имени файла, и создается новый файл журнала. Может быть целым числом в байтах или читаемой строкой в человекочитаемом формате, например «10МБ», «100КБ» и т. д. -
rotateФайлы журнала вращаются указанное количество раз, прежде чем быть удаленными. Если значение равно 0, старые версии удаляются, а не вращаются. -
maskПри создании файлов журналов применяется маска. Если поле пустое, chmod не выполняется.
Параметры
- массив
$configнеобязательно массив() - Параметры для FileLog, см. выше.
Переопределяет
BaseLog::__construct() _getFilename()source protected
_getFilename( string $type )
Получить имя файла
Параметры
- строка
$type - Тип журнала.
Возвращает
строкаИмя файла
_rotateFile()source protected
_rotateFile( string $filename )
Вращает файл журнала, если размер, указанный в конфигурации, достигнут. Также, если rotate количество достигнуто, удаляется самый старый файл.
Параметры
- строка
$filename - Имя файла журнала
Возвращает
смешанное значениеTrue, если вращение прошло успешно, или false в случае ошибки, в противном случае null. Void, если файл не нуждается во вращении.
config()source public
config( array $config array() )
Устанавливает защищенные свойства на основе предоставленной конфигурации
Параметры
- массив
$configнеобязательно массив() - Конфигурация движка
Возвращает
массивПереопределяет
BaseLog::config() write()source public
write( string $type , string $message )
Реализует запись в файлы журналов.
Параметры
- строка
$type - Тип журнала, который вы создаете.
- строка
$message - Сообщение, которое вы хотите записать в журнал.
Возвращает
булево значениеУспех записи.
Подробное описание свойств
$_defaultssource
protected массив
Значения по умолчанию конфигурации
См. также
FileLog::__construct()array(
'path' => LOGS,
'file' => null,
'types' => null,
'scopes' => array(),
'rotate' => 10,
'size' => 10485760, // 10MB
'mask' => null,
) $_sizesource
protected целое число
Максимальный размер файла, используется для вращения файлов журнала.
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/2.10/class-FileLog.html