ArangoDB-PHP API Documentation
  • Namespace
  • Class
  • Deprecated

Namespaces

  • triagens
    • ArangoDb

Classes

  • AdminHandler
  • AqlUserFunction
  • Autoloader
  • Batch
  • BatchPart
  • BindVars
  • Collection
  • CollectionHandler
  • Connection
  • ConnectionOptions
  • Cursor
  • Database
  • DefaultValues
  • Document
  • DocumentHandler
  • Edge
  • EdgeDefinition
  • EdgeHandler
  • Endpoint
  • Export
  • ExportCursor
  • Graph
  • GraphHandler
  • Handler
  • HttpHelper
  • HttpResponse
  • QueryCacheHandler
  • QueryHandler
  • Statement
  • TraceRequest
  • TraceResponse
  • Transaction
  • Traversal
  • UpdatePolicy
  • UrlHelper
  • Urls
  • User
  • UserHandler
  • ValueValidator
  • Vertex
  • VertexHandler

Exceptions

  • ClientException
  • ConnectException
  • Exception
  • ServerException

Class ServerException

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.

Exception implements Throwable
Extended by triagens\ArangoDb\Exception
Extended by triagens\ArangoDb\ServerException
Namespace: triagens\ArangoDb
Package: triagens\ArangoDb
Since: 0.2
Located at ServerException.php

Methods summary

public string
# __toString( )

Return a string representation of the exception

Return a string representation of the exception

Returns

string
  • string representation
public
# setDetails( array $details )

Set exception details

Set exception details

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

Parameters

$details
  • array of exception details
public array
# getDetails( )

Get exception details

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
public integer
# getServerCode( )

Get server error code

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
public string
# getServerMessage( )

Get server error message

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

Methods inherited from triagens\ArangoDb\Exception

__construct(), disableLogging(), enableLogging()

Methods inherited from Exception

__wakeup(), getCode(), getFile(), getLine(), getMessage(), getPrevious(), getTrace(), getTraceAsString()

Constants summary

string ENTRY_CODE

Error number index

Error number index

# 'errorNum'
string ENTRY_MESSAGE

Error message index

Error message index

# 'errorMessage'

Properties summary

Properties inherited from Exception

$code, $file, $line, $message

ArangoDB-PHP API Documentation API documentation generated by ApiGen