Inheritance diagram for ilErrorHandling:

Collaboration diagram for ilErrorHandling:

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

	getHandler ()
	Get a handler for an error or exception. 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)

	logMessageFor (Exception $exception, $log_trace)
	Get the error message to be logged. 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
	initHandlers ()
	Initialize Error and Exception Handlers. More...

	getIlRuntime ()
	Get ilRuntime. More...

	getWhoops ()
	Get an instance of Whoops/Run. More...

	isDevmodeActive ()
	Is the DEVMODE switched on? More...

	defaultHandler ()
	Get a default error handler. More...

	devmodeHandler ()
	Get the handler to be used in DEVMODE. More...

Static Protected Attributes
static	$handlers_registered = false

Detailed Description

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

◆ defaultHandler()

ilErrorHandling::defaultHandler ( )

protected

Get a default error handler.

Returns: Whoops\Handler

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

                                            {
                return new CallbackHandler(function(Exception $exception, Inspector $inspector, Run $run) {
                        if ($exception instanceof \Whoops\Exception\ErrorException
                        and $exception->getCode() == E_ERROR) {
                                global $tpl, $lng, $tree;
                                $_SESSION["failure"] = $exception->getMessage();
                                include("error.php");
                                exit();
                        }
 
                        require_once("Services/Utilities/classes/class.ilUtil.php");
                        ilUtil::sendFailure($exception->getMessage(), true);
                        // many test installation have display_errors on, we do not need additional information in this case
                        // however in cases of warnings, whoops seems to get rid of these messages, but not in the case of fatals
                        // so we do not check for ini_get("display_errors"), but for headers_sent()
                        if (!headers_sent())
                        {
                                // #0019268, when not in setup
                                if (class_exists("ilInitialisation"))
                                {
                                        ilInitialisation::initHTML();
                                        global $tpl, $lng, $tree;
                                        include("error.php");                // redirect will not display fatal error messages, since writing to session (sendFailure) will not work at this point
                                }
                                else    // when in setup...
                                {
                                        ilUtil::redirect("error.php");
                                }
                        }
                });
        }

References $lng, $tpl, ilUtil\redirect(), and ilUtil\sendFailure().

Referenced by getHandler().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ devmodeHandler()

ilErrorHandling::devmodeHandler ( )

protected

Get the handler to be used in DEVMODE.

Returns: Whoops\Handler

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

                                            {
                global $ilLog;
                
                switch (ERROR_HANDLER) {
                        case "TESTING":
                                return new ilTestingHandler();
                        case "PLAIN_TEXT":
                                return new ilPlainTextHandler();
                        case "PRETTY_PAGE":
                                return new PrettyPageHandler();
                        default:
                                if ($ilLog) {
                                        $ilLog->write("Unknown or undefined error handler '".ERROR_HANDLER."'. "
                                                                 ."Falling back to PrettyPageHandler.");
                                }
                                return new PrettyPageHandler();
                }
        }

References $ilLog.

Referenced by getHandler().

Here is the caller 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 158 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->write($m);
                        #$log->writeWarning($m);
                        #$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->write($a_error_obj->getMessage());
                        #$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, $_SERVER, $_SESSION, $log, $WARNING, exit, and ilUtil\redirect().

Here is the call graph for this function:

◆ getHandler()

ilErrorHandling::getHandler ( )

Get a handler for an error or exception.

Uses Whoops Pretty Page Handler in DEVMODE and the legacy ILIAS-Error handlers otherwise.

Returns: Whoops\Handler

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

                                     {
                // TODO: * Use Whoops in production mode? This would require an appropriate
                //                 error-handler.
                //               * Check for context? The current implementation e.g. would output HTML for
                //                 for SOAP.
 
                if ($this->isDevmodeActive()) {
                        return $this->devmodeHandler();
                }
 
                return $this->defaultHandler();
        }

References defaultHandler(), devmodeHandler(), and isDevmodeActive().

Here is the call graph for this function:

◆ getIlRuntime()

ilErrorHandling::getIlRuntime ( )

