Spec-Zone.ru › CakePHP 2.8

Класс FileLog

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

BaseLog реализует CakeLogInterface
Extended by FileLog
Пакет: Cake\Журнал\Двигатель
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение: Cake/Log/Engine/FileLog.php

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

  • $_defaults protected
    array
    Значения по умолчанию для конфигурации
  • $_file protected
    string
    Имя файла журнала
  • $_path protected
    string
    Путь для сохранения файлов журнала.
  • $_size protected
    integer
    Максимальный размер файла, используемый для вращения файлов журнала.

Унаследованные свойства

  • _config

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

  • __construct() public
    Создает новый логгер файлов.
  • _getFilename() protected
    Получить имя файла
  • _rotateFile() protected

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

  • config() public
    Устанавливает защищенные свойства на основе предоставленной конфигурации
  • write() public
    Реализует запись в файлы журнала.

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

__construct()source public

__construct( array $config array() )

Создает новый логгер файлов.

Конфигурация

  • types строка или массив, уровни, которые интересуют движок
  • scopes строка или массив, области, которые интересуют движок
  • file Имя файла журнала
  • path Путь для сохранения журналов.
  • size Используется для реализации базового вращения файлов журнала. Если размер файла журнала достигает указанного размера, существующий файл переименовывается путем добавления отметки времени к имени файла, и создается новый файл журнала. Может быть целым значением в байтах или строкой в удобочитаемом формате, например, '10MB', '100KB' и т.д.
  • 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,
)

$_filesource

protected строка

Имя файла журнала

null

$_pathsource

protected строка

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

null

$_sizesource

protected целое число

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

null

© 2005–2016 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.
http://api.cakephp.org/2.8/class-FileLog.html

Spec-Zone.ru

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