ENTRY_ID
ENTRY_ID
Document id index
Value object representing a graph
$_hidden : boolean
Flag to indicate whether document was changed locally
$_edgeDefinitions : array<mixed,\triagens\ArangoDb\EdgeDefinition>
The list of edge definitions defining the graph.
__construct(array $name, array $options) : \triagens\ArangoDb\Graph
Constructs an empty graph
array | $name |
|
array | $options |
|
createFromArray(array $values, array $options) : \triagens\ArangoDb\Document|\triagens\ArangoDb\Edge
Factory method to construct a new document using the values passed to populate it
array | $values |
|
array | $options |
|
toJson(array $options) : string
Returns the document as JSON-encoded string
array | $options |
|
toSerialized(array $options) : string
Returns the document as a serialized string
array | $options |
|
set(string $key, mixed $value) : void
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.
string | $key |
|
mixed | $value |
|
__set(string $key, mixed $value) : void
Set a document attribute, magic method
This is a magic method that allows the object to be used without declaring all document attributes first. This function is mapped to set() internally.
string | $key |
|
mixed | $value |
|
getAll(mixed $options) : array
Get all document attributes
mixed | $options |
|
getInternalId() : string
Get the internal document id (if already known)
Document ids are generated on the server only. Document ids consist of collection id and document id, in the format collectionId/documentId
getHandle() : string
Convenience function to get the document handle (if already known) - is an alias to getInternalId()
Document handles are generated on the server only. Document handles consist of collection id and document id, in the format collectionId/documentId
getId() : mixed
Get the document id (if already known)
Document ids are generated on the server only. Document ids are numeric but might be bigger than PHP_INT_MAX. To reliably store a document id elsewhere, a PHP string should be used
getCollectionId() : mixed
Get the collection id (if already known)
Collection ids are generated on the server only. Collection ids are numeric but might be bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used
setVerticesCollection(string $verticesCollection) : \triagens\ArangoDb\Graph
Set the vertices collection of the graph
string | $verticesCollection |
|
getVerticesCollection() : string
Get the vertices collection of the graph
name of the vertices collection
since | 1.2 |
---|
setEdgesCollection(mixed $edgesCollection) : \triagens\ArangoDb\Graph
Set the edges collection of the graph
mixed | $edgesCollection |
|
since | 1.2 |
---|
getEdgesCollection() : string
Get the edges collection of the graph
since | 1.2 |
---|
addEdgeDefinition(\triagens\ArangoDb\EdgeDefinition $edgeDefinition) : \triagens\ArangoDb\Graph
Adds an edge definition to the graph.
\triagens\ArangoDb\EdgeDefinition | $edgeDefinition |
|
since | 2.2 |
---|
getEdgeDefinitions() : array<mixed,\triagens\ArangoDb\EdgeDefinition>
Get the edge definitions of the graph.
since | 2.2 |
---|
addOrphanCollection(string $orphanCollection) : \triagens\ArangoDb\Graph
Adds an orphan collection to the graph.
string | $orphanCollection |
|
since | 2.2 |
---|
getOrphanCollections() : array<mixed,string>
Get the orphan collections of the graph.
since | 2.2 |
---|
getSingleUndirectedRelation() : \triagens\ArangoDb\EdgeDefinition
returns (or creates) the edge definition for single-vertexcollection-undirected graphs, throw an exception for any other type of graph.
None found |