protected

Get ilRuntime.

Returns: ilRuntime

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

                                          {
                return ilRuntime::getInstance();
        }

References ilRuntime\getInstance().

Referenced by initHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastError()

ilErrorHandling::getLastError ( )

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

        {
                return $this->error_obj;
        }

◆ getMessage()

ilErrorHandling::getMessage ( )

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

        {
                return $this->message;
        }

Referenced by appendMessage().

Here is the caller graph for this function:

◆ getWhoops()

ilErrorHandling::getWhoops ( )

protected

Get an instance of Whoops/Run.

Returns: Whoops\Run

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

                                       {
                return new Run();
        }

Referenced by initHandlers().

Here is the caller graph for this function:

◆ ilErrorHandling()

ilErrorHandling::ilErrorHandling ( )

Constructor @access public.

Definition at line 85 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;
                
                $this->initHandlers();
        }

References initHandlers(), and PEAR\PEAR().

Here is the call graph for this function:

◆ initHandlers()

ilErrorHandling::initHandlers ( )

protected

Initialize Error and Exception Handlers.

Initializes Whoops, a logging handler and a delegate handler for the late initialisation of an appropriate error handler.

Returns: void

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

                                          {
                if (self::$handlers_registered) {
                        // Only register whoops error handlers once.
                        return;
                }
                
                $ilRuntime = $this->getIlRuntime();
                $whoops = $this->getWhoops();
                
                $whoops->pushHandler(new ilDelegatingHandler($this));
                
                if ($ilRuntime->shouldLogErrors()) {
                        $whoops->pushHandler($this->loggingHandler());
                }
                
                $whoops->register();
                
                self::$handlers_registered = true;
        }

References getIlRuntime(), and getWhoops().

Referenced by ilErrorHandling().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDevmodeActive()

ilErrorHandling::isDevmodeActive ( )

protected

Is the DEVMODE switched on?

Returns: bool

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

                                             {
                return DEVMODE == 1;
        }

Referenced by getHandler().

Here is the caller graph for this function:

◆ logMessageFor()

ilErrorHandling::logMessageFor	(	Exception	$exception,
			$log_trace
	)

Get the error message to be logged.

TODO: Can be made protected when support for PHP 5.3. is dropped.

Parameters

$exception	Exception
$log_trace	bool

Returns: string

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

                                                                        {
                assert('is_bool($log_trace)');
                $prefix = "PHP Error: ";
                if ($exception instanceof \Whoops\Exception\ErrorException) {
                        switch ($exception->getCode()) {
                                case E_ERROR:
                                case E_USER_ERROR:
                                        $prefix = "PHP Fatal error: ";
                        }
                }
 
                $msg = $prefix.$exception->getMessage()." in ".$exception->getFile()." on line ".$exception->getLine();
 
                if ($log_trace) {
                        $msg .= "\n".$exception->getTraceAsString();
                }
 
                return $msg;
        }

◆ setMessage()

ilErrorHandling::setMessage ( $a_message )

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

        {
                $this->message = $a_message;
        }

Field Documentation

◆ $DEBUG_ENV

ilErrorHandling::$DEBUG_ENV

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

◆ $FATAL

ilErrorHandling::$FATAL

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

◆ $handlers_registered

ilErrorHandling::$handlers_registered = false

staticprotected

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

◆ $MESSAGE

ilErrorHandling::$MESSAGE

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

◆ $WARNING

ilErrorHandling::$WARNING

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

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ _ilErrorWriter()

◆ appendMessage()

◆ defaultHandler()

◆ devmodeHandler()

◆ errorHandler()

◆ getHandler()

◆ getIlRuntime()

◆ getLastError()

◆ getMessage()

◆ getWhoops()

◆ ilErrorHandling()

◆ initHandlers()

◆ isDevmodeActive()

◆ logMessageFor()

◆ setMessage()

Field Documentation

◆ $DEBUG_ENV

◆ $FATAL

◆ $handlers_registered

◆ $MESSAGE

◆ $WARNING