PHP Class SimpleSAML\Error\ErrorCodes

Show file Open project: simplesamlphp/simplesamlphp

Public Methods

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

Fetch all default translation strings for error code descriptions.

final public static defaultGetAllErrorCodeDescriptions ( ) : string
return	string	A map from error code to error code description

Fetch all default translation strings for error code titles.

final public static defaultGetAllErrorCodeTitles ( ) : array
return	array	A map from error code to error code title

Extend this to add error codes.

public static getAllErrorCodeDescriptions ( ) : string
return	string	A map from error code to error code description

Convenience-method for template-callers

public static getAllErrorCodeMessages ( ) : array
return	array	An array containing both errorcode maps.

Extend this to add error codes.

public static getAllErrorCodeTitles ( ) : array
return	array	A map from error code to error code title

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

public static getErrorCodeDescription ( string $errorCode ) : string
$errorCode	string	The error code to look up
return	string	A string to translate

Convenience-method for template-callers

public static getErrorCodeMessage ( string $errorCode ) : array
$errorCode	string	The error code to look up
return	array	An array containing both errorcode strings.

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

public static getErrorCodeTitle ( string $errorCode ) : string
$errorCode	string	The error code to look up
return	string	A string to translate