Класс yii\log\FileTarget
| Наследование | yii\log\FileTarget » yii\log\Target » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/log/FileTarget.php |
FileTarget записывает сообщения лога в файл.
Файл лога задаётся через $logFile. Если размер файла лога превышает $maxFileSize (в килобайтах), выполняется ротация, которая переименовывает текущий файл лога, добавляя к имени суффикс '.1'. Все существующие файлы лога перемещаются назад на одну позицию, т.е. '.2' в '.3', '.1' в '.2' и так далее. Свойство $maxLogFiles определяет, сколько файлов истории необходимо сохранить.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список присоединённых к этому компоненту поведений | yii\base\Component |
| $categories | массив | Список категорий сообщений, которые интересуют этот целевой объект. | yii\log\Target |
| $dirMode | целое число | Разрешения для вновь созданных каталогов. | yii\log\FileTarget |
| $enableRotation | булево | Определяет, будут ли файлы лога вращаться при достижении определённого максимального размера. | yii\log\FileTarget |
| $enabled | булево | Включить или выключить этот целевой объект лога. | yii\log\Target |
| $except | массив | Список категорий сообщений, которые этот целевой объект игнорирует. | yii\log\Target |
| $exportInterval | целое число | Количество сообщений, которые необходимо накопить перед экспортом. | yii\log\Target |
| $fileMode | целое число | Разрешения для вновь созданных файлов лога. | yii\log\FileTarget |
| $levels | целое число | Уровни сообщений, которые интересуют этот целевой объект. | yii\log\Target |
| $logFile | строка | Путь к файлу лога или алиас пути. | yii\log\FileTarget |
| $logVars | массив | Список предопределённых переменных PHP, которые необходимо записать в сообщении. | yii\log\Target |
| $maxFileSize | целое число | Максимальный размер файла лога в килобайтах. | yii\log\FileTarget |
| $maxLogFiles | целое число | Количество файлов лога, используемых для ротации. | yii\log\FileTarget |
| $messages | массив | Сообщения, полученные от логгера до сих пор этим целевым объектом лога. | yii\log\Target |
| $prefix | вызываемый объект | Вызываемый объект PHP, возвращающий строку, которая должна быть префиксом каждого экспортируемого сообщения. | yii\log\Target |
| $rotateByCopy | булево | Вращать файлы лога копированием и обрезанием, а не переименованием. | yii\log\FileTarget |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод по имени, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, по которым должен вести себя этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, может ли свойство быть прочитано. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, может ли свойство быть установлено. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| collect() | Обрабатывает заданные сообщения журнала. | yii\log\Target |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| export() | Записывает сообщения журнала в файл. | yii\log\FileTarget |
| filterMessages() | Фильтровать заданные сообщения в соответствии с их категориями и уровнями. | yii\log\Target |
| formatMessage() | Форматирует сообщение журнала для отображения как строки. | yii\log\Target |
| getBehavior() | Возвращает объект поведения с заданным именем. | yii\base\Component |
| getBehaviors() | Возвращает все поведения, прикреплённые к этому компоненту. | yii\base\Component |
| getLevels() | yii\log\Target | |
| getMessagePrefix() | Возвращает строку, которая будет добавляться в префикс к данному сообщению. | yii\log\Target |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, присоединённый к заданному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует маршрут. | yii\log\FileTarget |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| setLevels() | Устанавливает уровни сообщений, в которых заинтересован этот целевой компонент. | yii\log\Target |
| trigger() | Вызывает событие. | yii\base\Component |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| getContextMessage() | Генерирует контекстную информацию для записи в журнал. | yii\log\Target |
| rotateFiles() | Производит ротацию файлов журнала. | yii\log\FileTarget |
Подробное описание свойств
$dirMode открытое свойство
Разрешения для вновь созданных каталогов. Это значение будет использовано функцией PHP chmod(). Не будет применено umask. По умолчанию 0775, что означает, что каталог доступен для чтения и записи владельцу и группе, но только для чтения другим пользователям.
public integer $dirMode = 0775
$enableRotation открытое свойство (доступно с версии 2.0.3)
Надо ли вращать файлы журнала, когда они достигают определенного максимального размера. Вращение журналов включено по умолчанию. Это свойство позволяет отключить его, когда вы настроили внешние средства для вращения журнала на вашем сервере.
public boolean $enableRotation = true
$fileMode открытое свойство
Разрешения для вновь созданных файлов журнала. Это значение будет использовано функцией PHP chmod(). Не будет применено umask. Если не задано, разрешения будут определены текущей средой.
public integer $fileMode = null
$logFile открытое свойство
Путь к файлу журнала или псевдоним пути. Если не задано, будет использован файл "@runtime/logs/app.log". Каталог, содержащий файлы журнала, будет автоматически создан, если он не существует.
public string $logFile = null
$maxFileSize открытое свойство
Максимальный размер файла журнала в килобайтах. По умолчанию 10240, что соответствует 10 МБ.
public integer $maxFileSize = 10240
$maxLogFiles открытое свойство
Количество файлов журнала, используемых для вращения. По умолчанию 5.
public integer $maxLogFiles = 5
$rotateByCopy открытое свойство
Вращать файлы журнала копированием и обнулением вместо переименования файлов. По умолчанию true для большей совместимости с программами просмотра журналов и системами Windows, которые плохо работают с переименованием открытых файлов. Вращение переименованием, однако, немного быстрее.
Проблема с системами Windows, где функция rename() не работает с файлами, которые открыты каким-либо процессом, описана в комментарии Мартина Пеллетье в документации PHP. Установив rotateByCopy в true, вы можете обойти эту проблему.
public boolean $rotateByCopy = true
Подробное описание методов
export() открытый метод
Записывает сообщения журнала в файл.
| public void export ( ) | ||
|---|---|---|
| throws | yii\base\InvalidConfigException |
если невозможно открыть файл журнала для записи |
init() открытый метод
Инициализирует маршрут.
Этот метод вызывается после создания маршрута менеджером маршрутов.
| public void init ( ) |
|---|
rotateFiles() защищённый метод
Производит ротацию файлов журнала.
| protected void rotateFiles ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-log-filetarget.html
