Error Handling & global info handling uses PEAR error class. More...

Inheritance diagram for ilErrorHandling:

Collaboration diagram for ilErrorHandling:

Public Member Functions
	ilErrorHandling ()
	Constructor @access public. More...

	getLastError ()

	errorHandler ($a_error_obj)
	defines what has to happen in case of error @access private More...

	getMessage ()

	setMessage ($a_message)

	appendMessage ($a_message)

	handleUncaughtException (Exception $e)
	Called for each uncaught exception. More...

	handleRuntimeErrors ($a_error_code, $a_error_message, $a_error_file, $a_error_line)
	We should enhance the error reporting in future releases (funding required). More...

Public Member Functions inherited from PEAR
	PEAR ($error_class=null)
	Constructor. More...

	_PEAR ()
	Destructor (the emulated type of...). More...

&	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...

	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes. More...

	isError ($data, $code=null)
	Tell whether a value is a PEAR error. More...

	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...

	expectError ($code=' *')
	This method is used to tell which errors you expect to get. More...

	popExpect ()
	This method pops one element off the expected error codes stack. More...

	_checkDelExpect ($error_code)
	This method checks unsets an error code if available. More...

	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack. More...

&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...

&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options. More...

	staticPushErrorHandling ($mode, $options=null)

	staticPopErrorHandling ()

	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack. More...

	popErrorHandling ()
	Pop the last error handler used. More...

	loadExtension ($ext)
	OS independant PHP extension load. More...

Static Public Member Functions
static	_ilErrorWriter ($errno, $errstr, $errfile, $errline)
	This is used in Soap calls to write PHP error in ILIAS Logfile Not used yet!!! More...

Data Fields
	$DEBUG_ENV

	$FATAL

	$WARNING

	$MESSAGE

Data Fields inherited from PEAR
	$_debug = false

	$_default_error_mode = null

	$_default_error_options = null

	$_default_error_handler = ''

	$_error_class = 'PEAR_Error'

	$_expected_errors = array()

Protected Member Functions
	formatBacktraceArray (array $a_backtrace)

	translateErrorCode ($error_code)
	Translates an integer error code to the corresponding error string. More...

Detailed Description

Error Handling & global info handling uses PEAR error class.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om; Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version: $Id$

Todo:: when an error occured and clicking the back button to return to previous page the referer-var in session is deleted -> server error

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

Member Function Documentation

◆ _ilErrorWriter()

static ilErrorHandling::_ilErrorWriter	(	$errno,
		$errstr,
		$errfile,
		$errline
	)

static

This is used in Soap calls to write PHP error in ILIAS Logfile Not used yet!!!

@access public

Parameters

Definition at line 244 of file class.ilErrorHandling.php.

        {
                global $ilLog;
                
                switch($errno)
                {
                        case E_USER_ERROR:
                                $ilLog->write('PHP errror: '.$errstr.'. FATAL error on line '.$errline.' in file '.$errfile);
                                unset($ilLog);
                                exit(1);
                        
                        case E_USER_WARNING:
                                $ilLog->write('PHP warning: ['.$errno.'] '.$errstr.' on line '.$errline.' in file '.$errfile);
                                break;
                        
                }                               
                return true;
        }

References $ilLog, and exit.

◆ appendMessage()

ilErrorHandling::appendMessage ( $a_message )

Definition at line 226 of file class.ilErrorHandling.php.

        {
                if($this->getMessage())
                {
                        $this->message .= "<br /> ";
                }
                $this->message .= $a_message;
        }

References getMessage().

Here is the call graph for this function:

◆ errorHandler()

ilErrorHandling::errorHandler ( $a_error_obj )

defines what has to happen in case of error @access private

Parameters

