Collaboration diagram for ilLog:

Public Member Functions
	__construct ($a_log_path, $a_log_file, $a_tag="", $a_enabled=true, $a_log_level=null)
	constructor More...

	setLogLevel ($a_log_level)
	set global log level More...

	checkLogLevel ($a_log_level)
	determine log level More...

	setLogFormat ($a_format)

	getLogFormat ()

	setPath ($a_str)

	setFilename ($a_str)

	setTag ($a_str)

	writeLanguageLog ($a_topic, $a_lang_key)
	special language checking routine More...

	writeWarning ($a_message)
	special warning message More...

	logError ($a_code, $a_msg)
	this function is automatically called by class.ilErrorHandler in case of an error To log manually please use $this::write @access public More...

	write ($a_msg, $a_log_level=null)
	logging More...

	logStack ($a_message='')

	dump ($a_var, $a_log_level=null)
	Dump a variable to the log. More...

	__destruct ()

	delete ()
	delete logfile More...

Data Fields
	$path

	$filename

	$tag

	$log_format

	$FATAL

	$WARNING

	$MESSAGE

	$fp = false

Private Member Functions
	open ()
	Open log file. More...

Detailed Description

logging

this class provides a logging feature to the application this class is easy to use. call the constructor with e.g. $log = new Log(); you can give a filename if you want, else the defaultfilename is used.

Author: Peter Gabriel pgabr.nosp@m.iel@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

Id: class.ilLog.php 16024 2008-02-19 13:07:07Z akill

Definition at line 18 of file class.ilLog.php.

Constructor & Destructor Documentation

◆ __construct()

ilLog::__construct	(	$a_log_path,
		$a_log_file,
		$a_tag = `""`,
		$a_enabled = `true`,
		$a_log_level = `null`
	)

constructor

set the filename

Parameters

string

Returns: boolean @access public

Exceptions

ilLogException

Definition at line 64 of file class.ilLog.php.

    {
        // init vars
        include_once './Services/Logging/classes/public/class.ilLogLevel.php';
        
        $this->FATAL = ilLogLevel::CRITICAL;
        $this->WARNING = ilLogLevel::WARNING;
        $this->MESSAGE = ilLogLevel::INFO;
  
        $this->default_log_level = $this->WARNING;
        $this->current_log_level = $this->setLogLevel($a_log_level);
 
        $this->path = ($a_log_path) ? $a_log_path : ILIAS_ABSOLUTE_PATH;
        $this->filename = ($a_log_file) ? $a_log_file : "ilias.log";
        $this->tag = ($a_tag == "") ? "unknown" : $a_tag;
        $this->enabled = (bool) $a_enabled;
 
        $this->setLogFormat(@date("[y-m-d H:i:s] ") . "[" . $this->tag . "] ");
        
        $this->open();
    }

References $WARNING, ilLogLevel\CRITICAL, ilLogLevel\INFO, open(), setLogFormat(), setLogLevel(), and ilLogLevel\WARNING.

Here is the call graph for this function:

◆ __destruct()

ilLog::__destruct ( )

Definition at line 296 of file class.ilLog.php.

    {
        @fclose($this->fp);
    }

Member Function Documentation

◆ checkLogLevel()

ilLog::checkLogLevel ( $a_log_level )

determine log level

@access private

Parameters

integer log level

Returns: integer checked log level

Definition at line 114 of file class.ilLog.php.

    {
        if (empty($a_log_level)) {
            return $this->default_log_level;
        }
 
        $level = (int) $a_log_level;
        
        if ($a_log_level != (int) $a_log_level) {
            return $this->default_log_level;
        }
        
        return $level;
    }

Referenced by write().

Here is the caller graph for this function:

◆ delete()

ilLog::delete ( )

delete logfile

Definition at line 306 of file class.ilLog.php.

    {
        if (@is_file($this->path . "/" . $this->filename)) {
            @unlink($this->path . "/" . $this->filename);
        }
    }

◆ dump()

ilLog::dump	(	$a_var,
		$a_log_level = `null`
	)

Dump a variable to the log.

Parameters

return

Definition at line 275 of file class.ilLog.php.

    {
        $this->write(print_r($a_var, true), $a_log_level);
    }

References write().

Here is the call graph for this function:

◆ getLogFormat()

ilLog::getLogFormat ( )

Definition at line 134 of file class.ilLog.php.

    {
        return $this->log_format;
    }

References $log_format.

Referenced by write().

Here is the caller graph for this function:

◆ logError()

ilLog::logError	(	$a_code,
		$a_msg
	)

this function is automatically called by class.ilErrorHandler in case of an error To log manually please use $this::write @access public

Parameters

integer	error level code from PEAR_Error
string	error message

See also: this::write

Definition at line 201 of file class.ilLog.php.

    {
        switch ($a_code) {
            case "3":
                return; // don't log messages
                $error_level = "message";
                break;
 
            case "2":
                $error_level = "warning";
                break;
 
            case "1":
                $error_level = "fatal";
                break;
                
            default:
                $error_level = "unknown";
                break;
        }
        
        $this->write("ERROR (" . $error_level . "): " . $a_msg);
    }

References write().

Here is the call graph for this function:

◆ logStack()

ilLog::logStack ( $a_message = '' )

Definition at line 260 of file class.ilLog.php.

    {
        try {
            throw new Exception($a_message);
        } catch (Exception $e) {
            $this->write($e->getTraceAsString());
        }
    }

References Vendor\Package\$e, and write().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ open()

ilLog::open ( )

private

Open log file.

Exceptions

ilLogException

