From 6bc51625b717bc16a6bedf06c96600cae1642352 Mon Sep 17 00:00:00 2001 From: "Lucas S. Vieira" Date: Wed, 15 May 2024 23:42:18 +0100 Subject: [PATCH] reviewed docs --- docs/classes/ArangoDB-Graph-Graph.html | 154 ++++++++++++------------- docs/files/src/Graph/Graph.php.txt | 15 ++- docs/js/searchIndex.js | 6 +- 3 files changed, 87 insertions(+), 88 deletions(-) diff --git a/docs/classes/ArangoDB-Graph-Graph.html b/docs/classes/ArangoDB-Graph-Graph.html index 20dbf63..b4ac82f 100644 --- a/docs/classes/ArangoDB-Graph-Graph.html +++ b/docs/classes/ArangoDB-Graph-Graph.html @@ -264,9 +264,9 @@

Represents an ArangoDB Graph.

@@ -337,10 +337,11 @@

addEdge() -  : Edge|false +  : bool
Creates a new edge in the collection.<br> -Within the attributes the edge has to contain a _from and _to value referencing to valid vertices in the graph.
+Within the attributes the edge has to contain a _from and _to value referencing to valid vertices in the graph +Furthermore, the edge has to be valid in the definition of the used.
addEdgeDefinition() @@ -382,7 +383,7 @@

 : bool

-
Remove one edge definition from the graph.<br> +
Remove one edge definition from the graph<br> This will only remove the edge collection, the vertex collections remain untouched and can still be used in your queries.
@@ -398,7 +399,7 @@

 : bool -
Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph.<br> +
Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph<br> It can only remove vertex collections that are no longer part of edge definitions,<br> if they are used in edge definitions you are required to modify those first.
@@ -524,7 +525,7 @@

traversal() -  : TraversalCursor +  : Traversal
Returns a graph traversal.
@@ -557,9 +558,9 @@

Graph constructor.

@@ -635,9 +636,9 @@

Returns a string representation of graph object.

@@ -672,23 +673,22 @@

Creates a new edge in the collection.<br> -Within the attributes the edge has to contain a _from and _to value referencing to valid vertices in the graph.

+Within the attributes the edge has to contain a _from and _to value referencing to valid vertices in the graph +Furthermore, the edge has to be valid in the definition of the used.

public - addEdge(string $collection[, array<string|int, mixed> $attributes = [] ][, bool $waitForSync = true ][, bool $returnNew = false ]) : Edge|false + addEdge(string $collection[, array<string|int, mixed> $attributes = [] ][, bool $waitForSync = true ][, bool $returnNew = false ]) : bool
-

Furthermore the edge has to be valid in the definition of the used.

-
- +

Parameters
@@ -705,7 +705,7 @@
Parameters
: array<string|int, mixed> = []
-

The object attributes to be stored. Must contains '_to' and '_from' keys.

+

The object attributes to be stored. Must contain '_to' and '_from' keys.

@@ -748,9 +748,9 @@
Return values
- Edge|false + bool — -

A Edge object if edge exists. False if no graph with this name could be found
+

True if Edge object exists. False if no graph with this name could be found
or this collection is not part of the graph or one of the vertices ('_to' or '_from') does not exist.

@@ -771,9 +771,9 @@

Adds an edge definition to graph.

@@ -853,9 +853,9 @@

Adds a vertex to graph.

@@ -949,9 +949,9 @@

Adds a vertex collection to the set of orphan collections of the graph.

@@ -1015,9 +1015,9 @@

Removes a graph from server, if possible.

@@ -1084,9 +1084,9 @@

Drops an edge from graph.

@@ -1180,12 +1180,12 @@

-

Remove one edge definition from the graph.<br> +

Remove one edge definition from the graph<br> This will only remove the edge collection, the vertex collections remain untouched and can still be used in your queries.

@@ -1264,9 +1264,9 @@

Drops a vertex from graph.

@@ -1360,12 +1360,12 @@

-

Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph.<br> +

Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph<br> It can only remove vertex collections that are no longer part of edge definitions,<br> if they are used in edge definitions you are required to modify those first.

@@ -1435,9 +1435,9 @@

Returns an edge document.

@@ -1513,9 +1513,9 @@

Return all edge definitions of graph.

@@ -1550,9 +1550,9 @@

