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 ConnectionOptions

Simple container class for connection options.

This class also provides the default values for the connection options and will perform a simple validation of them.
It provides array access to its members.

triagens\ArangoDb\ConnectionOptions implements ArrayAccess
Namespace: triagens\ArangoDb
Package: triagens\ArangoDb
Since: 0.2
Located at ConnectionOptions.php

Methods summary

public
# __construct( array $options )

Set defaults, use options provided by client and validate them

Set defaults, use options provided by client and validate them

Parameters

$options
  • initial options

Throws

triagens\ArangoDb\ClientException
public array
# getAll( )

Get all options

Get all options

Returns

array
  • all options as an array
public
# offsetSet( string $offset, mixed $value )

Set and validate a specific option, necessary for ArrayAccess

Set and validate a specific option, necessary for ArrayAccess

Parameters

$offset
  • name of option
$value
  • value for option

Throws

triagens\ArangoDb\Exception

Implementation of

ArrayAccess::offsetSet()
public boolean
# offsetExists( string $offset )

Check whether an option exists, necessary for ArrayAccess

Check whether an option exists, necessary for ArrayAccess

Parameters

$offset
-name of option

Returns

boolean
  • true if option exists, false otherwise

Implementation of

ArrayAccess::offsetExists()
public
# offsetUnset( string $offset )

Remove an option and validate, necessary for ArrayAccess

Remove an option and validate, necessary for ArrayAccess

Parameters

$offset
  • name of option

Throws

triagens\ArangoDb\Exception

Implementation of

ArrayAccess::offsetUnset()
public mixed
# offsetGet( string $offset )

Get a specific option, necessary for ArrayAccess

Get a specific option, necessary for ArrayAccess

Parameters

$offset
  • name of option

Returns

mixed
  • value of option, will throw if option is not set

Throws

triagens\ArangoDb\ClientException

Implementation of

ArrayAccess::offsetGet()
public triagens\ArangoDb\Endpoint
# getEndpoint( )

Get the endpoint object for the connection

Get the endpoint object for the connection

Returns

triagens\ArangoDb\Endpoint
  • endpoint object

Throws

triagens\ArangoDb\ClientException

Constants summary

string OPTION_ENDPOINT

Endpoint string index constant

Endpoint string index constant

# 'endpoint'
string OPTION_HOST

Host name string index constant (deprecated, use endpoint instead)

Host name string index constant (deprecated, use endpoint instead)

# 'host'
string OPTION_PORT

Port number index constant (deprecated, use endpoint instead)

Port number index constant (deprecated, use endpoint instead)

# 'port'
string OPTION_TIMEOUT

Timeout value index constant

Timeout value index constant

# 'timeout'
string OPTION_TRACE

Trace function index constant

Trace function index constant

# 'trace'
string OPTION_VERIFY_CERT

"verify certificates" index constant

"verify certificates" index constant

# 'verifyCert'
string OPTION_ALLOW_SELF_SIGNED

"allow self-signed" index constant

"allow self-signed" index constant

# 'allowSelfSigned'
string OPTION_CIPHERS

ciphers allowed to be used in SSL

ciphers allowed to be used in SSL

# 'ciphers'
string OPTION_ENHANCED_TRACE

Enhanced trace

Enhanced trace

# 'enhancedTrace'
string OPTION_CREATE

"Create collections if they don't exist" index constant

"Create collections if they don't exist" index constant

# 'createCollection'
string OPTION_REVISION

Update revision constant

Update revision constant

# 'rev'
string OPTION_UPDATE_POLICY

Update policy index constant

Update policy index constant

# 'policy'
string OPTION_UPDATE_KEEPNULL

Update keepNull constant

Update keepNull constant

# 'keepNull'
string OPTION_REPLACE_POLICY

Replace policy index constant

Replace policy index constant

# 'policy'
string OPTION_DELETE_POLICY

Delete policy index constant

Delete policy index constant

# 'policy'
string OPTION_WAIT_SYNC

Wait for sync index constant

Wait for sync index constant

# 'waitForSync'
string OPTION_LIMIT

Limit index constant

Limit index constant

# 'limit'
string OPTION_SKIP

Skip index constant

Skip index constant

# 'skip'
string OPTION_BATCHSIZE

Batch size index constant

Batch size index constant

# 'batchSize'
string OPTION_JOURNAL_SIZE

Wait for sync index constant

Wait for sync index constant

# 'journalSize'
string OPTION_IS_SYSTEM

Wait for sync index constant

Wait for sync index constant

# 'isSystem'
string OPTION_IS_VOLATILE

Wait for sync index constant

Wait for sync index constant

# 'isVolatile'
string OPTION_AUTH_USER

Authentication user name

Authentication user name

# 'AuthUser'
string OPTION_AUTH_PASSWD

Authentication password

Authentication password

# 'AuthPasswd'
string OPTION_AUTH_TYPE

Authentication type

Authentication type

# 'AuthType'
string OPTION_CONNECTION

Connection

Connection

# 'Connection'
string OPTION_RECONNECT

Reconnect flag

Reconnect flag

# 'Reconnect'
string OPTION_BATCH

Batch flag

Batch flag

# 'Batch'
string OPTION_BATCHPART

Batchpart flag

Batchpart flag

# 'BatchPart'
string OPTION_DATABASE

Database flag

Database flag

# 'database'
string OPTION_CHECK_UTF8_CONFORM

UTF-8 CHeck Flag

UTF-8 CHeck Flag

# 'CheckUtf8Conform'
ArangoDB-PHP API Documentation API documentation generated by ApiGen