ArangoDB-PHP-Core API Documentation
  • Namespace
  • Class
  • Deprecated

Namespaces

  • frankmayer
    • ArangoDbPhpCore
      • Api
        • Rest
      • Config
      • Connectors
      • Plugins
      • Protocols
        • Http
      • TraitRepository

Classes

  • AbstractHttpRequest
  • HttpRequest
  • HttpResponse

Interfaces

  • HttpConnectorInterface
  • HttpRequestInterface
  • HttpResponseInterface

Class HttpResponse

Http-Response object holding the raw and objectified Response data.

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse implements frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponseInterface
Namespace: frankmayer\ArangoDbPhpCore\Protocols\Http
Package: frankmayer\ArangoDbPhpCore\Protocols\Http
Located at Protocols/Http/HttpResponse.php

Methods summary

public
# __construct( )
public
# build( $request )

Parameters

$request

Returns


$this

Throws

frankmayer\ArangoDbPhpCore\ServerException

Implementation of

frankmayer\ArangoDbPhpCore\Protocols\ResponseInterface::build()
protected string
# decodeGetStatusPhrase( $statusLineArray )

Parameters

$statusLineArray

Returns

string
protected
# splitResponseToHeadersArrayAndBody( $response )

Splits the response data to a Headers array and a body

Splits the response data to a Headers array and a body

It expects the response data to be in $this->request->response It puts the headers into $this->headers and the body into $this->body

Parameters

$response
public array
# deconstructBatchResponseBody( $batchResponseBody, $boundary )

Parameters

$batchResponseBody
$boundary

Returns

array

Throws

frankmayer\ArangoDbPhpCore\ServerException
public static array
# splitBatchPart( $batchPart )

Parameters

$batchPart

Returns

array
public
# setBatch( mixed $batch )

Parameters

$batch
public mixed
# getBatch( )

Returns

mixed
public
# setBody( mixed $body )

Parameters

$body
public mixed
# getBody( )

Returns

mixed
public
# setHeaders( array $headers )

Parameters

$headers
public array
# getHeaders( )

Returns

array
public
# setRequest( frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequest $request )

Parameters

$request
public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequest
# getRequest( )

Returns

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequest
public
# setStatus( mixed $status )

Parameters

$status
public mixed
# getStatus( )

Returns

mixed
public mixed
# getProtocol( )

Returns

mixed
public mixed
# getStatusPhrase( )

Returns

mixed
public
# setVerboseExtractStatusLine( boolean $verboseStatusLine )

Parameters

$verboseStatusLine
public boolean
# getVerboseExtractStatusLine( )

Returns

boolean
protected array
# getHeaderArray( $headers )

Parameters

$headers

Returns

array

Properties summary

public array $enabledHttpServerExceptions

An array with the http status codes of the ones, that we want to raise an exception for.

This should be set with an array like array(400,401,402,403);

An array with the http status codes of the ones, that we want to raise an exception for.

This should be set with an array like array(400,401,402,403);

#
public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequest $request

$request The request object

$request The request object

#
public array $headers

$headers The headers in form of an multidimensional array

$headers The headers in form of an multidimensional array

# []
public string $body

$body The body of the response

$body The body of the response

#
public array $batch

$batch An array of batch parts

$batch An array of batch parts

#
public string $protocol

$protocol The protocol used

$protocol The protocol used

#
public integer $status

$status The http status code of the response

$status The http status code of the response

#
public string $statusPhrase

$statusPhrase The associated text to the status code

$statusPhrase The associated text to the status code

#
public boolean $verboseExtractStatusLine

$verboseExtractStatusLine get only status code or also the accompanying text

$verboseExtractStatusLine get only status code or also the accompanying text

# false
public boolean $batchContentId

This holds the Batchpart Content-Id of the response if one was supplied to ArangoDB in the request.

This holds the Batchpart Content-Id of the response if one was supplied to ArangoDB in the request.

#
ArangoDB-PHP-Core API Documentation API documentation generated by ApiGen