SimpleSAML_Error_Exception Class Reference

Inheritance diagram for SimpleSAML_Error_Exception:

Collaboration diagram for SimpleSAML_Error_Exception:

Public Member Functions
	__construct ($message, $code=0, Exception $cause=null)
	Constructor for this error. More...
	getBacktrace ()
	Retrieve the backtrace. More...
	getCause ()
	Retrieve the cause of this exception. More...
	getClass ()
	Retrieve the class of this exception. More...
	format ($anonymize=false)
	Format this exception for logging. More...
	formatBacktrace ($anonymize=false)
	Format the backtrace for logging. More...
	log ($default_level)
	Print the exception to the log, by default with log level error. More...
	logError ()
	Print the exception to the log with log level error. More...
	logWarning ()
	Print the exception to the log with log level warning. More...
	logInfo ()
	Print the exception to the log with log level info. More...
	logDebug ()
	Print the exception to the log with log level debug. More...
	__sleep ()
	Function for serialization. More...

Static Public Member Functions
static	fromException (Exception $e)
	Convert any exception into a SimpleSAML_Error_Exception. More...

Protected Member Functions
	initBacktrace (Exception $exception)
	Load the backtrace from the given exception. More...
	logBacktrace ($level=\SimpleSAML\Logger::DEBUG)
	Print the backtrace to the log if the 'debug' option is enabled in the configuration. More...

Private Attributes
	$backtrace
	$cause

Detailed Description

Definition at line 12 of file Exception.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML_Error_Exception::__construct	(		$message,
			$code = 0,
		Exception	$cause = null
	)

Constructor for this error.

Note that the cause will be converted to a SimpleSAML_Error_UnserializableException unless it is a subclass of SimpleSAML_Error_Exception.

Parameters

string	$message	Exception message
int	$code	Error code
Exception | null	$cause	The cause of this exception.

Definition at line 44 of file Exception.php.

    {
        assert('is_string($message)');
        assert('is_int($code)');
 
        parent::__construct($message, $code);
 
        $this->initBacktrace($this);
 
        if ($cause !== null) {
            $this->cause = SimpleSAML_Error_Exception::fromException($cause);
        }
    }

References $cause, $code, $message, fromException(), and initBacktrace().

Here is the call graph for this function:

Member Function Documentation

__sleep()

SimpleSAML_Error_Exception::__sleep

(

)

Function for serialization.

This function builds a list of all variables which should be serialized. It will serialize all variables except the Exception::trace variable.

Returns

array Array with the variables that should be serialized.

Definition at line 304 of file Exception.php.

    {
 
        $ret = array_keys((array) $this);
 
        foreach ($ret as $i => $e) {
            if ($e === "\0Exception\0trace") {
                unset($ret[$i]);
            }
        }
 
        return $ret;
    }

References $i, and $ret.

format()

SimpleSAML_Error_Exception::format

(

$anonymize = false

)

Format this exception for logging.

Create an array of lines for logging.

Parameters

boolean

$anonymize

Whether the resulting messages should be anonymized or not.

Returns

array Log lines that should be written out.

Reimplemented in SimpleSAML_Error_NotFound.

Definition at line 151 of file Exception.php.

    {
        $ret = array(
            $this->getClass().': '.$this->getMessage(),
        );
        return array_merge($ret, $this->formatBacktrace($anonymize));
    }

References $ret, formatBacktrace(), and getClass().

Referenced by SimpleSAML_Error_Error\saveError().

Here is the call graph for this function:

Here is the caller graph for this function:

formatBacktrace()

SimpleSAML_Error_Exception::formatBacktrace

(

$anonymize = false

)

Format the backtrace for logging.

Create an array of lines for logging from the backtrace.

Parameters

boolean

$anonymize

Whether the resulting messages should be anonymized or not.

Returns

array All lines of the backtrace, properly formatted.

Definition at line 169 of file Exception.php.

    {
        $ret = array();
        $basedir = SimpleSAML_Configuration::getInstance()->getBaseDir();
 
        $e = $this;
        do {
            if ($e !== $this) {
                $ret[] = 'Caused by: '.$e->getClass().': '.$e->getMessage();
            }
            $ret[] = 'Backtrace:';
 
            $depth = count($e->backtrace);
            foreach ($e->backtrace as $i => $trace) {
                if ($anonymize) {
                    $trace = str_replace($basedir, '', $trace);
                }
 
                $ret[] = ($depth - $i - 1).' '.$trace;
            }
            $e = $e->cause;
        } while ($e !== null);
 
        return $ret;
    }

