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 AbstractHttpRequest

Class AbstractHttpRequest

HTTP-Request object that holds a request. Requests are in some cases not directly passed to the server, for instance when a request is destined for a batch.

frankmayer\ArangoDbPhpCore\Protocols\Http\AbstractHttpRequest implements frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequestInterface

Direct known subclasses

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequest

Abstract
Namespace: frankmayer\ArangoDbPhpCore\Protocols\Http
Package: frankmayer\ArangoDbPhpCore\Protocols\Http
Located at Protocols/Http/AbstractHttpRequest.php

Methods summary

public
# __construct( $client )

Parameters

$client
abstract public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
# send( )

Method to send an HTTP request. All request should be done through this method. Any async or batch handling is done within this method.

Method to send an HTTP request. All request should be done through this method. Any async or batch handling is done within this method.

Returns

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
Http Response object

Implementation of

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequestInterface::send()
abstract public mixed
# sendBatch( array $batchParts = [], string $boundary = 'XXXbXXX' )

Method to an HTTP batch request

Method to an HTTP batch request

Parameters

$batchParts
$boundary

Returns

mixed

Implementation of

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequestInterface::sendBatch()
public string
# buildUrlQuery( $urlQueryArray )

Parameters

$urlQueryArray

Returns

string

Constants summary

string METHOD_GET
# 'GET'
string METHOD_POST
# 'POST'
string METHOD_PUT
# 'PUT'
string METHOD_PATCH
# 'PATCH'
string METHOD_DELETE
# 'DELETE'
string METHOD_HEAD
# 'HEAD'
string METHOD_OPTIONS
# 'OPTIONS'
string API_BATCH
# '/_api/batch'

Properties summary

public frankmayer\ArangoDbPhpCore\Client $client
#
public frankmayer\ArangoDbPhpCore\ConnectorInterface $connector
#
public array $connectorOptions
# []
public string $address

The address of the endpoint

The address of the endpoint

#
public string $path

The path-part of the request

The path-part of the request

#
public string $body

The Body of the request

The Body of the request

#
public array $headers

The headers of the request

The headers of the request

# []
public array $options

The options of the request

The options of the request

# []
public string $type

The type of the request

The type of the request

#
public string $method

The method of the request

The method of the request

#
public string $response

The response data as a result of the request

The response data as a result of the request

#
public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponseInterface $responseObject

The response-object as a result of the request

The response-object as a result of the request

#
public object $handler

The wrapped handler of communications.

The wrapped handler of communications.

#
public string $batchBoundary

The boundary string for batch operations with ArangoDB

The boundary string for batch operations with ArangoDB

#
public object $batch

flag for if the request is a batch request (this does not include the batchpart requests)

flag for if the request is a batch request (this does not include the batchpart requests)

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