Definition at line 284 of file class.ilLog.php.

    {
        if (!$this->fp) {
            $this->fp = @fopen($this->path . "/" . $this->filename, "a");
        }
 
        if (!$this->fp && $this->enabled) {
            include_once("./Services/Logging/exceptions/class.ilLogException.php");
            throw new ilLogException('Unable to open log file for writing. Please check setup path to log file and possible write access.');
        }
    }

Referenced by __construct(), and write().

Here is the caller graph for this function:

◆ setFilename()

ilLog::setFilename ( $a_str )

Definition at line 150 of file class.ilLog.php.

    {
        $this->filename = $a_str;
        
        // on filename change reload close current file
        if ($this->fp) {
            fclose($this->fp);
            $this->fp = null;
        }
    }

◆ setLogFormat()

ilLog::setLogFormat ( $a_format )

Definition at line 129 of file class.ilLog.php.

    {
        $this->log_format = $a_format;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setLogLevel()

ilLog::setLogLevel ( $a_log_level )

set global log level

@access private

Parameters

integer log level

Returns: integer log level

Definition at line 93 of file class.ilLog.php.

    {
        switch (strtolower($a_log_level)) {
            case "fatal":
                return $this->FATAL;
            case "warning":
                return $this->WARNING;
            case "message":
                return $this->MESSAGE;
            default:
                return $this->default_log_level;
        }
    }

References $FATAL, $MESSAGE, and $WARNING.

Referenced by __construct().

Here is the caller graph for this function:

◆ setPath()

ilLog::setPath ( $a_str )

Definition at line 139 of file class.ilLog.php.

    {
        $this->path = $a_str;
 
        // on filename change reload close current file
        if ($this->fp) {
            fclose($this->fp);
            $this->fp = null;
        }
    }

◆ setTag()

ilLog::setTag ( $a_str )

Definition at line 161 of file class.ilLog.php.

    {
        $this->tag = $a_str;
    }

◆ write()

ilLog::write	(	$a_msg,
		$a_log_level = `null`
	)

logging

this method logs anything you want. It appends a line to the given logfile. Datetime and client id is appended automatically You may set the log level in each call. Leave blank to use default log level specified in ilias.ini: [log] level = "<level>" possible values are fatal,warning,message

@access public

Parameters

string	error message
integer	log level (optional)

Definition at line 239 of file class.ilLog.php.

    {
        if ($this->enabled and $this->current_log_level >= $this->checkLogLevel($a_log_level)) {
            $this->open();
            
            if ($this->fp == false) {
                //die("Logfile: cannot open file. Please give Logfile Writepermissions.");
            }
 
            if (fwrite($this->fp, $this->getLogFormat() . $a_msg . "\n") == -1) {
                //die("Logfile: cannot write to file. Please give Logfile Writepermissions.");
            }
            
            // note: logStack() calls write() again, so do not make this call
            // if no log level is given
            if ($a_log_level == $this->FATAL) {
                $this->logStack();
            }
        }
    }

References checkLogLevel(), getLogFormat(), logStack(), and open().

Referenced by dump(), logError(), logStack(), ilOrgUnitSimpleImportGUI\startImport(), ilOrgUnitSimpleUserImportGUI\startImport(), writeLanguageLog(), and writeWarning().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeLanguageLog()

ilLog::writeLanguageLog	(	$a_topic,
		$a_lang_key
	)

special language checking routine

only add a log entry to the logfile if there isn't a log entry for the topic

Parameters

string @access public

Definition at line 175 of file class.ilLog.php.

    {
        //TODO: go through logfile and search for the topic
        //only write the log if the error wasn't reported yet
        $this->write("Language (" . $a_lang_key . "): topic -" . $a_topic . "- not present", $this->MESSAGE);
    }

References write().

Here is the call graph for this function:

◆ writeWarning()

ilLog::writeWarning ( $a_message )

special warning message

Parameters

string @access public

Definition at line 188 of file class.ilLog.php.

    {
        $this->write("WARNING: " . $a_message);
    }

References write().

Here is the call graph for this function:

Field Documentation

◆ $FATAL

ilLog::$FATAL

Definition at line 36 of file class.ilLog.php.

Referenced by setLogLevel().

◆ $filename

ilLog::$filename

Definition at line 27 of file class.ilLog.php.

◆ $fp

ilLog::$fp = false

Definition at line 52 of file class.ilLog.php.

◆ $log_format

ilLog::$log_format

Definition at line 29 of file class.ilLog.php.

Referenced by getLogFormat().

◆ $MESSAGE

ilLog::$MESSAGE

Definition at line 50 of file class.ilLog.php.

Referenced by setLogLevel().

◆ $path

ilLog::$path

Definition at line 26 of file class.ilLog.php.

◆ $tag

ilLog::$tag

Definition at line 28 of file class.ilLog.php.

◆ $WARNING

ilLog::$WARNING

Definition at line 43 of file class.ilLog.php.

Referenced by __construct(), and setLogLevel().

The documentation for this class was generated from the following file:

Services/Logging/classes/class.ilLog.php

Public Member Functions

Data Fields

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ checkLogLevel()

◆ delete()

◆ dump()

◆ getLogFormat()

◆ logError()

◆ logStack()

◆ open()

◆ setFilename()

◆ setLogFormat()

◆ setLogLevel()

◆ setPath()

◆ setTag()

◆ write()

◆ writeLanguageLog()

◆ writeWarning()

Field Documentation

◆ $FATAL

◆ $filename

◆ $fp

◆ $log_format

◆ $MESSAGE

◆ $path

◆ $tag

◆ $WARNING