From 9a9c602098c79e06e883bf0e556e83ad76f92620 Mon Sep 17 00:00:00 2001 From: maxkernbach Date: Tue, 22 Jan 2019 11:31:38 +0100 Subject: [PATCH] generate 3.4 documentation --- docs/classes.svg | 571 +- docs/classes/ArangoDBClient.AdminHandler.html | 38 +- .../ArangoDBClient.AqlUserFunction.html | 4 +- docs/classes/ArangoDBClient.Autoloader.html | 4 +- docs/classes/ArangoDBClient.Batch.html | 46 +- docs/classes/ArangoDBClient.BatchPart.html | 46 +- docs/classes/ArangoDBClient.BindVars.html | 4 +- .../ArangoDBClient.ClientException.html | 4 +- docs/classes/ArangoDBClient.Collection.html | 100 +- .../ArangoDBClient.CollectionHandler.html | 83 +- .../ArangoDBClient.ConnectException.html | 4 +- docs/classes/ArangoDBClient.Connection.html | 4 +- .../ArangoDBClient.ConnectionOptions.html | 4 +- docs/classes/ArangoDBClient.Cursor.html | 44 +- docs/classes/ArangoDBClient.Database.html | 4 +- .../classes/ArangoDBClient.DefaultValues.html | 4 +- docs/classes/ArangoDBClient.Document.html | 4 +- .../ArangoDBClient.DocumentClassable.html | 166 + .../ArangoDBClient.DocumentHandler.html | 75 +- docs/classes/ArangoDBClient.Edge.html | 4 +- .../ArangoDBClient.EdgeDefinition.html | 4 +- docs/classes/ArangoDBClient.EdgeHandler.html | 90 +- docs/classes/ArangoDBClient.Endpoint.html | 4 +- docs/classes/ArangoDBClient.Exception.html | 4 +- docs/classes/ArangoDBClient.Export.html | 44 +- docs/classes/ArangoDBClient.ExportCursor.html | 44 +- .../ArangoDBClient.FailoverException.html | 4 +- docs/classes/ArangoDBClient.FoxxHandler.html | 38 +- docs/classes/ArangoDBClient.Graph.html | 4 +- docs/classes/ArangoDBClient.GraphHandler.html | 34 +- docs/classes/ArangoDBClient.Handler.html | 44 +- docs/classes/ArangoDBClient.HttpHelper.html | 4 +- docs/classes/ArangoDBClient.HttpResponse.html | 4 +- .../ArangoDBClient.QueryCacheHandler.html | 55 +- docs/classes/ArangoDBClient.QueryHandler.html | 38 +- .../ArangoDBClient.ServerException.html | 4 +- docs/classes/ArangoDBClient.Statement.html | 4 +- docs/classes/ArangoDBClient.TraceRequest.html | 4 +- .../classes/ArangoDBClient.TraceResponse.html | 4 +- docs/classes/ArangoDBClient.Transaction.html | 4 +- docs/classes/ArangoDBClient.Traversal.html | 4 +- docs/classes/ArangoDBClient.UpdatePolicy.html | 4 +- docs/classes/ArangoDBClient.UrlHelper.html | 4 +- docs/classes/ArangoDBClient.Urls.html | 11 +- docs/classes/ArangoDBClient.User.html | 4 +- docs/classes/ArangoDBClient.UserHandler.html | 38 +- .../ArangoDBClient.ValueValidator.html | 4 +- docs/classes/ArangoDBClient.Vertex.html | 4 +- .../classes/ArangoDBClient.VertexHandler.html | 75 +- docs/classes/ArangoDBClient.View.html | 256 + docs/classes/ArangoDBClient.ViewHandler.html | 500 ++ docs/deprecated.html | 8 +- docs/errors.html | 40 +- docs/graph_class.html | 4 +- docs/index.html | 6 +- docs/markers.html | 4 +- docs/namespaces/ArangoDBClient.html | 30 +- docs/packages/ArangoDBClient.html | 30 +- docs/packages/Default.html | 4 +- docs/packages/global.html | 4 +- docs/structure.xml | 6218 ++++++++++------- 61 files changed, 6039 insertions(+), 2861 deletions(-) create mode 100644 docs/classes/ArangoDBClient.DocumentClassable.html create mode 100644 docs/classes/ArangoDBClient.View.html create mode 100644 docs/classes/ArangoDBClient.ViewHandler.html 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 @@ - - - + + G - -cluster_Global - -Global + + +cluster_Global + +Global -cluster_\ArangoDBClient - -ArangoDBClient + +cluster_\ArangoDBClient + +ArangoDBClient -\\ArangoDBClient\\AqlUserFunction - -AqlUserFunction + +\\ArangoDBClient\\AqlUserFunction + +AqlUserFunction + + + +\\ArangoDBClient\\ViewHandler + +ViewHandler + + + +\\ArangoDBClient\\Handler + +«abstract» +Handler + + + +\\ArangoDBClient\\ViewHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\BatchPart - -BatchPart + +\\ArangoDBClient\\BatchPart + +BatchPart - -\\ArangoDBClient\\UserHandler - -UserHandler + + +\\ArangoDBClient\\View + +View - -\\ArangoDBClient\\Handler - -«abstract» -Handler + + +\\ArangoDBClient\\UserHandler + +UserHandler -\\ArangoDBClient\\UserHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\UserHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\Document - -Document + +\\ArangoDBClient\\Document + +Document -\\JsonSerializable - -\JsonSerializable + +\\JsonSerializable + +\JsonSerializable -\\ArangoDBClient\\Document->\\JsonSerializable - - + +\\ArangoDBClient\\Document->\\JsonSerializable + + -\\ArangoDBClient\\ConnectionOptions - -ConnectionOptions + +\\ArangoDBClient\\ConnectionOptions + +ConnectionOptions -\\ArrayAccess - -\ArrayAccess + +\\ArrayAccess + +\ArrayAccess -\\ArangoDBClient\\ConnectionOptions->\\ArrayAccess - - + +\\ArangoDBClient\\ConnectionOptions->\\ArrayAccess + + -\\ArangoDBClient\\Connection - -Connection + +\\ArangoDBClient\\Connection + +Connection -\\ArangoDBClient\\Transaction - -Transaction + +\\ArangoDBClient\\Transaction + +Transaction -\\ArangoDBClient\\ExportCursor - -ExportCursor + +\\ArangoDBClient\\ExportCursor + +ExportCursor -\\ArangoDBClient\\UrlHelper - -«abstract» -UrlHelper + +\\ArangoDBClient\\UrlHelper + +«abstract» +UrlHelper -\\ArangoDBClient\\QueryCacheHandler - -QueryCacheHandler + +\\ArangoDBClient\\QueryCacheHandler + +QueryCacheHandler -\\ArangoDBClient\\QueryCacheHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\QueryCacheHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\DocumentHandler - -DocumentHandler + +\\ArangoDBClient\\DocumentHandler + +DocumentHandler -\\ArangoDBClient\\DocumentHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\DocumentHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\Edge - -Edge + +\\ArangoDBClient\\Edge + +Edge -\\ArangoDBClient\\Edge->\\ArangoDBClient\\Document - - + +\\ArangoDBClient\\Edge->\\ArangoDBClient\\Document + + -\\ArangoDBClient\\Cursor - -Cursor + +\\ArangoDBClient\\Cursor + +Cursor -\\Iterator - -\Iterator + +\\Iterator + +\Iterator -\\ArangoDBClient\\Cursor->\\Iterator - - + +\\ArangoDBClient\\Cursor->\\Iterator + + -\\ArangoDBClient\\Database - -Database + +\\ArangoDBClient\\Database + +Database -\\ArangoDBClient\\FailoverException - -FailoverException + +\\ArangoDBClient\\FailoverException + +FailoverException -\\ArangoDBClient\\Exception - -Exception + +\\ArangoDBClient\\Exception + +Exception -\\ArangoDBClient\\FailoverException->\\ArangoDBClient\\Exception - - + +\\ArangoDBClient\\FailoverException->\\ArangoDBClient\\Exception + + -\\ArangoDBClient\\Batch - -Batch + +\\ArangoDBClient\\Batch + +Batch -\\ArangoDBClient\\TraceRequest - -TraceRequest + +\\ArangoDBClient\\TraceRequest + +TraceRequest -\\ArangoDBClient\\ConnectException - -ConnectException + +\\ArangoDBClient\\ConnectException + +ConnectException -\\ArangoDBClient\\ConnectException->\\ArangoDBClient\\Exception - - + +\\ArangoDBClient\\ConnectException->\\ArangoDBClient\\Exception + + -\\ArangoDBClient\\ValueValidator - -ValueValidator + +\\ArangoDBClient\\ValueValidator + +ValueValidator -\\ArangoDBClient\\Autoloader - -Autoloader + +\\ArangoDBClient\\Autoloader + +Autoloader -\\ArangoDBClient\\ClientException - -ClientException + +\\ArangoDBClient\\ClientException + +ClientException -\\ArangoDBClient\\ClientException->\\ArangoDBClient\\Exception - - + +\\ArangoDBClient\\ClientException->\\ArangoDBClient\\Exception + + -\\ArangoDBClient\\FoxxHandler - -FoxxHandler + +\\ArangoDBClient\\FoxxHandler + +FoxxHandler -\\ArangoDBClient\\FoxxHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\FoxxHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\User - -User + +\\ArangoDBClient\\User + +User -\\ArangoDBClient\\User->\\ArangoDBClient\\Document - - + +\\ArangoDBClient\\User->\\ArangoDBClient\\Document + + -\\ArangoDBClient\\BindVars - -BindVars + +\\ArangoDBClient\\BindVars + +BindVars -\\ArangoDBClient\\CollectionHandler - -CollectionHandler + +\\ArangoDBClient\\CollectionHandler + +CollectionHandler -\\ArangoDBClient\\CollectionHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\CollectionHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\Graph - -Graph + +\\ArangoDBClient\\Graph + +Graph -\\ArangoDBClient\\Graph->\\ArangoDBClient\\Document - - + +\\ArangoDBClient\\Graph->\\ArangoDBClient\\Document + + -\\ArangoDBClient\\EdgeDefinition - -EdgeDefinition + +\\ArangoDBClient\\EdgeDefinition + +EdgeDefinition -\\ArangoDBClient\\Vertex - -Vertex + +\\ArangoDBClient\\Vertex + +Vertex -\\ArangoDBClient\\Vertex->\\ArangoDBClient\\Document - - + +\\ArangoDBClient\\Vertex->\\ArangoDBClient\\Document + + -\\ArangoDBClient\\Collection - -Collection + +\\ArangoDBClient\\Collection + +Collection -\\ArangoDBClient\\HttpResponse - -HttpResponse + +\\ArangoDBClient\\HttpResponse + +HttpResponse -\\ArangoDBClient\\HttpHelper - -HttpHelper + +\\ArangoDBClient\\HttpHelper + +HttpHelper -\\ArangoDBClient\\UpdatePolicy - -UpdatePolicy + +\\ArangoDBClient\\UpdatePolicy + +UpdatePolicy -\\Exception - -\Exception + +\\Exception + +\Exception -\\ArangoDBClient\\Exception->\\Exception - - + +\\ArangoDBClient\\Exception->\\Exception + + -\\ArangoDBClient\\Endpoint - -Endpoint + +\\ArangoDBClient\\Endpoint + +Endpoint -\\ArangoDBClient\\QueryHandler - -QueryHandler + +\\ArangoDBClient\\QueryHandler + +QueryHandler -\\ArangoDBClient\\QueryHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\QueryHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\ServerException - -ServerException + +\\ArangoDBClient\\ServerException + +ServerException -\\ArangoDBClient\\ServerException->\\ArangoDBClient\\Exception - - + +\\ArangoDBClient\\ServerException->\\ArangoDBClient\\Exception + + -\\ArangoDBClient\\Traversal - -Traversal + +\\ArangoDBClient\\Traversal + +Traversal -\\ArangoDBClient\\VertexHandler - -VertexHandler + +\\ArangoDBClient\\VertexHandler + +VertexHandler -\\ArangoDBClient\\VertexHandler->\\ArangoDBClient\\DocumentHandler - - + +\\ArangoDBClient\\VertexHandler->\\ArangoDBClient\\DocumentHandler + + -\\ArangoDBClient\\Statement - -Statement + +\\ArangoDBClient\\Statement + +Statement -\\ArangoDBClient\\Urls - -«abstract» -Urls + +\\ArangoDBClient\\Urls + +«abstract» +Urls -\\ArangoDBClient\\TraceResponse - -TraceResponse + +\\ArangoDBClient\\TraceResponse + +TraceResponse -\\ArangoDBClient\\AdminHandler - -AdminHandler + +\\ArangoDBClient\\AdminHandler + +AdminHandler -\\ArangoDBClient\\AdminHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\AdminHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\EdgeHandler - -EdgeHandler + +\\ArangoDBClient\\EdgeHandler + +EdgeHandler -\\ArangoDBClient\\EdgeHandler->\\ArangoDBClient\\DocumentHandler - - + +\\ArangoDBClient\\EdgeHandler->\\ArangoDBClient\\DocumentHandler + + -\\ArangoDBClient\\Export - -Export + +\\ArangoDBClient\\Export + +Export -\\ArangoDBClient\\GraphHandler - -GraphHandler + +\\ArangoDBClient\\GraphHandler + +GraphHandler -\\ArangoDBClient\\GraphHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\GraphHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\DefaultValues - -«abstract» -DefaultValues + +\\ArangoDBClient\\DefaultValues + +«abstract» +DefaultValues + + + +\\ArangoDBClient\\DocumentClassable + +DocumentClassable diff --git a/docs/classes/ArangoDBClient.AdminHandler.html b/docs/classes/ArangoDBClient.AdminHandler.html index 47c5a0c1..c6a49f30 100644 --- a/docs/classes/ArangoDBClient.AdminHandler.html +++ b/docs/classes/ArangoDBClient.AdminHandler.html @@ -31,7 +31,7 @@ Reports
  • » Protected @@ -95,7 +96,10 @@
  • » Protected - +
  • » Private @@ -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 @@ Reports