ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Static Public Member Functions
SimpleSAML\Error\ErrorCodes Class Reference
+ Collaboration diagram for SimpleSAML\Error\ErrorCodes:

Static Public Member Functions

static defaultGetAllErrorCodeTitles ()
 Fetch all default translation strings for error code titles. More...
 
static getAllErrorCodeTitles ()
 Fetch all translation strings for error code titles. More...
 
static defaultGetAllErrorCodeDescriptions ()
 Fetch all default translation strings for error code descriptions. More...
 
static getAllErrorCodeDescriptions ()
 Fetch all translation strings for error code descriptions. More...
 
static getAllErrorCodeMessages ()
 Get a map of both errorcode titles and descriptions. More...
 
static getErrorCodeTitle ($errorCode)
 Fetch a translation string for a title for a given error code. More...
 
static getErrorCodeDescription ($errorCode)
 Fetch a translation string for a description for a given error code. More...
 
static getErrorCodeMessage ($errorCode)
 Get both title and description for a specific error code. More...
 

Detailed Description

Definition at line 11 of file ErrorCodes.php.

Member Function Documentation

◆ defaultGetAllErrorCodeDescriptions()

static SimpleSAML\Error\ErrorCodes::defaultGetAllErrorCodeDescriptions ( )
staticfinal

Fetch all default translation strings for error code descriptions.

Returns
string A map from error code to error code description

Definition at line 76 of file ErrorCodes.php.

77  {
78  return array(
79  'ACSPARAMS' => \SimpleSAML\Locale\Translate::noop('{errors:descr_ACSPARAMS}'),
80  'ARSPARAMS' => \SimpleSAML\Locale\Translate::noop('{errors:descr_ARSPARAMS}'),
81  'AUTHSOURCEERROR' => \SimpleSAML\Locale\Translate::noop('{errors:descr_AUTHSOURCEERROR}'),
82  'BADREQUEST' => \SimpleSAML\Locale\Translate::noop('{errors:descr_BADREQUEST}'),
83  'CASERROR' => \SimpleSAML\Locale\Translate::noop('{errors:descr_CASERROR}'),
84  'CONFIG' => \SimpleSAML\Locale\Translate::noop('{errors:descr_CONFIG}'),
85  'CREATEREQUEST' => \SimpleSAML\Locale\Translate::noop('{errors:descr_CREATEREQUEST}'),
86  'DISCOPARAMS' => \SimpleSAML\Locale\Translate::noop('{errors:descr_DISCOPARAMS}'),
87  'GENERATEAUTHNRESPONSE' => \SimpleSAML\Locale\Translate::noop('{errors:descr_GENERATEAUTHNRESPONSE}'),
88  'INVALIDCERT' => \SimpleSAML\Locale\Translate::noop('{errors:descr_INVALIDCERT}'),
89  'LDAPERROR' => \SimpleSAML\Locale\Translate::noop('{errors:descr_LDAPERROR}'),
90  'LOGOUTINFOLOST' => \SimpleSAML\Locale\Translate::noop('{errors:descr_LOGOUTINFOLOST}'),
91  'LOGOUTREQUEST' => \SimpleSAML\Locale\Translate::noop('{errors:descr_LOGOUTREQUEST}'),
92  'MEMCACHEDOWN' => \SimpleSAML\Locale\Translate::noop('{errors:descr_MEMCACHEDOWN}'),
93  'METADATA' => \SimpleSAML\Locale\Translate::noop('{errors:descr_METADATA}'),
94  'METADATANOTFOUND' => \SimpleSAML\Locale\Translate::noop('{errors:descr_METADATANOTFOUND}'),
95  'NOACCESS' => \SimpleSAML\Locale\Translate::noop('{errors:descr_NOACCESS}'),
96  'NOCERT' => \SimpleSAML\Locale\Translate::noop('{errors:descr_NOCERT}'),
97  'NORELAYSTATE' => \SimpleSAML\Locale\Translate::noop('{errors:descr_NORELAYSTATE}'),
98  'NOSTATE' => \SimpleSAML\Locale\Translate::noop('{errors:descr_NOSTATE}'),
99  'NOTFOUND' => \SimpleSAML\Locale\Translate::noop('{errors:descr_NOTFOUND}'),
100  'NOTFOUNDREASON' => \SimpleSAML\Locale\Translate::noop('{errors:descr_NOTFOUNDREASON}'),
101  'NOTSET' => \SimpleSAML\Locale\Translate::noop('{errors:descr_NOTSET}'),
102  'NOTVALIDCERT' => \SimpleSAML\Locale\Translate::noop('{errors:descr_NOTVALIDCERT}'),
103  'PROCESSASSERTION' => \SimpleSAML\Locale\Translate::noop('{errors:descr_PROCESSASSERTION}'),
104  'PROCESSAUTHNREQUEST' => \SimpleSAML\Locale\Translate::noop('{errors:descr_PROCESSAUTHNREQUEST}'),
105  'RESPONSESTATUSNOSUCCESS' => \SimpleSAML\Locale\Translate::noop('{errors:descr_RESPONSESTATUSNOSUCCESS}'),
106  'SLOSERVICEPARAMS' => \SimpleSAML\Locale\Translate::noop('{errors:descr_SLOSERVICEPARAMS}'),
107  'SSOPARAMS' => \SimpleSAML\Locale\Translate::noop('{errors:descr_SSOPARAMS}'),
108  'UNHANDLEDEXCEPTION' => \SimpleSAML\Locale\Translate::noop('{errors:descr_UNHANDLEDEXCEPTION}'),
109  'UNKNOWNCERT' => \SimpleSAML\Locale\Translate::noop('{errors:descr_UNKNOWNCERT}'),
110  'USERABORTED' => \SimpleSAML\Locale\Translate::noop('{errors:descr_USERABORTED}'),
111  'WRONGUSERPASS' => \SimpleSAML\Locale\Translate::noop('{errors:descr_WRONGUSERPASS}'),
112  );
113  }
SimpleSAML
Attribute-related utility methods.

