This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilLog:

Public Member Functions
	__construct (string $a_log_path, string $a_log_file, string $a_tag="", bool $a_enabled=true, ?int $a_log_level=null)

	setLogLevel (int $a_log_level)

	checkLogLevel ($a_log_level)

	setLogFormat (string $a_format)

	getLogFormat ()

	setPath (string $a_str)

	setFilename (string $a_str)

	setTag (string $a_str)

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

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

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

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

	logStack (string $a_message='')

	dump ($a_var, ?int $a_log_level=null)

	delete ()
	delete logfile More...

Protected Attributes
int	$default_log_level

int	$current_log_level

bool	$enabled

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

Private Attributes
string	$path = ''

string	$filename = ''

string	$tag = ''

string	$log_format = ''

int	$FATAL
	Log level 10: Log only fatal errors that could lead to serious problems. More...

int	$WARNING
	Log level 20: This is the standard log level that is set if no level is given. More...

int	$MESSAGE
	Log level 30: Logs messages and notices that are less important for system functionality like not translated language values. More...

	$fp = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Deprecated:: 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 30 of file class.ilLog.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

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

       {
         // init vars
 
         $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->default_log_level);
 
         $this->path = ($a_log_path) ?: ILIAS_ABSOLUTE_PATH;
         $this->filename = ($a_log_file) ?: "ilias.log";
         $this->tag = ($a_tag == "") ? "unknown" : $a_tag;
         $this->enabled = $a_enabled;
         $this->setLogFormat(date("[y-m-d H:i:s] ") . "[" . $this->tag . "] ");
         $this->open();
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkLogLevel()

ilLog::checkLogLevel ( $a_log_level )

Parameters

int $a_log_level

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

References $default_log_level, and ILIAS\Repository\int().

Referenced by write().

                                                : int
     {
         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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilLog::delete ( )

delete logfile

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

Referenced by ilSurveyQuestionpoolExport\buildExportFileXML().

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

Here is the caller graph for this function:

◆ dump()

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

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

References write().

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

Here is the call graph for this function:

◆ getLogFormat()

ilLog::getLogFormat ( )

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

References $log_format.

Referenced by write().

                                   : string
     {
         return $this->log_format;
     }

Here is the caller graph for this function:

◆ logError()

ilLog::logError	(	string	$a_code,
		string	$a_msg
	)

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

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

References write().

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

Here is the call graph for this function:

◆ logStack()

ilLog::logStack ( string $a_message = '' )

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

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

Referenced by write().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ open()

ilLog::open ( )

private

Open log file.

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

Referenced by __construct(), and write().

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

Here is the caller graph for this function:

◆ setFilename()

ilLog::setFilename ( string $a_str )

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

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

◆ setLogFormat()

ilLog::setLogFormat ( string $a_format )

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

Referenced by __construct().

                                                   : void
     {
         $this->log_format = $a_format;
     }

Here is the caller graph for this function:

◆ setLogLevel()

ilLog::setLogLevel ( int $a_log_level )

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

References $default_log_level, $FATAL, $MESSAGE, and $WARNING.

Referenced by __construct().

                                                  : int
     {
         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;
         }
     }

Here is the caller graph for this function:

◆ setPath()

ilLog::setPath ( string $a_str )

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

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

◆ setTag()

ilLog::setTag ( string $a_str )

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

                                          : void
     {
         $this->tag = $a_str;
     }

◆ write()

ilLog::write	(	string	$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

Parameters

?int	$a_log_level

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

References checkLogLevel(), getLogFormat(), ILIAS\Repository\int(), logStack(), and open().

Referenced by dump(), ilObjGlossary\exportFileItems(), ilObjContentObject\exportFileItems(), ilStructureObject\exportXML(), ilObjGlossary\exportXML(), ilObjContentObject\exportXML(), ilObjGlossary\exportXMLGlossaryItems(), ilObjGlossary\exportXMLMediaObjects(), ilObjContentObject\exportXMLMediaObjects(), ilObjContentObject\exportXMLPageObjects(), logError(), logStack(), ilOrgUnitSimpleUserImportGUI\startImport(), ilOrgUnitSimpleImportGUI\startImport(), writeLanguageLog(), and writeWarning().

                                                              : void
     {
         $a_log_level = (int) $a_log_level;
         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();
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeLanguageLog()

ilLog::writeLanguageLog	(	string	$a_topic,
		string	$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

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

References write().

                                                                          : void
     {
         //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);
     }

Here is the call graph for this function:

◆ writeWarning()

ilLog::writeWarning ( string $a_message )

special warning message

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

References write().

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

Here is the call graph for this function:

Field Documentation

◆ $current_log_level

int ilLog::$current_log_level

protected

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

◆ $default_log_level

int ilLog::$default_log_level

protected

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

Referenced by checkLogLevel(), and setLogLevel().

◆ $enabled

bool ilLog::$enabled

protected

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

◆ $FATAL

int ilLog::$FATAL

private

Log level 10: Log only fatal errors that could lead to serious problems.

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

Referenced by setLogLevel().

◆ $filename

string ilLog::$filename = ''

private

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

◆ $fp

ilLog::$fp = null

private

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

◆ $log_format

string ilLog::$log_format = ''

private

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

Referenced by getLogFormat().

◆ $MESSAGE

int ilLog::$MESSAGE

private

Log level 30: Logs messages and notices that are less important for system functionality like not translated language values.

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

Referenced by setLogLevel().

◆ $path

string ilLog::$path = ''

private

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

◆ $tag

string ilLog::$tag = ''

private

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

◆ $WARNING

int ilLog::$WARNING

private

Log level 20: This is the standard log level that is set if no level is given.

Definition at line 45 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

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkLogLevel()

◆ delete()

◆ dump()

◆ getLogFormat()

◆ logError()

◆ logStack()

◆ open()

◆ setFilename()

◆ setLogFormat()

◆ setLogLevel()

◆ setPath()

◆ setTag()

◆ write()

◆ writeLanguageLog()

◆ writeWarning()

Field Documentation

◆ $current_log_level

◆ $default_log_level

◆ $enabled

◆ $FATAL

◆ $filename

◆ $fp

◆ $log_format

◆ $MESSAGE

◆ $path

◆ $tag

◆ $WARNING