Arango PHP ODM

Api
in package

AbstractYes

API Helper to Arango HTTP Interface

Tags
copyright

2018 Lucas S. Vieira

Table of Contents

Constants

ADMIN_ENGINE  = "/_api/engine"
ADMIN_FLUSH_WAL  = "/_admin/wal/flush"
ADMIN_LOG  = "/_admin/log"
ADMIN_LOG_LEVEL  = "/_admin/log/level"
ADMIN_ROUTING_RELOAD  = "/_admin/routing/reload"
ADMIN_SERVER_AVAILABILITY  = "/_admin/server/availability"
ADMIN_SERVER_ROLE  = "/_admin/server/role"
ADMIN_STATISTICS  = "/_admin/statistics"
ADMIN_STATISTICS_DESCRIPTION  = "/_admin/statistics-description"
ADMIN_TASKS  = "/_api/tasks"
ADMIN_TIME  = "/_admin/time"
ADMIN_VERSION  = "/_api/version"
ADMIN_WAL_PROPERTIES  = "_admin/wal/properties"
ADMIN_WAL_TRANSACTIONS  = "_admin/wal/transactions"
ALL  = "/_api/simple/all"
ALL_KEYS  = "/_api/simple/all"
ANY  = "/_api/simple/any"
AQL_USER_FUNCTION  = "/_api/aqlfunction"
AUTH_BASE  = "/_open/auth"
BATCH  = "/_api/batch"
COLLECTION  = "/_api/collection"
COLLECTION_CHECKSUM  = "/checksum"
COLLECTION_COUNT  = "/count"
COLLECTION_LOAD  = "/load"
COLLECTION_PROPERTIES  = "/properties"
COLLECTION_RECALCULATE_COUNT  = "/recalculateCount"
COLLECTION_RENAME  = "/rename"
COLLECTION_REVISION  = "/revision"
COLLECTION_ROTATE  = "/rotate"
COLLECTION_TRUNCATE  = "/truncate"
CURRENT_DATABASE  = "/_api/database/current"
CURSOR  = "/_api/cursor"
DATABASE  = "/_api/database"
DB  = "/_db/"
DOCUMENT  = "/_api/document"
EDGE  = "/_api/document"
EDGES  = "/_api/edges"
ENDPOINT  = "/_api/endpoint"
EXAMPLE  = "/_api/simple/by-example"
EXPLAIN  = "/_api/explain"
FIRST_EXAMPLE  = "/_api/simple/first-example"
FOXX  = "/_api/foxx"
FOXX_SERVICE  = "/_api/foxx/service"
FULLTEXT  = "/_api/simple/fulltext"
GRAPH  = "/_api/gharial"
IMPORT  = "/_api/import"
INDEX  = "/_api/index"
JWT_AUTH_BASE  = "/_open/auth"
LOOKUP_BY_KEYS  = "/_api/simple/lookup-by_keys"
PART_EDGE  = "vertex"
PART_VERTEX  = "vertex"
QUERY  = "/_api/query"
QUERY_CACHE  = "/_api/query-cache"
REMOVE_BY_EXAMPLE  = "/_api/simple/remove-by-example"
REMOVE_BY_KEYS  = "/_api/simple/remove-by-keys"
REPLACE_BY_EXAMPLE  = "/_api/simple/replace-by-example"
TRANSACTION  = "/_api/transaction"
TRANSACTION_BEGIN  = "/_api/transaction/begin"
TRAVERSAL  = "/_api/traversal"
UPDATE_BY_EXAMPLE  = "/_api/simple/update-by-example"
UPLOAD  = "/_api/upload"
USER  = "/_api/user"
USER_DATABASES  = "/_api/database/user"

Methods

addQuery()  : string
Add an URI query
addUriParam()  : string
Add an URI param to an URI
buildDatabaseUri()  : string
Builds URIs for access to Arango HTTP Interface
buildSystemUri()  : string
Builds URIs for access some special endpoints on Arango HTTP Interface

Constants

ADMIN_ENGINE

public mixed ADMIN_ENGINE = "/_api/engine"

ADMIN_FLUSH_WAL

public mixed ADMIN_FLUSH_WAL = "/_admin/wal/flush"

ADMIN_LOG

public mixed ADMIN_LOG = "/_admin/log"

ADMIN_LOG_LEVEL

public mixed ADMIN_LOG_LEVEL = "/_admin/log/level"

ADMIN_ROUTING_RELOAD

public mixed ADMIN_ROUTING_RELOAD = "/_admin/routing/reload"

ADMIN_SERVER_AVAILABILITY

public mixed ADMIN_SERVER_AVAILABILITY = "/_admin/server/availability"

ADMIN_SERVER_ROLE

public mixed ADMIN_SERVER_ROLE = "/_admin/server/role"

ADMIN_STATISTICS

public mixed ADMIN_STATISTICS = "/_admin/statistics"

ADMIN_STATISTICS_DESCRIPTION

public mixed ADMIN_STATISTICS_DESCRIPTION = "/_admin/statistics-description"

ADMIN_TASKS

public mixed ADMIN_TASKS = "/_api/tasks"

ADMIN_TIME

public mixed ADMIN_TIME = "/_admin/time"

ADMIN_VERSION

public mixed ADMIN_VERSION = "/_api/version"

ADMIN_WAL_PROPERTIES

public mixed ADMIN_WAL_PROPERTIES = "_admin/wal/properties"