object Error

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

        {
                global $log;
 
                // see bug 18499 (some calls to raiseError do not pass a code, which leads to security issues, if these calls
                // are done due to permission checks)
                if ($a_error_obj->getCode() == null)
                {
                        $a_error_obj->code = $this->WARNING;
                }
 
                $this->error_obj =& $a_error_obj;
//echo "-".$_SESSION["referer"]."-";
                if ($_SESSION["failure"] && substr($a_error_obj->getMessage(), 0, 22) != "Cannot find this block")
                {
                        $m = "Fatal Error: Called raise error two times.<br>".
                                "First error: ".$_SESSION["failure"].'<br>'.
                                "Last Error:". $a_error_obj->getMessage();
                        //return;
                        $log->logError($a_error_obj->getCode(), $m);
                        unset($_SESSION["failure"]);
                        die ($m);
                }
 
                if (substr($a_error_obj->getMessage(), 0, 22) == "Cannot find this block")
                {
                        if (DEVMODE == 1)
                        {
                                echo "<b>DEVMODE</b><br><br>";
                                echo "<b>Template Block not found.</b><br>";
                                echo "You used a template block in your code that is not available.<br>";
                                echo "Native Messge: <b>".$a_error_obj->getMessage()."</b><br>";
                                if (is_array($a_error_obj->backtrace))
                                {
                                        echo "Backtrace:<br>";
                                        foreach ($a_error_obj->backtrace as $b)
                                        {
                                                if ($b["function"] == "setCurrentBlock" &&
                                                        basename($b["file"]) != "class.ilTemplate.php")
                                                {
                                                        echo "<b>";
                                                }
                                                echo "File: ".$b["file"].", ";
                                                echo "Line: ".$b["line"].", ";
                                                echo $b["function"]."()<br>";
                                                if ($b["function"] == "setCurrentBlock" &&
                                                        basename($b["file"]) != "class.ilTemplate.php")
                                                {
                                                        echo "</b>";
                                                }
                                        }
                                }
                                exit;
                        }
                        return;
                }
 
                if (is_object($log) and $log->enabled == true)
                {
                        $log->logError($a_error_obj->getCode(),$a_error_obj->getMessage());
                }
 
//echo $a_error_obj->getCode().":"; exit;
                if ($a_error_obj->getCode() == $this->FATAL)
                {
                        trigger_error(stripslashes($a_error_obj->getMessage()), E_USER_ERROR);
                        exit();
                }
 
                if ($a_error_obj->getCode() == $this->WARNING)
                {
                        if ($this->DEBUG_ENV)
                        {
                                $message = $a_error_obj->getMessage();
                        }
                        else
                        {
                                $message = "Under Construction";
                        }
 
                        $_SESSION["failure"] = $message;
 
                        if (!defined("ILIAS_MODULE"))
                        {
                                ilUtil::redirect("error.php");
                        }
                        else
                        {
                                ilUtil::redirect("../error.php");
                        }
                }
 
                if ($a_error_obj->getCode() == $this->MESSAGE)
                {
                        $_SESSION["failure"] = $a_error_obj->getMessage();
                        // save post vars to session in case of error
                        $_SESSION["error_post_vars"] = $_POST;
 
                        if (empty($_SESSION["referer"]))
                        {
                                $dirname = dirname($_SERVER["PHP_SELF"]);
                                $ilurl = parse_url(ILIAS_HTTP_PATH);
                                $subdir = substr(strstr($dirname,$ilurl["path"]),strlen($ilurl["path"]));
                                $updir = "";
 
                                if ($subdir)
                                {
                                        $num_subdirs = substr_count($subdir,"/");
 
                                        for ($i=1;$i<=$num_subdirs;$i++)
                                        {
                                                $updir .= "../";
                                        }
                                }
                                ilUtil::redirect($updir."index.php");
                        }
 
                        /* #12104 
                        check if already GET-Parameters exists in Referer-URI                    
                        if (substr($_SESSION["referer"],-4) == ".php")
                        {
                                $glue = "?";
                        }
                        else
                        {
                            // this did break permanent links (".html&")
                                $glue = "&";
                        }
                        */
                        ilUtil::redirect($_SESSION["referer"]);                 
                }
        }

References $_POST, $_SESSION, $log, $WARNING, exit, and ilUtil\redirect().

Here is the call graph for this function:

◆ formatBacktraceArray()

ilErrorHandling::formatBacktraceArray ( array $a_backtrace )

protected

Parameters

array $a_backtrace

Returns: array

Definition at line 317 of file class.ilErrorHandling.php.

        {
                $stack = array();
                $i     = 1;
 
                unset($a_backtrace[0]); // remove first call from stack trace
                foreach($a_backtrace as $item)
                {
                        $stack_line = "#$i " . $item['file'] . "(" . $item['line'] . "): ";
                        if(isset($item['class']))
                        {
                                $stack_line .= $item['class'] . "->";
                        }
                        $stack_line .= $item['function'] . "()";
                        array_push($stack, $stack_line);
                        $i++;
                }
 
                return $stack;
        }

Referenced by handleRuntimeErrors().

Here is the caller graph for this function:

◆ getLastError()

ilErrorHandling::getLastError ( )

Definition at line 75 of file class.ilErrorHandling.php.

        {
                return $this->error_obj;
        }

◆ getMessage()

ilErrorHandling::getMessage ( )

Definition at line 218 of file class.ilErrorHandling.php.

        {
                return $this->message;
        }

Referenced by appendMessage().

Here is the caller graph for this function:

◆ handleRuntimeErrors()

ilErrorHandling::handleRuntimeErrors	(	$a_error_code,
		$a_error_message,
		$a_error_file,
		$a_error_line
	)

