G

diff --git a/docs/classes.svg b/docs/classes.svg index fba77b91..414d1431 100644 --- a/docs/classes.svg +++ b/docs/classes.svg @@ -1,390 +1,489 @@ - -

» Private

```
$_connection
```

@@ -376,7 +380,7 @@

Returns

Sets the document class to use

setDocumentClass(string $class) : \ArangoDBClient\Handler

setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

@@ -385,7 +389,21 @@

Parameters

$class

string

Document class to use

Returns

\ArangoDBClient\Handler

\ArangoDBClient\DocumentClassable

+ +

Sets the edge class to use

setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

$class

+string

Edge class to use

Returns

\ArangoDBClient\DocumentClassable

@@ -505,6 +523,16 @@

Default

Edge class to use

$_edgeClass : string

Default

'\ArangoDBClient\Edge'

Connection object

$_connection

@@ -536,7 +564,7 @@

details for server version

+ generated on 2019-01-22T11:16:23+01:00.

diff --git a/docs/classes/ArangoDBClient.AqlUserFunction.html b/docs/classes/ArangoDBClient.AqlUserFunction.html index 90d14955..45fd6504 100644 --- a/docs/classes/ArangoDBClient.AqlUserFunction.html +++ b/docs/classes/ArangoDBClient.AqlUserFunction.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -589,7 +589,7 @@

Collections index

+ generated on 2019-01-22T11:16:22+01:00.
diff --git a/docs/classes/ArangoDBClient.Autoloader.html b/docs/classes/ArangoDBClient.Autoloader.html index f18c3d11..ea38fcbb 100644 --- a/docs/classes/ArangoDBClient.Autoloader.html +++ b/docs/classes/ArangoDBClient.Autoloader.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -178,7 +178,7 @@

Class file extension

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.Batch.html b/docs/classes/ArangoDBClient.Batch.html index 5e3e9825..eb7906ac 100644 --- a/docs/classes/ArangoDBClient.Batch.html +++ b/docs/classes/ArangoDBClient.Batch.html @@ -31,7 +31,7 @@

Errors - 19

Markers
Deprecated elements @@ -80,7 +80,8 @@
Sets the batch active in its associated connection.
```
setActive()
```
Sets the batch's associated connection into capture mode.
```
setCapture()
```
Sets the connection for he current batch. (mostly internal function)
```
setConnection()
```
Sets the document class to use
```
setDocumentClass()
```
Sets the document class to use
```
setDocumentClass()
```
Sets the edge class to use
```
setEdgeClass()
```
Split batch request and use ContentId as array key
```
splitWithContentIdKey()
```
Start capturing requests. To stop capturing, use stopCapture()
```
startCapture()
```
Stop capturing requests. If the batch has not been processed yet, more requests can be appended by calling startCapture() again.
```
stopCapture()
```

```
$_batchResponse
```

» Protected -
- Document class to use
```
$_documentClass
```
+
- Document class to use
```
$_documentClass
```
- Edge class to use
```
$_edgeClass
```
» Private
@@ -306,6 +314,18 @@
Returns

boolean
+
+
Insert a document into a collection
+
```
insert($collection, $document, array $options = array()) 
```
+
+
+
This is an alias for save().
+
Parameters
+
$collection
+
$document
+
$options
+
+
Remove a document from a collection, identified by the document itself
```
remove(\ArangoDBClient\Document $document, array $options = array()) : boolean
```
@@ -487,6 +507,9 @@
$options

Options are :
'createCollection' - create the collection if it does not yet exist.
'waitForSync' - if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.
'overwrite' - if set to true, will turn the insert into a replace operation if a document with the specified key already exists.
'returnNew' - if set to true, then the newly created document will be returned.
'returnOld' - if set to true, then the replaced document will be returned - useful only when using overwrite = true.

Exceptions

@@ -501,7 +524,7 @@

Returns

Sets the document class to use

setDocumentClass(string $class) : \ArangoDBClient\Handler

setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

@@ -510,7 +533,21 @@

Parameters

$class

string

Document class to use

Returns

\ArangoDBClient\Handler

\ArangoDBClient\DocumentClassable

+ +

Sets the edge class to use

setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

$class

+string

Edge class to use

Returns

\ArangoDBClient\DocumentClassable

@@ -840,6 +877,16 @@

Default

Edge class to use

$_edgeClass : string

Default

'\ArangoDBClient\Edge'