◆ defaultGetAllErrorCodeTitles()

static SimpleSAML\Error\ErrorCodes::defaultGetAllErrorCodeTitles ( )
staticfinal

Fetch all default translation strings for error code titles.

Returns
array A map from error code to error code title

Definition at line 18 of file ErrorCodes.php.

19  {
20  return array(
21  'ACSPARAMS' => \SimpleSAML\Locale\Translate::noop('{errors:title_ACSPARAMS}'),
22  'ARSPARAMS' => \SimpleSAML\Locale\Translate::noop('{errors:title_ARSPARAMS}'),
23  'AUTHSOURCEERROR' => \SimpleSAML\Locale\Translate::noop('{errors:title_AUTHSOURCEERROR}'),
24  'BADREQUEST' => \SimpleSAML\Locale\Translate::noop('{errors:title_BADREQUEST}'),
25  'CASERROR' => \SimpleSAML\Locale\Translate::noop('{errors:title_CASERROR}'),
26  'CONFIG' => \SimpleSAML\Locale\Translate::noop('{errors:title_CONFIG}'),
27  'CREATEREQUEST' => \SimpleSAML\Locale\Translate::noop('{errors:title_CREATEREQUEST}'),
28  'DISCOPARAMS' => \SimpleSAML\Locale\Translate::noop('{errors:title_DISCOPARAMS}'),
29  'GENERATEAUTHNRESPONSE' => \SimpleSAML\Locale\Translate::noop('{errors:title_GENERATEAUTHNRESPONSE}'),
30  'INVALIDCERT' => \SimpleSAML\Locale\Translate::noop('{errors:title_INVALIDCERT}'),
31  'LDAPERROR' => \SimpleSAML\Locale\Translate::noop('{errors:title_LDAPERROR}'),
32  'LOGOUTINFOLOST' => \SimpleSAML\Locale\Translate::noop('{errors:title_LOGOUTINFOLOST}'),
33  'LOGOUTREQUEST' => \SimpleSAML\Locale\Translate::noop('{errors:title_LOGOUTREQUEST}'),
34  'MEMCACHEDOWN' => \SimpleSAML\Locale\Translate::noop('{errors:title_MEMCACHEDOWN}'),
35  'METADATA' => \SimpleSAML\Locale\Translate::noop('{errors:title_METADATA}'),
36  'METADATANOTFOUND' => \SimpleSAML\Locale\Translate::noop('{errors:title_METADATANOTFOUND}'),
37  'NOACCESS' => \SimpleSAML\Locale\Translate::noop('{errors:title_NOACCESS}'),
38  'NOCERT' => \SimpleSAML\Locale\Translate::noop('{errors:title_NOCERT}'),
39  'NORELAYSTATE' => \SimpleSAML\Locale\Translate::noop('{errors:title_NORELAYSTATE}'),
40  'NOSTATE' => \SimpleSAML\Locale\Translate::noop('{errors:title_NOSTATE}'),
41  'NOTFOUND' => \SimpleSAML\Locale\Translate::noop('{errors:title_NOTFOUND}'),
42  'NOTFOUNDREASON' => \SimpleSAML\Locale\Translate::noop('{errors:title_NOTFOUNDREASON}'),
43  'NOTSET' => \SimpleSAML\Locale\Translate::noop('{errors:title_NOTSET}'),
44  'NOTVALIDCERT' => \SimpleSAML\Locale\Translate::noop('{errors:title_NOTVALIDCERT}'),
45  'PROCESSASSERTION' => \SimpleSAML\Locale\Translate::noop('{errors:title_PROCESSASSERTION}'),
46  'PROCESSAUTHNREQUEST' => \SimpleSAML\Locale\Translate::noop('{errors:title_PROCESSAUTHNREQUEST}'),
47  'RESPONSESTATUSNOSUCCESS' => \SimpleSAML\Locale\Translate::noop('{errors:title_RESPONSESTATUSNOSUCCESS}'),
48  'SLOSERVICEPARAMS' => \SimpleSAML\Locale\Translate::noop('{errors:title_SLOSERVICEPARAMS}'),
49  'SSOPARAMS' => \SimpleSAML\Locale\Translate::noop('{errors:title_SSOPARAMS}'),
50  'UNHANDLEDEXCEPTION' => \SimpleSAML\Locale\Translate::noop('{errors:title_UNHANDLEDEXCEPTION}'),
51  'UNKNOWNCERT' => \SimpleSAML\Locale\Translate::noop('{errors:title_UNKNOWNCERT}'),
52  'USERABORTED' => \SimpleSAML\Locale\Translate::noop('{errors:title_USERABORTED}'),
53  'WRONGUSERPASS' => \SimpleSAML\Locale\Translate::noop('{errors:title_WRONGUSERPASS}'),
54  );
55  }
SimpleSAML
Attribute-related utility methods.

