Inheritance diagram for SimpleSAML_Error_NotFound:

Collaboration diagram for SimpleSAML_Error_NotFound:

Public Member Functions
	__construct ($reason=NULL)
	Create a new NotFound error. More...

	getReason ()
	Retrieve the reason why the given page could not be found. More...

	format ($anonymize=false)
	NotFound exceptions don't need to display a backtrace, as they are very simple and the trace is usually trivial, so just log the message without any backtrace at all. More...

Public Member Functions inherited from SimpleSAML_Error_Error
	__construct ($errorCode, Exception $cause=null, $httpCode=null)
	Constructor for this error. More...

	getErrorCode ()
	Retrieve the error code given when throwing this error. More...

	getParameters ()
	Retrieve the error parameters given when throwing this error. More...

	getDictTitle ()
	Retrieve the error title tag in dictionary. More...

	getDictDescr ()
	Retrieve the error description tag in dictionary. More...

	show ()
	Display this error. 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...

Private Attributes
	$reason
	Reason why the given page could not be found. More...

Additional Inherited Members
Static Public Member Functions inherited from SimpleSAML_Error_Exception
static	fromException (Exception $e)
	Convert any exception into a SimpleSAML_Error_Exception. More...

Protected Member Functions inherited from SimpleSAML_Error_Error
	setHTTPCode ()
	Set the HTTP return code for this error. More...

	saveError ()
	Save an error report. More...

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...

Protected Attributes inherited from SimpleSAML_Error_Error
	$httpCode = 500

	$includeTemplate = null

Detailed Description

Definition at line 12 of file NotFound.php.

Constructor & Destructor Documentation

◆ __construct()

SimpleSAML_Error_NotFound::__construct ( $reason = NULL )

Create a new NotFound error.

Parameters

string $reason Optional description of why the given page could not be found.

Definition at line 26 of file NotFound.php.

                                                    {
 
                assert('is_null($reason) || is_string($reason)');
 
                $url = \SimpleSAML\Utils\HTTP::getSelfURL();
 
                if($reason === NULL) {
                        parent::__construct(array('NOTFOUND', '%URL%' => $url));
                        $this->message = "The requested page '$url' could not be found.";
                } else {
                        parent::__construct(array('NOTFOUNDREASON', '%URL%' => $url, '%REASON%' => $reason));
                        $this->message = "The requested page '$url' could not be found. ".$reason;
                }
 
                $this->reason = $reason;
                $this->httpCode = 404;
        }

References $reason, and $url.

Member Function Documentation

◆ format()

SimpleSAML_Error_NotFound::format ( $anonymize = false )

NotFound exceptions don't need to display a backtrace, as they are very simple and the trace is usually trivial, so just log the message without any backtrace at all.

Parameters

bool $anonymize Whether to anonymize the trace or not.

Returns: array

Reimplemented from SimpleSAML_Error_Exception.

Definition at line 63 of file NotFound.php.

                                                   {
                return array(
                        $this->getClass().': '.$this->getMessage(),
                );
        }

References SimpleSAML_Error_Exception\getClass().

Here is the call graph for this function:

◆ getReason()

SimpleSAML_Error_NotFound::getReason ( )

Retrieve the reason why the given page could not be found.

Returns: string|NULL The reason why the page could not be found.

Definition at line 50 of file NotFound.php.

                                    {
                return $this->reason;
        }

References $reason.

Field Documentation

◆ $reason

SimpleSAML_Error_NotFound::$reason

private

Reason why the given page could not be found.

Definition at line 18 of file NotFound.php.

Referenced by __construct(), and getReason().

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

libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Error/NotFound.php

Public Member Functions

Private Attributes

Additional Inherited Members