SimpleSAML_Error_Assertion Class Reference

Inheritance diagram for SimpleSAML_Error_Assertion:

Collaboration diagram for SimpleSAML_Error_Assertion:

Public Member Functions
	__construct ($assertion=NULL)
	Constructor for the assertion exception. More...
	getAssertion ()
	Retrieve the assertion which failed. More...
Public Member Functions inherited from SimpleSAML_Error_Exception
	__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	installHandler ()
	Install this assertion handler. More...
static	onAssertion ($file, $line, $message)
	Handle assertion. More...
Static Public Member Functions inherited from SimpleSAML_Error_Exception
static	fromException (Exception $e)
	Convert any exception into a SimpleSAML_Error_Exception. More...

Private Attributes
	$assertion
	The assertion which failed, or NULL if only an expression was passed to the assert-function. More...

Additional Inherited Members
Protected Member Functions inherited from SimpleSAML_Error_Exception
	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...

Detailed Description

Definition at line 9 of file Assertion.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML_Error_Assertion::__construct

(

$assertion = NULL

)

Constructor for the assertion exception.

Should only be called from the onAssertion handler.

Parameters

string | NULL

$assertion

The assertion which failed, or NULL if the assert-function was given an expression.

Definition at line 27 of file Assertion.php.

                                                       {
                assert('is_null($assertion) || is_string($assertion)');
 
                $msg = 'Assertion failed: ' . var_export($assertion, TRUE);
                parent::__construct($msg);
 
                $this->assertion = $assertion;
        }

References $assertion.

Member Function Documentation

getAssertion()

SimpleSAML_Error_Assertion::getAssertion

(

)

Retrieve the assertion which failed.

Returns

string|NULL The assertion which failed, or NULL if the assert-function was called with an expression.

Definition at line 42 of file Assertion.php.

                                       {
                return $this->assertion;
        }

References $assertion.

installHandler()

static SimpleSAML_Error_Assertion::installHandler ( )

static

Install this assertion handler.

This function will register this assertion handler. If will not enable assertions if they are disabled.

Definition at line 53 of file Assertion.php.

                                                {
 
                assert_options(ASSERT_WARNING,    0);
                assert_options(ASSERT_QUIET_EVAL, 0);
                assert_options(ASSERT_CALLBACK,   array('SimpleSAML_Error_Assertion', 'onAssertion'));
        }

onAssertion()

static SimpleSAML_Error_Assertion::onAssertion (   $file,   $line,   $message  )

static

Handle assertion.

This function handles an assertion.

Parameters

string	$file	The file assert was called from.
int	$line	The line assert was called from.
mixed	$message	The expression which was passed to the assert-function.

Definition at line 70 of file Assertion.php.

                                                                   {
 
                if(!empty($message)) {
                        $exception = new self($message);
                } else {
                        $exception = new self();
                }
 
                $exception->logError();
        }

References $message.

Field Documentation

$assertion

SimpleSAML_Error_Assertion::$assertion

private

The assertion which failed, or NULL if only an expression was passed to the assert-function.

Definition at line 16 of file Assertion.php.

Referenced by __construct(), and getAssertion().

---

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

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