Версия: 6.x
burger close
Класс AbstractLog
Граф наследования:AbstractLog:
LogAlerts LogImportYml LogTelephony LogExchange LogExternalRequest LogCron LogDbAdapter LogCashRegister LogDelivery LogDeliveryCdek LogOnlinePay LogPaymentYandexKassaApi LogSupport

Подробное описание

Базовый класс для создания классов логирования

Открытые члены

 getIdentifier ()
 
 getTitle ()
 
 getDescription ()
 
 getLogLevelList ()
 
 getDefaultMaxFileSize ()
 
 getReaderForSite (int $site_id)
 
 write (string $text, string $level=null)
 
 getFileLinks ()
 
 getSiteId ()
 
 setSiteId (int $site_id)
 
 isEnabled ()
 
 isEnabledLevel (string $level)
 
 getMaxFileSize ()
 

Открытые статические члены

static getInstance ()
 

Поля данных

const LEVEL_INFO = 'info'
 

Защищенные члены

 __construct ()
 
 selfLogLevelList ()
 
 log ()
 
 getFileName ()
 
 getFileNameBySite (int $site_id)
 
 setEnabled (bool $enabled)
 
 setEnabledLevels (array $enabled_levels)
 
 setMaxFileSize (int $max_file_size)
 

Статические защищенные данные

static $instances = []
 

Конструктор(ы)

__construct ( )
protected

Singleton, необходимо использовать ::getInstance() для создания объекта

Методы

getDefaultMaxFileSize ( )

Возвращает максимальный размер лог-файла по умолчанию (в мегабайтах)

Возвращает
int
getDescription ( )

Возвращает описание класса логирования

Возвращает
string
getFileLinks ( )

Возвращает ссылки на существующие лог-файлы

Возвращает
string[]
Исключения
DbException
getFileName ( )
protected

Возвращает имя лог-файла на диске

Возвращает
string
getFileNameBySite ( int  $site_id)
protected

Возвращает имя лог-файла для указанного сайта

Аргументы
int$site_id- id сайта
Возвращает
string
getIdentifier ( )
abstract

Возвращает идентификатор класса логирования

Возвращает
string
static getInstance ( )
static

Возвращает единственный экземпляр текущего класса

Возвращает
static
getLogLevelList ( )
final

Возвращает список допустимых уровней лог-записей Использует статическое кэширование

Возвращает
string[]
getMaxFileSize ( )

Возвращает максимальный размер лог-файла (в мегабайтах)

Возвращает
int
getReaderForSite ( int  $site_id)

Возвращает объект LogReader для лог файла для сайта $site_id

Аргументы
int$site_idID сайта
Возвращает
LogReader
Исключения
RSException
getSiteId ( )

Возвращает id текущего сайта

Возвращает
mixed
getTitle ( )
abstract

Возвращает название класса логирования

Возвращает
string
isEnabled ( )

Возвращает включено ли логирование

Возвращает
bool
isEnabledLevel ( string  $level)

Возвращает разрешена ли запись логов указанного уровня

Аргументы
string$level- проверяемый уровень лог-записей
Возвращает
bool
log ( )
protected

Возвращает объект лог-файла, который непосредствнно пишет данные в файл

Возвращает
Log
selfLogLevelList ( )
protected

Возвращает список допустимых уровней лог-записей Уровни логирования используются для настройки детальности логирования и фильтрации записей при просмотре лог-файлов

Возвращает
string[]
setEnabled ( bool  $enabled)
protected

Устанавливает включено ли логирование

Аргументы
bool$enabled- значение
Возвращает
void
setEnabledLevels ( array  $enabled_levels)
protected

Устанавливает разрешённые для записи уровни логов

Аргументы
string[]$enabled_levels - значение
Возвращает
void
setMaxFileSize ( int  $max_file_size)
protected

Устанавливает максимальный размер лог-файла (в мегабайтах)

Аргументы
int$max_file_size- значение
Возвращает
void
setSiteId ( int  $site_id)

Устанавливает id текущего сайта

Аргументы
int$site_id
write ( string  $text,
string  $level = null 
)

Производит запись в лог-файл

Аргументы
string$text- лог-запись
string$level- уровень логирования, если не указан - используется первый уровень в списке

Поля

$instances = []
staticprotected
const LEVEL_INFO = 'info'