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 Collection

Class Collection

frankmayer\ArangoDbPhpCore\Api\Rest\Api
Extended by frankmayer\ArangoDbPhpCore\Api\Rest\Collection implements frankmayer\ArangoDbPhpCore\Api\RestApiInterface
Namespace: frankmayer\ArangoDbPhpCore\Api\Rest
Package: frankmayer\ArangoDbPhpCore\Api\Rest
Located at Api/Rest/Collection.php

Methods summary

public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
# create( string $collectionName, array $collectionParameters = [], array $options = [] )

Parameters

$collectionName
The collection name
$collectionParameters
Collection parameters according to the HTTP API
$options
Other options (not stable yet...)

Returns

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse

Throws

frankmayer\ArangoDbPhpCore\ClientException
public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
# drop( string $collectionName, array $options = [] )

Parameters

$collectionName
$options

Returns

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

Parameters

$collectionName
$options

Returns

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

Parameters

$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/collection'

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