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

Namespaces

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

Classes

  • Api
  • Async
  • Batch
  • Collection
  • Database
  • Document
  • DocumentBase
  • Edge

Traits

  • DocumentTrait
  • EdgeTrait

Class DocumentBase

Class DocumentBase

frankmayer\ArangoDbPhpCore\Api\Rest\Api
Extended by frankmayer\ArangoDbPhpCore\Api\Rest\DocumentBase

Direct known subclasses

frankmayer\ArangoDbPhpCore\Api\Rest\Document, frankmayer\ArangoDbPhpCore\Api\Rest\Edge

Namespace: frankmayer\ArangoDbPhpCore\Api\Rest
Package: frankmayer\ArangoDbPhpCore\Api\Rest
Located at Api/Rest/DocumentBase.php

Methods summary

public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
# replace( string $handle, string $body, array $urlQuery = [], array $options = [] )

Parameters

$handle
$body
$urlQuery
$options

Returns

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
# update( string $handle, string $body, array $urlQuery = [], array $options = [] )

Parameters

$handle
$body
$urlQuery
$options

Returns

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
# getAll( string $collection, array $options = [] )

Parameters

$collection
$options

Returns

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
# get( string $handle, array $options = [] )

Parameters

$handle
The document handle of the document we want to get. Example: MyCollection/22334
$options

Returns

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
# getHeader( string $handle, array $options = [] )

Parameters

$handle
The document handle of the document we want to get. Example: MyCollection/22334
$options

Returns

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
# delete( string $handle, array $options = [] )

Parameters

$handle
$options

Returns

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse

Methods inherited from frankmayer\ArangoDbPhpCore\Api\Rest\Api

__construct(), array_merge_recursive_distinct(), getRequest(), getResponse(), getReturnObject()

Constants summary

string API_PATH
# '/_api/document'

Constants inherited from frankmayer\ArangoDbPhpCore\Api\Rest\Api

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

Properties summary

Properties inherited from frankmayer\ArangoDbPhpCore\Api\Rest\Api

$client

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