\Aculab\WebServicesWrapperWebServiceException

The exception class raised when errors occur.

Summary

Methods

Properties

Constants

getHttpStatusCode()
getHttpReasonPhrase()
getResponseBody()
getWebServiceError()
getWebServiceErrorDescription()
getWebServiceErrorDetails()
getWebServiceErrorHelpLink()
getWebServiceErrorDateTime()
getWebServiceErrorRequestDateTime()
getWebServiceErrorRequestUrl()
getLocalFilename()
getWebsocketRejectReason()
getWebsocketRejectCode()
getWebsocketRejectMessage()

No public properties found

CONNECTION_FAILURE
HTTP_ERROR_RESPONSE
WEB_SERVICE_ERROR_RESPONSE
LOCAL_FILE_ACCESS_ERROR
RESPONSE_DECODE_ERROR
WEBSOCKET_REJECT_RESPONSE

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: WebServiceException.php
Package: aculab/web-services-wrapper
Class hierarchy: \Exception

\Aculab\WebServicesWrapper\WebServiceException

Constants

CONNECTION_FAILURE

CONNECTION_FAILURE

The exception code used when the connection to the web service failed.

This code will be used when the web services server can not be reached.

HTTP_ERROR_RESPONSE

HTTP_ERROR_RESPONSE

The exception code used when the web service returned an HTTP error code.

This code is used when the HTTP status code is not a success (2xx) code. The HTTP status code, reason phrase and response body are available. The response body will usually contain a description of the problem that occurred.

WEB_SERVICE_ERROR_RESPONSE

WEB_SERVICE_ERROR_RESPONSE

The exception code used when the web service returned error details.

This code is used when the HTTP status code is not a success (2xx) code and detailed error information is available in the response body. The HTTP status code, reason phrase, response body and the web service error details are available.

LOCAL_FILE_ACCESS_ERROR

LOCAL_FILE_ACCESS_ERROR

The exception code used when there was a problem accessing local file.

This is used when uploading or downloading files and an error occurred reading or writing the local file.

RESPONSE_DECODE_ERROR

RESPONSE_DECODE_ERROR

The exception code used when the web service response was not understood.

WEBSOCKET_REJECT_RESPONSE

WEBSOCKET_REJECT_RESPONSE

The exception code used when the websocket returned a reject event.

This code is used when the websocket has returned a reject event. The websocket reject reason is available.

Methods

getHttpStatusCode()

getHttpStatusCode() : string

Get the HTTP status code.

Gets the HTTP status code that triggered the exception, or an empty string.

Returns

string

getHttpReasonPhrase()

getHttpReasonPhrase() : string

Get the HTTP reason phrase.

Gets the HTTP reason phrase that triggered the exception, or an empty string.

Returns

string

getResponseBody()

getResponseBody() : string

Get the HTTP response body.

Gets the HTTP response body that triggered the exception, or an empty string.

Returns

string

getWebServiceError()

getWebServiceError() : string

Get the web service error.

Gets the web service error that triggered the exception, or an empty string.

Returns

string

getWebServiceErrorDescription()

getWebServiceErrorDescription() : string

Get the web service error description.

Gets the description of the web service error that triggered the exception, or an empty string.

Returns

string

getWebServiceErrorDetails()

getWebServiceErrorDetails() : array|null

Get the web service error details.

Gets the details of the web service error that triggered the exception, or null.

Returns

array|null —

An array of strings or null.

getWebServiceErrorHelpLink()

getWebServiceErrorHelpLink() : string

Get the web service error help link.

Gets the help link for the web service error that triggered the exception, or an empty string.

Returns

string

getWebServiceErrorDateTime()

getWebServiceErrorDateTime() : \DateTime|null

Get the web service error time.

Gets the time of the web service error that triggered the exception occurred, or null.

Returns

\DateTime|null

getWebServiceErrorRequestDateTime()

getWebServiceErrorRequestDateTime() : \DateTime|null

Get the web service request time.

Gets the time of the web service request that triggered the exception occurred, or null.

Returns

\DateTime|null

getWebServiceErrorRequestUrl()

getWebServiceErrorRequestUrl() : string

Get the web service request url.

Gets the url of the web service request that triggered the exception, or an empty string.

Returns

string

getLocalFilename()

getLocalFilename() : string

Get the local filename.

Gets the local filename of the file that triggered the exception, or an empty string.

Returns

string

getWebsocketRejectReason()

getWebsocketRejectReason() : string

Get the websocket reject reason.

Gets the reason given in the websocket reject event.

Returns

string

getWebsocketRejectCode()

getWebsocketRejectCode() : integer

Get the websocket reject code.

Gets the code given in the websocket reject event.

Returns

integer

getWebsocketRejectMessage()

getWebsocketRejectMessage() : string

Get the websocket reject message.

Gets the message given in the websocket reject event.

Returns

string