We should enhance the error reporting in future releases (funding required).

Idea: We should convert php errors to exceptions and tweak the exception handling (already enhanced by smeyer in former releases) We should implement handlers depending on the context (web/html, soap/xml, rest/json, cli/plain text, ...)

Parameters

int	$a_error_code
string	$a_error_message
string	$a_error_file
int	$a_error_line

Returns: mixed The error handler must return FALSE to populate

Definition at line 289 of file class.ilErrorHandling.php.

        {
                // #15641 - the silence operator should suppress the error completely
                if(error_reporting() === 0)
                {
                        return;
                }
                
                $backtrace_array = $this->formatBacktraceArray(debug_backtrace());
                $error_code      = $this->translateErrorCode($a_error_code);
 
                if(ilRuntime::getInstance()->shouldLogErrors())
                {
                        error_log($error_code . ': ' . $a_error_message . ' in '.$a_error_file . ' on line ' . $a_error_line . PHP_EOL . implode(PHP_EOL, $backtrace_array));
                }
 
                if(ilRuntime::getInstance()->shouldDisplayErrors())
                {
                        print '<br /><b>' . $error_code . '</b>: ' . $a_error_message . ' in <b>'.$a_error_file . '</b> on line <b>' . $a_error_line . '</b><br/>' . implode('<br />', $backtrace_array);
                }
 
                return true;
        }

References formatBacktraceArray(), ilRuntime\getInstance(), print, and translateErrorCode().

Here is the call graph for this function:

◆ handleUncaughtException()

ilErrorHandling::handleUncaughtException ( Exception $e )

Called for each uncaught exception.

Parameters

Exception $e

Definition at line 267 of file class.ilErrorHandling.php.

        {
                $error = $e->getMessage();
                if (DEVMODE)
                {
                        $error.= '<br /><br />';
                        $error.= nl2br($e->getTraceAsString());
                }
                $this->raiseError($error,$this->WARNING);
        }

References PEAR\raiseError().

Here is the call graph for this function:

◆ ilErrorHandling()

ilErrorHandling::ilErrorHandling ( )

Constructor @access public.

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

        {
                $this->PEAR();
 
                // init vars
                $this->DEBUG_ENV = true;
                $this->FATAL     = 1;
                $this->WARNING   = 2;
                $this->MESSAGE   = 3;
 
                $this->error_obj = false;
 
                // Runtime errors currently only handled for HHVM
                if(ilRuntime::getInstance()->isHHVM())
                {
                        set_error_handler(
                                array($this, 'handleRuntimeErrors'),
                                ilRuntime::getInstance()->getReportedErrorLevels()
                        );
                }
                set_exception_handler(array($this, 'handleUncaughtException'));
        }

References ilRuntime\getInstance(), and PEAR\PEAR().

Here is the call graph for this function:

◆ setMessage()

ilErrorHandling::setMessage ( $a_message )

Definition at line 222 of file class.ilErrorHandling.php.

        {
                $this->message = $a_message;
        }

◆ translateErrorCode()

ilErrorHandling::translateErrorCode ( $error_code )

protected

Translates an integer error code to the corresponding error string.

Parameters

int $error_code

Returns: string

Definition at line 343 of file class.ilErrorHandling.php.

        {
                $constants = get_defined_constants(true);
                foreach($constants['Core'] as $constant => $value)
                {
                        if(substr($constant, 0, 2) == 'E_' && $value == $error_code)
                        {
                                return $constant;
                        }
                }
 
                return 'E_UNKNOWN';
        }

Referenced by handleRuntimeErrors().

Here is the caller graph for this function:

Field Documentation

◆ $DEBUG_ENV

ilErrorHandling::$DEBUG_ENV

Definition at line 25 of file class.ilErrorHandling.php.

◆ $FATAL

ilErrorHandling::$FATAL

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

◆ $MESSAGE

ilErrorHandling::$MESSAGE

Definition at line 46 of file class.ilErrorHandling.php.

◆ $WARNING

ilErrorHandling::$WARNING

Definition at line 39 of file class.ilErrorHandling.php.

Referenced by errorHandler().

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

Services/Init/classes/class.ilErrorHandling.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Member Function Documentation

◆ _ilErrorWriter()

◆ appendMessage()

◆ errorHandler()

◆ formatBacktraceArray()

◆ getLastError()

◆ getMessage()

◆ handleRuntimeErrors()

◆ handleUncaughtException()

◆ ilErrorHandling()

◆ setMessage()

◆ translateErrorCode()

Field Documentation

◆ $DEBUG_ENV

◆ $FATAL

◆ $MESSAGE

◆ $WARNING