PHP Class SimpleSAML_Error_NotFound, simplesamlphp

This exception can be thrown from within a module page handler. The user will then be shown a 404 Not Found error page.

Author: Olav Morken, UNINETT AS.

Inheritance: extends SimpleSAML_Error_Error

Datei anzeigen Open project: simplesamlphp/simplesamlphp

Public Methods

Method	Description
__construct ( string $reason = NULL )	Create a new NotFound error
format ( boolean $anonymize = false ) : array	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.
getReason ( ) : string \| null	Retrieve the reason why the given page could not be found.

Method Details

__construct() public method

Create a new NotFound error

public __construct ( string $reason = NULL )
$reason	string	Optional description of why the given page could not be found.

format() public method

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.

public format ( boolean $anonymize = false ) : array
$anonymize	boolean	Whether to anonymize the trace or not.
return	array

getReason() public method

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

public getReason ( ) : string \| null
return	string \| null	The reason why the page could not be found.