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 Endpoint

Endpoint specification

An endpoint contains the server location the client connects to the following endpoint types are currently supported (more to be added later):

  • tcp://host:port for tcp connections
  • unix://socket for UNIX sockets (provided the server supports this)
  • ssl://host:port for SSL connections (provided the server supports this)

Note: SSL support is added in ArangoDB server 1.1


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

Methods summary

public
# __construct( string $value )

Create a new endpoint

Create a new endpoint

Parameters

$value
  • endpoint specification

Throws

triagens\ArangoDb\ClientException
public string
# __toString( )

Return a string representation of the endpoint

Return a string representation of the endpoint

Returns

string
  • string representation of the endpoint

Magic

public static string
# getType( string $value )

Return the type of an endpoint

Return the type of an endpoint

Parameters

$value
  • endpoint specification value

Returns

string
  • endpoint type
public static string
# getHost( string $value )

Return the host name of an endpoint

Return the host name of an endpoint

Parameters

$value
  • endpoint specification value

Returns

string
  • host name
public static boolean
# isValid( string $value )

check whether an endpoint specification is valid

check whether an endpoint specification is valid

Parameters

$value
  • endpoint specification value

Returns

boolean
  • true if endpoint specification is valid, false otherwise
public static array
# listEndpoints( triagens\ArangoDb\Connection $connection )

List endpoints

List endpoints

This will list the endpoints that are configured on the server

Parameters

$connection
  • the connection to be used

Returns

array
$responseArray - The response array.

Throws

triagens\ArangoDb\Exception

Link

https://docs.arangodb.com/HTTP/Endpoints/index.html

Constants summary

string TYPE_TCP

TCP endpoint type

TCP endpoint type

# 'tcp'
string TYPE_SSL

SSL endpoint type

SSL endpoint type

# 'ssl'
string TYPE_UNIX

UNIX socket endpoint type

UNIX socket endpoint type

# 'unix'
string REGEXP_TCP

Regexp for TCP endpoints

Regexp for TCP endpoints

# '/^tcp:\/\/(.+?):(\d+)\/?$/'
string REGEXP_SSL

Regexp for SSL endpoints

Regexp for SSL endpoints

# '/^ssl:\/\/(.+?):(\d+)\/?$/'
string REGEXP_UNIX

Regexp for UNIX socket endpoints

Regexp for UNIX socket endpoints

# '/^unix:\/\/(.+)$/'
string ENTRY_ENDPOINT

Endpoint index

Endpoint index

# 'endpoint'
string ENTRY_DATABASES

Databases index

Databases index

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