Inheritance diagram for SimpleSAML\Error\ConfigurationError:

Collaboration diagram for SimpleSAML\Error\ConfigurationError:

Public Member Functions
	__construct ($reason=null, $file=null, array $config=null)
	ConfigurationError constructor. More...

	getReason ()
	Get the reason for this exception. More...

	getConfFile ()
	Get the configuration file that caused this exception. 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...

Protected Attributes
	$reason

	$config_file

Protected Attributes inherited from SimpleSAML_Error_Error
	$httpCode = 500

	$includeTemplate = null

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

Detailed Description

Definition at line 11 of file ConfigurationError.php.

Constructor & Destructor Documentation

◆ __construct()

SimpleSAML\Error\ConfigurationError::__construct	(		$reason = `null`,
			$file = `null`,
		array	$config = `null`
	)

ConfigurationError constructor.

Parameters

string \| null	$reason	The reason for this exception.
string \| null	$file	The configuration file that originated this error.
array \| null	$config	The configuration array that led to this problem.

Definition at line 36 of file ConfigurationError.php.

    {
        $file_str = '';
        $reason_str = '.';
        $params = array('CONFIG');
        if ($file !== null) {
            $params['%FILE%'] = $file;
            $basepath = dirname(dirname(dirname(dirname(__FILE__)))).'/';
            $file_str = '('.str_replace($basepath, '', $file).') ';
        }
        if ($reason !== null) {
            $params['%REASON%'] = $reason;
            $reason_str = ': '.$reason;
        }
        $this->reason = $reason;
        $this->config_file = $file;
        parent::__construct($params);
        $this->message = 'The configuration '.$file_str.'is invalid'.$reason_str;
    }

References PHPMailer\PHPMailer\$params, and SimpleSAML\Error\ConfigurationError\$reason.

Member Function Documentation

◆ getConfFile()

SimpleSAML\Error\ConfigurationError::getConfFile ( )

Get the configuration file that caused this exception.

Returns: null|string The configuration file that caused this exception.

Definition at line 73 of file ConfigurationError.php.

    {
        return $this->config_file;
    }

References SimpleSAML\Error\ConfigurationError\$config_file.

◆ getReason()

SimpleSAML\Error\ConfigurationError::getReason ( )

Get the reason for this exception.

Returns: null|string The reason for this exception.

Definition at line 62 of file ConfigurationError.php.

    {
        return $this->reason;
    }

References SimpleSAML\Error\ConfigurationError\$reason.

Field Documentation

◆ $config_file

SimpleSAML\Error\ConfigurationError::$config_file

protected

Definition at line 26 of file ConfigurationError.php.

Referenced by SimpleSAML\Error\ConfigurationError\getConfFile().

◆ $reason

SimpleSAML\Error\ConfigurationError::$reason

protected

Definition at line 19 of file ConfigurationError.php.

Referenced by SimpleSAML\Error\CriticalConfigurationError\__construct(), SimpleSAML\Error\ConfigurationError\__construct(), SimpleSAML\Error\CriticalConfigurationError\fromException(), and SimpleSAML\Error\ConfigurationError\getReason().

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members