ArangoDB-PHP API Documentation
  • Namespace
  • Class
  • Deprecated

Namespaces

  • triagens
    • ArangoDb

Classes

  • AdminHandler
  • AqlUserFunction
  • Autoloader
  • Batch
  • BatchPart
  • BindVars
  • Collection
  • CollectionHandler
  • Connection
  • ConnectionOptions
  • Cursor
  • Database
  • DefaultValues
  • Document
  • DocumentHandler
  • Edge
  • EdgeDefinition
  • EdgeHandler
  • Endpoint
  • Export
  • ExportCursor
  • Graph
  • GraphHandler
  • Handler
  • HttpHelper
  • HttpResponse
  • QueryCacheHandler
  • QueryHandler
  • Statement
  • TraceRequest
  • TraceResponse
  • Transaction
  • Traversal
  • UpdatePolicy
  • UrlHelper
  • Urls
  • User
  • UserHandler
  • ValueValidator
  • Vertex
  • VertexHandler

Exceptions

  • ClientException
  • ConnectException
  • Exception
  • ServerException

Class Handler

A base class for REST-based handlers

Direct known subclasses

triagens\ArangoDb\AdminHandler, triagens\ArangoDb\CollectionHandler, triagens\ArangoDb\DocumentHandler, triagens\ArangoDb\GraphHandler, triagens\ArangoDb\QueryCacheHandler, triagens\ArangoDb\QueryHandler, triagens\ArangoDb\UserHandler

Indirect known subclasses

triagens\ArangoDb\EdgeHandler, triagens\ArangoDb\VertexHandler

Abstract
Namespace: triagens\ArangoDb
Package: triagens\ArangoDb
Since: 0.2
Located at Handler.php

Methods summary

public
# __construct( triagens\ArangoDb\Connection $connection )

Construct a new handler

Construct a new handler

Parameters

$connection
  • connection to be used
protected triagens\ArangoDb\Connection
# getConnection( )

Return the connection object

Return the connection object

Returns

triagens\ArangoDb\Connection
  • the connection object
protected mixed
# getConnectionOption( $optionName )

Return a connection option This is a convenience function that calls json_encode_wrapper on the connection

Return a connection option This is a convenience function that calls json_encode_wrapper on the connection

Parameters

$optionName
The option to return a value for

Returns

mixed
  • the option's value

Throws

triagens\ArangoDb\ClientException
protected string
# json_encode_wrapper( array $body )

Return a json encoded string for the array passed. This is a convenience function that calls json_encode_wrapper on the connection

Return a json encoded string for the array passed. This is a convenience function that calls json_encode_wrapper on the connection

Parameters

$body
  • The body to encode into json

Returns

string
  • json string of the body that was passed

Throws

triagens\ArangoDb\ClientException
protected array
# includeOptionsInParams( array $options, array $includeArray = [] )

Helper function that runs through the options given and includes them into the parameters array given. Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in form of url parameters (like 'waitForSync', 'keepNull', etc...) .

Helper function that runs through the options given and includes them into the parameters array given. Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in form of url parameters (like 'waitForSync', 'keepNull', etc...) .

Parameters

$options
  • The options array that holds the options to include in the parameters
$includeArray
  • The array that defines which options are allowed to be included, and what their default value is. for example: 'waitForSync'=>true

Returns

array
$params - array of parameters for use in a url

Throws

triagens\ArangoDb\ClientException
protected array
# includeOptionsInBody( array $options, array $body, array $includeArray = [] )

Helper function that runs through the options given and includes them into the parameters array given. Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) .

Helper function that runs through the options given and includes them into the parameters array given. Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) .

Parameters

$options
  • The options array that holds the options to include in the parameters
$body
  • The array into which the options will be included.
$includeArray
  • The array that defines which options are allowed to be included, and what their default value is. for example: 'waitForSync'=>true

Returns

array
$params - array of parameters for use in a url
protected string
# makeCollection( mixed $value )

Turn a value into a collection name

Turn a value into a collection name

Parameters

$value
  • document, collection or string

Returns

string
  • collection name

Throws

triagens\ArangoDb\ClientException
ArangoDB-PHP API Documentation API documentation generated by ApiGen