Constants

OPTION_ENDPOINT

OPTION_ENDPOINT

Endpoint string index constant

OPTION_HOST

OPTION_HOST

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

OPTION_PORT

OPTION_PORT

Port number index constant (deprecated, use endpoint instead)

OPTION_TIMEOUT

OPTION_TIMEOUT

Timeout value index constant

OPTION_TRACE

OPTION_TRACE

Trace function index constant

OPTION_ENHANCED_TRACE

OPTION_ENHANCED_TRACE

Enhanced trace

OPTION_CREATE

OPTION_CREATE

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

OPTION_REVISION

OPTION_REVISION

Update revision constant

OPTION_UPDATE_POLICY

OPTION_UPDATE_POLICY

Update policy index constant

OPTION_UPDATE_KEEPNULL

OPTION_UPDATE_KEEPNULL

Update keepNull constant

OPTION_REPLACE_POLICY

OPTION_REPLACE_POLICY

Replace policy index constant

OPTION_DELETE_POLICY

OPTION_DELETE_POLICY

Delete policy index constant

OPTION_WAIT_SYNC

OPTION_WAIT_SYNC

Wait for sync index constant

OPTION_LIMIT

OPTION_LIMIT

Limit index constant

OPTION_SKIP

OPTION_SKIP

Skip index constant

OPTION_BATCHSIZE

OPTION_BATCHSIZE

Batch size index constant

OPTION_JOURNAL_SIZE

OPTION_JOURNAL_SIZE

Wait for sync index constant

OPTION_IS_SYSTEM

OPTION_IS_SYSTEM

Wait for sync index constant

OPTION_IS_VOLATILE

OPTION_IS_VOLATILE

Wait for sync index constant

OPTION_AUTH_USER

OPTION_AUTH_USER

Authentication user name

OPTION_AUTH_PASSWD

OPTION_AUTH_PASSWD

Authentication password

OPTION_AUTH_TYPE

OPTION_AUTH_TYPE

Authentication type

OPTION_CONNECTION

OPTION_CONNECTION

Connection

OPTION_RECONNECT

OPTION_RECONNECT

Reconnect flag

OPTION_BATCH

OPTION_BATCH

Batch flag

OPTION_BATCHPART

OPTION_BATCHPART

Batchpart flag

OPTION_DATABASE

OPTION_DATABASE

Database flag

OPTION_CHECK_UTF8_CONFORM

OPTION_CHECK_UTF8_CONFORM

UTF-8 CHeck Flag

Properties

$_values

$_values : array

The current options

Type

array

Methods

__construct()

__construct(array $options) : \triagens\ArangoDb\ConnectionOptions

Set defaults, use options provided by client and validate them

Parameters

array $options
  • initial options

Returns

\triagens\ArangoDb\ConnectionOptions

getAll()

getAll() : array

Get all options

Returns

array —
  • all options as an array

offsetSet()

offsetSet(string $offset, mixed $value) : void

Set and validate a specific option, necessary for ArrayAccess

Parameters

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

Throws

\triagens\ArangoDb\Exception

offsetExists()

offsetExists(string $offset) : boolean

Check whether an option exists, necessary for ArrayAccess

Parameters

string $offset

-name of option

Returns

boolean —
  • true if option exists, false otherwise

offsetUnset()

offsetUnset(string $offset) : void

Remove an option and validate, necessary for ArrayAccess

Parameters

string $offset
  • name of option

Throws

\triagens\ArangoDb\Exception

offsetGet()

offsetGet(string $offset) : mixed

Get a specific option, necessary for ArrayAccess

Parameters

string $offset
  • name of option

Throws

\triagens\ArangoDb\ClientException

Returns

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

getEndpoint()

getEndpoint() : \triagens\ArangoDb\Endpoint

Get the endpoint object for the connection

Throws

\triagens\ArangoDb\ClientException

Returns

\triagens\ArangoDb\Endpoint
  • endpoint object

getDefaults()

getDefaults() : array

Get the default values for the options

Returns

array —
  • array of default connection options

getSupportedAuthTypes()

getSupportedAuthTypes() : array

Return the supported authorization types

Returns

array —
  • array with supported authorization types

getSupportedConnectionTypes()

getSupportedConnectionTypes() : array

Return the supported connection types

Returns

array —
  • array with supported connection types

validate()

validate() : void

Validate the options

Throws

\triagens\ArangoDb\ClientException