Connection object

$_connection

@@ -876,6 +923,24 @@

example parameter

overwrite option

OPTION_OVERWRITE = 'overwrite'

option for returning the new document

OPTION_RETURN_NEW = 'returnNew'

option for returning the old document

OPTION_RETURN_OLD = 'returnOld'

@@ -883,7 +948,7 @@

example parameter

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.Edge.html b/docs/classes/ArangoDBClient.Edge.html index 3591b43b..8364d9aa 100644 --- a/docs/classes/ArangoDBClient.Edge.html +++ b/docs/classes/ArangoDBClient.Edge.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -1047,7 +1047,7 @@

waitForSync option index

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.EdgeDefinition.html b/docs/classes/ArangoDBClient.EdgeDefinition.html index 1bf5565a..8f1cfc84 100644 --- a/docs/classes/ArangoDBClient.EdgeDefinition.html +++ b/docs/classes/ArangoDBClient.EdgeDefinition.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -378,7 +378,7 @@

Default

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.EdgeHandler.html b/docs/classes/ArangoDBClient.EdgeHandler.html index a9312230..58d8a9ab 100644 --- a/docs/classes/ArangoDBClient.EdgeHandler.html +++ b/docs/classes/ArangoDBClient.EdgeHandler.html @@ -31,7 +31,7 @@

Errors - 19

Markers
Deprecated elements @@ -61,6 +61,7 @@
Methods
@@ -166,6 +175,20 @@
Methods
+
+
Construct a new handler
+
```
__construct(\ArangoDBClient\Connection $connection) 
```
+
+
+
+
Parameters
+
+
$connection
+\ArangoDBClient\Connection
+
connection to be used
+
+
+
Construct a new handler
```
__construct(\ArangoDBClient\Connection $connection) 
```
@@ -414,6 +437,18 @@
Returns
array- array of connected edges
+
+
Insert a document into a collection
+
```
insert($collection, $document, array $options = array()) 
```
+
Inherited
+
+
This is an alias for save().
+
Parameters
+
$collection
+
$document
+
$options
+
+
Get connected outbound edges for a given vertex
```
outEdges(mixed $collection, mixed $vertexHandle) : array
```
@@ -622,6 +657,9 @@
$options

Options are :
'createCollection' - create the collection if it does not yet exist.
'waitForSync' - if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.
'overwrite' - if set to true, will turn the insert into a replace operation if a document with the specified key already exists.
'returnNew' - if set to true, then the newly created document will be returned.
'returnOld' - if set to true, then the replaced document will be returned - useful only when using overwrite = true.

Exceptions

@@ -688,7 +726,7 @@

Returns

Sets the document class to use

setDocumentClass(string $class) : \ArangoDBClient\Handler

setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

@@ -697,7 +735,21 @@

Parameters

$class

string

Document class to use

Returns

\ArangoDBClient\Handler

\ArangoDBClient\DocumentClassable

+ +

Sets the edge class to use

setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

$class

+string

Edge class to use

Returns

\ArangoDBClient\DocumentClassable

@@ -1053,6 +1105,16 @@

Default

Edge class to use

$_edgeClass : string

Default

'\ArangoDBClient\Edge'

Connection object

$_connection

@@ -1143,6 +1205,24 @@

example parameter

overwrite option

OPTION_OVERWRITE = 'overwrite'

option for returning the new document

OPTION_RETURN_NEW = 'returnNew'

option for returning the old document

OPTION_RETURN_OLD = 'returnOld'

example parameter

OPTION_TO = 'to'

@@ -1162,7 +1242,7 @@

vertex parameter

+ generated on 2019-01-22T11:16:23+01:00.

diff --git a/docs/classes/ArangoDBClient.Endpoint.html b/docs/classes/ArangoDBClient.Endpoint.html index 40ef9b61..ed225fb1 100644 --- a/docs/classes/ArangoDBClient.Endpoint.html +++ b/docs/classes/ArangoDBClient.Endpoint.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -340,7 +340,7 @@

UNIX socket endpoint type

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.Exception.html b/docs/classes/ArangoDBClient.Exception.html index 3d58f4b2..30c3c1b4 100644 --- a/docs/classes/ArangoDBClient.Exception.html +++ b/docs/classes/ArangoDBClient.Exception.html @@ -31,7 +31,7 @@

Errors - 19