ADMIN_WAL_TRANSACTIONS

public mixed ADMIN_WAL_TRANSACTIONS = "_admin/wal/transactions"

ALL

public mixed ALL = "/_api/simple/all"

ALL_KEYS

public mixed ALL_KEYS = "/_api/simple/all"

ANY

public mixed ANY = "/_api/simple/any"

AQL_USER_FUNCTION

public mixed AQL_USER_FUNCTION = "/_api/aqlfunction"

AUTH_BASE

public mixed AUTH_BASE = "/_open/auth"

BATCH

public mixed BATCH = "/_api/batch"

COLLECTION

public mixed COLLECTION = "/_api/collection"

COLLECTION_CHECKSUM

public mixed COLLECTION_CHECKSUM = "/checksum"

COLLECTION_COUNT

public mixed COLLECTION_COUNT = "/count"

COLLECTION_LOAD

public mixed COLLECTION_LOAD = "/load"

COLLECTION_PROPERTIES

public mixed COLLECTION_PROPERTIES = "/properties"

COLLECTION_RECALCULATE_COUNT

public mixed COLLECTION_RECALCULATE_COUNT = "/recalculateCount"

COLLECTION_RENAME

public mixed COLLECTION_RENAME = "/rename"

COLLECTION_REVISION

public mixed COLLECTION_REVISION = "/revision"

COLLECTION_ROTATE

public mixed COLLECTION_ROTATE = "/rotate"

COLLECTION_TRUNCATE

public mixed COLLECTION_TRUNCATE = "/truncate"

CURRENT_DATABASE

public mixed CURRENT_DATABASE = "/_api/database/current"

CURSOR

public mixed CURSOR = "/_api/cursor"

DATABASE

public mixed DATABASE = "/_api/database"

DB

public mixed DB = "/_db/"

DOCUMENT

public mixed DOCUMENT = "/_api/document"

EDGE

public mixed EDGE = "/_api/document"

EDGES

public mixed EDGES = "/_api/edges"

ENDPOINT

public mixed ENDPOINT = "/_api/endpoint"

EXAMPLE

public mixed EXAMPLE = "/_api/simple/by-example"

EXPLAIN

public mixed EXPLAIN = "/_api/explain"

FIRST_EXAMPLE

public mixed FIRST_EXAMPLE = "/_api/simple/first-example"

FOXX

public mixed FOXX = "/_api/foxx"

FOXX_SERVICE

public mixed FOXX_SERVICE = "/_api/foxx/service"

FULLTEXT

public mixed FULLTEXT = "/_api/simple/fulltext"

GRAPH

public mixed GRAPH = "/_api/gharial"

IMPORT

public mixed IMPORT = "/_api/import"

INDEX

public mixed INDEX = "/_api/index"

JWT_AUTH_BASE

public mixed JWT_AUTH_BASE = "/_open/auth"

LOOKUP_BY_KEYS

public mixed LOOKUP_BY_KEYS = "/_api/simple/lookup-by_keys"

PART_EDGE

public mixed PART_EDGE = "vertex"

PART_VERTEX

public mixed PART_VERTEX = "vertex"

QUERY

public mixed QUERY = "/_api/query"

QUERY_CACHE

public mixed QUERY_CACHE = "/_api/query-cache"

REMOVE_BY_EXAMPLE

public mixed REMOVE_BY_EXAMPLE = "/_api/simple/remove-by-example"

REMOVE_BY_KEYS

public mixed REMOVE_BY_KEYS = "/_api/simple/remove-by-keys"

REPLACE_BY_EXAMPLE

public mixed REPLACE_BY_EXAMPLE = "/_api/simple/replace-by-example"

TRANSACTION

public mixed TRANSACTION = "/_api/transaction"

TRANSACTION_BEGIN

public mixed TRANSACTION_BEGIN = "/_api/transaction/begin"

TRAVERSAL

public mixed TRAVERSAL = "/_api/traversal"

UPDATE_BY_EXAMPLE

public mixed UPDATE_BY_EXAMPLE = "/_api/simple/update-by-example"

UPLOAD

public mixed UPLOAD = "/_api/upload"

USER

public mixed USER = "/_api/user"

USER_DATABASES

public mixed USER_DATABASES = "/_api/database/user"

Methods

addQuery()

Add an URI query

public static addQuery(string $baseUri[, array<string|int, mixed> $data = [] ]) : string
Parameters
$baseUri : string

Base URI to add a query.

$data : array<string|int, mixed> = []

Query data.

Return values
string —

The modified URI with the Query.

addUriParam()

Add an URI param to an URI

public static addUriParam(string $baseUri, string|int $param) : string
Parameters
$baseUri : string

Base URI to add a parameter.

$param : string|int

Parameter value.

Return values
string —

The modified URI.

buildDatabaseUri()

Builds URIs for access to Arango HTTP Interface

public static buildDatabaseUri(string $baseUri, string $database[, string $apiEndpoint = '' ]) : string
Parameters
$baseUri : string

Base URI to add a parameter.

$database : string

Database name.

$apiEndpoint : string = ''

Base Api endpoint (One of Api class constants).

Return values
string —

The modified database URI.

buildSystemUri()

Builds URIs for access some special endpoints on Arango HTTP Interface

public static buildSystemUri(string $baseUri, string $endpoint) : string
Parameters
$baseUri : string

Base URI to add a parameter.

$endpoint : string

One of Api class constants.

Return values
string —

The modified system URI.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results