References $i, $ret, and SimpleSAML_Configuration\getInstance().

Referenced by format(), and logBacktrace().

Here is the call graph for this function:

Here is the caller graph for this function:

fromException()

static SimpleSAML_Error_Exception::fromException ( Exception  $e )

static

Convert any exception into a SimpleSAML_Error_Exception.

Parameters

Exception

$e

The exception.

Returns

SimpleSAML_Error_Exception The new exception.

Reimplemented in sspmod_saml_Error.

Definition at line 66 of file Exception.php.

    {
 
        if ($e instanceof SimpleSAML_Error_Exception) {
            return $e;
        }
        return new SimpleSAML_Error_UnserializableException($e);
    }

Referenced by __construct().

Here is the caller graph for this function:

getBacktrace()

SimpleSAML_Error_Exception::getBacktrace

(

)

Retrieve the backtrace.

Returns

array An array where each function call is a single item.

Definition at line 114 of file Exception.php.

    {
        return $this->backtrace;
    }

References $backtrace.

getCause()

SimpleSAML_Error_Exception::getCause

(

)

Retrieve the cause of this exception.

Returns

SimpleSAML_Error_Exception|null The cause of this exception.

Definition at line 125 of file Exception.php.

    {
        return $this->cause;
    }

References $cause.

getClass()

SimpleSAML_Error_Exception::getClass

(

)

Retrieve the class of this exception.

Returns

string The name of the class.

Reimplemented in SimpleSAML_Error_UnserializableException.

Definition at line 136 of file Exception.php.

    {
        return get_class($this);
    }

Referenced by format(), SimpleSAML_Error_NotFound\format(), logDebug(), logError(), logInfo(), and logWarning().

Here is the caller graph for this function:

initBacktrace()

SimpleSAML_Error_Exception::initBacktrace ( Exception  $exception )

protected

Load the backtrace from the given exception.

Parameters

Exception

$exception

The exception we should fetch the backtrace from.

Definition at line 81 of file Exception.php.

    {
 
        $this->backtrace = array();
 
        // position in the top function on the stack
        $pos = $exception->getFile().':'.$exception->getLine();
 
        foreach ($exception->getTrace() as $t) {
 
            $function = $t['function'];
            if (array_key_exists('class', $t)) {
                $function = $t['class'].'::'.$function;
            }
 
            $this->backtrace[] = $pos.' ('.$function.')';
 
            if (array_key_exists('file', $t)) {
                $pos = $t['file'].':'.$t['line'];
            } else {
                $pos = '[builtin]';
            }
        }
 
        $this->backtrace[] = $pos.' (N/A)';
    }

References $function, and $t.

Referenced by __construct(), and SimpleSAML_Error_UnserializableException\__construct().

Here is the caller graph for this function:

log()

SimpleSAML_Error_Exception::log

(

$default_level

)

Print the exception to the log, by default with log level error.

Override to allow errors extending this class to specify the log level themselves.

Parameters

int

$default_level

The log level to use if this method was not overridden.

Definition at line 236 of file Exception.php.

    {
        $fn = array(
            SimpleSAML\Logger::ERR     => 'logError',
            SimpleSAML\Logger::WARNING => 'logWarning',
            SimpleSAML\Logger::INFO    => 'logInfo',
            SimpleSAML\Logger::DEBUG   => 'logDebug',
        );
        call_user_func(array($this, $fn[$default_level]), $default_level);
    }

References DEBUG.

Referenced by sspmod_saml_IdP_SAML2\handleAuthError().

Here is the caller graph for this function:

logBacktrace()

SimpleSAML_Error_Exception::logBacktrace (   $level = \SimpleSAML\Logger::DEBUG )

protected

Print the backtrace to the log if the 'debug' option is enabled in the configuration.