Markers
Deprecated elements @@ -153,7 +153,7 @@
Default

Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
Documentation is powered by phpDocumentor 2.9.0 and
- generated on 2018-07-31T14:00:29+02:00.
+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.Export.html b/docs/classes/ArangoDBClient.Export.html index a09c285b..d023e893 100644 --- a/docs/classes/ArangoDBClient.Export.html +++ b/docs/classes/ArangoDBClient.Export.html @@ -31,7 +31,7 @@ Reports
» Protected @@ -79,7 +80,10 @@
» Protected -
- Document class to use
```
$_documentClass
```
+
- Document class to use
```
$_documentClass
```
- Edge class to use
```
$_edgeClass
```

» Private

Exceptions

Sets the document class to use

setDocumentClass(string $class) : \ArangoDBClient\Export

setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

@@ -225,7 +229,21 @@

Parameters

$class

string

Document class to use

Returns

\ArangoDBClient\Export

\ArangoDBClient\DocumentClassable

Sets the edge class to use

setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

$class

+string

Edge class to use

Returns

\ArangoDBClient\DocumentClassable

@@ -262,6 +280,16 @@

Default

Edge class to use

$_edgeClass : string

Default

'\ArangoDBClient\Edge'

The current batch size (number of result documents retrieved per round-trip)

$_batchSize : mixed

@@ -386,7 +414,7 @@

Export restrictions

+ generated on 2019-01-22T11:16:23+01:00.

» Private @@ -82,7 +83,10 @@
» Protected -
- Document class to use
```
$_documentClass
```
+
- Document class to use
```
$_documentClass
```
- Edge class to use
```
$_edgeClass
```

» Private

Returns

mixed

Sets the document class to use

setDocumentClass(string $class) : \ArangoDBClient\ExportCursor

setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

@@ -242,7 +246,21 @@

Parameters

$class

string

Document class to use

Returns

\ArangoDBClient\ExportCursor

\ArangoDBClient\DocumentClassable

Sets the edge class to use

setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

$class

+string

Edge class to use

Returns

\ArangoDBClient\DocumentClassable

@@ -299,6 +317,16 @@

Default

Edge class to use

$_edgeClass : string

Default

'\ArangoDBClient\Edge'

The connection object

$_connection : \ArangoDBClient\Connection

@@ -410,7 +438,7 @@

