EnglishRisolutoLogクラス(risoluto_log.php) - Risoluto - Simple Framework for PHP - Wiki - Risolut...

Return

Class reference: RisolutoLog Class(risoluto_log.php)

Outline

1. Class reference: RisolutoLog Class(risoluto_log.php)
   1. Abstraction of the class
   2. How to generate class instance
   3. What this class depends on
   4. Content of the class
      1. Class variable
      2. Class method

Abstraction of the class

This class provides general log output function. Log output is named as “risoluto_YYYYMMDD.log” and stored under RISOLUTO_LOGS. There is concept of log level and it does not output below specified level written in risoluto.ini (less urgent ones). This enables not to output by only one setting in real operation even lots of log output logics are included for the purpose of debug.

How to generate class instance

 require_once( RISOLUTO_FUNC . 'risoluto_log.php' );
 
 $instance = RisolutoLog::singleton();

What this class depends on

• RisolutoConf class

Content of the class

Class variable

$obj_instance

Scope	private(static)
Type	object
Usage	Since this is singleton pattern, it keeps the instance itself.

$str_logPath

Scope	private(static)
Type	string
Usage	it keeps full path to the output log file.

$arr_loglevel

Scope	private
Type	array
Usage	it keeps log level information.

Defined contents are as below:

 array(
    "stop"   => -1
  , "emerg"  =>  0
  , "alert"  =>  1
  , "crit"   =>  2
  , "error"  =>  3
  , "warn"   =>  4
  , "notice" =>  5
  , "info"   =>  6
  , "debug"  =>  7
 );

Class method

__construct()

Scope	private
Parameter	none
Return value	none
Usage	constructor of this class (no actual processing)

__clone()

Scope	private
Parameter	none
Return value	none
Type of return value	none
Usage	clone method of this class (no actual processing)

singleton()

Scope	public(static)
Parameter	none
Return value	none
Type of return value	none
Usage	return instance of this class after generating it by singleton pattern

logging()

Scope	public
Parameter	string $loglvl log level （stop|emerg|alert|crit|error|warn|notice|info|debug）/string $logmes message to output
Return value	result of function execution ( true: normal termination / false: abnormal termination )
Type of return value	boolean
Usage	to output message specified by the parameter in log level specified by the parameter.

 $result = $instance->logging( 'debug', 'DEBUG LOG' );
 
 var_dump( $result );

Return