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 HttpRequest

Class HttpRequest

frankmayer\ArangoDbPhpCore\Protocols\Http\AbstractHttpRequest implements frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequestInterface
Extended by frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequest implements frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequestInterface
Namespace: frankmayer\ArangoDbPhpCore\Protocols\Http
Package: frankmayer\ArangoDbPhpCore\Protocols\Http
Located at Protocols/Http/HttpRequest.php

Methods summary

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()
public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponseInterface
# sendBatch( array $batchParts = [], string $boundary = 'XXXbXXX' )

Parameters

$batchParts
$boundary

Returns

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponseInterface

Implementation of

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequestInterface::sendBatch()
public
# setAddress( string $address )

Parameters

$address
public string
# getAddress( )

Returns

string
public
# setBody( string $body )

Parameters

$body
public string
# getBody( )

Returns

string
public
# setClient( frankmayer\ArangoDbPhpCore\Client $client )

Parameters

$client
public frankmayer\ArangoDbPhpCore\Client
# getClient( )

Returns

frankmayer\ArangoDbPhpCore\Client
public
# setConnector( frankmayer\ArangoDbPhpCore\ConnectorInterface $connector )

Parameters

$connector
public frankmayer\ArangoDbPhpCore\ConnectorInterface
# getConnector( )

Returns

frankmayer\ArangoDbPhpCore\ConnectorInterface
public
# setHeaders( array $headers )

Parameters

$headers
public array
# getHeaders( )

Returns

array
public
# setMethod( string $method )

Parameters

$method
public string
# getMethod( )

Returns

string
public
# setOptions( array $options )

Parameters

$options
public array
# getOptions( )

Returns

array
public
# setPath( string $path )

Parameters

$path
public string
# getPath( )

Returns

string
public
# setResponse( string $response )

Parameters

$response
public string
# getResponse( )

Returns

string

Methods inherited from frankmayer\ArangoDbPhpCore\Protocols\Http\AbstractHttpRequest

__construct(), buildUrlQuery()

Constants summary

Constants inherited from frankmayer\ArangoDbPhpCore\Protocols\Http\AbstractHttpRequest

API_BATCH, METHOD_DELETE, METHOD_GET, METHOD_HEAD, METHOD_OPTIONS, METHOD_PATCH, METHOD_POST, METHOD_PUT

Properties summary

public array $batchParts

$batchparts

$batchparts

#
public boolean $async

$async

$async

#
public boolean $batch

$batch

$batch

#
public string $batchBoundary

$batchBoundary

$batchBoundary

#
public boolean $isBatchPart202

todo: is this still needed?

todo: is this still needed?

#

Properties inherited from frankmayer\ArangoDbPhpCore\Protocols\Http\AbstractHttpRequest

$address, $body, $client, $connector, $connectorOptions, $handler, $headers, $method, $options, $path, $response, $responseObject, $type

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