"type" option entry (is used when converting the result into documents or ed
Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
Documentation is powered by phpDocumentor 2.9.0 and
- generated on 2018-07-31T14:00:29+02:00.
+ generated on 2019-01-22T11:16:23+01:00.

Errors - 19

Markers
Deprecated elements @@ -219,7 +219,7 @@
Default

Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
Documentation is powered by phpDocumentor 2.9.0 and
- generated on 2018-07-31T14:00:29+02:00.
+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.FoxxHandler.html b/docs/classes/ArangoDBClient.FoxxHandler.html index 635a5929..4d6e1754 100644 --- a/docs/classes/ArangoDBClient.FoxxHandler.html +++ b/docs/classes/ArangoDBClient.FoxxHandler.html @@ -31,7 +31,7 @@ Reports
» Protected @@ -83,7 +84,10 @@
» Protected -
- Document class to use
```
$_documentClass
```
+
- Document class to use
```
$_documentClass
```
- Edge class to use
```
$_edgeClass
```

» Private

```
$_connection
```

@@ -203,7 +207,7 @@

Returns

Sets the document class to use

setDocumentClass(string $class) : \ArangoDBClient\Handler

setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

@@ -212,7 +216,21 @@

Parameters

$class

string

Document class to use

Returns

\ArangoDBClient\Handler

\ArangoDBClient\DocumentClassable

+ +

Sets the edge class to use

setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

$class

+string

Edge class to use

Returns

\ArangoDBClient\DocumentClassable

@@ -332,6 +350,16 @@

Default

Edge class to use

$_edgeClass : string

Default

'\ArangoDBClient\Edge'

Connection object

$_connection

@@ -355,7 +383,7 @@

Default

+ generated on 2019-01-22T11:16:23+01:00.

diff --git a/docs/classes/ArangoDBClient.Graph.html b/docs/classes/ArangoDBClient.Graph.html index 9b32d66c..6fad9e43 100644 --- a/docs/classes/ArangoDBClient.Graph.html +++ b/docs/classes/ArangoDBClient.Graph.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -1117,7 +1117,7 @@

waitForSync option index

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.GraphHandler.html b/docs/classes/ArangoDBClient.GraphHandler.html index e578a8a9..c388cc7f 100644 --- a/docs/classes/ArangoDBClient.GraphHandler.html +++ b/docs/classes/ArangoDBClient.GraphHandler.html @@ -31,7 +31,7 @@

Errors - 19

Markers
Deprecated elements @@ -90,6 +90,7 @@
```
setCacheEnabled()
```
Sets the count for any method creating a cursor.
```
setCount()
```
Sets the document class to use
```
setDocumentClass()
```
Sets the edge class to use
```
setEdgeClass()
```
Sets the limit for any method creating a cursor.
```
setLimit()
```
Update an existing edge in a graph, identified by graph name and edge id
```
updateEdge()
```
Update an existing vertex in a graph, identified by graph name and vertex id
```
updateVertex()
```

» Protected

@@ -1031,7 +1033,7 @@

$count

Sets the document class to use

setDocumentClass(string $class) : \ArangoDBClient\Handler

setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

@@ -1040,7 +1042,21 @@

Parameters

$class

string

Document class to use

Returns

\ArangoDBClient\Handler

\ArangoDBClient\DocumentClassable

+ +

Sets the edge class to use

setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

$class

+string

Edge class to use

Returns

\ArangoDBClient\DocumentClassable

@@ -1284,6 +1300,16 @@

Default

Edge class to use

$_edgeClass : string

Default

'\ArangoDBClient\Edge'

GraphHandler cache store

$cache

@@ -1443,7 +1469,7 @@

vertex parameter

+ generated on 2019-01-22T11:16:23+01:00.

diff --git a/docs/classes/ArangoDBClient.Handler.html b/docs/classes/ArangoDBClient.Handler.html index f9e2f2a9..3c8be405 100644 --- a/docs/classes/ArangoDBClient.Handler.html +++ b/docs/classes/ArangoDBClient.Handler.html @@ -31,7 +31,7 @@ -

Sets the document class to use

setDocumentClass(string $class) : \ArangoDBClient\Handler

setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

@@ -139,7 +143,21 @@

Parameters

$class

string

Document class to use

Returns

\ArangoDBClient\Handler

\ArangoDBClient\DocumentClassable

Sets the edge class to use

setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

$class

+string

Edge class to use

Returns

\ArangoDBClient\DocumentClassable

@@ -259,6 +277,16 @@

Default

Edge class to use

$_edgeClass : string

Default

'\ArangoDBClient\Edge'

Connection object

$_connection

@@ -282,7 +310,7 @@

Default

+ generated on 2019-01-22T11:16:23+01:00.

diff --git a/docs/classes/ArangoDBClient.HttpHelper.html b/docs/classes/ArangoDBClient.HttpHelper.html index fc0b170d..d3aa9f2f 100644 --- a/docs/classes/ArangoDBClient.HttpHelper.html +++ b/docs/classes/ArangoDBClient.HttpHelper.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -359,7 +359,7 @@

Separator between header and body

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.HttpResponse.html b/docs/classes/ArangoDBClient.HttpResponse.html index 22fb490e..ae5c7cb3 100644 --- a/docs/classes/ArangoDBClient.HttpResponse.html +++ b/docs/classes/ArangoDBClient.HttpResponse.html @@ -31,7 +31,7 @@

Errors - 19

Markers
Deprecated elements @@ -374,7 +374,7 @@
HTTP location header

Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
Documentation is powered by phpDocumentor 2.9.0 and
- generated on 2018-07-31T14:00:29+02:00.
+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.QueryCacheHandler.html b/docs/classes/ArangoDBClient.QueryCacheHandler.html index ceac5571..6e413a01 100644 --- a/docs/classes/ArangoDBClient.QueryCacheHandler.html +++ b/docs/classes/ArangoDBClient.QueryCacheHandler.html @@ -31,7 +31,7 @@ Reports

» Protected -
- Document class to use
```
$_documentClass
```
+
- Document class to use
```
$_documentClass
```
- Edge class to use
```
$_edgeClass
```
» Private
- ```
$_connection
```
@@ -186,6 +191,22 @@
Exceptions
+
+
Returns the entries from the query cache in current database
+
```
getEntries() : array
```
+
+
+
+
Exceptions
+ + + +
\ArangoDBClient\Exception
+
Returns
+
+array- entries in query cache
+
+
Returns the AQL query result cache properties
```
getProperties() : array
```
@@ -203,7 +224,7 @@
Returns
Sets the document class to use
-
```
setDocumentClass(string $class) : \ArangoDBClient\Handler
```
+
```
setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
```
Inherited

@@ -212,7 +233,21 @@
Parameters

$class
string
Document class to use

Returns
-
\ArangoDBClient\Handler
+
\ArangoDBClient\DocumentClassable
+
+ +
+
Sets the edge class to use
+
```
setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
```
+
Inherited
+
+
+
Parameters
+
+
$class
+string
Edge class to use
+
Returns
+
\ArangoDBClient\DocumentClassable
@@ -362,6 +397,16 @@
Default

+
+
Edge class to use
+
```
$_edgeClass : string
```
+
+
Default
+
'\ArangoDBClient\Edge'
+
+
+
+
Connection object
```
$_connection 
```
@@ -385,7 +430,7 @@
Default

Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
Documentation is powered by phpDocumentor 2.9.0 and
- generated on 2018-07-31T14:00:29+02:00.
+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.QueryHandler.html b/docs/classes/ArangoDBClient.QueryHandler.html index a99f8b72..f69728cf 100644 --- a/docs/classes/ArangoDBClient.QueryHandler.html +++ b/docs/classes/ArangoDBClient.QueryHandler.html @@ -31,7 +31,7 @@ Reports
» Protected @@ -85,7 +86,10 @@
» Protected -
- Document class to use
```
$_documentClass
```
+
- Document class to use
```
$_documentClass
```
- Edge class to use
```
$_edgeClass
```

» Private

```
$_connection
```

@@ -198,7 +202,7 @@

Returns

Sets the document class to use

setDocumentClass(string $class) : \ArangoDBClient\Handler

setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

@@ -207,7 +211,21 @@

Parameters

$class

string

Document class to use

Returns

\ArangoDBClient\Handler

\ArangoDBClient\DocumentClassable

+ +

Sets the edge class to use

setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

$class

+string

Edge class to use

Returns

\ArangoDBClient\DocumentClassable

@@ -327,6 +345,16 @@

Default

Edge class to use

$_edgeClass : string

Default

'\ArangoDBClient\Edge'

Connection object

$_connection

@@ -350,7 +378,7 @@

Default

+ generated on 2019-01-22T11:16:23+01:00.

diff --git a/docs/classes/ArangoDBClient.ServerException.html b/docs/classes/ArangoDBClient.ServerException.html index 8c7eb7a9..6d740ce4 100644 --- a/docs/classes/ArangoDBClient.ServerException.html +++ b/docs/classes/ArangoDBClient.ServerException.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -275,7 +275,7 @@

Error message index

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.Statement.html b/docs/classes/ArangoDBClient.Statement.html index 29ba43a4..1ed51179 100644 --- a/docs/classes/ArangoDBClient.Statement.html +++ b/docs/classes/ArangoDBClient.Statement.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -889,7 +889,7 @@

Full count option index

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.TraceRequest.html b/docs/classes/ArangoDBClient.TraceRequest.html index 02368e81..2f1636a6 100644 --- a/docs/classes/ArangoDBClient.TraceRequest.html +++ b/docs/classes/ArangoDBClient.TraceRequest.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -252,7 +252,7 @@

Default

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.TraceResponse.html b/docs/classes/ArangoDBClient.TraceResponse.html index 60b12a6d..3e7222b3 100644 --- a/docs/classes/ArangoDBClient.TraceResponse.html +++ b/docs/classes/ArangoDBClient.TraceResponse.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -271,7 +271,7 @@

Default

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.Transaction.html b/docs/classes/ArangoDBClient.Transaction.html index 10986d50..270cae0e 100644 --- a/docs/classes/ArangoDBClient.Transaction.html +++ b/docs/classes/ArangoDBClient.Transaction.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -785,7 +785,7 @@

WRITE index

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.Traversal.html b/docs/classes/ArangoDBClient.Traversal.html index 8a51173b..5a82a1cc 100644 --- a/docs/classes/ArangoDBClient.Traversal.html +++ b/docs/classes/ArangoDBClient.Traversal.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -440,7 +440,7 @@

count fields

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.UpdatePolicy.html b/docs/classes/ArangoDBClient.UpdatePolicy.html index 377e66c4..22e49c3f 100644 --- a/docs/classes/ArangoDBClient.UpdatePolicy.html +++ b/docs/classes/ArangoDBClient.UpdatePolicy.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -137,7 +137,7 @@

last update will win in case of conflicting versions

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.UrlHelper.html b/docs/classes/ArangoDBClient.UrlHelper.html index b2482a25..076c7f08 100644 --- a/docs/classes/ArangoDBClient.UrlHelper.html +++ b/docs/classes/ArangoDBClient.UrlHelper.html @@ -31,7 +31,7 @@ @@ -405,6 +406,12 @@

base URL part for user management

URL base part for all view-related REST calls

URL_VIEW = '/_api/view'

URL for select-range

URL_WITHIN = '/_api/simple/within'

@@ -418,7 +425,7 @@

URL for select-range

+ generated on 2019-01-22T11:16:23+01:00.

diff --git a/docs/classes/ArangoDBClient.User.html b/docs/classes/ArangoDBClient.User.html index e2e953da..9484c5f1 100644 --- a/docs/classes/ArangoDBClient.User.html +++ b/docs/classes/ArangoDBClient.User.html @@ -31,7 +31,7 @@

Errors - 19

Markers
Deprecated elements @@ -997,7 +997,7 @@
waitForSync option index

Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
Documentation is powered by phpDocumentor 2.9.0 and
- generated on 2018-07-31T14:00:29+02:00.
+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.UserHandler.html b/docs/classes/ArangoDBClient.UserHandler.html index 8e8ad5e4..405b6226 100644 --- a/docs/classes/ArangoDBClient.UserHandler.html +++ b/docs/classes/ArangoDBClient.UserHandler.html @@ -31,7 +31,7 @@ Reports

» Protected -
- Document class to use
```
$_documentClass
```
+
- Document class to use
```
$_documentClass
```
- Edge class to use
```
$_edgeClass
```

» Private

```
$_connection
```

@@ -523,7 +527,7 @@

Returns

Sets the document class to use

setDocumentClass(string $class) : \ArangoDBClient\Handler

setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

@@ -532,7 +536,21 @@

Parameters

$class

string

Document class to use

Returns

\ArangoDBClient\Handler

\ArangoDBClient\DocumentClassable

+ +

Sets the edge class to use

setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

$class

+string

Edge class to use

Returns

\ArangoDBClient\DocumentClassable

@@ -690,6 +708,16 @@

Default

Edge class to use

$_edgeClass : string

Default

'\ArangoDBClient\Edge'

Connection object

$_connection

@@ -713,7 +741,7 @@

Default

+ generated on 2019-01-22T11:16:22+01:00.

diff --git a/docs/classes/ArangoDBClient.ValueValidator.html b/docs/classes/ArangoDBClient.ValueValidator.html index bffc7fb8..0f50d566 100644 --- a/docs/classes/ArangoDBClient.ValueValidator.html +++ b/docs/classes/ArangoDBClient.ValueValidator.html @@ -31,7 +31,7 @@

Errors - 19

Exceptions

@@ -523,7 +546,7 @@

Returns

Sets the document class to use

setDocumentClass(string $class) : \ArangoDBClient\Handler

setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

@@ -532,7 +555,21 @@

Parameters

$class

string

Document class to use

Returns

\ArangoDBClient\Handler

\ArangoDBClient\DocumentClassable

+ +

Sets the edge class to use

setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

$class

+string

Edge class to use

Returns

\ArangoDBClient\DocumentClassable

@@ -862,6 +899,16 @@

Default

Edge class to use

$_edgeClass : string

Default

'\ArangoDBClient\Edge'

Connection object

$_connection

@@ -898,6 +945,24 @@

example parameter

overwrite option

OPTION_OVERWRITE = 'overwrite'

option for returning the new document

OPTION_RETURN_NEW = 'returnNew'

option for returning the old document

OPTION_RETURN_OLD = 'returnOld'

@@ -905,7 +970,7 @@

example parameter

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/classes/ArangoDBClient.View.html b/docs/classes/ArangoDBClient.View.html new file mode 100644 index 00000000..3f108271 --- /dev/null +++ b/docs/classes/ArangoDBClient.View.html @@ -0,0 +1,256 @@ + + + + + +ArangoDB PHP client API » \ArangoDBClient\View + + + + + + + + + + +

+ Javascript is disabled; several features are only available + if Javascript is enabled. +

+ +

Value object representing a view

+ + + + + + + + + +

package	ArangoDBClient
since	3.4

+ Methods

Constructs an empty view

__construct(array $name, string $type)

+ + + +

since	3.4

Parameters

$name

+array

name for view

$type

+string

view type

Exceptions

+ + + +

`\ArangoDBClient\ClientException`

Return the view as an array

getAll() : array

Returns

+array- view data as an array

Return the view id

getId() : string

Returns

+string- view id

Return the view name

getName() : string

Returns

+string- view name

Return the view type

getType() : string

Returns

+string- view type

Set the view's id

setId(string $id) : void

Parameters

$id

+string

view id

+ Properties

The view id (might be NULL for new views)

$_id : string

Default

The view name

$_name : string

Default

+ Constants

View id index

ENTRY_ID = 'id'

View name index

ENTRY_NAME = 'name'

View type index

ENTRY_TYPE = 'type'

+ + diff --git a/docs/classes/ArangoDBClient.ViewHandler.html b/docs/classes/ArangoDBClient.ViewHandler.html new file mode 100644 index 00000000..b1f035b0 --- /dev/null +++ b/docs/classes/ArangoDBClient.ViewHandler.html @@ -0,0 +1,500 @@ + + + + + +ArangoDB PHP client API » \ArangoDBClient\ViewHandler + + + + + + + + + + +

+ Javascript is disabled; several features are only available + if Javascript is enabled. +

+ +

A handler that manages views.

+ + + + + + + + + + + + + +

package	ArangoDBClient
since	3.4
inherited_from	\ArangoDBClient\Handler

+ Methods

Construct a new handler

__construct(\ArangoDBClient\Connection $connection)

Inherited

Parameters

$connection

+\ArangoDBClient\Connection

connection to be used

Create a view

create(\ArangoDBClient\View $view) : array

This will create a view using the given view object and return an array of the created view object's attributes.

+ + + +

since	3.4

Parameters

$view

+\ArangoDBClient\View

The view object which holds the information of the view to be created

Exceptions

+ + + +

`\ArangoDBClient\Exception`

Returns

array

Drop a view

drop(mixed $view) : boolean

+ + + +

since	3.4

Parameters

$view

+mixed

view name as a string or instance of View

Exceptions

+ + + +

`\ArangoDBClient\Exception`

Returns

+boolean- always true, will throw if there is an error

Get a view

get(String $view) : \ArangoDBClient\View | false

This will get a view.

+ + + +

since	3.4

Parameters

$view

+String

The name of the view

Exceptions

+ + + +

`\ArangoDBClient\ClientException`

Returns

+\ArangoDBClient\Viewfalse +

Get a view's properties

properties(mixed $view) : array

+ + + +

since	3.4

Parameters

$view

+mixed

view name as a string or instance of View

Exceptions

+ + + +

`\ArangoDBClient\Exception`

Returns

+array- Returns an array of attributes. Will throw if there is an error

Rename a view

rename(mixed $view, string $name) : boolean

Parameters

$view

+mixed

view name as a string or instance of View

$name

+string

new name for collection

Exceptions

+ + + +

`\ArangoDBClient\Exception`

Returns

+boolean- always true, will throw if there is an error

Sets the document class to use

setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

$class

+string

Document class to use

Returns

\ArangoDBClient\DocumentClassable

Sets the edge class to use

setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable

Inherited

Parameters

$class

+string

Edge class to use

Returns

\ArangoDBClient\DocumentClassable

Set a view's properties

setProperties(mixed $view, array $properties) : array

+ + + +

since	3.4

Parameters

$view

+mixed

view name as a string or instance of View

$properties

+array

array with view properties

Exceptions

+ + + +

`\ArangoDBClient\Exception`

Returns

+array- Returns an array of attributes. Will throw if there is an error

Return the connection object

getConnection() : \ArangoDBClient\Connection

Inherited

Returns

+\ArangoDBClient\Connection- the connection object

Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection

getConnectionOption($optionName) : mixed

Inherited

Parameters

$optionName

The option to return a value for

Exceptions

+ + + +

`\ArangoDBClient\ClientException`

Returns

+mixed- the option's value

Helper function that runs through the options given and includes them into the parameters array given.

includeOptionsInBody(array $options, array $body, array $includeArray = array()) : array

Inherited

Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) .

Parameters

$options

+array

The options array that holds the options to include in the parameters

$body

+array

The array into which the options will be included.

$includeArray

+array

The array that defines which options are allowed to be included, and what their default value is. for example: 'waitForSync'=>true

Returns

+array$params - array of parameters for use in a url

Return a json encoded string for the array passed.

json_encode_wrapper(array $body) : string

Inherited

This is a convenience function that calls json_encode_wrapper on the connection

Parameters

$body

+array

The body to encode into json

Exceptions

+ + + +

`\ArangoDBClient\ClientException`

Returns

+string- json string of the body that was passed

Turn a value into a collection name

makeCollection(mixed $value) : string

Inherited

Parameters

$value

+mixed

document, collection or string

Exceptions

+ + + +

`\ArangoDBClient\ClientException`

Returns

+string- collection name

+ Properties

Document class to use

$_documentClass : string

Default

'\ArangoDBClient\Document'

Edge class to use

$_edgeClass : string

Default

'\ArangoDBClient\Edge'

Connection object

$_connection

Default

+ + + +

param

+ Constants

rename option

OPTION_RENAME = 'rename'

+ + diff --git a/docs/deprecated.html b/docs/deprecated.html index f72e33a4..54420ca1 100644 --- a/docs/deprecated.html +++ b/docs/deprecated.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -71,12 +71,12 @@ deprecated -189 +190 use UserHandler::grantDatabasePermissions instead deprecated -230 +231 use UserHandler::revokeDatabasePermissions instead @@ -86,7 +86,7 @@

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/errors.html b/docs/errors.html index 8285d736..9f008861 100644 --- a/docs/errors.html +++ b/docs/errors.html @@ -31,7 +31,7 @@

Errors - 19

Markers

Deprecated elements @@ -77,6 +77,8 @@

Document.php2 @@ -139,9 +141,10 @@

-DocumentHandler.php5 +DocumentHandler.php8

@@ -152,27 +155,42 @@ - + - + - + - + - + + + + + + + + + + + + + + + + @@ -203,7 +221,7 @@ - +

error	195	210	Name of argument $revision does not match with the DocBlock's name $ifMatch in getHead()
error	195	210	The type hint of the argument is incorrect for the type definition of the @param tag with argument $revision in getHead()
error	195	210	Name of argument $ifMatch does not match with the DocBlock's name $revision in getHead()
error	195	210	The type hint of the argument is incorrect for the type definition of the @param tag with argument $ifMatch in getHead()
error	766	407	Argument $collection is missing from the Docblock of insert
error	407	Argument $document is missing from the Docblock of insert
error	407	Argument $options is missing from the Docblock of insert
error	818	No summary for method createCollectionIfOptions()
error	1854	1845	No summary for method createCollectionIfOptions()

@@ -332,7 +350,7 @@ error -252 +268 No summary for method createCollectionIfOptions()

@@ -350,7 +368,7 @@ error -1418 +1423 No summary for method setCacheEnabled() @@ -361,7 +379,7 @@

+ generated on 2019-01-22T11:16:23+01:00.
diff --git a/docs/graph_class.html b/docs/graph_class.html index 200759d3..94c50dda 100644 --- a/docs/graph_class.html +++ b/docs/graph_class.html @@ -31,7 +31,7 @@

Returns

Sets the document class to use

Parameters

$class

Returns

Sets the edge class to use

Parameters

$class

Returns

Default

Edge class to use

Default

Connection object

details for server version

Collections index

Class file extension

Returns

Sets the document class to use

Parameters

Parameters

$class

Returns

Sets the edge class to use

Parameters

$class

Returns

Default

Edge class to use

Default

An array of BatchPartCursor options

Default

Returns

Sets the document class to use

Parameters

Parameters

$class

Returns

Sets the edge class to use

Parameters

$class

Returns

Default

Edge class to use

Default

The batch that this instance is part of

Default

Default

Default

Returns

Get the numberOfShards value (if already known)

Returns

Get the replicationFactor value (if already known)

Returns

Returns

Get the sharding strategy value (if already known)

Returns

Get the collection status (if already known)

$value

Set the replicationFactor value

Parameters

$value

Set the shardKeys value

$value

Set the shardingStragy value

Parameters

$value

Set the collection status.

Default

The collection numberOfShards value (might be NULL for new collections)

Default

The replicationFactor value (might be NULL for new collections)

Default

Default

The shardingStrategy value (might be NULL for new collections)

Default

The collection status value

Collection 'numberOfShards' index

Collection 'replicationFactor' index

Collection 'shardingStrategy' index

Collection 'shardKeys' index