Returns the graph ID.

@@ -1587,9 +1587,9 @@

Returns the graph key.

@@ -1624,9 +1624,9 @@

Returns the minimal replication factor used for every new collection in the graph.

@@ -1661,9 +1661,9 @@

Gets the graph name.

@@ -1698,9 +1698,9 @@

Returns the number of shards that is used for every collection within this graph.

@@ -1735,9 +1735,9 @@

Returns the orphan collections in the graph.

@@ -1772,9 +1772,9 @@

Returns the replication factor used when initially creating collections for this graph.

@@ -1809,9 +1809,9 @@

Gets the graph revision.

@@ -1846,9 +1846,9 @@

Gets a vertex from the given collection.

@@ -1924,9 +1924,9 @@

Lists all vertex collections within this graph.

@@ -1976,9 +1976,9 @@

Returns true if is a new graph.

@@ -2013,9 +2013,9 @@

If this graph is a smartGraph.

@@ -2050,9 +2050,9 @@

Return a JSON representation of graph attributes.

@@ -2087,9 +2087,9 @@

Save the Graph on server, if possible.

@@ -2143,9 +2143,9 @@

Returns a array representation of graph.

@@ -2180,16 +2180,16 @@

Returns a graph traversal.

public - traversal(Vertex $vertex[, string $direction = Traversal::GRAPH_DIRECTION_ANY ][, int $depth = 0 ]) : TraversalCursor + traversal(Vertex $vertex[, string $direction = Traversal::GRAPH_DIRECTION_ANY ][, int $depth = 0 ]) : Traversal
@@ -2244,7 +2244,7 @@

