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 Graph

Value object representing a graph


triagens\ArangoDb\Document
Extended by triagens\ArangoDb\Graph
Namespace: triagens\ArangoDb
Package: triagens\ArangoDb
Since: 1.2
Located at Graph.php

Methods summary

public
# __construct( array $name = null, array $options = [] )

Constructs an empty graph

Constructs an empty graph

Parameters

$name
  • optional, initial name for graph
$options
  • optional, initial options for graph

Throws

triagens\ArangoDb\ClientException

Since

1.2

Overrides

triagens\ArangoDb\Document::__construct
public triagens\ArangoDb\Graph
# addEdgeDefinition( triagens\ArangoDb\EdgeDefinition $edgeDefinition )

Adds an edge definition to the graph.

Adds an edge definition to the graph.

Parameters

$edgeDefinition
  • the edge Definition.

Returns

triagens\ArangoDb\Graph

Since

2.2
public triagens\ArangoDb\EdgeDefinition[]
# getEdgeDefinitions( )

Get the edge definitions of the graph.

Get the edge definitions of the graph.

Returns

triagens\ArangoDb\EdgeDefinition[]

Since

2.2
public triagens\ArangoDb\Graph
# addOrphanCollection( string $orphanCollection )

Adds an orphan collection to the graph.

Adds an orphan collection to the graph.

Parameters

$orphanCollection
  • the orphan collection.

Returns

triagens\ArangoDb\Graph

Since

2.2
public string[]
# getOrphanCollections( )

Get the orphan collections of the graph.

Get the orphan collections of the graph.

Returns

string[]

Since

2.2
public
# set( string $key, mixed $value )

Set a graph attribute

Set a graph attribute

The key (attribute name) must be a string. This will validate the value of the attribute and might throw an exception if the value is invalid.

Parameters

$key
  • attribute name
$value
  • value for attribute

Throws

triagens\ArangoDb\ClientException

Overrides

triagens\ArangoDb\Document::set

Methods inherited from triagens\ArangoDb\Document

__clone(), __get(), __isset(), __set(), __toString(), __unset(), createFromArray(), filterHiddenAttributes(), get(), getAll(), getAllAsObject(), getAllForInsertUpdate(), getChanged(), getCollectionId(), getHandle(), getHiddenAttributes(), getId(), getInternalId(), getInternalKey(), getIsNew(), getKey(), getRevision(), isIgnoreHiddenAttributes(), setChanged(), setHiddenAttributes(), setIgnoreHiddenAttributes(), setInternalId(), setInternalKey(), setIsNew(), setRevision(), toJson(), toSerialized()

Constants summary

string ENTRY_EDGE_DEFINITIONS

Graph edge definitions

Graph edge definitions

# 'edgeDefinitions'
string ENTRY_FROM

Graph edge definitions from collections

Graph edge definitions from collections

# 'from'
string ENTRY_TO

Graph edge definitions to collections

Graph edge definitions to collections

# 'to'
string ENTRY_COLLECTION

Graph edge definitions collections

Graph edge definitions collections

# 'collection'
string ENTRY_ORPHAN_COLLECTIONS

Graph orphan collections

Graph orphan collections

# 'orphanCollections'

Constants inherited from triagens\ArangoDb\Document

ENTRY_HIDDENATTRIBUTES, ENTRY_ID, ENTRY_IGNOREHIDDENATTRIBUTES, ENTRY_ISNEW, ENTRY_KEY, ENTRY_REV, OPTION_KEEPNULL, OPTION_POLICY, OPTION_WAIT_FOR_SYNC

Properties summary

protected triagens\ArangoDb\EdgeDefinition[] $_edgeDefinitions

The list of edge definitions defining the graph.

The list of edge definitions defining the graph.

# []
protected array $_orphanCollections

The list of orphan collections defining the graph. These collections are not used in any edge definition of the graph.

The list of orphan collections defining the graph. These collections are not used in any edge definition of the graph.

# []

Properties inherited from triagens\ArangoDb\Document

$_changed, $_doValidate, $_hiddenAttributes, $_id, $_ignoreHiddenAttributes, $_isNew, $_key, $_rev, $_values

ArangoDB-PHP API Documentation API documentation generated by ApiGen