\triagens\ArangoDbServerException

Server-Exception

This exception type will be thrown by the client when the server returns an error in response to a client request.

The exception code is the HTTP status code as returned by the server. In case the server provides additional details about the error, these details can be queried using the getDetails() function.

Summary

Methods
Properties
Constants
__toString()
setDetails()
getDetails()
getServerCode()
getServerMessage()
No public properties found
ENTRY_CODE
ENTRY_MESSAGE
No protected methods found
No protected properties found
N/A
No private methods found
$_details
N/A

Constants

ENTRY_CODE

ENTRY_CODE

Error number index

ENTRY_MESSAGE

ENTRY_MESSAGE

Error message index

Properties

$_details

$_details : 

Optional details for the exception

Type

Methods

__toString()

__toString() : string

Return a string representation of the exception

Returns

string —
  • string representation

setDetails()

setDetails(array $details) : void

Set exception details

If the server provides additional details about the error that occurred, they will be put here.

Parameters

array $details
  • array of exception details

getDetails()

getDetails() : array

Get exception details

If the server has provided additional details about the error that occurred, they can be queries using the method

Returns

array —
  • array of details

getServerCode()

getServerCode() : integer

Get server error code

If the server has provided additional details about the error that occurred, this will return the server error code

Returns

integer —
  • server error code

getServerMessage()

getServerMessage() : string

Get server error message

If the server has provided additional details about the error that occurred, this will return the server error string

Returns

string —
  • server error message