◆ getAllErrorCodeDescriptions()

static SimpleSAML\Error\ErrorCodes::getAllErrorCodeDescriptions ( )
static

Fetch all translation strings for error code descriptions.

Extend this to add error codes.

Returns
string A map from error code to error code description

Definition at line 122 of file ErrorCodes.php.

123  {
124  return self::defaultGetAllErrorCodeDescriptions();
125  }

◆ getAllErrorCodeMessages()

static SimpleSAML\Error\ErrorCodes::getAllErrorCodeMessages ( )
static

Get a map of both errorcode titles and descriptions.

Convenience-method for template-callers

Returns
array An array containing both errorcode maps.

Definition at line 135 of file ErrorCodes.php.

Referenced by sspmod_authX509_Auth_Source_X509userCert\authFailed().

136  {
137  return array(
138  'title' => self::getAllErrorCodeTitles(),
139  'descr' => self::getAllErrorCodeDescriptions(),
140  );
141  }
+ Here is the caller graph for this function:

◆ getAllErrorCodeTitles()

static SimpleSAML\Error\ErrorCodes::getAllErrorCodeTitles ( )
static

Fetch all translation strings for error code titles.

Extend this to add error codes.

Returns
array A map from error code to error code title

Definition at line 65 of file ErrorCodes.php.

66  {
67  return self::defaultGetAllErrorCodeTitles();
68  }

◆ getErrorCodeDescription()

static SimpleSAML\Error\ErrorCodes::getErrorCodeDescription (   $errorCode)
static

Fetch a translation string for a description for a given error code.

Parameters
string$errorCodeThe error code to look up
Returns
string A string to translate

Definition at line 165 of file ErrorCodes.php.

References $errorCode.

Referenced by SimpleSAML_Error_Error\__construct().

166  {
167  $errorCodeDescriptions = self::getAllErrorCodeDescriptions();
168  return $errorCodeDescriptions[$errorCode];
169  }
$errorCode
$errorCode
Definition: loginuserpass.php:41
+ Here is the caller graph for this function:

◆ getErrorCodeMessage()

static SimpleSAML\Error\ErrorCodes::getErrorCodeMessage (   $errorCode)
static

Get both title and description for a specific error code.

Convenience-method for template-callers

Parameters
string$errorCodeThe error code to look up
Returns
array An array containing both errorcode strings.

Definition at line 181 of file ErrorCodes.php.

References $errorCode.

182  {
183  return array(
184  'title' => self::getErrorCodeTitle($errorCode),
185  'descr' => self::getErrorCodeDescription($errorCode),
186  );
187  }
$errorCode
$errorCode
Definition: loginuserpass.php:41

◆ getErrorCodeTitle()

static SimpleSAML\Error\ErrorCodes::getErrorCodeTitle (   $errorCode)
static

Fetch a translation string for a title for a given error code.

Parameters
string$errorCodeThe error code to look up
Returns
string A string to translate

Definition at line 151 of file ErrorCodes.php.

References $errorCode.

Referenced by SimpleSAML_Error_Error\__construct().

152  {
153  $errorCodeTitles = self::getAllErrorCodeTitles();
154  return $errorCodeTitles[$errorCode];
155  }
$errorCode
$errorCode
Definition: loginuserpass.php:41
+ Here is the caller graph for this function:
The documentation for this class was generated from the following file: