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 HttpResponse

Container class for HTTP responses


Namespace: triagens\ArangoDb
Package: triagens\ArangoDb
Since: 0.2
Located at HttpResponse.php

Methods summary

public
# __construct( string $responseString, string $originUrl = null, string $originMethod = null, boolean $wasAsync = false )

Set up the response

Set up the response

Parameters

$responseString
  • the complete HTTP response as supplied by the server
$originUrl
The original URL the response is coming from
$originMethod
The HTTP method that was used when sending data to the origin URL
$wasAsync

Throws

triagens\ArangoDb\ClientException
public integer
# getHttpCode( )

Return the HTTP status code of the response

Return the HTTP status code of the response

Returns

integer
  • HTTP status code of response
public string
# getHeader( string $name )

Return an individual HTTP headers of the response

Return an individual HTTP headers of the response

Parameters

$name
  • name of header

Returns

string
  • header value, NULL if header wasn't set in response
public array
# getHeaders( )

Return the HTTP headers of the response

Return the HTTP headers of the response

Returns

array
  • array of all headers with values
public string
# getLocationHeader( )

Return the location HTTP header of the response

Return the location HTTP header of the response

Returns

string
  • header value, NULL is header wasn't set in response
public string
# getBody( )

Return the body of the response

Return the body of the response

Returns

string
  • body of the response
public string
# getResult( )

Return the result line (first header line) of the response

Return the result line (first header line) of the response

Returns

string
  • the result line (first line of header)
public array
# getJson( )

Return the data from the JSON-encoded body

Return the data from the JSON-encoded body

Returns

array
  • array of values from the JSON-encoded response body

Throws

triagens\ArangoDb\ClientException
public triagens\ArangoDb\HttpResponse
# setBatchPart( Batchpart $batchPart )

Parameters

$batchPart

Returns

triagens\ArangoDb\HttpResponse
public Batchpart
# getBatchPart( )

Returns

Batchpart

Constants summary

string HEADER_LOCATION

HTTP location header

HTTP location header

# 'location'
ArangoDB-PHP API Documentation API documentation generated by ApiGen