Return values
- TraversalCursor + Traversal
diff --git a/docs/files/src/Graph/Graph.php.txt b/docs/files/src/Graph/Graph.php.txt index ef37515..fc51c8c 100644 --- a/docs/files/src/Graph/Graph.php.txt +++ b/docs/files/src/Graph/Graph.php.txt @@ -7,7 +7,6 @@ use ArangoDB\Http\Api; use ArangoDB\Document\Edge; use ArangoDB\Document\Vertex; use ArangoDB\Database\Database; -use ArangoDB\Cursor\TraversalCursor; use ArangoDB\DataStructures\ArrayList; use ArangoDB\Graph\Traversal\Traversal; use GuzzleHttp\Exception\ClientException; @@ -403,7 +402,7 @@ class Graph implements \JsonSerializable } /** - * Remove one edge definition from the graph.
+ * Remove one edge definition from the graph
* This will only remove the edge collection, * the vertex collections remain untouched and can still be used in your queries. * @@ -521,7 +520,7 @@ class Graph implements \JsonSerializable } /** - * Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph.
+ * Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph
* It can only remove vertex collections that are no longer part of edge definitions,
* if they are used in edge definitions you are required to modify those first. * @@ -727,15 +726,15 @@ class Graph implements \JsonSerializable /** * Creates a new edge in the collection.
- * Within the attributes the edge has to contain a _from and _to value referencing to valid vertices in the graph. - * Furthermore the edge has to be valid in the definition of the used. + * Within the attributes the edge has to contain a _from and _to value referencing to valid vertices in the graph + * Furthermore, the edge has to be valid in the definition of the used. * * @param string $collection The name of the edge collection the edge belongs to. - * @param array $attributes The object attributes to be stored. Must contains '_to' and '_from' keys. + * @param array $attributes The object attributes to be stored. Must contain '_to' and '_from' keys. * @param bool $waitForSync Define if the request should wait until synced to disk. Default is true. * @param bool $returnNew Define if the response should contain the complete new version of the document. Default is false. * - * @return Edge|false A Edge object if edge exists. False if no graph with this name could be found
+ * @return bool True if Edge object exists. False if no graph with this name could be found
* or this collection is not part of the graph or one of the vertices ('_to' or '_from') does not exist. * * @throws DatabaseException|GuzzleException|ArangoException @@ -820,7 +819,7 @@ class Graph implements \JsonSerializable * @param int $depth Visits only nodes in at least the given depth. * @param string $direction Direction for traversal. Must be either "outbound", "inbound", or "any". * - * @return TraversalCursor + * @return Traversal * * @throws CursorException|GuzzleException|ArangoException */ diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js index 85aab65..b5bf766 100644 --- a/docs/js/searchIndex.js +++ b/docs/js/searchIndex.js @@ -1688,7 +1688,7 @@ Search.appendIndex( }, { "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AdropEdgeDefinition\u0028\u0029", "name": "dropEdgeDefinition", - "summary": "Remove\u0020one\u0020edge\u0020definition\u0020from\u0020the\u0020graph.\u003Cbr\u003E\nThis\u0020will\u0020only\u0020remove\u0020the\u0020edge\u0020collection,\nthe\u0020vertex\u0020collections\u0020remain\u0020untouched\u0020and\u0020can\u0020still\u0020be\u0020used\u0020in\u0020your\u0020queries.", + "summary": "Remove\u0020one\u0020edge\u0020definition\u0020from\u0020the\u0020graph\u003Cbr\u003E\nThis\u0020will\u0020only\u0020remove\u0020the\u0020edge\u0020collection,\nthe\u0020vertex\u0020collections\u0020remain\u0020untouched\u0020and\u0020can\u0020still\u0020be\u0020used\u0020in\u0020your\u0020queries.", "url": "classes/ArangoDB-Graph-Graph.html#method_dropEdgeDefinition" }, { "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetVertexCollections\u0028\u0029", @@ -1703,7 +1703,7 @@ Search.appendIndex( }, { "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AdropVertexCollection\u0028\u0029", "name": "dropVertexCollection", - "summary": "Removes\u0020a\u0020vertex\u0020collection\u0020from\u0020the\u0020graph\u0020and\u0020optionally\u0020deletes\u0020the\u0020collection,\u0020if\u0020it\u0020is\u0020not\u0020used\u0020in\u0020any\u0020other\u0020graph.\u003Cbr\u003E\nIt\u0020can\u0020only\u0020remove\u0020vertex\u0020collections\u0020that\u0020are\u0020no\u0020longer\u0020part\u0020of\u0020edge\u0020definitions,\u003Cbr\u003E\nif\u0020they\u0020are\u0020used\u0020in\u0020edge\u0020definitions\u0020you\u0020are\u0020required\u0020to\u0020modify\u0020those\u0020first.", + "summary": "Removes\u0020a\u0020vertex\u0020collection\u0020from\u0020the\u0020graph\u0020and\u0020optionally\u0020deletes\u0020the\u0020collection,\u0020if\u0020it\u0020is\u0020not\u0020used\u0020in\u0020any\u0020other\u0020graph\u003Cbr\u003E\nIt\u0020can\u0020only\u0020remove\u0020vertex\u0020collections\u0020that\u0020are\u0020no\u0020longer\u0020part\u0020of\u0020edge\u0020definitions,\u003Cbr\u003E\nif\u0020they\u0020are\u0020used\u0020in\u0020edge\u0020definitions\u0020you\u0020are\u0020required\u0020to\u0020modify\u0020those\u0020first.", "url": "classes/ArangoDB-Graph-Graph.html#method_dropVertexCollection" }, { "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetVertex\u0028\u0029", @@ -1728,7 +1728,7 @@ Search.appendIndex( }, { "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AaddEdge\u0028\u0029", "name": "addEdge", - "summary": "Creates\u0020a\u0020new\u0020edge\u0020in\u0020the\u0020collection.\u003Cbr\u003E\nWithin\u0020the\u0020attributes\u0020the\u0020edge\u0020has\u0020to\u0020contain\u0020a\u0020_from\u0020and\u0020_to\u0020value\u0020referencing\u0020to\u0020valid\u0020vertices\u0020in\u0020the\u0020graph.", + "summary": "Creates\u0020a\u0020new\u0020edge\u0020in\u0020the\u0020collection.\u003Cbr\u003E\nWithin\u0020the\u0020attributes\u0020the\u0020edge\u0020has\u0020to\u0020contain\u0020a\u0020_from\u0020and\u0020_to\u0020value\u0020referencing\u0020to\u0020valid\u0020vertices\u0020in\u0020the\u0020graph\nFurthermore,\u0020the\u0020edge\u0020has\u0020to\u0020be\u0020valid\u0020in\u0020the\u0020definition\u0020of\u0020the\u0020used.", "url": "classes/ArangoDB-Graph-Graph.html#method_addEdge" }, { "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AdropEdge\u0028\u0029",