Inheritance diagram for SimpleSAML_Error_BadRequest:

Collaboration diagram for SimpleSAML_Error_BadRequest:

Public Member Functions
	__construct ($reason)
	Create a new BadRequest error. More...

	getReason ()
	Retrieve the reason why the request was invalid. 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 this request was invalid. 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 BadRequest.php.

Constructor & Destructor Documentation

◆ __construct()

SimpleSAML_Error_BadRequest::__construct ( $reason )

Create a new BadRequest error.

Parameters

string $reason Description of why the request was unacceptable.

Definition at line 26 of file BadRequest.php.

References $reason, and array.

                                              {
                 assert('is_string($reason)');
 
                 $this->reason = $reason;
                 parent::__construct(array('BADREQUEST', '%REASON%' => $this->reason));
                 $this->httpCode = 400;
         }

Member Function Documentation

◆ getReason()

SimpleSAML_Error_BadRequest::getReason ( )

Retrieve the reason why the request was invalid.

Returns: string The reason why the request was invalid.

Definition at line 40 of file BadRequest.php.

References $reason.

                                     {
                 return $this->reason;
         }

Field Documentation

◆ $reason

SimpleSAML_Error_BadRequest::$reason

private

Reason why this request was invalid.

Definition at line 18 of file BadRequest.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/BadRequest.php

Public Member Functions

Private Attributes