GalaxyError Class Reference

Public Member Functions
	__construct ()
	getError ()
	getErrorMessage ()
	getErrorType ()
	setError ($type, $message)

Constructor & Destructor Documentation

GalaxyError::__construct

(

)

Constructor.

Member Function Documentation

GalaxyError::getError

(

)

Retrieves the most recent error.

The error message uses the key 'message' and the type uses the key 'type'. The following is a list of error types and their meaning:

• API: The blend4php API functions have been improperly used
• Galaxy: The Galaxy server indicated an error.
• HTTP: An error occured using the REST HTTP protocols (e.g. PUT, POST, GET, PATCH, DELETE).
• FILE: An error occured saving a download file from Galaxy.

Returns

An associative array containing both the 'type' and 'message' for the error.

GalaxyError::getErrorMessage

(

)

Retrieves the most recent error message.

Returns

A string containing the error message.

GalaxyError::getErrorType

(

)

Retrieves the most recent error type.

The following is a list of error types and their meaning:

• API: The blend4php API functions have been improperly used
• Galaxy: The Galaxy server indicated an error.
• HTTP: An error occured using the REST HTTP protocols (e.g. PUT, POST, GET, PATCH, DELETE).
• FILE: An error occured saving a download file from Galaxy.

Returns

A string indicating the type of error.

GalaxyError::setError	(		$type,
			$message
	)

Set's the error type and message.

The following is a list of error types and their meaning:

• API: The blend4php API functions have been improperly used
• Galaxy: The Galaxy server indicated an error.
• HTTP: An error occured using the REST HTTP protocols (e.g. PUT, POST, GET, PATCH, DELETE).
• FILE: An error occured saving a download file from Galaxy.

Parameters

$type	The type of error.
$message	The error message.

---

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

• Error.inc