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 Edge

Value object representing a single collection-based edge document


triagens\ArangoDb\Document
Extended by triagens\ArangoDb\Edge
Namespace: triagens\ArangoDb
Package: triagens\ArangoDb
Since: 1.0
Located at Edge.php

Methods summary

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

Set a document attribute

Set a document 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
public triagens\ArangoDb\Edge
# setFrom( mixed $from )

Set the 'from' vertex document-handler

Set the 'from' vertex document-handler

Parameters

$from
  • from vertex

Returns

triagens\ArangoDb\Edge
  • edge object
public mixed
# getFrom( )

Get the 'from' vertex document-handler (if already known)

Get the 'from' vertex document-handler (if already known)

Returns

mixed
  • document-handler
public triagens\ArangoDb\Edge
# setTo( mixed $to )

Set the 'to' vertex document-handler

Set the 'to' vertex document-handler

Parameters

$to
  • to vertex

Returns

triagens\ArangoDb\Edge
  • edge object
public mixed
# getTo( )

Get the 'to' vertex document-handler (if already known)

Get the 'to' vertex document-handler (if already known)

Returns

mixed
  • document-handler
public mixed
# getAllForInsertUpdate( )

Get all document attributes for insertion/update

Get all document attributes for insertion/update

Returns

mixed
  • associative array of all document attributes/values

Overrides

triagens\ArangoDb\Document::getAllForInsertUpdate

Methods inherited from triagens\ArangoDb\Document

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

Constants summary

string ENTRY_FROM

Document _from index

Document _from index

# '_from'
string ENTRY_TO

Revision _to index

Revision _to index

# '_to'

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 mixed $_from

The edge's from (might be NULL for new documents)

The edge's from (might be NULL for new documents)

#
protected mixed $_to

The edge's to (might be NULL for new documents)

The edge's to (might be NULL for new documents)

#

Properties inherited from triagens\ArangoDb\Document

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

ArangoDB-PHP API Documentation API documentation generated by ApiGen