ArangoDB-PHP-Core API Documentation
  • Namespace
  • Class
  • Deprecated

Namespaces

  • frankmayer
    • ArangoDbPhpCore
      • Api
        • Rest
      • Config
      • Connectors
      • Plugins
      • Protocols
        • Http
      • TraitRepository

Classes

  • ConnectionOptions
  • DefaultValues
  • Endpoint
  • UpdatePolicy

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: frankmayer\ArangoDbPhpCore\Config
Package: frankmayer\ArangoDbPhpCore\Config
Copyright: Copyright 2013-2015, FRANKMAYER.NET, Athens, Greece
Author: Frank Mayer
Located at Config/Endpoint.php

Methods summary

public frankmayer\ArangoDbPhpCore\Config\Endpoint
# __construct( string $value )

Create a new endpoint

Create a new endpoint

Parameters

$value
  • endpoint specification

Returns

frankmayer\ArangoDbPhpCore\Config\Endpoint

Throws

frankmayer\ArangoDbPhpCore\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
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

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:\/\/(.+)$/'
ArangoDB-PHP-Core API Documentation API documentation generated by ApiGen