Definition at line 199 of file Exception.php.

    {
        // see if debugging is enabled for backtraces
        $debug = SimpleSAML_Configuration::getInstance()->getArrayize('debug', array('backtraces' => false));
 
        if (!(in_array('backtraces', $debug, true) // implicitly enabled
              || (array_key_exists('backtraces', $debug) && $debug['backtraces'] === true) // explicitly set
              // TODO: deprecate the old style and remove it in 2.0
              || (array_key_exists(0, $debug) && $debug[0] === true) // old style 'debug' configuration option
        )) {
            return;
        }
 
        $backtrace = $this->formatBacktrace();
 
        $callback = array('\SimpleSAML\Logger');
        $functions = array(
            \SimpleSAML\Logger::ERR     => 'error',
            \SimpleSAML\Logger::WARNING => 'warning',
            \SimpleSAML\Logger::INFO    => 'info',
            \SimpleSAML\Logger::DEBUG   => 'debug',
        );
        $callback[] = $functions[$level];
 
        foreach ($backtrace as $line) {
            call_user_func($callback, $line);
        }
    }

References $backtrace, $debug, DEBUG, formatBacktrace(), and SimpleSAML_Configuration\getInstance().

Referenced by logDebug(), logError(), logInfo(), and logWarning().

Here is the call graph for this function:

Here is the caller graph for this function:

logDebug()

SimpleSAML_Error_Exception::logDebug

(

)

Print the exception to the log with log level debug.

This function will write this exception to the log, including a full backtrace.

Definition at line 289 of file Exception.php.

    {
        SimpleSAML\Logger::debug($this->getClass().': '.$this->getMessage());
        $this->logBacktrace(\SimpleSAML\Logger::DEBUG);
    }

References SimpleSAML\Logger\debug(), DEBUG, getClass(), and logBacktrace().

Here is the call graph for this function:

logError()

SimpleSAML_Error_Exception::logError

(

)

Print the exception to the log with log level error.

This function will write this exception to the log, including a full backtrace.

Definition at line 253 of file Exception.php.

    {
        SimpleSAML\Logger::error($this->getClass().': '.$this->getMessage());
        $this->logBacktrace(\SimpleSAML\Logger::ERR);
    }

References SimpleSAML\Logger\error(), getClass(), and logBacktrace().

Referenced by SimpleSAML_Error_Error\show().

Here is the call graph for this function:

Here is the caller graph for this function:

logInfo()

SimpleSAML_Error_Exception::logInfo

(

)

Print the exception to the log with log level info.

This function will write this exception to the log, including a full backtrace.

Definition at line 277 of file Exception.php.

    {
        SimpleSAML\Logger::info($this->getClass().': '.$this->getMessage());
        $this->logBacktrace(\SimpleSAML\Logger::INFO);
    }

References getClass(), SimpleSAML\Logger\info(), and logBacktrace().

Here is the call graph for this function:

logWarning()

SimpleSAML_Error_Exception::logWarning

(

)

Print the exception to the log with log level warning.

This function will write this exception to the log, including a full backtrace.

Definition at line 265 of file Exception.php.

    {
        SimpleSAML\Logger::warning($this->getClass().': '.$this->getMessage());
        $this->logBacktrace(\SimpleSAML\Logger::WARNING);
    }

References getClass(), logBacktrace(), and SimpleSAML\Logger\warning().

Here is the call graph for this function:

Field Documentation

$backtrace

SimpleSAML_Error_Exception::$backtrace

private

Definition at line 23 of file Exception.php.

Referenced by getBacktrace(), and logBacktrace().

$cause

SimpleSAML_Error_Exception::$cause

private

Definition at line 31 of file Exception.php.

Referenced by SimpleSAML_Error_AuthSource\__construct(), SimpleSAML_Error_Error\__construct(), __construct(), SimpleSAML\Module\saml\Error\NoAuthnContext\__construct(), SimpleSAML\Module\saml\Error\NoAvailableIDP\__construct(), SimpleSAML\Module\saml\Error\NoPassive\__construct(), SimpleSAML\Module\saml\Error\NoSupportedIDP\__construct(), SimpleSAML\Module\saml\Error\ProxyCountExceeded\__construct(), sspmod_saml_Error\__construct(), SimpleSAML_Error_UserAborted\__construct(), and getCause().

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Error/Exception.php