include/SugarLogger/SugarLogger.php

Show: inherited
Table of Contents

\SugarLogger

Package: SugarCRM

Default SugarCRM Logger

Parent(s)
\LoggerTemplate
Api
 

Properties

Propertyprotected  $dateFormat= ''%c''
Default value'%c'Details
Type
n/a
Propertyprotected  $date_suffix= '""'
Default value""Details
Type
n/a
Propertyprotected  $ext= ''.log''
Default value'.log'Details
Type
n/a
Propertypublic  $filename_suffix= 'array( //bug#50265: Added none option for previous version users "" => "None", "%m_%Y" => "Month_Year", "%d_%m" => "Day_Month", "%m_%d_%y" => "Month_Day_Year", )'
static

used for config screen

Default valuearray( //bug#50265: Added none option for previous version users "" => "None", "%m_%Y" => "Month_Year", "%d_%m" => "Day_Month", "%m_%d_%y" => "Month_Day_Year", )Details
Type
n/a
Propertyprotected  $filesuffix= '""'
Default value""Details
Type
n/a
Propertyprotected  $fp= 'false'

Logger file handle

Default valuefalseDetails
Type
n/a
Propertyprotected  $initialized= 'false'

Let's us know if we've initialized the logger file

Default valuefalseDetails
Type
n/a
Propertyprotected  $logSize= ''10MB''
Default value'10MB'Details
Type
n/a
Propertyprotected  $log_dir= ''.''
Default value'.'Details
Type
n/a
Propertyprotected  $logfile= ''sugarcrm''

properties for the SugarLogger

Default value'sugarcrm'Details
Type
n/a
Propertyprotected  $maxLogs= '10'
Default value10Details
Type
n/a

Methods

methodpublic__construct( ) : void

Constructor

Reads the config file for logger settings

methodpublic__destruct( ) : void

Destructor

Closes the SugarLogger file handle

methodpublic__get(  $key ) : void

Parameters
Name Type Description
$key
methodpublic__wakeup( ) : void

This is needed to prevent unserialize vulnerability

methodprotected_attemptToCreateIfNecessary( ) : void

Creates the SugarLogger file if it doesn't exist

methodprotected_doInitialization( ) : void

Handles the SugarLogger initialization

methodprotected_fileCanBeCreatedAndWrittenTo( ) : void

Checks to see if the SugarLogger file can be created and written to

methodpublicgetLogFileName( ) : void

Used by the diagnostic tools to get SugarLogger log file information

methodpublicgetLogFileNameWithPath( ) : void

Used by the diagnostic tools to get SugarLogger log file information

methodpubliclog(  $level,  $message ) : void

see LoggerTemplate::log()

Parameters
Name Type Description
$level
$message
methodprotectedrollLog(  $force = false ) : void

rolls the logger file to start using a new file

Parameters
Name Type Description
$force
Documentation was generated by DocBlox 0.18.1.