From 4eb07645885b6faceae1acadc225a0bc10fc3576 Mon Sep 17 00:00:00 2001 From: "Lucas S. Vieira" Date: Sat, 11 Oct 2025 21:58:00 +0100 Subject: [PATCH 1/3] fix[indexes]: Inverted index to use default options as defined in its class --- src/Collection/Index/Index.php | 7 +++---- src/Collection/Index/InvertedIndex.php | 11 ++++++----- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/Collection/Index/Index.php b/src/Collection/Index/Index.php index 904d4a2..0e0fec1 100644 --- a/src/Collection/Index/Index.php +++ b/src/Collection/Index/Index.php @@ -98,15 +98,14 @@ public function __construct(string $type, array $fields, array $attributes = []) } $fieldNames = []; - foreach ($fields as $key => $field) { if (is_string($field)) { - array_push($fieldNames, $field); + $fieldNames[] = $field; continue; } if (is_array($field)) { - array_push($fieldNames, $field['name']); + $fieldNames[] = $field['name']; continue; } @@ -114,7 +113,7 @@ public function __construct(string $type, array $fields, array $attributes = []) } $this->type = $type; - $this->fields = $fields; + $this->fields = $fieldNames; // Default values; $this->id = $attributes['id'] ?? ''; diff --git a/src/Collection/Index/InvertedIndex.php b/src/Collection/Index/InvertedIndex.php index adc0e3a..80278a4 100644 --- a/src/Collection/Index/InvertedIndex.php +++ b/src/Collection/Index/InvertedIndex.php @@ -5,11 +5,11 @@ use ArangoDB\Validation\Exceptions\InvalidParameterException; /** -* Inverted index representation -* -* @package ArangoDB\Collection\Index -* @author Lucas S. Vieira -*/ + * Inverted index representation + * + * @package ArangoDB\Collection\Index + * @author Lucas S. Vieira + */ final class InvertedIndex extends Index { /** @@ -35,6 +35,7 @@ final class InvertedIndex extends Index */ public function __construct(array $fields, array $attributes = []) { + $attributes = array_merge($this->defaultOptions, $attributes); parent::__construct('inverted', $fields, $attributes); } } From 9a54948740024cf1af8e9b7a5dd4e9fa86d28ce6 Mon Sep 17 00:00:00 2001 From: "Lucas S. Vieira" Date: Sat, 11 Oct 2025 22:59:09 +0100 Subject: [PATCH 2/3] chore[docs]: rebuild documentation --- docs/classes/ArangoDB-AQL-AQL.html | 196 +- docs/classes/ArangoDB-AQL-BindContainer.html | 1198 ++++++- ...ArangoDB-AQL-Contracts-QueryInterface.html | 137 +- ...goDB-AQL-Contracts-StatementInterface.html | 328 +- .../ArangoDB-AQL-Exceptions-AQLException.html | 98 +- ...oDB-AQL-Exceptions-StatementException.html | 98 +- .../ArangoDB-AQL-Functions-AQLFunction.html | 1008 +++++- docs/classes/ArangoDB-AQL-Statement.html | 959 +++++- docs/classes/ArangoDB-Admin-Admin.html | 629 +++- docs/classes/ArangoDB-Admin-Server.html | 440 ++- docs/classes/ArangoDB-Admin-Task-Task.html | 1072 +++++- docs/classes/ArangoDB-Auth-Authenticable.html | 466 ++- ...rangoDB-Auth-Exceptions-AuthException.html | 92 +- ...rangoDB-Auth-Exceptions-UserException.html | 92 +- docs/classes/ArangoDB-Auth-User.html | 1113 +++++- docs/classes/ArangoDB-Batch-Import.html | 234 +- .../ArangoDB-Collection-Collection.html | 2748 ++++++++++++++- ...B-Collection-Contracts-IndexInterface.html | 413 ++- .../ArangoDB-Collection-Index-EdgeIndex.html | 1229 ++++++- .../ArangoDB-Collection-Index-Factory.html | 95 +- ...angoDB-Collection-Index-FullTextIndex.html | 1319 ++++++- ...goDB-Collection-Index-GeoSpatialIndex.html | 1335 +++++++- .../ArangoDB-Collection-Index-HashIndex.html | 1358 +++++++- .../ArangoDB-Collection-Index-Index.html | 1223 ++++++- ...angoDB-Collection-Index-InvertedIndex.html | 1271 ++++++- ...goDB-Collection-Index-PersistentIndex.html | 1260 ++++++- ...rangoDB-Collection-Index-PrimaryIndex.html | 1229 ++++++- ...angoDB-Collection-Index-SkipListIndex.html | 1358 +++++++- .../ArangoDB-Collection-Index-TTLIndex.html | 1319 ++++++- .../ArangoDB-Collection-IndexableTrait.html | 668 ++++ docs/classes/ArangoDB-Collection-KeyType.html | 176 + .../ArangoDB-Connection-Connection.html | 1402 +++++++- ...ArangoDB-Connection-ManagesConnection.html | 196 +- ...Connection-ManagesConnectionInterface.html | 123 +- docs/classes/ArangoDB-Cursor-Base.html | 1320 ++++++- .../ArangoDB-Cursor-CollectionCursor.html | 2198 +++++++++++- ...goDB-Cursor-Contracts-CursorInterface.html | 69 +- docs/classes/ArangoDB-Cursor-Cursor.html | 2141 +++++++++++- ...oDB-Cursor-Exceptions-CursorException.html | 98 +- .../ArangoDB-Cursor-TraversalCursor.html | 2166 +++++++++++- .../ArangoDB-DataStructures-ArrayList.html | 1099 +++++- ...ataStructures-Contracts-ListInterface.html | 558 ++- .../ArangoDB-DataStructures-CountTrait.html | 74 +- ...ArangoDB-DataStructures-IteratorTrait.html | 250 +- ...rangoDB-DataStructures-SerializeTrait.html | 74 +- docs/classes/ArangoDB-Database-Database.html | 1604 ++++++++- .../ArangoDB-Database-DatabaseHandler.html | 617 +++- docs/classes/ArangoDB-Document-Document.html | 1600 ++++++++- docs/classes/ArangoDB-Document-Edge.html | 1866 +++++++++- docs/classes/ArangoDB-Document-Vertex.html | 1600 ++++++++- ...goDB-Entity-Contracts-EntityInterface.html | 221 +- .../ArangoDB-Exceptions-BaseException.html | 98 +- ...angoDB-Exceptions-ConnectionException.html | 98 +- ...Exceptions-Database-DatabaseException.html | 98 +- .../ArangoDB-Exceptions-Exception.html | 98 +- .../ArangoDB-Exceptions-IndexException.html | 98 +- .../ArangoDB-Exceptions-ServerException.html | 98 +- ...ngoDB-Exceptions-TransactionException.html | 98 +- .../ArangoDB-Graph-EdgeDefinition.html | 462 ++- docs/classes/ArangoDB-Graph-Graph.html | 2709 ++++++++++++++- .../ArangoDB-Graph-Traversal-Path.html | 316 +- .../ArangoDB-Graph-Traversal-Traversal.html | 580 +++- docs/classes/ArangoDB-Http-Api.html | 2804 ++++++++++++++- docs/classes/ArangoDB-Http-RestClient.html | 789 ++++- ...oDB-Transaction-Contracts-Transaction.html | 274 +- ...oDB-Transaction-JavascriptTransaction.html | 400 ++- ...rangoDB-Transaction-StreamTransaction.html | 691 +++- ...B-Validation-Admin-Task-TaskValidator.html | 407 ++- ...rangoDB-Validation-Auth-UserValidator.html | 359 +- ...dation-Collection-CollectionValidator.html | 407 ++- ...Connection-ConnectionOptionsValidator.html | 407 ++- ...Validation-Document-DocumentValidator.html | 577 +++- ...oDB-Validation-Document-EdgeValidator.html | 636 +++- ...dation-Document-PatchOptionsValidator.html | 359 +- ...ation-Document-UpdateOptionsValidator.html | 357 +- ...-Exceptions-InvalidKeyOptionException.html | 214 +- ...-Exceptions-InvalidParameterException.html | 214 +- ...-Exceptions-MissingParameterException.html | 157 +- ...ngoDB-Validation-Graph-GraphValidator.html | 407 ++- ...angoDB-Validation-Rules-RuleInterface.html | 85 +- .../ArangoDB-Validation-Rules-Rules.html | 555 ++- ...ansaction-TransactionOptionsValidator.html | 407 ++- .../ArangoDB-Validation-Validator.html | 311 +- ...rangoDB-Validation-ValidatorInterface.html | 117 +- docs/classes/ArangoDB-View-View.html | 614 +++- docs/files/src-collection-indexabletrait.html | 415 +++ docs/files/src/Collection/Collection.php.txt | 120 +- docs/files/src/Collection/Index/Index.php.txt | 7 +- .../Collection/Index/InvertedIndex.php.txt | 11 +- .../src/Collection/IndexableTrait.php.txt | 112 + docs/indices/files.html | 1 + docs/js/searchIndex.js | 3020 +++++++++++++++++ docs/namespaces/arangodb-collection.html | 10 +- docs/packages/ArangoDB-Collection.html | 10 +- phpdoc.dist.xml | 3 - 95 files changed, 64148 insertions(+), 299 deletions(-) create mode 100644 docs/classes/ArangoDB-Collection-IndexableTrait.html create mode 100644 docs/files/src-collection-indexabletrait.html create mode 100644 docs/files/src/Collection/IndexableTrait.php.txt diff --git a/docs/classes/ArangoDB-AQL-AQL.html b/docs/classes/ArangoDB-AQL-AQL.html index 0132e40..e0fb076 100644 --- a/docs/classes/ArangoDB-AQL-AQL.html +++ b/docs/classes/ArangoDB-AQL-AQL.html @@ -309,14 +309,198 @@

+

+ Methods + +

+
+
+ functions() + +  : ArrayList +
+
Returns all registered AQL user functions.
+ +
+ validateQuery() + +  : bool +
+
Validates a given AQL statement
+ +
- + +
+

+ Methods + + +

+
+

+ functions() + + +

+ + +

Returns all registered AQL user functions.

+ + + public + static functions(Connection $connection[, string $namespace = "" ]) : ArrayList + +
+
+ + +
Parameters
+
+
+ $connection + : Connection +
+
+

Connection object to use.

+
+ +
+
+ $namespace + : string + = ""
+
+

Returns all registered AQL user functions from namespace 'namespace' under result.

+
+ +
+
+ + +
+ Tags + + +
+
+
+ throws +
+
+ ServerException|GuzzleException + + +
+
+ + + +
+
Return values
+ ArrayList + — +

ArrayList with all AQL functions from server.

+
+ +
+ +
+
+

+ validateQuery() + + +

+ + +

Validates a given AQL statement

+ + + public + static validateQuery(StatementInterface $statement, Connection $connection) : bool + +
+
+ + +
Parameters
+
+
+ $statement + : StatementInterface +
+
+

Statement to be validated.

+
+ +
+
+ $connection + : Connection +
+
+

Connection object to use.

+
+ +
+
+ + +
+ Tags + + +
+
+
+ throws +
+
+ AQLException|GuzzleException + + +
+
+ + + +
+
Return values
+ bool +
+ +
+
+
@@ -422,10 +606,18 @@

  • Table Of Contents
    • -
    +
  • Methods
  • + +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-AQL-BindContainer.html b/docs/classes/ArangoDB-AQL-BindContainer.html index 8532548..28578e6 100644 --- a/docs/classes/ArangoDB-AQL-BindContainer.html +++ b/docs/classes/ArangoDB-AQL-BindContainer.html @@ -309,15 +309,1174 @@

    +

    + Properties + +

    +
    +
    + $content + +  : array<string|int, mixed> +
    +
    List of data
    +
    + $position + +  : int +
    +
    Current index
    + +
    + $validator + +  : DocumentValidator +
    +
    Validate input data
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    BindContainer constructor.
    + +
    + __toString() + +  : false|string +
    +
    String representation of ArrayList
    + +
    + append() + +  : void +
    +
    Appends a list to another.
    + +
    + count() + +  : int +
    +
    Count elements of an object
    + +
    + current() + +  : mixed +
    +
    Return the current element
    + +
    + first() + +  : mixed +
    +
    Get the first value of list
    + +
    + get() + +  : mixed +
    +
    Get a value by its key
    + +
    + getAll() + +  : array<string|int, mixed> +
    +
    Get the stored vars
    + +
    + has() + +  : bool +
    +
    Check if a given key exists on list
    + +
    + jsonSerialize() + +  : array<string|int, mixed>|mixed +
    +
    Return a JSON representation of list
    + +
    + key() + +  : mixed +
    +
    Return the key of the current element
    + +
    + last() + +  : mixed +
    +
    Get the last value of list
    + +
    + next() + +  : void +
    +
    Move forward to next element
    + +
    + push() + +  : void +
    +
    Add a value to list
    + +
    + put() + +  : void +
    +
    Add validation to value being set.
    + +
    + remove() + +  : void +
    +
    Remove a value by its key on list
    + +
    + rewind() + +  : void +
    +
    Rewind the Iterator to the first element
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Return an array representation for list
    + +
    + valid() + +  : bool +
    +
    Checks if current position is valid
    + +
    + values() + +  : array<string|int, mixed> +
    +
    Return an array with list values only
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $content + + + + +

    + + +

    List of data

    + + + + protected + array<string|int, mixed> + $content + + + + + + + + + + +
    +
    +

    + $position + + + + +

    + + +

    Current index

    + + + + protected + int + $position + = 0 + + + + + + + + + +
    + +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    BindContainer constructor.

    + + + public + __construct() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + __toString() + + +

    + + +

    String representation of ArrayList

    + + + public + __toString() : false|string + +
    +
    + + + + + + + +
    +
    Return values
    + false|string +
    + +
    +
    +

    + append() + + +

    + + +

    Appends a list to another.

    + + + public + append(ListInterface $list) : void + +
    +
    + + +
    Parameters
    +
    +
    + $list + : ListInterface +
    +
    +

    ListInterface object to append.

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

    + count() + + +

    + + +

    Count elements of an object

    + + + public + count() : int + +
    +
    + + + + + + + +
    +
    Return values
    + int +
    + +
    +
    +

    + current() + + +

    + + +

    Return the current element

    + + + public + current() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + first() + + +

    + + +

    Get the first value of list

    + + + public + first() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + get() + + +

    + + +

    Get a value by its key

    + + + public + get(int|string $key) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $key + : int|string +
    +
    +

    KeyType to verify on list.

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

    + getAll() + + +

    + + +

    Get the stored vars

    + + + public + getAll() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + has() + + +

    + + +

    Check if a given key exists on list

    + + + public + has(mixed $key) : bool + +
    +
    + + +
    Parameters
    +
    +
    + $key + : mixed +
    +
    +

    int|string to verify on list.

    +
    + +
    +
    + + + + + +
    +
    Return values
    + bool + — +

    True if key exists, false otherwise.

    +
    + +
    + +
    +
    +

    + jsonSerialize() + + +

    + + +

    Return a JSON representation of list

    + + + public + jsonSerialize() : array<string|int, mixed>|mixed + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed>|mixed +
    + +
    +
    +

    + key() + + +

    + + +

    Return the key of the current element

    + + + public + key() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + last() + + +

    + + +

    Get the last value of list

    + + + public + last() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + next() + + +

    + + +

    Move forward to next element

    + + + public + next() : void + +
    +
    + + + + + + + + +
    +
    +

    + push() + + +

    + + +

    Add a value to list

    + + + public + push(mixed $value) : void + +
    +
    + + +
    Parameters
    +
    +
    + $value + : mixed +
    +
    +

    Value to add.

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

    + put() + + +

    + + +

    Add validation to value being set.

    + + + public + put(int|string $key, mixed $value) : void + +
    +
    + +

    All values must be primitives data types

    +
    + +
    Parameters
    +
    +
    + $key + : int|string +
    +
    + +
    +
    + $value + : mixed +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException + + +
    +
    + + + + +
    +
    +

    + remove() + + +

    + + +

    Remove a value by its key on list

    + + + public + remove(mixed $key) : void + +
    +
    + + +
    Parameters
    +
    +
    + $key + : mixed +
    +
    +

    int|string to remove from list.

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

    + rewind() + + +

    + + +

    Rewind the Iterator to the first element

    + + + public + rewind() : void + +
    +
    + + + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Return an array representation for list

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + valid() + + +

    + + +

    Checks if current position is valid

    + + + public + valid() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + values() + + +

    + + +

    Return an array with list values only

    + + + public + values() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -423,10 +1582,45 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-AQL-Contracts-QueryInterface.html b/docs/classes/ArangoDB-AQL-Contracts-QueryInterface.html index e8ab53c..7cd6570 100644 --- a/docs/classes/ArangoDB-AQL-Contracts-QueryInterface.html +++ b/docs/classes/ArangoDB-AQL-Contracts-QueryInterface.html @@ -299,13 +299,141 @@

    +

    + Methods + +

    +
    +
    + execute() + +  : Base +
    +
    Execute an statment on server and returns a cursor
    + +
    + query() + +  : StatementInterface +
    +
    Instantiate a new StatementInterface object with the specified query
    + +
    - + +
    +

    + Methods + + +

    + +
    +

    + query() + + +

    + + +

    Instantiate a new StatementInterface object with the specified query

    + + + public + query(string $query) : StatementInterface + +
    +
    + + +
    Parameters
    +
    +
    + $query + : string +
    +
    + +
    +
    + + + + + +
    +
    Return values
    + StatementInterface +
    + +
    +
    +
    @@ -415,6 +543,13 @@

  • Methods
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-AQL-Contracts-StatementInterface.html b/docs/classes/ArangoDB-AQL-Contracts-StatementInterface.html index 858238e..2c0a4c7 100644 --- a/docs/classes/ArangoDB-AQL-Contracts-StatementInterface.html +++ b/docs/classes/ArangoDB-AQL-Contracts-StatementInterface.html @@ -299,13 +299,328 @@

    +

    + Methods + +

    +
    +
    + __toString() + +  : string +
    +
    Get the string representation of query
    + +
    + bindValue() + +  : bool +
    +
    Binds a value to specified parameter name.
    + +
    + getBindVars() + +  : array<string|int, mixed> +
    +
    Get the bind vars
    + +
    + getQuery() + +  : string +
    +
    Returns the query string
    + +
    + hasAliases() + +  : bool +
    +
    If the query has some alias (e.g: "@myparam" ) +on it to receive a value after through binding
    + +
    + toAql() + +  : string +
    +
    'Resolves' the query, returning the string after bind all params and values
    + +
    - + +
    +

    + Methods + + +

    +
    +

    + __toString() + + +

    + + +

    Get the string representation of query

    + + + public + __toString() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + bindValue() + + +

    + + +

    Binds a value to specified parameter name.

    + + + public + bindValue(string $parameter, mixed $value) : bool + +
    +
    + + +
    Parameters
    +
    +
    + $parameter + : string +
    +
    + +
    +
    + $value + : mixed +
    +
    + +
    +
    + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + getBindVars() + + +

    + + +

    Get the bind vars

    + + + public + getBindVars() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getQuery() + + +

    + + +

    Returns the query string

    + + + public + getQuery() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + hasAliases() + + +

    + + +

    If the query has some alias (e.g: "@myparam" ) +on it to receive a value after through binding

    + + + public + hasAliases() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + toAql() + + +

    + + +

    'Resolves' the query, returning the string after bind all params and values

    + + + public + toAql() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +
    @@ -415,6 +730,17 @@

  • Methods
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-AQL-Exceptions-AQLException.html b/docs/classes/ArangoDB-AQL-Exceptions-AQLException.html index 1e502b2..8ad3703 100644 --- a/docs/classes/ArangoDB-AQL-Exceptions-AQLException.html +++ b/docs/classes/ArangoDB-AQL-Exceptions-AQLException.html @@ -312,14 +312,101 @@

    +

    + Methods + +

    +
    +
    + __construct() + +  : mixed +
    +
    Base exception constructor.
    + +
    - + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    Base exception constructor.

    + + + public + __construct(string $message[, Throwable|null $previous = null ][, int $code = 0 ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $message + : string +
    +
    +

    Exception message.

    +
    + +
    +
    + $previous + : Throwable|null + = null
    +
    +

    Previous exception or error.

    +
    + +
    +
    + $code + : int + = 0
    +
    +

    Error code.

    +
    + +
    +
    + + + + + + +
    +
    +
    @@ -425,10 +512,17 @@

  • Table Of Contents
    • -
    +
  • Methods
  • + +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-AQL-Exceptions-StatementException.html b/docs/classes/ArangoDB-AQL-Exceptions-StatementException.html index 77df564..0c9b928 100644 --- a/docs/classes/ArangoDB-AQL-Exceptions-StatementException.html +++ b/docs/classes/ArangoDB-AQL-Exceptions-StatementException.html @@ -312,14 +312,101 @@

    +

    + Methods + +

    +
    +
    + __construct() + +  : mixed +
    +
    Base exception constructor.
    + +
    - + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    Base exception constructor.

    + + + public + __construct(string $message[, Throwable|null $previous = null ][, int $code = 0 ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $message + : string +
    +
    +

    Exception message.

    +
    + +
    +
    + $previous + : Throwable|null + = null
    +
    +

    Previous exception or error.

    +
    + +
    +
    + $code + : int + = 0
    +
    +

    Error code.

    +
    + +
    +
    + + + + + + +
    +
    +
    @@ -425,10 +512,17 @@

  • Table Of Contents
    • -
    +
  • Methods
  • + +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-AQL-Functions-AQLFunction.html b/docs/classes/ArangoDB-AQL-Functions-AQLFunction.html index a958285..2cc180e 100644 --- a/docs/classes/ArangoDB-AQL-Functions-AQLFunction.html +++ b/docs/classes/ArangoDB-AQL-Functions-AQLFunction.html @@ -318,15 +318,989 @@

    +

    + Properties + +

    +
    +
    + $code + +  : string +
    +
    String representation of function body.
    +
    + $connection + +  : Connection|null +
    +
    Connection object.
    + +
    + $deletion + +  : array<string|int, mixed> +
    +
    Stores the deletion data for an AQLFunction object.
    + +
    + $isDeterministic + +  : bool +
    +
    An optional boolean value to indicate whether the function results are fully deterministic. <br> +(function return value solely depends on the input value and return value is the same for repeated calls with same input)
    + +
    + $isNew + +  : bool +
    +
    If the entity is not a representation of an existing user function on server, +this property is true.
    + +
    + $name + +  : string +
    +
    Fully qualified name of user function.
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    AQLFunction constructor.
    + +
    + delete() + +  : bool +
    +
    Removes an AQL function from server, if possible
    + +
    + getCode() + +  : string +
    +
    Returns the AQL function code.
    + +
    + getDeletionData() + +  : array<string|int, mixed> +
    +
    If the object has performed a delete operation, this method will return the deletion data.
    + +
    + getName() + +  : string +
    +
    Returns the AQL function name.
    + +
    + hasConnection() + +  : bool +
    +
    If this AQL function has a connection set or not.
    + +
    + isDeterministic() + +  : bool +
    +
    Indicates if the function results are deterministic. <br>
    + +
    + isNew() + +  : bool +
    +
    If the AQLFunction object is a new created AQLFunction (and not exists on server) <br> +or if it is a representation of an existing one.
    + +
    + jsonSerialize() + +  : array<string|int, mixed>|mixed +
    +
    Return a JSON representation of AQL function object.
    + +
    + save() + +  : bool +
    +
    Saves the AQL function on server.
    + +
    + setConnection() + +  : void +
    +
    Sets a connection to use.
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Returns a array representation of AQL function object.
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $code + + + + +

    + + +

    String representation of function body.

    + + + + protected + string + $code + + + + + + + + + + +
    +
    +

    + $connection + + + + +

    + + +

    Connection object.

    + + + + protected + Connection|null + $connection + + + + + + + + + + +
    +
    +

    + $deletion + + + + +

    + + +

    Stores the deletion data for an AQLFunction object.

    + + + + protected + array<string|int, mixed> + $deletion + = [] + + + + + + + + + +
    +
    +

    + $isDeterministic + + + + +

    + + +

    An optional boolean value to indicate whether the function results are fully deterministic. <br> +(function return value solely depends on the input value and return value is the same for repeated calls with same input)

    + + + + protected + bool + $isDeterministic + + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If the entity is not a representation of an existing user function on server, +this property is true.

    + + + + protected + bool + $isNew + + + + + + + + + + +
    +
    +

    + $name + + + + +

    + + +

    Fully qualified name of user function.

    + + + + protected + string + $name + + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    AQLFunction constructor.

    + + + public + __construct(string $name, string $code[, Connection|null $connection = null ][, bool $isDeterministic = true ][, bool $isNew = true ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $name + : string +
    +
    +

    The AQL function name.

    +
    + +
    +
    + $code + : string +
    +
    +

    The AQL function code.

    +
    + +
    +
    + $connection + : Connection|null + = null
    +
    +

    Connection object to use.

    +
    + +
    +
    + $isDeterministic + : bool + = true
    +
    +

    Indicates if the function results are deterministic.

    +
    + +
    +
    + $isNew + : bool + = true
    +
    +

    Indicates if the function object is a new one or not.

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

    + delete() + + +

    + + +

    Removes an AQL function from server, if possible

    + + + public + delete() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if operation was successful, false otherwise

    +
    + +
    + +
    +
    +

    + getCode() + + +

    + + +

    Returns the AQL function code.

    + + + public + getCode() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getDeletionData() + + +

    + + +

    If the object has performed a delete operation, this method will return the deletion data.

    + + + public + getDeletionData() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getName() + + +

    + + +

    Returns the AQL function name.

    + + + public + getName() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + hasConnection() + + +

    + + +

    If this AQL function has a connection set or not.

    + + + public + hasConnection() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool + — +

    True if it has a connection object. False otherwise.

    +
    + +
    + +
    +
    +

    + isDeterministic() + + +

    + + +

    Indicates if the function results are deterministic. <br>

    + + + public + isDeterministic() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isNew() + + +

    + + +

    If the AQLFunction object is a new created AQLFunction (and not exists on server) <br> +or if it is a representation of an existing one.

    + + + public + isNew() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + jsonSerialize() + + +

    + + +

    Return a JSON representation of AQL function object.

    + + + public + jsonSerialize() : array<string|int, mixed>|mixed + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed>|mixed +
    + +
    +
    +

    + save() + + +

    + + +

    Saves the AQL function on server.

    + + + public + save() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if operation was successful, false otherwise.

    +
    + +
    + +
    +
    +

    + setConnection() + + +

    + + +

    Sets a connection to use.

    + + + public + setConnection(Connection $connection) : void + +
    +
    + + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

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

    + toArray() + + +

    + + +

    Returns a array representation of AQL function object.

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -432,10 +1406,40 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-AQL-Statement.html b/docs/classes/ArangoDB-AQL-Statement.html index 9f28d13..3b33307 100644 --- a/docs/classes/ArangoDB-AQL-Statement.html +++ b/docs/classes/ArangoDB-AQL-Statement.html @@ -316,15 +316,941 @@

    +

    + Properties + +

    +
    +
    + $collectionAlias + +  : string +
    +
    If the statement use an alias for collection, +store the alias here +(e.g "@collection", "@coll")
    +
    + $container + +  : BindContainer +
    +
    Contains all references calling 'bindValue' method
    + +
    + $formats + +  : array<string|int, mixed> +
    +
    Formats to format output string
    + +
    + $query + +  : string +
    +
    The query string
    + +
    + $queryParameters + +  : array<string|int, mixed> +
    +
    Parameters set with '@' in query
    + +
    + $validator + +  : ValidatorInterface +
    +
    Validator for binding values or params
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    Statement constructor.
    + +
    + __toString() + +  : string +
    +
    String representation of query
    + +
    + bindValue() + +  : bool +
    +
    Binds a value to specified parameter name.
    + +
    + getBindVars() + +  : array<string|int, mixed> +
    +
    Get the bind vars
    + +
    + getQuery() + +  : string +
    +
    Returns the query string
    + +
    + hasAliases() + +  : bool +
    +
    If the query has some alias on it to receive an value after through binding
    + +
    + toAql() + +  : string +
    +
    'Resolves' the query, returning the string after bind all params and values
    + +
    + hasParam() + +  : bool +
    +
    Check if parameter exists
    + +
    + isCollectionAlias() + +  : bool +
    +
    Verify if an alias is defined for collection aliasing
    + +
    + output() + +  : string +
    +
    Returns the proper output formatted given parameter
    + +
    + processQueryParameters() + +  : void +
    +
    Find occurrences of bind params in query string
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $collectionAlias + + + + +

    + + +

    If the statement use an alias for collection, +store the alias here +(e.g "@collection", "@coll")

    + + + + protected + string + $collectionAlias + = "" + + + + + + + + + +
    +
    +

    + $container + + + + +

    + + +

    Contains all references calling 'bindValue' method

    + + + + protected + BindContainer + $container + + + + + + + + + + +
    +
    +

    + $formats + + + + +

    + + +

    Formats to format output string

    + + + + protected + array<string|int, mixed> + $formats + = ["float" => "%F", "integer" => "%d", "string" => "'%s'", "boolean" => "%s", "collection" => "%s"] + + + + + + + + + +
    +
    +

    + $query + + + + +

    + + +

    The query string

    + + + + protected + string + $query + + + + + + + + + + +
    +
    +

    + $queryParameters + + + + +

    + + +

    Parameters set with '@' in query

    + + + + protected + array<string|int, mixed> + $queryParameters + = [] + + + + + + + + + +
    +
    +

    + $validator + + + + +

    + + +

    Validator for binding values or params

    + + + + protected + ValidatorInterface + $validator + + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    Statement constructor.

    + + + public + __construct(string $query) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $query + : string +
    +
    +

    AQL query string.

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

    + __toString() + + +

    + + +

    String representation of query

    + + + public + __toString() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + bindValue() + + +

    + + +

    Binds a value to specified parameter name.

    + + + public + bindValue(string $parameter, mixed $value) : bool + +
    +
    + + +
    Parameters
    +
    +
    + $parameter + : string +
    +
    +

    Parameter name.

    +
    + +
    +
    + $value + : mixed +
    +
    +

    Value for parameter.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if the parameter has an alias on query string. False otherwise.

    +
    + +
    + +
    +
    +

    + getBindVars() + + +

    + + +

    Get the bind vars

    + + + public + getBindVars() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getQuery() + + +

    + + +

    Returns the query string

    + + + public + getQuery() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + hasAliases() + + +

    + + +

    If the query has some alias on it to receive an value after through binding

    + + + public + hasAliases() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + toAql() + + +

    + + +

    'Resolves' the query, returning the string after bind all params and values

    + + + public + toAql() : string + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + StatementException + + +
    +
    + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + hasParam() + + +

    + + +

    Check if parameter exists

    + + + private + hasParam(string $parameter) : bool + +
    +
    + + +
    Parameters
    +
    +
    + $parameter + : string +
    +
    +

    Parameter name.

    +
    + +
    +
    + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isCollectionAlias() + + +

    + + +

    Verify if an alias is defined for collection aliasing

    + + + private + isCollectionAlias([string $alias = "@collection" ]) : bool + +
    +
    + + +
    Parameters
    +
    +
    + $alias + : string + = "@collection"
    +
    +

    The candidate alias to be checked.

    +
    + +
    +
    + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + output() + + +

    + + +

    Returns the proper output formatted given parameter

    + + + private + output(string $parameter) : string + +
    +
    + + +
    Parameters
    +
    +
    + $parameter + : string +
    +
    +

    Parameter name.

    +
    + +
    +
    + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + processQueryParameters() + + +

    + + +

    Find occurrences of bind params in query string

    + + + private + processQueryParameters() : void + +
    +
    + + + + + + + + +
    +
    +
    @@ -430,10 +1356,39 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Admin-Admin.html b/docs/classes/ArangoDB-Admin-Admin.html index de93c72..26fc69a 100644 --- a/docs/classes/ArangoDB-Admin-Admin.html +++ b/docs/classes/ArangoDB-Admin-Admin.html @@ -309,14 +309,626 @@

    +

    + Methods + +

    +
    +
    + flushWal() + +  : bool +
    +
    Flushes the <b>write-ahead log</b>. By flushing the currently active write-ahead +logfile, the data in it can be transferred to collection journals and +datafiles. This is useful to ensure that all data for a collection is +present in the collection journals and datafiles, for example, when dumping +the data of a collection.
    + +
    + statistics() + +  : array<string|int, mixed> +
    +
    Returns the statistics information.
    + +
    + tasks() + +  : mixed +
    +
    Returns all tasks of server information.
    + +
    + time() + +  : float +
    +
    Returns the system time.
    + +
    + user() + +  : User|bool +
    +
    Finds a user on server.
    + +
    + walProperties() + +  : array<string|int, mixed> +
    +
    Retrieves the configuration of the <b>write-ahead log</b>.
    + +
    + walTransactions() + +  : array<string|int, mixed> +
    +
    Returns information about the currently running transactions.
    + +
    - + +
    +

    + Methods + + +

    +
    +

    + flushWal() + + +

    + + +

    Flushes the <b>write-ahead log</b>. By flushing the currently active write-ahead +logfile, the data in it can be transferred to collection journals and +datafiles. This is useful to ensure that all data for a collection is +present in the collection journals and datafiles, for example, when dumping +the data of a collection.

    + + + public + static flushWal(Connection $connection[, bool $waitForSync = true ][, bool $waitForCollector = true ]) : bool + +
    +
    + + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

    +
    + +
    +
    + $waitForSync + : bool + = true
    +
    +

    If true, the operation should block until the not-yet synchronized data in the write-ahead log was synchronized to disk.

    +
    + +
    +
    + $waitForCollector + : bool + = true
    +
    +

    If true, the operation should block until the data in the flushed log has been collected by the write-ahead log garbage collector.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if operation was successful. False otherwise.

    +
    + +
    + +
    +
    +

    + statistics() + + +

    + + +

    Returns the statistics information.

    + + + public + static statistics(Connection $connection) : array<string|int, mixed> + +
    +
    + + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + array<string|int, mixed> + — +

    Array with statistics information about server.

    +
    + +
    + +
    + +
    +

    + time() + + +

    + + +

    Returns the system time.

    + + + public + static time(Connection $connection) : float + +
    +
    + + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + float + — +

    Unix timestamp from server.

    +
    + +
    + +
    +
    +

    + user() + + +

    + + +

    Finds a user on server.

    + + + public + static user(Connection $connection, string $username) : User|bool + +
    +
    + + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

    +
    + +
    +
    + $username + : string +
    +
    +

    Username of user.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException|MissingParameterException|GuzzleException|ServerException + + +
    +
    + + + +
    +
    Return values
    + User|bool + — +

    User objects if the user with the given 'username' exists, false if not.

    +
    + +
    + +
    +
    +

    + walProperties() + + +

    + + +

    Retrieves the configuration of the <b>write-ahead log</b>.

    + + + public + static walProperties(Connection $connection) : array<string|int, mixed> + +
    +
    + +

    The result is a array with the following keys:
    +allowOversizeEntries: whether or not operations that are bigger than a single logfile can be executed and stored
    +logfileSize: the size of each write-ahead logfile
    +historicLogfiles: the maximum number of historic logfiles to keep
    +reserveLogfiles: the maximum number of reserve logfiles that ArangoDB allocates in the background
    +syncInterval: the interval for automatic synchronization of not-yet synchronized write-ahead log data (in milliseconds)
    +throttleWait: the maximum wait time that operations will wait before they get aborted if case of write-throttling (in milliseconds)
    +throttleWhenPending: the number of unprocessed garbage-collection operations that, when reached, will activate write-throttling. +A value of 0 means that write-throttling will not be triggered.

    +
    + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException + + +
    +
    + see +
    +
    + https://www.arangodb.com/docs/stable/http/miscellaneous-functions.html#retrieves-the-configuration-of-the-write-ahead-log + + +
    +
    + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + walTransactions() + + +

    + + +

    Returns information about the currently running transactions.

    + + + public + static walTransactions(Connection $connection) : array<string|int, mixed> + +
    +
    + + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + array<string|int, mixed> + — +

    An array with the following parameters:
    +runningTransactions: number of currently running transactions
    +minLastCollected: minimum id of the last collected logfile (at the start of each running transaction). This is null if no transaction is running.
    +minLastSealed: minimum id of the last sealed logfile (at the start of each running transaction). This is null if no transaction is running.

    +
    + +
    + +
    +
    +
    @@ -422,10 +1034,23 @@

  • Table Of Contents
    • -
    +
  • Methods
  • + +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Admin-Server.html b/docs/classes/ArangoDB-Admin-Server.html index c25fc02..b79e971 100644 --- a/docs/classes/ArangoDB-Admin-Server.html +++ b/docs/classes/ArangoDB-Admin-Server.html @@ -309,14 +309,439 @@

    +

    + Methods + +

    +
    +
    + engine() + +  : string +
    +
    Returns the storage engine the server is configured to use.
    + +
    + isAvailable() + +  : bool +
    +
    Checks if the Arango server is available for arbitrary operations.<br> +(e.g Is not set to read-only mode and isn't a follower on failover setups)<br> +If server during startup or during shutdown returns false.
    + +
    + logLevel() + +  : array<string|int, mixed> +
    +
    Returns the server's current log level settings.
    + +
    + role() + +  : string +
    +
    Returns the role of a server in a cluster.
    + +
    + version() + +  : string +
    +
    Returns the Arango server version.
    + +
    - + +
    +

    + Methods + + +

    +
    +

    + engine() + + +

    + + +

    Returns the storage engine the server is configured to use.

    + + + public + static engine(Connection $connection) : string + +
    +
    + +

    (mmfiles or rocksdb)

    +
    + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + GuzzleException|ServerException + + +
    +
    + see +
    +
    + https://www.arangodb.com/docs/stable/http/miscellaneous-functions.html#return-server-database-engine-type + + +
    +
    + + + +
    +
    Return values
    + string + — +

    Engine name. Will be mmfiles or rocksdb

    +
    + +
    + +
    +
    +

    + isAvailable() + + +

    + + +

    Checks if the Arango server is available for arbitrary operations.<br> +(e.g Is not set to read-only mode and isn't a follower on failover setups)<br> +If server during startup or during shutdown returns false.

    + + + public + static isAvailable(Connection $connection) : bool + +
    +
    + + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if server is available. False if not.

    +
    + +
    + +
    +
    +

    + logLevel() + + +

    + + +

    Returns the server's current log level settings.

    + + + public + static logLevel(Connection $connection) : array<string|int, mixed> + +
    +
    + + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + array<string|int, mixed> + — +

    An array with the log topics being the object keys, and the log levels being the object values.

    +
    + +
    + +
    +
    +

    + role() + + +

    + + +

    Returns the role of a server in a cluster.

    + + + public + static role(Connection $connection) : string + +
    +
    + + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + GuzzleException|ServerException + + +
    +
    + + + +
    +
    Return values
    + string + — +

    The role of server in a cluster. Possible return values for role are:
    +single: for standalone servers.
    +coordinator: if server is a coordinator in a cluster.
    +primary: if the server is a DBServer in a cluster.
    +secondary: a not used role.
    +agent: if the server is an Agency node in a cluster.
    +undefined: if the role cannot be determined.

    +
    + +
    + +
    +
    +

    + version() + + +

    + + +

    Returns the Arango server version.

    + + + public + static version(Connection $connection) : string + +
    +
    + + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + string + — +

    The server version string. The string has the format “major.minor.sub”.
    +Major and minor will be numeric, and sub may contain a number or a textual version.

    +
    + +
    + +
    +
    +
    @@ -422,10 +847,21 @@

  • Table Of Contents
    • -
    +
  • Methods
  • + +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Admin-Task-Task.html b/docs/classes/ArangoDB-Admin-Task-Task.html index 035ae86..ffab8f3 100644 --- a/docs/classes/ArangoDB-Admin-Task-Task.html +++ b/docs/classes/ArangoDB-Admin-Task-Task.html @@ -318,15 +318,1052 @@

    +

    + Properties + +

    +
    +
    + $attributes + +  : array<string|int, mixed> +
    +
    Attributes of task.
    +
    + $connection + +  : Connection +
    +
    Connection object.
    + +
    + $defaultOptions + +  : array<string|int, mixed> +
    +
    Default options.
    + +
    + $id + +  : string +
    +
    Task id.
    + +
    + $isNew + +  : bool +
    +
    If the entity is not an representation of a existing task on server, +this property is true.
    + +
    + $type + +  : string +
    +
    Task type.
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    Task constructor.
    + +
    + delete() + +  : bool +
    +
    Removes a task from server, if possible.
    + +
    + getCommand() + +  : string +
    +
    Returns the command.
    + +
    + getId() + +  : string|null +
    +
    Return the Task id.
    + +
    + getType() + +  : string +
    +
    Return the task type.
    + +
    + hasConnection() + +  : bool +
    +
    If this task has a connection set or not.
    + +
    + isNew() + +  : bool +
    +
    If the task object is a new created task (and not exists on server) <br> +or if it is a representation of an existing one.
    + +
    + jsonSerialize() + +  : mixed +
    +
    Return a JSON representation of Task object.
    + +
    + save() + +  : bool +
    +
    Saves this task on server, if possible
    + +
    + setCommand() + +  : void +
    +
    Sets the command to task.
    + +
    + setConnection() + +  : void +
    +
    Sets a connection to use.
    + +
    + setId() + +  : void +
    +
    Sets a custom id for task.
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Returns a array representation of task.
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $attributes + + + + +

    + + +

    Attributes of task.

    + + + + protected + array<string|int, mixed> + $attributes + + + + + + + + + + +
    +
    +

    + $connection + + + + +

    + + +

    Connection object.

    + + + + protected + Connection + $connection + + + + + + + + + + +
    +
    +

    + $defaultOptions + + + + +

    + + +

    Default options.

    + + + + protected + array<string|int, mixed> + $defaultOptions + = ['offset' => 30, 'period' => 30, 'params' => []] + + + + + + + + + +
    +
    +

    + $id + + + + +

    + + +

    Task id.

    + + + + protected + string + $id + + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If the entity is not an representation of a existing task on server, +this property is true.

    + + + + protected + bool + $isNew + = true + + + + + + + + + +
    +
    +

    + $type + + + + +

    + + +

    Task type.

    + + + + protected + string + $type + = 'unknown' + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    Task constructor.

    + + + public + __construct(string $name, string $command[, Connection|null $connection = null ][, array<string|int, mixed> $options = [] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $name + : string +
    +
    +

    Task name.

    +
    + +
    +
    + $command + : string +
    +
    +

    Task command.

    +
    + +
    +
    + $connection + : Connection|null + = null
    +
    +

    Connection to use.

    +
    + +
    +
    + $options + : array<string|int, mixed> + = []
    +
    +

    Additional options for task.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException|MissingParameterException + + +
    +
    + + + + +
    +
    +

    + delete() + + +

    + + +

    Removes a task from server, if possible.

    + + + public + delete() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if operation was successful, false otherwise

    +
    + +
    + +
    +
    +

    + getCommand() + + +

    + + +

    Returns the command.

    + + + public + getCommand() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getId() + + +

    + + +

    Return the Task id.

    + + + public + getId() : string|null + +
    +
    + + + + + + + +
    +
    Return values
    + string|null + — +

    Task id, if exists or null if the task is a new one.

    +
    + +
    + +
    +
    +

    + getType() + + +

    + + +

    Return the task type.

    + + + public + getType() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + hasConnection() + + +

    + + +

    If this task has a connection set or not.

    + + + public + hasConnection() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool + — +

    True of has a connection object. False otherwise.

    +
    + +
    + +
    +
    +

    + isNew() + + +

    + + +

    If the task object is a new created task (and not exists on server) <br> +or if it is a representation of an existing one.

    + + + public + isNew() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + jsonSerialize() + + +

    + + +

    Return a JSON representation of Task object.

    + + + public + jsonSerialize() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + save() + + +

    + + +

    Saves this task on server, if possible

    + + + public + save() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if operation was successful, false otherwise

    +
    + +
    + +
    +
    +

    + setCommand() + + +

    + + +

    Sets the command to task.

    + + + public + setCommand(string $command) : void + +
    +
    + + +
    Parameters
    +
    +
    + $command + : string +
    +
    + +
    +
    + + + + + + +
    +
    +

    + setConnection() + + +

    + + +

    Sets a connection to use.

    + + + public + setConnection(Connection $connection) : void + +
    +
    + + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

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

    + setId() + + +

    + + +

    Sets a custom id for task.

    + + + public + setId(string $id) : void + +
    +
    + + +
    Parameters
    +
    +
    + $id + : string +
    +
    + +
    +
    + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Returns a array representation of task.

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -432,10 +1469,41 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Auth-Authenticable.html b/docs/classes/ArangoDB-Auth-Authenticable.html index 6b8dd9d..cb9ae3f 100644 --- a/docs/classes/ArangoDB-Auth-Authenticable.html +++ b/docs/classes/ArangoDB-Auth-Authenticable.html @@ -308,15 +308,457 @@

    +

    + Properties + +

    +
    +
    + $authToken + +  : array<string|int, mixed> +
    + +
    + $options + +  : array<string|int, mixed> +
    + +
    + $restClient + +  : RestClient +
    + +
    + +

    + Methods + +

    +
    +
    + __construct() + +  : mixed +
    +
    Authenticable constructor.
    + +
    + authenticate() + +  : void +
    +
    Authenticates a user on ArangoDB Server
    + +
    + getAuthorizationHeader() + +  : array<string|int, mixed> +
    +
    Return the authorization header
    + +
    + getAuthenticationEndpoint() + +  : string +
    +
    Authentication endpoint for a given database
    + +
    + getCredentials() + +  : array<string|int, mixed> +
    +
    Return authentication credentials
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $authToken + + + + +

    + + + + + + protected + array<string|int, mixed> + $authToken + + + +

    JWT token

    +
    + + + + + + + +
    +
    +

    + $options + + + + +

    + + + + + + protected + array<string|int, mixed> + $options + + + + + + + + + + +
    + +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    Authenticable constructor.

    + + + public + __construct(array<string|int, mixed> $options) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $options + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException|GuzzleException|AuthException|ConnectionException + + +
    +
    + + + + +
    +
    +

    + authenticate() + + +

    + + +

    Authenticates a user on ArangoDB Server

    + + + protected + authenticate(array<string|int, mixed> $credentials) : void + +
    +
    + + +
    Parameters
    +
    +
    + $credentials + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + RequestException|AuthException|GuzzleException|ConnectionException + + +
    +
    + + + + +
    +
    +

    + getAuthorizationHeader() + + +

    + + +

    Return the authorization header

    + + + protected + getAuthorizationHeader() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getAuthenticationEndpoint() + + +

    + + +

    Authentication endpoint for a given database

    + + + private + getAuthenticationEndpoint() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getCredentials() + + +

    + + +

    Return authentication credentials

    + + + private + getCredentials() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -422,10 +864,30 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Auth-Exceptions-AuthException.html b/docs/classes/ArangoDB-Auth-Exceptions-AuthException.html index 6ec14bd..f19d134 100644 --- a/docs/classes/ArangoDB-Auth-Exceptions-AuthException.html +++ b/docs/classes/ArangoDB-Auth-Exceptions-AuthException.html @@ -312,14 +312,95 @@

    +

    + Methods + +

    +
    +
    + __construct() + +  : mixed +
    +
    AuthException constructor.
    + +
    - + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    AuthException constructor.

    + + + public + __construct(string $message[, Throwable|null $previous = null ][, int $code = 0 ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $message + : string +
    +
    + +
    +
    + $previous + : Throwable|null + = null
    +
    + +
    +
    + $code + : int + = 0
    +
    + +
    +
    + + + + + + +
    +
    +
    @@ -425,10 +506,17 @@

  • Table Of Contents
    • -
    +
  • Methods
  • + +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Auth-Exceptions-UserException.html b/docs/classes/ArangoDB-Auth-Exceptions-UserException.html index 3f3cc92..79d1319 100644 --- a/docs/classes/ArangoDB-Auth-Exceptions-UserException.html +++ b/docs/classes/ArangoDB-Auth-Exceptions-UserException.html @@ -312,14 +312,95 @@

    +

    + Methods + +

    +
    +
    + __construct() + +  : mixed +
    +
    UserException constructor.
    + +
    - + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    UserException constructor.

    + + + public + __construct(string $message[, Throwable|null $previous = null ][, int $code = 0 ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $message + : string +
    +
    + +
    +
    + $previous + : Throwable|null + = null
    +
    + +
    +
    + $code + : int + = 0
    +
    + +
    +
    + + + + + + +
    +
    +
    @@ -425,10 +506,17 @@

  • Table Of Contents
    • -
    +
  • Methods
  • + +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Auth-User.html b/docs/classes/ArangoDB-Auth-User.html index 463517c..89ff0df 100644 --- a/docs/classes/ArangoDB-Auth-User.html +++ b/docs/classes/ArangoDB-Auth-User.html @@ -316,15 +316,1092 @@

    +

    + Properties + +

    +
    +
    + $active + +  : bool +
    +
    If user is active or not on database.
    +
    + $connection + +  : Connection|null +
    +
    Connection object to use.
    + +
    + $extra + +  : array<string|int, mixed>|null +
    +
    Extra data about the user.
    + +
    + $isNew + +  : bool +
    +
    If user is a new User or an existing one.
    + +
    + $password + +  : string +
    +
    Password of user.
    + +
    + $user + +  : string +
    +
    Name of user on server.
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    User constructor.
    + +
    + __debugInfo() + +  : array<string|int, mixed> +
    +
    Proper debug dump for User objects.
    + +
    + __get() + +  : mixed|null +
    +
    Get some attribute.
    + +
    + __toString() + +  : string +
    +
    String representation of User object.
    + +
    + delete() + +  : bool +
    +
    Removes an user from server.
    + +
    + getExtra() + +  : array<string|int, mixed>|null +
    +
    Returns extra data about user.
    + +
    + getUsername() + +  : string +
    +
    Returns the username.
    + +
    + isActive() + +  : bool +
    +
    Get the activation status of the user.
    + +
    + isNew() + +  : bool +
    +
    Returns true if is a new user.
    + +
    + jsonSerialize() + +  : array<string|int, mixed>|mixed +
    +
    Return a JSON representation of list.
    + +
    + save() + +  : bool +
    +
    Saves (or update) a user on server
    + +
    + setActive() + +  : void +
    +
    Set the activation status of the user.
    + +
    + setExtra() + +  : void +
    +
    Set extra data for user.
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Returns a array representation of user
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $active + + + + +

    + + +

    If user is active or not on database.

    + + + + protected + bool + $active + + + + + + + + + + +
    +
    +

    + $connection + + + + +

    + + +

    Connection object to use.

    + + + + protected + Connection|null + $connection + + + + + + + + + + +
    +
    +

    + $extra + + + + +

    + + +

    Extra data about the user.

    + + + + protected + array<string|int, mixed>|null + $extra + = null + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If user is a new User or an existing one.

    + + + + protected + bool + $isNew + + + + + + + + + + +
    +
    +

    + $password + + + + +

    + + +

    Password of user.

    + + + + protected + string + $password + = '' + +

    Used only of new users that will be created on server.

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

    + $user + + + + +

    + + +

    Name of user on server.

    + + + + protected + string + $user + + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    User constructor.

    + + + public + __construct([array<string|int, mixed> $attributes = [] ][, Connection|null $connection = null ][, bool $isNew = true ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $attributes + : array<string|int, mixed> + = []
    +
    +

    User attributes.

    +
    + +
    +
    + $connection + : Connection|null + = null
    +
    +

    Connection object to use.

    +
    + +
    +
    + $isNew + : bool + = true
    +
    +

    If the user is a new one or representation of an existing user.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException|MissingParameterException + + +
    +
    + + + + +
    +
    +

    + __debugInfo() + + +

    + + +

    Proper debug dump for User objects.

    + + + public + __debugInfo() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + __get() + + +

    + + +

    Get some attribute.

    + + + public + __get(string $name) : mixed|null + +
    +
    + + +
    Parameters
    +
    +
    + $name + : string +
    +
    +

    Attribute name.

    +
    + +
    +
    + + + + + +
    +
    Return values
    + mixed|null + — +

    Attribute value.

    +
    + +
    + +
    +
    +

    + __toString() + + +

    + + +

    String representation of User object.

    + + + public + __toString() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + delete() + + +

    + + +

    Removes an user from server.

    + + + public + delete() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + GuzzleException|UserException + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if user was removed, false otherwise (e.g. user not exists).

    +
    + +
    + +
    +
    +

    + getExtra() + + +

    + + +

    Returns extra data about user.

    + + + public + getExtra() : array<string|int, mixed>|null + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed>|null +
    + +
    +
    +

    + getUsername() + + +

    + + +

    Returns the username.

    + + + public + getUsername() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + isActive() + + +

    + + +

    Get the activation status of the user.

    + + + public + isActive() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isNew() + + +

    + + +

    Returns true if is a new user.

    + + + public + isNew() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + jsonSerialize() + + +

    + + +

    Return a JSON representation of list.

    + + + public + jsonSerialize() : array<string|int, mixed>|mixed + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed>|mixed +
    + +
    +
    +

    + save() + + +

    + + +

    Saves (or update) a user on server

    + + + public + save() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + UserException + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if user was created or updated on server. Throws an exception if user is duplicated.

    +
    + +
    + +
    +
    +

    + setActive() + + +

    + + +

    Set the activation status of the user.

    + + + public + setActive(bool $active) : void + +
    +
    + + +
    Parameters
    +
    +
    + $active + : bool +
    +
    + +
    +
    + + + + + + +
    +
    +

    + setExtra() + + +

    + + +

    Set extra data for user.

    + + + public + setExtra(array<string|int, mixed> $extra) : void + +
    +
    + + +
    Parameters
    +
    +
    + $extra + : array<string|int, mixed> +
    +
    + +
    +
    + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Returns a array representation of user

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -430,10 +1507,42 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Batch-Import.html b/docs/classes/ArangoDB-Batch-Import.html index 3f0f42e..edca4b6 100644 --- a/docs/classes/ArangoDB-Batch-Import.html +++ b/docs/classes/ArangoDB-Batch-Import.html @@ -309,14 +309,236 @@

    +

    + Methods + +

    +
    +
    + importArrayDocuments() + +  : array<string|int, mixed> +
    +
    Import multiple documents from a array document
    + +
    + importJsonDocuments() + +  : array<string|int, mixed> +
    +
    Import multiple documents from a JSON document
    + +
    - + +
    +

    + Methods + + +

    +
    +

    + importArrayDocuments() + + +

    + + +

    Import multiple documents from a array document

    + + + public + static importArrayDocuments(Connection $connection, string $collection, string $arrayDocuments) : array<string|int, mixed> + +
    +
    + + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

    +
    + +
    +
    + $collection + : string +
    +
    +

    Collection to import. Must exist on server.

    +
    + +
    +
    + $arrayDocuments + : string +
    +
    +

    Documents JSON arrays as string representation

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException|InvalidParameterException|MissingParameterException + + +
    +
    + see +
    +
    + https://www.arangodb.com/docs/stable/http/bulk-imports-importing-self-contained.html + + +
    +
    + + + +
    +
    Return values
    + array<string|int, mixed> + — +

    with the results of operation

    +
    + +
    + +
    +
    +

    + importJsonDocuments() + + +

    + + +

    Import multiple documents from a JSON document

    + + + public + static importJsonDocuments(Connection $connection, string $collection, string $jsonDocuments) : array<string|int, mixed> + +
    +
    + + +
    Parameters
    +
    +
    + $connection + : Connection +
    +
    +

    Connection object to use.

    +
    + +
    +
    + $collection + : string +
    +
    +

    Collection to import. Must exist on server.

    +
    + +
    +
    + $jsonDocuments + : string +
    +
    +

    JSON documents as string representation

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + ServerException|GuzzleException|InvalidParameterException|MissingParameterException + + +
    +
    + see +
    +
    + https://www.arangodb.com/docs/stable/http/bulk-imports-importing-self-contained.html + + +
    +
    + + + +
    +
    Return values
    + array<string|int, mixed> + — +

    with the results of operation

    +
    + +
    + +
    +
    +
    @@ -422,10 +644,18 @@

  • Table Of Contents
    • -
    +
  • Methods
  • + +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-Collection.html b/docs/classes/ArangoDB-Collection-Collection.html index 87ace2a..866ca94 100644 --- a/docs/classes/ArangoDB-Collection-Collection.html +++ b/docs/classes/ArangoDB-Collection-Collection.html @@ -254,6 +254,9 @@

    implements JsonSerializable + + uses + IndexableTrait

    @@ -264,9 +267,9 @@

    Represents an ArangoDB collection

    @@ -316,15 +319,2688 @@

    +

    + Properties + +

    +
    +
    + $attributes + +  : array<string|int, mixed> +
    +
    Attributes of collection
    + +
    + $connection + +  : Connection +
    +
    Connection object
    + +
    + $database + +  : Database +
    +
    Database object
    + +
    + $deletedStatus + +  : int +
    +
    Deleted status of collection
    + +
    + $descriptorAttributes + +  : array<string|int, mixed> +
    +
    Fields to be set directly
    + +
    + $isNew + +  : bool +
    +
    If the collection is a new one or a representation of an existing collection on server
    + +
    + $loadedStatus + +  : int +
    +
    Loaded status of collection
    + +
    + $loadingStatus + +  : int +
    +
    Loading status of collection
    + +
    + $statusStrings + +  : array<string|int, mixed> +
    +
    Status descriptions
    + +
    + $typeStrings + +  : array<string|int, mixed> +
    +
    Type descriptions
    + +
    + $unknownStatus + +  : int +
    +
    Unknown status of collection
    + +
    + $unloadedStatus + +  : int +
    +
    Unloaded status of collection
    + +
    + $unloadingStatus + +  : int +
    +
    Unloading status of collection
    + +
    + $defaults + +  : array<string|int, mixed> +
    +
    Default values when creating collections
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    Collection constructor.
    + +
    + __get() + +  : mixed|null +
    +
    Get some attribute
    + +
    + __set() + +  : mixed +
    +
    Set an attribute
    + +
    + __toString() + +  : string +
    +
    Return a string representation of document
    + +
    + addIndex() + +  : bool +
    +
    Create an index for collection
    + +
    + all() + +  : CursorInterface|bool +
    +
    Returns a cursor for access all documents on this Collection
    + +
    + count() + +  : int +
    +
    Return the number of documents in a collection.
    + +
    + drop() + +  : bool +
    +
    Drops the collection on database
    + +
    + dropIndex() + +  : bool +
    +
    Drops an index of collection
    + +
    + findByKey() + +  : Document|false +
    +
    Find a document by its key
    + +
    + getAttributes() + +  : array<string|int, mixed> +
    +
    Return the collection attributes on array
    + +
    + getChecksum() + +  : string +
    +
    Return the checksum of collection metadata
    + +
    + getDatabase() + +  : Database +
    +
    Returns the database where collection belongs
    + +
    + getGloballyUniqueId() + +  : string +
    +
    Return the globally Unique ID of collection
    + +
    + getId() + +  : string|null +
    +
    Return the ID of collection
    + +
    + getIndexes() + +  : ArrayList +
    +
    Return all indexes of collection
    + +
    + getName() + +  : string +
    +
    Return the name of collection
    + +
    + getRevision() + +  : string +
    +
    Return the revision of collection
    + +
    + getStatus() + +  : int +
    +
    Return the status of collection
    + +
    + getStatusDescription() + +  : string +
    +
    Return a string description of status
    + +
    + getType() + +  : string +
    +
    Return the collection type
    + +
    + isGraph() + +  : bool +
    +
    Return if the collection is a graph collection
    + +
    + isNew() + +  : bool +
    +
    Returns true if is a new object
    + +
    + isSystem() + +  : bool +
    +
    Checks if the collection is a system collection
    + +
    + jsonSerialize() + +  : mixed +
    + +
    + recalculateCount() + +  : bool +
    +
    Recalculates the document count of a collection, if it ever becomes inconsistent.
    + +
    + rename() + +  : bool +
    +
    Renames the collection
    + +
    + save() + +  : bool +
    +
    Saves or update the collection.
    + +
    + setAttributes() + +  : void +
    +
    Set collection attributes
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Return an array representation of collection
    + +
    + truncate() + +  : bool +
    +
    Truncate the collection
    + +
    + getCreateParameters() + +  : array<string|int, mixed> +
    +
    Return only fields to be sent on a POST request
    + +
    + getUpdateParameters() + +  : array<string|int, mixed> +
    +
    Return only fields to update this collection.
    + +
    + update() + +  : bool +
    +
    Update collection.
    + +
    + + + + + + +
    +

    + Properties + + +

    +
    +

    + $attributes + + + + +

    + + +

    Attributes of collection

    + + + + protected + array<string|int, mixed> + $attributes + + + + + + + + + + +
    +
    +

    + $connection + + + + +

    + + +

    Connection object

    + + + + protected + Connection + $connection + + + + + + + + + + +
    +
    +

    + $database + + + + +

    + + +

    Database object

    + + + + protected + Database + $database + + + + + + + + + + +
    +
    +

    + $deletedStatus + + + + +

    + + +

    Deleted status of collection

    + + + + protected + static int + $deletedStatus + = 5 + + + + + + + + + +
    +
    +

    + $descriptorAttributes + + + + +

    + + +

    Fields to be set directly

    + + + + protected + array<string|int, mixed> + $descriptorAttributes + = ['id' => null, 'objectId' => null, 'name' => '', 'type' => 2, 'status' => 0, 'cacheEnabled' => false, 'isSystem' => false, 'globallyUniqueId' => '', 'revision' => 0, 'count' => 0, 'checksum' => ''] + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If the collection is a new one or a representation of an existing collection on server

    + + + + protected + bool + $isNew + + + + + + + + + + +
    +
    +

    + $loadedStatus + + + + +

    + + +

    Loaded status of collection

    + + + + protected + static int + $loadedStatus + = 3 + + + + + + + + + +
    +
    +

    + $loadingStatus + + + + +

    + + +

    Loading status of collection

    + + + + protected + static int + $loadingStatus + = 6 + + + + + + + + + +
    +
    +

    + $statusStrings + + + + +

    + + +

    Status descriptions

    + + + + protected + array<string|int, mixed> + $statusStrings + = [0 => 'unknown', 1 => 'unknown', 2 => 'unloaded', 3 => 'loaded', 4 => 'unloading', 5 => 'deleted', 6 => 'loading'] + + + + + + + + + +
    +
    +

    + $typeStrings + + + + +

    + + +

    Type descriptions

    + + + + protected + array<string|int, mixed> + $typeStrings + = [2 => 'document', 3 => 'graph'] + + + + + + + + + +
    +
    +

    + $unknownStatus + + + + +

    + + +

    Unknown status of collection

    + + + + protected + static int + $unknownStatus + = 1 + + + + + + + + + +
    +
    +

    + $unloadedStatus + + + + +

    + + +

    Unloaded status of collection

    + + + + protected + static int + $unloadedStatus + = 2 + + + + + + + + + +
    +
    +

    + $unloadingStatus + + + + +

    + + +

    Unloading status of collection

    + + + + protected + static int + $unloadingStatus + = 4 + + + + + + + + + +
    +
    +

    + $defaults + + + + +

    + + +

    Default values when creating collections

    + + + + private + array<string|int, mixed> + $defaults + = ['replicationFactor' => 1, 'waitForSync' => false, 'shardingStrategy' => 'community-compat', 'shardKeys' => ["_key"], 'numberOfShards' => 1, 'isSystem' => false, 'type' => 2, 'keyOptions' => ['allowUserKeys' => true, 'type' => \ArangoDB\Collection\KeyType::TRADITIONAL]] + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    Collection constructor.

    + + + public + __construct(string $name, Database $database[, array<string|int, mixed> $attributes = [] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $name + : string +
    +
    + +
    +
    + $database + : Database +
    +
    + +
    +
    + $attributes + : array<string|int, mixed> + = []
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException|MissingParameterException|InvalidParameterException + + +
    +
    + + + + +
    +
    +

    + __get() + + +

    + + +

    Get some attribute

    + + + public + __get(string $name) : mixed|null + +
    +
    + + +
    Parameters
    +
    +
    + $name + : string +
    +
    + +
    +
    + + + + + +
    +
    Return values
    + mixed|null +
    + +
    +
    +

    + __set() + + +

    + + +

    Set an attribute

    + + + public + __set(string $name, mixed $value) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $name + : string +
    +
    + +
    +
    + $value + : mixed +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + Exception + + +
    +
    + + + + +
    +
    +

    + __toString() + + +

    + + +

    Return a string representation of document

    + + + public + __toString() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + addIndex() + + +

    + + +

    Create an index for collection

    + + + public + addIndex(IndexInterface $index) : bool + +
    +
    + + +
    Parameters
    +
    +
    + $index + : IndexInterface +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool +
    + +
    + +
    +

    + count() + + +

    + + +

    Return the number of documents in a collection.

    + + + public + count() : int + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + int + — +

    Total count of documents on collection.

    +
    + +
    + +
    +
    +

    + drop() + + +

    + + +

    Drops the collection on database

    + + + public + drop() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + dropIndex() + + +

    + + +

    Drops an index of collection

    + + + public + dropIndex(IndexInterface $index) : bool + +
    +
    + + +
    Parameters
    +
    +
    + $index + : IndexInterface +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + findByKey() + + +

    + + +

    Find a document by its key

    + + + public + findByKey(string $key[, bool $isVertex = false ]) : Document|false + +
    +
    + + +
    Parameters
    +
    +
    + $key + : string +
    +
    +

    Document key

    +
    + +
    +
    + $isVertex + : bool + = false
    +
    +

    If the collection is a vertex in a graph, passing true will return document as Vertex object.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException|InvalidParameterException|MissingParameterException + + +
    +
    + + + +
    +
    Return values
    + Document|false +
    + +
    +
    +

    + getAttributes() + + +

    + + +

    Return the collection attributes on array

    + + + public + getAttributes() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getChecksum() + + +

    + + +

    Return the checksum of collection metadata

    + + + public + getChecksum() : string + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getDatabase() + + +

    + + +

    Returns the database where collection belongs

    + + + public + getDatabase() : Database + +
    +
    + + + + + + + +
    +
    Return values
    + Database +
    + +
    +
    +

    + getGloballyUniqueId() + + +

    + + +

    Return the globally Unique ID of collection

    + + + public + getGloballyUniqueId() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getId() + + +

    + + +

    Return the ID of collection

    + + + public + getId() : string|null + +
    +
    + + + + + + + +
    +
    Return values
    + string|null + — +

    String if collection exists on database. Null if not.

    +
    + +
    + +
    + +
    +

    + getName() + + +

    + + +

    Return the name of collection

    + + + public + getName() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getRevision() + + +

    + + +

    Return the revision of collection

    + + + public + getRevision() : string + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getStatus() + + +

    + + +

    Return the status of collection

    + + + public + getStatus() : int + +
    +
    + + + + + + + +
    +
    Return values
    + int + — +

    An integer between 0 and 6

    +
    + +
    + +
    +
    +

    + getStatusDescription() + + +

    + + +

    Return a string description of status

    + + + public + getStatusDescription() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getType() + + +

    + + +

    Return the collection type

    + + + public + getType() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + isGraph() + + +

    + + +

    Return if the collection is a graph collection

    + + + public + isGraph() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isNew() + + +

    + + +

    Returns true if is a new object

    + + + public + isNew() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isSystem() + + +

    + + +

    Checks if the collection is a system collection

    + + + public + isSystem() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool + — +

    True if is a system collection. False otherwise.

    +
    + +
    + +
    +
    +

    + jsonSerialize() + +

    + - + + + public + jsonSerialize() : mixed - +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + JsonSerializable::jsonSerialize + + +
    +
    + + + + +
    +
    +

    + recalculateCount() + + +

    + + +

    Recalculates the document count of a collection, if it ever becomes inconsistent.

    + + + public + recalculateCount() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + rename() + + +

    + + +

    Renames the collection

    + + + public + rename(string $newName) : bool + +
    +
    + + +
    Parameters
    +
    +
    + $newName + : string +
    +
    +

    The new name of collection.

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + save() + + +

    + + +

    Saves or update the collection.

    + + + public + save() : bool + +
    +
    + +

    Except for 'waitForSync' and 'name', a collection can not be modified after creation. +For change 'name', the method 'rename' must be used.

    +
    + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + setAttributes() + + +

    + + +

    Set collection attributes

    + + + public + setAttributes(array<string|int, mixed> $data) : void + +
    +
    + + +
    Parameters
    +
    +
    + $data + : array<string|int, mixed> +
    +
    + +
    +
    + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Return an array representation of collection

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + truncate() + + +

    + + +

    Truncate the collection

    + + + public + truncate() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + getCreateParameters() + + +

    + + +

    Return only fields to be sent on a POST request

    + + + protected + getCreateParameters() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getUpdateParameters() + + +

    + + +

    Return only fields to update this collection.

    + + + protected + getUpdateParameters() : array<string|int, mixed> + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + Collection::rename() + + +
    +
    + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + update() + + +

    + + +

    Update collection.

    + + + private + update() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool +
    + +
    +
    -
    @@ -430,10 +3106,70 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-Contracts-IndexInterface.html b/docs/classes/ArangoDB-Collection-Contracts-IndexInterface.html index 52991c4..cc4fb85 100644 --- a/docs/classes/ArangoDB-Collection-Contracts-IndexInterface.html +++ b/docs/classes/ArangoDB-Collection-Contracts-IndexInterface.html @@ -303,13 +303,411 @@

    +

    + Methods + +

    +
    +
    + getCollection() + +  : Collection|null +
    +
    Returns the collection where the index belongs to
    + +
    + getCreateData() + +  : array<string|int, mixed> +
    +
    Return data for create index on server
    + +
    + getId() + +  : string +
    +
    Returns the index id
    + +
    + getName() + +  : string +
    +
    Returns the index name
    + +
    + getType() + +  : string +
    +
    Returns the index type
    + +
    + isNew() + +  : bool +
    +
    If the index is a new one
    + +
    + isSparse() + +  : bool +
    +
    If index is sparse
    + +
    + isUnique() + +  : bool +
    +
    If index was set to use 'unique' constraint
    + +
    - + +
    +

    + Methods + + +

    +
    +

    + getCollection() + + +

    + + +

    Returns the collection where the index belongs to

    + + + public + getCollection() : Collection|null + +
    +
    + + + + + + + +
    +
    Return values
    + Collection|null + — +

    A collection object or null if the index was not set to an collection yet

    +
    + +
    + +
    +
    +

    + getCreateData() + + +

    + + +

    Return data for create index on server

    + + + public + getCreateData() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getId() + + +

    + + +

    Returns the index id

    + + + public + getId() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getName() + + +

    + + +

    Returns the index name

    + + + public + getName() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getType() + + +

    + + +

    Returns the index type

    + + + public + getType() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + isNew() + + +

    + + +

    If the index is a new one

    + + + public + isNew() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool + — +

    True for new one index. False for a existing index.

    +
    + +
    + +
    +
    +

    + isSparse() + + +

    + + +

    If index is sparse

    + + + public + isSparse() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isUnique() + + +

    + + +

    If index was set to use 'unique' constraint

    + + + public + isUnique() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +
    @@ -419,6 +817,19 @@

  • Methods
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-Index-EdgeIndex.html b/docs/classes/ArangoDB-Collection-Index-EdgeIndex.html index b4db7cf..a6a4550 100644 --- a/docs/classes/ArangoDB-Collection-Index-EdgeIndex.html +++ b/docs/classes/ArangoDB-Collection-Index-EdgeIndex.html @@ -313,15 +313,1205 @@

    +

    + Properties + +

    +
    +
    + $collection + +  : Collection +
    +
    Collection where the index belongs to
    +
    + $fields + +  : array<string|int, mixed> +
    +
    Fields of index
    + +
    + $id + +  : string +
    +
    Index Id.
    + +
    + $indexTypes + +  : array<string|int, mixed> +
    +
    Valid indexes types
    + +
    + $isNew + +  : bool +
    +
    If the index is a new one or +a representation of an existing index
    + +
    + $name + +  : string +
    +
    Index name.
    + +
    + $sparse + +  : bool +
    +
    Sparse
    + +
    + $type + +  : string +
    +
    Index type
    + +
    + $unique + +  : bool +
    +
    Unique constraint
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    EdgeIndex constructor.
    + +
    + __toString() + +  : mixed +
    +
    String representation of index
    + +
    + getCollection() + +  : Collection|null +
    +
    Returns the collection where index belong to
    + +
    + getCreateData() + +  : array<string|int, mixed> +
    +
    This type of Index cannot be create/deleted explicitly by user.
    + +
    + getFields() + +  : array<string|int, mixed> +
    +
    Returns index fields
    + +
    + getId() + +  : string +
    +
    Index Id
    + +
    + getName() + +  : string +
    +
    Returns index name
    + +
    + getType() + +  : string +
    +
    Returns index type
    + +
    + isNew() + +  : bool +
    +
    If the index is a new one
    + +
    + isSparse() + +  : bool +
    +
    If the index is sparse
    + +
    + isUnique() + +  : bool +
    +
    If index has 'unique' constraint
    + +
    + jsonSerialize() + +  : mixed +
    + +
    + setCollection() + +  : void +
    +
    Set the collection where the index belongs to
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Returns a array representation of entity
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $collection + + + + +

    + + +

    Collection where the index belongs to

    + + + + protected + Collection + $collection + + + + + + + + + + +
    +
    +

    + $fields + + + + +

    + + +

    Fields of index

    + + + + protected + array<string|int, mixed> + $fields + + + + + + + + + + +
    +
    +

    + $id + + + + +

    + + +

    Index Id.

    + + + + protected + string + $id + + + + + + + + + + +
    +
    +

    + $indexTypes + + + + +

    + + +

    Valid indexes types

    + + + + protected + static array<string|int, mixed> + $indexTypes + = ['fulltext', 'general', 'geo', 'hash', 'persistent', 'skiplist', 'ttl', 'primary', 'edge', 'inverted'] + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If the index is a new one or +a representation of an existing index

    + + + + protected + bool + $isNew + + + + + + + + + + +
    +
    +

    + $name + + + + +

    + + +

    Index name.

    + + + + protected + string + $name + + + + + + + + + + +
    +
    +

    + $sparse + + + + +

    + + +

    Sparse

    + + + + protected + bool + $sparse + + + + + + + + + + +
    +
    +

    + $type + + + + +

    + + +

    Index type

    + + + + protected + string + $type + + + + + + + + + + +
    +
    +

    + $unique + + + + +

    + + +

    Unique constraint

    + + + + protected + bool + $unique + + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    EdgeIndex constructor.

    + + + public + __construct(array<string|int, mixed> $fields[, array<string|int, mixed> $attributes = [] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $fields + : array<string|int, mixed> +
    +
    + +
    +
    + $attributes + : array<string|int, mixed> + = []
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException + + +
    +
    + + + + +
    +
    +

    + __toString() + + +

    + + +

    String representation of index

    + + + public + __toString() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + getCollection() + + +

    + + +

    Returns the collection where index belong to

    + + + public + getCollection() : Collection|null + +
    +
    + + + + + + + +
    +
    Return values
    + Collection|null + — +

    A collection object or null if the index was not set to an collection yet

    +
    + +
    + +
    +
    +

    + getCreateData() + + +

    + + +

    This type of Index cannot be create/deleted explicitly by user.

    + + + public + getCreateData() : array<string|int, mixed> + +
    +
    + +

    Throws an exception if an attempt of create one is made

    +
    + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + IndexException + + +
    +
    + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getFields() + + +

    + + +

    Returns index fields

    + + + public + getFields() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getId() + + +

    + + +

    Index Id

    + + + public + getId() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getName() + + +

    + + +

    Returns index name

    + + + public + getName() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getType() + + +

    + + +

    Returns index type

    + + + public + getType() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + isNew() + + +

    + + +

    If the index is a new one

    + + + public + isNew() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + EntityInterface::isNew() + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if is a new object. False otherwise.

    +
    + +
    + +
    +
    +

    + isSparse() + + +

    + + +

    If the index is sparse

    + + + public + isSparse() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isUnique() + + +

    + + +

    If index has 'unique' constraint

    + + + public + isUnique() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + jsonSerialize() + + +

    + + + + + public + jsonSerialize() : mixed + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + JsonSerializable::jsonSerialize() + + +
    +
    + + + + +
    +
    +

    + setCollection() + + +

    + + +

    Set the collection where the index belongs to

    + + + public + setCollection(Collection $collection) : void + +
    +
    + + +
    Parameters
    +
    +
    + $collection + : Collection +
    +
    + +
    +
    + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Returns a array representation of entity

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -427,10 +1617,45 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-Index-Factory.html b/docs/classes/ArangoDB-Collection-Index-Factory.html index 6204371..27d7183 100644 --- a/docs/classes/ArangoDB-Collection-Index-Factory.html +++ b/docs/classes/ArangoDB-Collection-Index-Factory.html @@ -311,14 +311,98 @@

    +

    + Methods + +

    +
    +
    + factory() + +  : IndexInterface +
    + +
    - + +
    +

    + Methods + + +

    + +
    +
    @@ -424,10 +508,17 @@

  • Table Of Contents
    • -
    +
  • Methods
  • + +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-Index-FullTextIndex.html b/docs/classes/ArangoDB-Collection-Index-FullTextIndex.html index 644eae1..f3fc536 100644 --- a/docs/classes/ArangoDB-Collection-Index-FullTextIndex.html +++ b/docs/classes/ArangoDB-Collection-Index-FullTextIndex.html @@ -313,15 +313,1293 @@

    +

    + Properties + +

    +
    +
    + $collection + +  : Collection +
    +
    Collection where the index belongs to
    +
    + $fields + +  : array<string|int, mixed> +
    +
    Fields of index
    + +
    + $id + +  : string +
    +
    Index Id.
    + +
    + $indexTypes + +  : array<string|int, mixed> +
    +
    Valid indexes types
    + +
    + $isNew + +  : bool +
    +
    If the index is a new one or +a representation of an existing index
    + +
    + $minLength + +  : int +
    +
    Minimum length of index
    + +
    + $name + +  : string +
    +
    Index name.
    + +
    + $sparse + +  : bool +
    +
    Sparse
    + +
    + $type + +  : string +
    +
    Index type
    + +
    + $unique + +  : bool +
    +
    Unique constraint
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    FullTextIndex constructor.
    + +
    + __toString() + +  : mixed +
    +
    String representation of index
    + +
    + getCollection() + +  : Collection|null +
    +
    Returns the collection where index belong to
    + +
    + getCreateData() + +  : array<string|int, mixed> +
    +
    Return data for create index on server
    + +
    + getFields() + +  : array<string|int, mixed> +
    +
    Returns index fields
    + +
    + getId() + +  : string +
    +
    Index Id
    + +
    + getMinLength() + +  : int +
    +
    Return index minimum length
    + +
    + getName() + +  : string +
    +
    Returns index name
    + +
    + getType() + +  : string +
    +
    Returns index type
    + +
    + isNew() + +  : bool +
    +
    If the index is a new one
    + +
    + isSparse() + +  : bool +
    +
    If the index is sparse
    + +
    + isUnique() + +  : bool +
    +
    If index has 'unique' constraint
    + +
    + jsonSerialize() + +  : mixed +
    + +
    + setCollection() + +  : void +
    +
    Set the collection where the index belongs to
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Returns a array representation of index
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $collection + + + + +

    + + +

    Collection where the index belongs to

    + + + + protected + Collection + $collection + + + + + + + + + + +
    +
    +

    + $fields + + + + +

    + + +

    Fields of index

    + + + + protected + array<string|int, mixed> + $fields + + + + + + + + + + +
    +
    +

    + $id + + + + +

    + + +

    Index Id.

    + + + + protected + string + $id + + + + + + + + + + +
    +
    +

    + $indexTypes + + + + +

    + + +

    Valid indexes types

    + + + + protected + static array<string|int, mixed> + $indexTypes + = ['fulltext', 'general', 'geo', 'hash', 'persistent', 'skiplist', 'ttl', 'primary', 'edge', 'inverted'] + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If the index is a new one or +a representation of an existing index

    + + + + protected + bool + $isNew + + + + + + + + + + +
    +
    +

    + $minLength + + + + +

    + + +

    Minimum length of index

    + + + + protected + int + $minLength + + + + + + + + + + +
    +
    +

    + $name + + + + +

    + + +

    Index name.

    + + + + protected + string + $name + + + + + + + + + + +
    +
    +

    + $sparse + + + + +

    + + +

    Sparse

    + + + + protected + bool + $sparse + + + + + + + + + + +
    +
    +

    + $type + + + + +

    + + +

    Index type

    + + + + protected + string + $type + + + + + + + + + + +
    +
    +

    + $unique + + + + +

    + + +

    Unique constraint

    + + + + protected + bool + $unique + + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    FullTextIndex constructor.

    + + + public + __construct(array<string|int, mixed> $fields[, int $minLength = 0 ][, array<string|int, mixed> $attributes = [] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $fields + : array<string|int, mixed> +
    +
    +

    An array of attribute names. Normally with just one attribute.

    +
    + +
    +
    + $minLength + : int + = 0
    +
    +

    Minimum character length to index. Will default to a server-defined value if 0 is set.

    +
    + +
    +
    + $attributes + : array<string|int, mixed> + = []
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException + + +
    +
    + + + + +
    +
    +

    + __toString() + + +

    + + +

    String representation of index

    + + + public + __toString() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + getCollection() + + +

    + + +

    Returns the collection where index belong to

    + + + public + getCollection() : Collection|null + +
    +
    + + + + + + + +
    +
    Return values
    + Collection|null + — +

    A collection object or null if the index was not set to an collection yet

    +
    + +
    + +
    +
    +

    + getCreateData() + + +

    + + +

    Return data for create index on server

    + + + public + getCreateData() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getFields() + + +

    + + +

    Returns index fields

    + + + public + getFields() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getId() + + +

    + + +

    Index Id

    + + + public + getId() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getMinLength() + + +

    + + +

    Return index minimum length

    + + + public + getMinLength() : int + +
    +
    + + + + + + + +
    +
    Return values
    + int +
    + +
    +
    +

    + getName() + + +

    + + +

    Returns index name

    + + + public + getName() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getType() + + +

    + + +

    Returns index type

    + + + public + getType() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + isNew() + + +

    + + +

    If the index is a new one

    + + + public + isNew() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + EntityInterface::isNew() + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if is a new object. False otherwise.

    +
    + +
    + +
    +
    +

    + isSparse() + + +

    + + +

    If the index is sparse

    + + + public + isSparse() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isUnique() + + +

    + + +

    If index has 'unique' constraint

    + + + public + isUnique() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + jsonSerialize() + + +

    + + + + + public + jsonSerialize() : mixed + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + JsonSerializable::jsonSerialize() + + +
    +
    + + + + +
    +
    +

    + setCollection() + + +

    + + +

    Set the collection where the index belongs to

    + + + public + setCollection(Collection $collection) : void + +
    +
    + + +
    Parameters
    +
    +
    + $collection + : Collection +
    +
    + +
    +
    + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Returns a array representation of index

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -427,10 +1705,47 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-Index-GeoSpatialIndex.html b/docs/classes/ArangoDB-Collection-Index-GeoSpatialIndex.html index 61e2b63..cd2ab87 100644 --- a/docs/classes/ArangoDB-Collection-Index-GeoSpatialIndex.html +++ b/docs/classes/ArangoDB-Collection-Index-GeoSpatialIndex.html @@ -313,15 +313,1309 @@

    +

    + Properties + +

    +
    +
    + $collection + +  : Collection +
    +
    Collection where the index belongs to
    +
    + $fields + +  : array<string|int, mixed> +
    +
    Fields of index
    + +
    + $geoJson + +  : bool +
    +
    If a geo-spatial index on a location is constructed +and geoJson is true, then the order within the array is longitude +followed by latitude.
    + +
    + $id + +  : string +
    +
    Index Id.
    + +
    + $indexTypes + +  : array<string|int, mixed> +
    +
    Valid indexes types
    + +
    + $isNew + +  : bool +
    +
    If the index is a new one or +a representation of an existing index
    + +
    + $name + +  : string +
    +
    Index name.
    + +
    + $sparse + +  : bool +
    +
    Sparse
    + +
    + $type + +  : string +
    +
    Index type
    + +
    + $unique + +  : bool +
    +
    Unique constraint
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    GeoSpatialIndex constructor.
    + +
    + __toString() + +  : mixed +
    +
    String representation of index
    + +
    + getCollection() + +  : Collection|null +
    +
    Returns the collection where index belong to
    + +
    + getCreateData() + +  : array<string|int, mixed> +
    +
    Return data for create index on server
    + +
    + getFields() + +  : array<string|int, mixed> +
    +
    Returns index fields
    + +
    + getId() + +  : string +
    +
    Index Id
    + +
    + getName() + +  : string +
    +
    Returns index name
    + +
    + getType() + +  : string +
    +
    Returns index type
    + +
    + isGeoJson() + +  : bool +
    +
    If the index is a GeoJson.
    + +
    + isNew() + +  : bool +
    +
    If the index is a new one
    + +
    + isSparse() + +  : bool +
    +
    If the index is sparse
    + +
    + isUnique() + +  : bool +
    +
    If index has 'unique' constraint
    + +
    + jsonSerialize() + +  : mixed +
    + +
    + setCollection() + +  : void +
    +
    Set the collection where the index belongs to
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Returns a array representation of index
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $collection + + + + +

    + + +

    Collection where the index belongs to

    + + + + protected + Collection + $collection + + + + + + + + + + +
    +
    +

    + $fields + + + + +

    + + +

    Fields of index

    + + + + protected + array<string|int, mixed> + $fields + + + + + + + + + + +
    +
    +

    + $geoJson + + + + +

    + + +

    If a geo-spatial index on a location is constructed +and geoJson is true, then the order within the array is longitude +followed by latitude.

    + + + + protected + bool + $geoJson + + + + + +
    + Tags + + +
    +
    +
    + link +
    +
    + https://geojson.org/geojson-spec.html#positions + +
    +
    + + + + + +
    +
    +

    + $id + + + + +

    + + +

    Index Id.

    + + + + protected + string + $id + + + + + + + + + + +
    +
    +

    + $indexTypes + + + + +

    + + +

    Valid indexes types

    + + + + protected + static array<string|int, mixed> + $indexTypes + = ['fulltext', 'general', 'geo', 'hash', 'persistent', 'skiplist', 'ttl', 'primary', 'edge', 'inverted'] + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If the index is a new one or +a representation of an existing index

    + + + + protected + bool + $isNew + + + + + + + + + + +
    +
    +

    + $name + + + + +

    + + +

    Index name.

    + + + + protected + string + $name + + + + + + + + + + +
    +
    +

    + $sparse + + + + +

    + + +

    Sparse

    + + + + protected + bool + $sparse + + + + + + + + + + +
    +
    +

    + $type + + + + +

    + + +

    Index type

    + + + + protected + string + $type + + + + + + + + + + +
    +
    +

    + $unique + + + + +

    + + +

    Unique constraint

    + + + + protected + bool + $unique + + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    GeoSpatialIndex constructor.

    + + + public + __construct(array<string|int, mixed> $fields[, bool $geoJson = true ][, array<string|int, mixed> $attributes = [] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $fields + : array<string|int, mixed> +
    +
    +

    An array of attribute names.

    +
    + +
    +
    + $geoJson + : bool + = true
    +
    + +
    +
    + $attributes + : array<string|int, mixed> + = []
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException + + +
    +
    + + + + +
    +
    +

    + __toString() + + +

    + + +

    String representation of index

    + + + public + __toString() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + getCollection() + + +

    + + +

    Returns the collection where index belong to

    + + + public + getCollection() : Collection|null + +
    +
    + + + + + + + +
    +
    Return values
    + Collection|null + — +

    A collection object or null if the index was not set to an collection yet

    +
    + +
    + +
    +
    +

    + getCreateData() + + +

    + + +

    Return data for create index on server

    + + + public + getCreateData() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getFields() + + +

    + + +

    Returns index fields

    + + + public + getFields() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getId() + + +

    + + +

    Index Id

    + + + public + getId() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getName() + + +

    + + +

    Returns index name

    + + + public + getName() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getType() + + +

    + + +

    Returns index type

    + + + public + getType() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + isGeoJson() + + +

    + + +

    If the index is a GeoJson.

    + + + public + isGeoJson() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isNew() + + +

    + + +

    If the index is a new one

    + + + public + isNew() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + EntityInterface::isNew() + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if is a new object. False otherwise.

    +
    + +
    + +
    +
    +

    + isSparse() + + +

    + + +

    If the index is sparse

    + + + public + isSparse() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isUnique() + + +

    + + +

    If index has 'unique' constraint

    + + + public + isUnique() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + jsonSerialize() + + +

    + + + + + public + jsonSerialize() : mixed + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + JsonSerializable::jsonSerialize() + + +
    +
    + + + + +
    +
    +

    + setCollection() + + +

    + + +

    Set the collection where the index belongs to

    + + + public + setCollection(Collection $collection) : void + +
    +
    + + +
    Parameters
    +
    +
    + $collection + : Collection +
    +
    + +
    +
    + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Returns a array representation of index

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -427,10 +1721,47 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-Index-HashIndex.html b/docs/classes/ArangoDB-Collection-Index-HashIndex.html index 7a1efd9..fe7c171 100644 --- a/docs/classes/ArangoDB-Collection-Index-HashIndex.html +++ b/docs/classes/ArangoDB-Collection-Index-HashIndex.html @@ -317,15 +317,1331 @@

    +

    + Properties + +

    +
    +
    + $collection + +  : Collection +
    +
    Collection where the index belongs to
    +
    + $deduplicate + +  : bool +
    +
    If set to false, the deduplication of array values is turned off
    + +
    + $defaultsOptions + +  : array<string|int, mixed> +
    +
    Default options for hash index
    + +
    + $fields + +  : array<string|int, mixed> +
    +
    Fields of index
    + +
    + $id + +  : string +
    +
    Index Id.
    + +
    + $indexTypes + +  : array<string|int, mixed> +
    +
    Valid indexes types
    + +
    + $isNew + +  : bool +
    +
    If the index is a new one or +a representation of an existing index
    + +
    + $name + +  : string +
    +
    Index name.
    + +
    + $sparse + +  : bool +
    +
    Sparse
    + +
    + $type + +  : string +
    +
    Index type
    + +
    + $unique + +  : bool +
    +
    Unique constraint
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    HashIndex constructor.
    + +
    + __toString() + +  : mixed +
    +
    String representation of index
    + +
    + getCollection() + +  : Collection|null +
    +
    Returns the collection where index belong to
    + +
    + getCreateData() + +  : array<string|int, mixed> +
    +
    Return data for create index on server
    + +
    + getFields() + +  : array<string|int, mixed> +
    +
    Returns index fields
    + +
    + getId() + +  : string +
    +
    Index Id
    + +
    + getName() + +  : string +
    +
    Returns index name
    + +
    + getType() + +  : string +
    +
    Returns index type
    + +
    + isDeduplicate() + +  : bool +
    +
    Return the deduplicate parameter
    + +
    + isNew() + +  : bool +
    +
    If the index is a new one
    + +
    + isSparse() + +  : bool +
    +
    If the index is sparse
    + +
    + isUnique() + +  : bool +
    +
    If index has 'unique' constraint
    + +
    + jsonSerialize() + +  : mixed +
    + +
    + setCollection() + +  : void +
    +
    Set the collection where the index belongs to
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Returns a array representation of index
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $collection + + + + +

    + + +

    Collection where the index belongs to

    + + + + protected + Collection + $collection + + + + + + + + + + +
    +
    +

    + $deduplicate + + + + +

    + + +

    If set to false, the deduplication of array values is turned off

    + + + + protected + bool + $deduplicate + + + + + + + + + + +
    +
    +

    + $defaultsOptions + + + + +

    + + +

    Default options for hash index

    + + + + protected + array<string|int, mixed> + $defaultsOptions + = ['unique' => true, 'sparse' => true, 'deduplicate' => true] + + + + + + + + + +
    +
    +

    + $fields + + + + +

    + + +

    Fields of index

    + + + + protected + array<string|int, mixed> + $fields + + + + + + + + + + +
    +
    +

    + $id + + + + +

    + + +

    Index Id.

    + + + + protected + string + $id + + + + + + + + + + +
    +
    +

    + $indexTypes + + + + +

    + + +

    Valid indexes types

    + + + + protected + static array<string|int, mixed> + $indexTypes + = ['fulltext', 'general', 'geo', 'hash', 'persistent', 'skiplist', 'ttl', 'primary', 'edge', 'inverted'] + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If the index is a new one or +a representation of an existing index

    + + + + protected + bool + $isNew + + + + + + + + + + +
    +
    +

    + $name + + + + +

    + + +

    Index name.

    + + + + protected + string + $name + + + + + + + + + + +
    +
    +

    + $sparse + + + + +

    + + +

    Sparse

    + + + + protected + bool + $sparse + + + + + + + + + + +
    +
    +

    + $type + + + + +

    + + +

    Index type

    + + + + protected + string + $type + + + + + + + + + + +
    +
    +

    + $unique + + + + +

    + + +

    Unique constraint

    + + + + protected + bool + $unique + + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    HashIndex constructor.

    + + + public + __construct(array<string|int, mixed> $fields[, array<string|int, mixed> $attributes = [] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $fields + : array<string|int, mixed> +
    +
    +

    An array of attribute names.

    +
    + +
    +
    + $attributes + : array<string|int, mixed> + = []
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException + + +
    +
    + + + + +
    +
    +

    + __toString() + + +

    + + +

    String representation of index

    + + + public + __toString() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + getCollection() + + +

    + + +

    Returns the collection where index belong to

    + + + public + getCollection() : Collection|null + +
    +
    + + + + + + + +
    +
    Return values
    + Collection|null + — +

    A collection object or null if the index was not set to an collection yet

    +
    + +
    + +
    +
    +

    + getCreateData() + + +

    + + +

    Return data for create index on server

    + + + public + getCreateData() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getFields() + + +

    + + +

    Returns index fields

    + + + public + getFields() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getId() + + +

    + + +

    Index Id

    + + + public + getId() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getName() + + +

    + + +

    Returns index name

    + + + public + getName() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getType() + + +

    + + +

    Returns index type

    + + + public + getType() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + isDeduplicate() + + +

    + + +

    Return the deduplicate parameter

    + + + public + isDeduplicate() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isNew() + + +

    + + +

    If the index is a new one

    + + + public + isNew() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + EntityInterface::isNew() + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if is a new object. False otherwise.

    +
    + +
    + +
    +
    +

    + isSparse() + + +

    + + +

    If the index is sparse

    + + + public + isSparse() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isUnique() + + +

    + + +

    If index has 'unique' constraint

    + + + public + isUnique() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + jsonSerialize() + + +

    + + + + + public + jsonSerialize() : mixed + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + JsonSerializable::jsonSerialize() + + +
    +
    + + + + +
    +
    +

    + setCollection() + + +

    + + +

    Set the collection where the index belongs to

    + + + public + setCollection(Collection $collection) : void + +
    +
    + + +
    Parameters
    +
    +
    + $collection + : Collection +
    +
    + +
    +
    + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Returns a array representation of index

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -431,10 +1747,48 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-Index-Index.html b/docs/classes/ArangoDB-Collection-Index-Index.html index beb25c6..98925a6 100644 --- a/docs/classes/ArangoDB-Collection-Index-Index.html +++ b/docs/classes/ArangoDB-Collection-Index-Index.html @@ -317,15 +317,1199 @@

    +

    + Properties + +

    +
    +
    + $collection + +  : Collection +
    +
    Collection where the index belongs to
    +
    + $fields + +  : array<string|int, mixed> +
    +
    Fields of index
    + +
    + $id + +  : string +
    +
    Index Id.
    + +
    + $indexTypes + +  : array<string|int, mixed> +
    +
    Valid indexes types
    + +
    + $isNew + +  : bool +
    +
    If the index is a new one or +a representation of an existing index
    + +
    + $name + +  : string +
    +
    Index name.
    + +
    + $sparse + +  : bool +
    +
    Sparse
    + +
    + $type + +  : string +
    +
    Index type
    + +
    + $unique + +  : bool +
    +
    Unique constraint
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    Index constructor.
    + +
    + __toString() + +  : mixed +
    +
    String representation of index
    + +
    + getCollection() + +  : Collection|null +
    +
    Returns the collection where index belong to
    + +
    + getCreateData() + +  : array<string|int, mixed> +
    +
    Return data for create index on server
    + +
    + getFields() + +  : array<string|int, mixed> +
    +
    Returns index fields
    + +
    + getId() + +  : string +
    +
    Index Id
    + +
    + getName() + +  : string +
    +
    Returns index name
    + +
    + getType() + +  : string +
    +
    Returns index type
    + +
    + isNew() + +  : bool +
    +
    If the index is a new one
    + +
    + isSparse() + +  : bool +
    +
    If the index is sparse
    + +
    + isUnique() + +  : bool +
    +
    If index has 'unique' constraint
    + +
    + jsonSerialize() + +  : mixed +
    + +
    + setCollection() + +  : void +
    +
    Set the collection where the index belongs to
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Returns a array representation of entity
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $collection + + + + +

    + + +

    Collection where the index belongs to

    + + + + protected + Collection + $collection + + + + + + + + + + +
    +
    +

    + $fields + + + + +

    + + +

    Fields of index

    + + + + protected + array<string|int, mixed> + $fields + + + + + + + + + + +
    +
    +

    + $id + + + + +

    + + +

    Index Id.

    + + + + protected + string + $id + + + + + + + + + + +
    +
    +

    + $indexTypes + + + + +

    + + +

    Valid indexes types

    + + + + protected + static array<string|int, mixed> + $indexTypes + = ['fulltext', 'general', 'geo', 'hash', 'persistent', 'skiplist', 'ttl', 'primary', 'edge', 'inverted'] + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If the index is a new one or +a representation of an existing index

    + + + + protected + bool + $isNew + + + + + + + + + + +
    +
    +

    + $name + + + + +

    + + +

    Index name.

    + + + + protected + string + $name + + + + + + + + + + +
    +
    +

    + $sparse + + + + +

    + + +

    Sparse

    + + + + protected + bool + $sparse + + + + + + + + + + +
    +
    +

    + $type + + + + +

    + + +

    Index type

    + + + + protected + string + $type + + + + + + + + + + +
    +
    +

    + $unique + + + + +

    + + +

    Unique constraint

    + + + + protected + bool + $unique + + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    Index constructor.

    + + + public + __construct(string $type, array<string|int, mixed> $fields[, array<string|int, mixed> $attributes = [] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $type + : string +
    +
    +

    The index type. Must be one of following values: 'fulltext', 'general', 'geo', 'hash', 'persistent', 'skiplist', 'inverted' or 'ttl'

    +
    + +
    +
    + $fields + : array<string|int, mixed> +
    +
    +

    An array of attribute names. Normally with just one attribute.

    +
    + +
    +
    + $attributes + : array<string|int, mixed> + = []
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException + + +
    +
    + + + + +
    +
    +

    + __toString() + + +

    + + +

    String representation of index

    + + + public + __toString() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + getCollection() + + +

    + + +

    Returns the collection where index belong to

    + + + public + getCollection() : Collection|null + +
    +
    + + + + + + + +
    +
    Return values
    + Collection|null + — +

    A collection object or null if the index was not set to an collection yet

    +
    + +
    + +
    +
    +

    + getCreateData() + + +

    + + +

    Return data for create index on server

    + + + public + getCreateData() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getFields() + + +

    + + +

    Returns index fields

    + + + public + getFields() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getId() + + +

    + + +

    Index Id

    + + + public + getId() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getName() + + +

    + + +

    Returns index name

    + + + public + getName() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getType() + + +

    + + +

    Returns index type

    + + + public + getType() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + isNew() + + +

    + + +

    If the index is a new one

    + + + public + isNew() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + EntityInterface::isNew() + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if is a new object. False otherwise.

    +
    + +
    + +
    +
    +

    + isSparse() + + +

    + + +

    If the index is sparse

    + + + public + isSparse() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isUnique() + + +

    + + +

    If index has 'unique' constraint

    + + + public + isUnique() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + jsonSerialize() + + +

    + + + + + public + jsonSerialize() : mixed + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + JsonSerializable::jsonSerialize() + + +
    +
    + + + + +
    +
    +

    + setCollection() + + +

    + + +

    Set the collection where the index belongs to

    + + + public + setCollection(Collection $collection) : void + +
    +
    + + +
    Parameters
    +
    +
    + $collection + : Collection +
    +
    + +
    +
    + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Returns a array representation of entity

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -431,10 +1615,45 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-Index-InvertedIndex.html b/docs/classes/ArangoDB-Collection-Index-InvertedIndex.html index 6f89ac6..95f60d5 100644 --- a/docs/classes/ArangoDB-Collection-Index-InvertedIndex.html +++ b/docs/classes/ArangoDB-Collection-Index-InvertedIndex.html @@ -313,15 +313,1246 @@

    +

    + Properties + +

    +
    +
    + $collection + +  : Collection +
    +
    Collection where the index belongs to
    +
    + $defaultOptions + +  : array<string|int, mixed> +
    +
    Default options for inverted index
    + +
    + $fields + +  : array<string|int, mixed> +
    +
    Fields of index
    + +
    + $id + +  : string +
    +
    Index Id.
    + +
    + $indexTypes + +  : array<string|int, mixed> +
    +
    Valid indexes types
    + +
    + $isNew + +  : bool +
    +
    If the index is a new one or +a representation of an existing index
    + +
    + $name + +  : string +
    +
    Index name.
    + +
    + $sparse + +  : bool +
    +
    Sparse
    + +
    + $type + +  : string +
    +
    Index type
    + +
    + $unique + +  : bool +
    +
    Unique constraint
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    InvertedIndex constructor
    + +
    + __toString() + +  : mixed +
    +
    String representation of index
    + +
    + getCollection() + +  : Collection|null +
    +
    Returns the collection where index belong to
    + +
    + getCreateData() + +  : array<string|int, mixed> +
    +
    Return data for create index on server
    + +
    + getFields() + +  : array<string|int, mixed> +
    +
    Returns index fields
    + +
    + getId() + +  : string +
    +
    Index Id
    + +
    + getName() + +  : string +
    +
    Returns index name
    + +
    + getType() + +  : string +
    +
    Returns index type
    + +
    + isNew() + +  : bool +
    +
    If the index is a new one
    + +
    + isSparse() + +  : bool +
    +
    If the index is sparse
    + +
    + isUnique() + +  : bool +
    +
    If index has 'unique' constraint
    + +
    + jsonSerialize() + +  : mixed +
    + +
    + setCollection() + +  : void +
    +
    Set the collection where the index belongs to
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Returns a array representation of entity
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $collection + + + + +

    + + +

    Collection where the index belongs to

    + + + + protected + Collection + $collection + + + + + + + + + + +
    +
    +

    + $defaultOptions + + + + +

    + + +

    Default options for inverted index

    + + + + protected + array<string|int, mixed> + $defaultOptions + = [ + 'unique' => true, + 'sparse' => true, + 'analyzer' => "identity", + 'inBackground' => true, + // Keep the collection available for writes during the index creation + 'parallelism' => 2, +] + + + + + + + + + +
    +
    +

    + $fields + + + + +

    + + +

    Fields of index

    + + + + protected + array<string|int, mixed> + $fields + + + + + + + + + + +
    +
    +

    + $id + + + + +

    + + +

    Index Id.

    + + + + protected + string + $id + + + + + + + + + + +
    +
    +

    + $indexTypes + + + + +

    + + +

    Valid indexes types

    + + + + protected + static array<string|int, mixed> + $indexTypes + = ['fulltext', 'general', 'geo', 'hash', 'persistent', 'skiplist', 'ttl', 'primary', 'edge', 'inverted'] + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If the index is a new one or +a representation of an existing index

    + + + + protected + bool + $isNew + + + + + + + + + + +
    +
    +

    + $name + + + + +

    + + +

    Index name.

    + + + + protected + string + $name + + + + + + + + + + +
    +
    +

    + $sparse + + + + +

    + + +

    Sparse

    + + + + protected + bool + $sparse + + + + + + + + + + +
    +
    +

    + $type + + + + +

    + + +

    Index type

    + + + + protected + string + $type + + + + + + + + + + +
    +
    +

    + $unique + + + + +

    + + +

    Unique constraint

    + + + + protected + bool + $unique + + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    InvertedIndex constructor

    + + + public + __construct(array<string|int, mixed> $fields[, array<string|int, mixed> $attributes = [] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $fields + : array<string|int, mixed> +
    +
    +

    Fields for which the index applies to

    +
    + +
    +
    + $attributes + : array<string|int, mixed> + = []
    +
    +

    Index $attributes

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException + + +
    +
    + + + + +
    +
    +

    + __toString() + + +

    + + +

    String representation of index

    + + + public + __toString() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + getCollection() + + +

    + + +

    Returns the collection where index belong to

    + + + public + getCollection() : Collection|null + +
    +
    + + + + + + + +
    +
    Return values
    + Collection|null + — +

    A collection object or null if the index was not set to an collection yet

    +
    + +
    + +
    +
    +

    + getCreateData() + + +

    + + +

    Return data for create index on server

    + + + public + getCreateData() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getFields() + + +

    + + +

    Returns index fields

    + + + public + getFields() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getId() + + +

    + + +

    Index Id

    + + + public + getId() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getName() + + +

    + + +

    Returns index name

    + + + public + getName() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getType() + + +

    + + +

    Returns index type

    + + + public + getType() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + isNew() + + +

    + + +

    If the index is a new one

    + + + public + isNew() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + EntityInterface::isNew() + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if is a new object. False otherwise.

    +
    + +
    + +
    +
    +

    + isSparse() + + +

    + + +

    If the index is sparse

    + + + public + isSparse() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isUnique() + + +

    + + +

    If index has 'unique' constraint

    + + + public + isUnique() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + jsonSerialize() + + +

    + + + + + public + jsonSerialize() : mixed + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + JsonSerializable::jsonSerialize() + + +
    +
    + + + + +
    +
    +

    + setCollection() + + +

    + + +

    Set the collection where the index belongs to

    + + + public + setCollection(Collection $collection) : void + +
    +
    + + +
    Parameters
    +
    +
    + $collection + : Collection +
    +
    + +
    +
    + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Returns a array representation of entity

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -427,10 +1658,46 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-Index-PersistentIndex.html b/docs/classes/ArangoDB-Collection-Index-PersistentIndex.html index 9365c09..ec4fb76 100644 --- a/docs/classes/ArangoDB-Collection-Index-PersistentIndex.html +++ b/docs/classes/ArangoDB-Collection-Index-PersistentIndex.html @@ -313,15 +313,1235 @@

    +

    + Properties + +

    +
    +
    + $collection + +  : Collection +
    +
    Collection where the index belongs to
    +
    + $defaultsOptions + +  : array<string|int, mixed> +
    +
    Default options for persistent index
    + +
    + $fields + +  : array<string|int, mixed> +
    +
    Fields of index
    + +
    + $id + +  : string +
    +
    Index Id.
    + +
    + $indexTypes + +  : array<string|int, mixed> +
    +
    Valid indexes types
    + +
    + $isNew + +  : bool +
    +
    If the index is a new one or +a representation of an existing index
    + +
    + $name + +  : string +
    +
    Index name.
    + +
    + $sparse + +  : bool +
    +
    Sparse
    + +
    + $type + +  : string +
    +
    Index type
    + +
    + $unique + +  : bool +
    +
    Unique constraint
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    PersistentIndex constructor.
    + +
    + __toString() + +  : mixed +
    +
    String representation of index
    + +
    + getCollection() + +  : Collection|null +
    +
    Returns the collection where index belong to
    + +
    + getCreateData() + +  : array<string|int, mixed> +
    +
    Return data for create index on server
    + +
    + getFields() + +  : array<string|int, mixed> +
    +
    Returns index fields
    + +
    + getId() + +  : string +
    +
    Index Id
    + +
    + getName() + +  : string +
    +
    Returns index name
    + +
    + getType() + +  : string +
    +
    Returns index type
    + +
    + isNew() + +  : bool +
    +
    If the index is a new one
    + +
    + isSparse() + +  : bool +
    +
    If the index is sparse
    + +
    + isUnique() + +  : bool +
    +
    If index has 'unique' constraint
    + +
    + jsonSerialize() + +  : mixed +
    + +
    + setCollection() + +  : void +
    +
    Set the collection where the index belongs to
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Returns a array representation of entity
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $collection + + + + +

    + + +

    Collection where the index belongs to

    + + + + protected + Collection + $collection + + + + + + + + + + +
    +
    +

    + $defaultsOptions + + + + +

    + + +

    Default options for persistent index

    + + + + protected + array<string|int, mixed> + $defaultsOptions + = ['unique' => true, 'sparse' => true] + + + + + + + + + +
    +
    +

    + $fields + + + + +

    + + +

    Fields of index

    + + + + protected + array<string|int, mixed> + $fields + + + + + + + + + + +
    +
    +

    + $id + + + + +

    + + +

    Index Id.

    + + + + protected + string + $id + + + + + + + + + + +
    +
    +

    + $indexTypes + + + + +

    + + +

    Valid indexes types

    + + + + protected + static array<string|int, mixed> + $indexTypes + = ['fulltext', 'general', 'geo', 'hash', 'persistent', 'skiplist', 'ttl', 'primary', 'edge', 'inverted'] + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If the index is a new one or +a representation of an existing index

    + + + + protected + bool + $isNew + + + + + + + + + + +
    +
    +

    + $name + + + + +

    + + +

    Index name.

    + + + + protected + string + $name + + + + + + + + + + +
    +
    +

    + $sparse + + + + +

    + + +

    Sparse

    + + + + protected + bool + $sparse + + + + + + + + + + +
    +
    +

    + $type + + + + +

    + + +

    Index type

    + + + + protected + string + $type + + + + + + + + + + +
    +
    +

    + $unique + + + + +

    + + +

    Unique constraint

    + + + + protected + bool + $unique + + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    PersistentIndex constructor.

    + + + public + __construct(array<string|int, mixed> $fields[, array<string|int, mixed> $attributes = [] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $fields + : array<string|int, mixed> +
    +
    + +
    +
    + $attributes + : array<string|int, mixed> + = []
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException + + +
    +
    + + + + +
    +
    +

    + __toString() + + +

    + + +

    String representation of index

    + + + public + __toString() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + getCollection() + + +

    + + +

    Returns the collection where index belong to

    + + + public + getCollection() : Collection|null + +
    +
    + + + + + + + +
    +
    Return values
    + Collection|null + — +

    A collection object or null if the index was not set to an collection yet

    +
    + +
    + +
    +
    +

    + getCreateData() + + +

    + + +

    Return data for create index on server

    + + + public + getCreateData() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getFields() + + +

    + + +

    Returns index fields

    + + + public + getFields() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getId() + + +

    + + +

    Index Id

    + + + public + getId() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getName() + + +

    + + +

    Returns index name

    + + + public + getName() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getType() + + +

    + + +

    Returns index type

    + + + public + getType() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + isNew() + + +

    + + +

    If the index is a new one

    + + + public + isNew() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + EntityInterface::isNew() + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if is a new object. False otherwise.

    +
    + +
    + +
    +
    +

    + isSparse() + + +

    + + +

    If the index is sparse

    + + + public + isSparse() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isUnique() + + +

    + + +

    If index has 'unique' constraint

    + + + public + isUnique() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + jsonSerialize() + + +

    + + + + + public + jsonSerialize() : mixed + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + JsonSerializable::jsonSerialize() + + +
    +
    + + + + +
    +
    +

    + setCollection() + + +

    + + +

    Set the collection where the index belongs to

    + + + public + setCollection(Collection $collection) : void + +
    +
    + + +
    Parameters
    +
    +
    + $collection + : Collection +
    +
    + +
    +
    + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Returns a array representation of entity

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -427,10 +1647,46 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-Index-PrimaryIndex.html b/docs/classes/ArangoDB-Collection-Index-PrimaryIndex.html index c243237..49cedab 100644 --- a/docs/classes/ArangoDB-Collection-Index-PrimaryIndex.html +++ b/docs/classes/ArangoDB-Collection-Index-PrimaryIndex.html @@ -311,15 +311,1205 @@

    +

    + Properties + +

    +
    +
    + $collection + +  : Collection +
    +
    Collection where the index belongs to
    +
    + $fields + +  : array<string|int, mixed> +
    +
    Fields of index
    + +
    + $id + +  : string +
    +
    Index Id.
    + +
    + $indexTypes + +  : array<string|int, mixed> +
    +
    Valid indexes types
    + +
    + $isNew + +  : bool +
    +
    If the index is a new one or +a representation of an existing index
    + +
    + $name + +  : string +
    +
    Index name.
    + +
    + $sparse + +  : bool +
    +
    Sparse
    + +
    + $type + +  : string +
    +
    Index type
    + +
    + $unique + +  : bool +
    +
    Unique constraint
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    PrimaryIndex constructor.
    + +
    + __toString() + +  : mixed +
    +
    String representation of index
    + +
    + getCollection() + +  : Collection|null +
    +
    Returns the collection where index belong to
    + +
    + getCreateData() + +  : array<string|int, mixed> +
    +
    This type of Index cannot be create/deleted explicitly by user.
    + +
    + getFields() + +  : array<string|int, mixed> +
    +
    Returns index fields
    + +
    + getId() + +  : string +
    +
    Index Id
    + +
    + getName() + +  : string +
    +
    Returns index name
    + +
    + getType() + +  : string +
    +
    Returns index type
    + +
    + isNew() + +  : bool +
    +
    If the index is a new one
    + +
    + isSparse() + +  : bool +
    +
    If the index is sparse
    + +
    + isUnique() + +  : bool +
    +
    If index has 'unique' constraint
    + +
    + jsonSerialize() + +  : mixed +
    + +
    + setCollection() + +  : void +
    +
    Set the collection where the index belongs to
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Returns a array representation of entity
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $collection + + + + +

    + + +

    Collection where the index belongs to

    + + + + protected + Collection + $collection + + + + + + + + + + +
    +
    +

    + $fields + + + + +

    + + +

    Fields of index

    + + + + protected + array<string|int, mixed> + $fields + + + + + + + + + + +
    +
    +

    + $id + + + + +

    + + +

    Index Id.

    + + + + protected + string + $id + + + + + + + + + + +
    +
    +

    + $indexTypes + + + + +

    + + +

    Valid indexes types

    + + + + protected + static array<string|int, mixed> + $indexTypes + = ['fulltext', 'general', 'geo', 'hash', 'persistent', 'skiplist', 'ttl', 'primary', 'edge', 'inverted'] + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If the index is a new one or +a representation of an existing index

    + + + + protected + bool + $isNew + + + + + + + + + + +
    +
    +

    + $name + + + + +

    + + +

    Index name.

    + + + + protected + string + $name + + + + + + + + + + +
    +
    +

    + $sparse + + + + +

    + + +

    Sparse

    + + + + protected + bool + $sparse + + + + + + + + + + +
    +
    +

    + $type + + + + +

    + + +

    Index type

    + + + + protected + string + $type + + + + + + + + + + +
    +
    +

    + $unique + + + + +

    + + +

    Unique constraint

    + + + + protected + bool + $unique + + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    PrimaryIndex constructor.

    + + + public + __construct(array<string|int, mixed> $fields[, array<string|int, mixed> $attributes = [] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $fields + : array<string|int, mixed> +
    +
    + +
    +
    + $attributes + : array<string|int, mixed> + = []
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException + + +
    +
    + + + + +
    +
    +

    + __toString() + + +

    + + +

    String representation of index

    + + + public + __toString() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + getCollection() + + +

    + + +

    Returns the collection where index belong to

    + + + public + getCollection() : Collection|null + +
    +
    + + + + + + + +
    +
    Return values
    + Collection|null + — +

    A collection object or null if the index was not set to an collection yet

    +
    + +
    + +
    +
    +

    + getCreateData() + + +

    + + +

    This type of Index cannot be create/deleted explicitly by user.

    + + + public + getCreateData() : array<string|int, mixed> + +
    +
    + +

    Throws an exception if an attempt of create one is made

    +
    + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + IndexException + + +
    +
    + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getFields() + + +

    + + +

    Returns index fields

    + + + public + getFields() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getId() + + +

    + + +

    Index Id

    + + + public + getId() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getName() + + +

    + + +

    Returns index name

    + + + public + getName() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getType() + + +

    + + +

    Returns index type

    + + + public + getType() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + isNew() + + +

    + + +

    If the index is a new one

    + + + public + isNew() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + EntityInterface::isNew() + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if is a new object. False otherwise.

    +
    + +
    + +
    +
    +

    + isSparse() + + +

    + + +

    If the index is sparse

    + + + public + isSparse() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isUnique() + + +

    + + +

    If index has 'unique' constraint

    + + + public + isUnique() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + jsonSerialize() + + +

    + + + + + public + jsonSerialize() : mixed + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + JsonSerializable::jsonSerialize() + + +
    +
    + + + + +
    +
    +

    + setCollection() + + +

    + + +

    Set the collection where the index belongs to

    + + + public + setCollection(Collection $collection) : void + +
    +
    + + +
    Parameters
    +
    +
    + $collection + : Collection +
    +
    + +
    +
    + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Returns a array representation of entity

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -425,10 +1615,45 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-Index-SkipListIndex.html b/docs/classes/ArangoDB-Collection-Index-SkipListIndex.html index 9d60e20..8ae2163 100644 --- a/docs/classes/ArangoDB-Collection-Index-SkipListIndex.html +++ b/docs/classes/ArangoDB-Collection-Index-SkipListIndex.html @@ -319,15 +319,1331 @@

    +

    + Properties + +

    +
    +
    + $collection + +  : Collection +
    +
    Collection where the index belongs to
    +
    + $deduplicate + +  : bool +
    +
    If set to false, the deduplication of array values is turned off
    + +
    + $defaultsOptions + +  : array<string|int, mixed> +
    +
    Default options for hash index
    + +
    + $fields + +  : array<string|int, mixed> +
    +
    Fields of index
    + +
    + $id + +  : string +
    +
    Index Id.
    + +
    + $indexTypes + +  : array<string|int, mixed> +
    +
    Valid indexes types
    + +
    + $isNew + +  : bool +
    +
    If the index is a new one or +a representation of an existing index
    + +
    + $name + +  : string +
    +
    Index name.
    + +
    + $sparse + +  : bool +
    +
    Sparse
    + +
    + $type + +  : string +
    +
    Index type
    + +
    + $unique + +  : bool +
    +
    Unique constraint
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    SkipListIndex constructor.
    + +
    + __toString() + +  : mixed +
    +
    String representation of index
    + +
    + getCollection() + +  : Collection|null +
    +
    Returns the collection where index belong to
    + +
    + getCreateData() + +  : array<string|int, mixed> +
    +
    Return data for create index on server
    + +
    + getFields() + +  : array<string|int, mixed> +
    +
    Returns index fields
    + +
    + getId() + +  : string +
    +
    Index Id
    + +
    + getName() + +  : string +
    +
    Returns index name
    + +
    + getType() + +  : string +
    +
    Returns index type
    + +
    + isDeduplicate() + +  : bool +
    +
    Return the deduplicate parameter
    + +
    + isNew() + +  : bool +
    +
    If the index is a new one
    + +
    + isSparse() + +  : bool +
    +
    If the index is sparse
    + +
    + isUnique() + +  : bool +
    +
    If index has 'unique' constraint
    + +
    + jsonSerialize() + +  : mixed +
    + +
    + setCollection() + +  : void +
    +
    Set the collection where the index belongs to
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Returns a array representation of index
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $collection + + + + +

    + + +

    Collection where the index belongs to

    + + + + protected + Collection + $collection + + + + + + + + + + +
    +
    +

    + $deduplicate + + + + +

    + + +

    If set to false, the deduplication of array values is turned off

    + + + + protected + bool + $deduplicate + + + + + + + + + + +
    +
    +

    + $defaultsOptions + + + + +

    + + +

    Default options for hash index

    + + + + protected + array<string|int, mixed> + $defaultsOptions + = ['unique' => true, 'sparse' => true, 'deduplicate' => true] + + + + + + + + + +
    +
    +

    + $fields + + + + +

    + + +

    Fields of index

    + + + + protected + array<string|int, mixed> + $fields + + + + + + + + + + +
    +
    +

    + $id + + + + +

    + + +

    Index Id.

    + + + + protected + string + $id + + + + + + + + + + +
    +
    +

    + $indexTypes + + + + +

    + + +

    Valid indexes types

    + + + + protected + static array<string|int, mixed> + $indexTypes + = ['fulltext', 'general', 'geo', 'hash', 'persistent', 'skiplist', 'ttl', 'primary', 'edge', 'inverted'] + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If the index is a new one or +a representation of an existing index

    + + + + protected + bool + $isNew + + + + + + + + + + +
    +
    +

    + $name + + + + +

    + + +

    Index name.

    + + + + protected + string + $name + + + + + + + + + + +
    +
    +

    + $sparse + + + + +

    + + +

    Sparse

    + + + + protected + bool + $sparse + + + + + + + + + + +
    +
    +

    + $type + + + + +

    + + +

    Index type

    + + + + protected + string + $type + + + + + + + + + + +
    +
    +

    + $unique + + + + +

    + + +

    Unique constraint

    + + + + protected + bool + $unique + + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    SkipListIndex constructor.

    + + + public + __construct(array<string|int, mixed> $fields[, array<string|int, mixed> $attributes = [] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $fields + : array<string|int, mixed> +
    +
    +

    An array of attribute names.

    +
    + +
    +
    + $attributes + : array<string|int, mixed> + = []
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException + + +
    +
    + + + + +
    +
    +

    + __toString() + + +

    + + +

    String representation of index

    + + + public + __toString() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + getCollection() + + +

    + + +

    Returns the collection where index belong to

    + + + public + getCollection() : Collection|null + +
    +
    + + + + + + + +
    +
    Return values
    + Collection|null + — +

    A collection object or null if the index was not set to an collection yet

    +
    + +
    + +
    +
    +

    + getCreateData() + + +

    + + +

    Return data for create index on server

    + + + public + getCreateData() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getFields() + + +

    + + +

    Returns index fields

    + + + public + getFields() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getId() + + +

    + + +

    Index Id

    + + + public + getId() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getName() + + +

    + + +

    Returns index name

    + + + public + getName() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getType() + + +

    + + +

    Returns index type

    + + + public + getType() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + isDeduplicate() + + +

    + + +

    Return the deduplicate parameter

    + + + public + isDeduplicate() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isNew() + + +

    + + +

    If the index is a new one

    + + + public + isNew() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + EntityInterface::isNew() + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if is a new object. False otherwise.

    +
    + +
    + +
    +
    +

    + isSparse() + + +

    + + +

    If the index is sparse

    + + + public + isSparse() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isUnique() + + +

    + + +

    If index has 'unique' constraint

    + + + public + isUnique() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + jsonSerialize() + + +

    + + + + + public + jsonSerialize() : mixed + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + JsonSerializable::jsonSerialize() + + +
    +
    + + + + +
    +
    +

    + setCollection() + + +

    + + +

    Set the collection where the index belongs to

    + + + public + setCollection(Collection $collection) : void + +
    +
    + + +
    Parameters
    +
    +
    + $collection + : Collection +
    +
    + +
    +
    + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Returns a array representation of index

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -433,10 +1749,48 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-Index-TTLIndex.html b/docs/classes/ArangoDB-Collection-Index-TTLIndex.html index a130859..6c5a562 100644 --- a/docs/classes/ArangoDB-Collection-Index-TTLIndex.html +++ b/docs/classes/ArangoDB-Collection-Index-TTLIndex.html @@ -313,15 +313,1293 @@

    +

    + Properties + +

    +
    +
    + $collection + +  : Collection +
    +
    Collection where the index belongs to
    +
    + $expiresAfter + +  : int +
    +
    Time (in seconds) after a document's creation after which the documents counts as expired
    + +
    + $fields + +  : array<string|int, mixed> +
    +
    Fields of index
    + +
    + $id + +  : string +
    +
    Index Id.
    + +
    + $indexTypes + +  : array<string|int, mixed> +
    +
    Valid indexes types
    + +
    + $isNew + +  : bool +
    +
    If the index is a new one or +a representation of an existing index
    + +
    + $name + +  : string +
    +
    Index name.
    + +
    + $sparse + +  : bool +
    +
    Sparse
    + +
    + $type + +  : string +
    +
    Index type
    + +
    + $unique + +  : bool +
    +
    Unique constraint
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    TTLIndex constructor.
    + +
    + __toString() + +  : mixed +
    +
    String representation of index
    + +
    + expireAfter() + +  : int +
    +
    Return time (in seconds) to expire documents on index
    + +
    + getCollection() + +  : Collection|null +
    +
    Returns the collection where index belong to
    + +
    + getCreateData() + +  : array<string|int, mixed> +
    +
    Return data for create index on server
    + +
    + getFields() + +  : array<string|int, mixed> +
    +
    Returns index fields
    + +
    + getId() + +  : string +
    +
    Index Id
    + +
    + getName() + +  : string +
    +
    Returns index name
    + +
    + getType() + +  : string +
    +
    Returns index type
    + +
    + isNew() + +  : bool +
    +
    If the index is a new one
    + +
    + isSparse() + +  : bool +
    +
    If the index is sparse
    + +
    + isUnique() + +  : bool +
    +
    If index has 'unique' constraint
    + +
    + jsonSerialize() + +  : mixed +
    + +
    + setCollection() + +  : void +
    +
    Set the collection where the index belongs to
    + +
    + toArray() + +  : array<string|int, mixed> +
    +
    Returns a array representation of index
    + +
    - +
    +

    + Properties + + +

    +
    +

    + $collection + + + + +

    + + +

    Collection where the index belongs to

    + + + + protected + Collection + $collection + + + + + + + + + + +
    +
    +

    + $expiresAfter + + + + +

    + + +

    Time (in seconds) after a document's creation after which the documents counts as expired

    + + + + protected + int + $expiresAfter + + + + + + + + + + +
    +
    +

    + $fields + + + + +

    + + +

    Fields of index

    + + + + protected + array<string|int, mixed> + $fields + + + + + + + + + + +
    +
    +

    + $id + + + + +

    + + +

    Index Id.

    + + + + protected + string + $id + + + + + + + + + + +
    +
    +

    + $indexTypes + + + + +

    + + +

    Valid indexes types

    + + + + protected + static array<string|int, mixed> + $indexTypes + = ['fulltext', 'general', 'geo', 'hash', 'persistent', 'skiplist', 'ttl', 'primary', 'edge', 'inverted'] + + + + + + + + + +
    +
    +

    + $isNew + + + + +

    + + +

    If the index is a new one or +a representation of an existing index

    + + + + protected + bool + $isNew + + + + + + + + + + +
    +
    +

    + $name + + + + +

    + + +

    Index name.

    + + + + protected + string + $name + + + + + + + + + + +
    +
    +

    + $sparse + + + + +

    + + +

    Sparse

    + + + + protected + bool + $sparse + + + + + + + + + + +
    +
    +

    + $type + + + + +

    + + +

    Index type

    + + + + protected + string + $type + + + + + + + + + + +
    +
    +

    + $unique + + + + +

    + + +

    Unique constraint

    + + + + protected + bool + $unique + + + + + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    TTLIndex constructor.

    + + + public + __construct(array<string|int, mixed> $fields[, int $expireAfter = 60 ][, array<string|int, mixed> $attributes = [] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $fields + : array<string|int, mixed> +
    +
    +

    An array of attribute names.

    +
    + +
    +
    + $expireAfter + : int + = 60
    +
    +

    Time (in seconds) to expire a document

    +
    + +
    +
    + $attributes + : array<string|int, mixed> + = []
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidParameterException + + +
    +
    + + + + +
    +
    +

    + __toString() + + +

    + + +

    String representation of index

    + + + public + __toString() : mixed + +
    +
    + + + + + + + + +
    +
    +

    + expireAfter() + + +

    + + +

    Return time (in seconds) to expire documents on index

    + + + public + expireAfter() : int + +
    +
    + + + + + + + +
    +
    Return values
    + int +
    + +
    +
    +

    + getCollection() + + +

    + + +

    Returns the collection where index belong to

    + + + public + getCollection() : Collection|null + +
    +
    + + + + + + + +
    +
    Return values
    + Collection|null + — +

    A collection object or null if the index was not set to an collection yet

    +
    + +
    + +
    +
    +

    + getCreateData() + + +

    + + +

    Return data for create index on server

    + + + public + getCreateData() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getFields() + + +

    + + +

    Returns index fields

    + + + public + getFields() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +

    + getId() + + +

    + + +

    Index Id

    + + + public + getId() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getName() + + +

    + + +

    Returns index name

    + + + public + getName() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + getType() + + +

    + + +

    Returns index type

    + + + public + getType() : string + +
    +
    + + + + + + + +
    +
    Return values
    + string +
    + +
    +
    +

    + isNew() + + +

    + + +

    If the index is a new one

    + + + public + isNew() : bool + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + EntityInterface::isNew() + + +
    +
    + + + +
    +
    Return values
    + bool + — +

    True if is a new object. False otherwise.

    +
    + +
    + +
    +
    +

    + isSparse() + + +

    + + +

    If the index is sparse

    + + + public + isSparse() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + isUnique() + + +

    + + +

    If index has 'unique' constraint

    + + + public + isUnique() : bool + +
    +
    + + + + + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + jsonSerialize() + + +

    + + + + + public + jsonSerialize() : mixed + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + see +
    +
    + JsonSerializable::jsonSerialize() + + +
    +
    + + + + +
    +
    +

    + setCollection() + + +

    + + +

    Set the collection where the index belongs to

    + + + public + setCollection(Collection $collection) : void + +
    +
    + + +
    Parameters
    +
    +
    + $collection + : Collection +
    +
    + +
    +
    + + + + + + +
    +
    +

    + toArray() + + +

    + + +

    Returns a array representation of index

    + + + public + toArray() : array<string|int, mixed> + +
    +
    + + + + + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +
    +
    +
    @@ -427,10 +1705,47 @@

  • Table Of Contents
    • -
    +
  • Properties
  • +
  • Methods
  • + +
  • Properties
  • +
  • + +
  • +
  • Methods
  • +
  • + +
  • diff --git a/docs/classes/ArangoDB-Collection-IndexableTrait.html b/docs/classes/ArangoDB-Collection-IndexableTrait.html new file mode 100644 index 0000000..d1d505a --- /dev/null +++ b/docs/classes/ArangoDB-Collection-IndexableTrait.html @@ -0,0 +1,668 @@ + + + + + Arango PHP ODM + + + + + + + + + + + + + + + + + + + + + +
    +

    Arango PHP ODM

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

    + IndexableTrait +

    + + + +

    Indexable trait

    + + + + +
    + Tags + + +
    +
    +
    + author +
    +
    + +

    Lucas S. Vieira

    +
    + +
    +
    + + + + + +

    + Table of Contents + + +

    + + + + + + + + + + +

    + Methods + + +

    +
    +
    + addIndex() + +  : bool +
    +
    Create an index for collection
    + +
    + dropIndex() + +  : bool +
    +
    Drops an index of collection
    + +
    + getIndexes() + +  : ArrayList +
    +
    Return all indexes of collection
    + +
    + + + + + + + + +
    +

    + Methods + + +

    +
    +

    + addIndex() + + +

    + + +

    Create an index for collection

    + + + public + addIndex(IndexInterface $index) : bool + +
    +
    + + +
    Parameters
    +
    +
    + $index + : IndexInterface +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool +
    + +
    +
    +

    + dropIndex() + + +

    + + +

    Drops an index of collection

    + + + public + dropIndex(IndexInterface $index) : bool + +
    +
    + + +
    Parameters
    +
    +
    + $index + : IndexInterface +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + DatabaseException|GuzzleException + + +
    +
    + + + +
    +
    Return values
    + bool +
    + +
    + +
    + +
    +
    +
    +
    +
    
    +        
    + +
    +
    + + + +
    +
    +
    + +
    + On this page + + +
    + +
    +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      + + +
      + + + + + + + + diff --git a/docs/classes/ArangoDB-Collection-KeyType.html b/docs/classes/ArangoDB-Collection-KeyType.html index d7a0903..02c6da3 100644 --- a/docs/classes/ArangoDB-Collection-KeyType.html +++ b/docs/classes/ArangoDB-Collection-KeyType.html @@ -304,6 +304,37 @@

      +

      + Constants + + +

      +
      +
      + AUTOINCREMENT + +  = 'autoincrement' +
      + +
      + PADDED + +  = 'padded' +
      + +
      + TRADITIONAL + +  = 'traditional' +
      + +
      + UUID + +  = 'uuid' +
      + +
      @@ -311,6 +342,141 @@

      +
      +

      + Constants + + +

      +
      +

      + AUTOINCREMENT + + +

      + + + + + + + public + mixed + AUTOINCREMENT + = 'autoincrement' + + + + + + + + + +
      +
      +

      + PADDED + + +

      + + + + + + + public + mixed + PADDED + = 'padded' + + + + + + + + + +
      +
      +

      + TRADITIONAL + + +

      + + + + + + + public + mixed + TRADITIONAL + = 'traditional' + + + + + + + + + +
      +
      +

      + UUID + + +

      + + + + + + + public + mixed + UUID + = 'uuid' + + + + + + + + + +
      +
      @@ -420,8 +586,18 @@

    • Table Of Contents
    • +
    • Constants
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Connection-Connection.html b/docs/classes/ArangoDB-Connection-Connection.html index cea3fe7..ff1e8a4 100644 --- a/docs/classes/ArangoDB-Connection-Connection.html +++ b/docs/classes/ArangoDB-Connection-Connection.html @@ -309,15 +309,1376 @@

      +

      + Properties + +

      +
      +
      + $authToken + +  : array<string|int, mixed> +
      + +
      + $defaultHeaders + +  : array<string|int, mixed> +
      +
      Default headers to send to server.
      + +
      + $options + +  : array<string|int, mixed> +
      + +
      + $restClient + +  : RestClient +
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Connection constructor.
      + +
      + __debugInfo() + +  : array<string|int, mixed> +
      +
      Proper debug dump for connection objects.
      + +
      + customHttpRequest() + +  : ResponseInterface +
      +
      Makes a custom HTTP request.
      + +
      + delete() + +  : ResponseInterface +
      +
      Executes a DELETE request on server.
      + +
      + get() + +  : ResponseInterface +
      +
      Executes a GET request on server.
      + +
      + getBaseUri() + +  : string +
      +
      Return the base endpoint URI.
      + +
      + getDatabase() + +  : Database +
      +
      Return the database object for this connection
      + +
      + getDatabaseName() + +  : string +
      +
      Return the name of database handled
      + +
      + getDefaultHeaders() + +  : array<string|int, mixed> +
      +
      Return the connection default headers.
      + +
      + getUsername() + +  : string +
      +
      Returns the name of user on server
      + +
      + isAuthenticated() + +  : bool +
      +
      If connection is authenticated.
      + +
      + patch() + +  : ResponseInterface +
      +
      Executes a PATCH request on server.
      + +
      + post() + +  : ResponseInterface +
      +
      Executes a POST request on server.
      + +
      + put() + +  : ResponseInterface +
      +
      Executes a PUT request on server.
      + +
      + setDefaultHeaders() + +  : void +
      +
      Set the connection default headers.
      + +
      + authenticate() + +  : void +
      +
      Authenticates a user on ArangoDB Server
      + +
      + getAuthorizationHeader() + +  : array<string|int, mixed> +
      +
      Return the authorization header
      + +
      + + + + + + +
      +

      + Properties + + +

      +
      +

      + $authToken + + + + +

      + + + + + + protected + array<string|int, mixed> + $authToken + + + +

      JWT token

      +
      + + + + + + + +
      +
      +

      + $defaultHeaders + + + + +

      + + +

      Default headers to send to server.

      + + + + protected + array<string|int, mixed> + $defaultHeaders + = [] + + + + + + + + + +
      +
      +

      + $options + + + + +

      + + + + + + protected + array<string|int, mixed> + $options + + + + + + + + + + +
      + +
      + +
      +

      + Methods + + +

      + +
      +

      + __debugInfo() + + +

      + + +

      Proper debug dump for connection objects.

      + + + public + __debugInfo() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + customHttpRequest() + + +

      + + +

      Makes a custom HTTP request.

      + + + public + customHttpRequest(string $method, string $uri[, string $body = "" ][, array<string|int, mixed> $headers = [] ]) : ResponseInterface + +
      +
      + + +
      Parameters
      +
      +
      + $method + : string +
      +
      +

      HTTP Method to use.

      +
      + +
      +
      + $uri + : string +
      +
      +

      URI to make the request.

      +
      + +
      +
      + $body + : string + = ""
      +
      +

      The body content.

      +
      + +
      +
      + $headers + : array<string|int, mixed> + = []
      +
      +

      Additional headers to send on request.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException + + +
      +
      + + + +
      +
      Return values
      + ResponseInterface +
      + +
      +
      +

      + delete() + + +

      + + +

      Executes a DELETE request on server.

      + + + public + delete(string $endpoint[, array<string|int, mixed> $body = [] ][, array<string|int, mixed> $headers = [] ]) : ResponseInterface + +
      +
      + + +
      Parameters
      +
      +
      + $endpoint + : string +
      +
      +

      URI to make the request.

      +
      + +
      +
      + $body + : array<string|int, mixed> + = []
      +
      +

      The body content.

      +
      + +
      +
      + $headers + : array<string|int, mixed> + = []
      +
      +

      Additional headers to send on request.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException + + +
      +
      + + + +
      +
      Return values
      + ResponseInterface +
      + +
      +
      +

      + get() + + +

      + + +

      Executes a GET request on server.

      + + + public + get(string $endpoint[, array<string|int, mixed> $body = [] ][, array<string|int, mixed> $headers = [] ]) : ResponseInterface + +
      +
      + + +
      Parameters
      +
      +
      + $endpoint + : string +
      +
      +

      URI to make the request.

      +
      + +
      +
      + $body + : array<string|int, mixed> + = []
      +
      +

      The body content.

      +
      + +
      +
      + $headers + : array<string|int, mixed> + = []
      +
      +

      Additional headers to send on request.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException + + +
      +
      + + + +
      +
      Return values
      + ResponseInterface +
      + +
      +
      +

      + getBaseUri() + + +

      + + +

      Return the base endpoint URI.

      + + + public + getBaseUri() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      + +
      +

      + getDatabaseName() + + +

      + + +

      Return the name of database handled

      + + + public + getDatabaseName() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + getDefaultHeaders() + + +

      + + +

      Return the connection default headers.

      + + + public + getDefaultHeaders() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + getUsername() + + +

      + + +

      Returns the name of user on server

      + + + public + getUsername() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + isAuthenticated() + + +

      + + +

      If connection is authenticated.

      + + + public + isAuthenticated() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool + — +

      True if connection already authenticate, false otherwise.

      +
      + +
      + +
      +
      +

      + patch() + + +

      + + +

      Executes a PATCH request on server.

      + + + public + patch(string $endpoint[, array<string|int, mixed> $body = [] ][, array<string|int, mixed> $headers = [] ]) : ResponseInterface + +
      +
      + + +
      Parameters
      +
      +
      + $endpoint + : string +
      +
      +

      URI to make the request.

      +
      + +
      +
      + $body + : array<string|int, mixed> + = []
      +
      +

      The body content.

      +
      + +
      +
      + $headers + : array<string|int, mixed> + = []
      +
      +

      Additional headers to send on request.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException + + +
      +
      + + + +
      +
      Return values
      + ResponseInterface +
      + +
      +
      +

      + post() + + +

      + + +

      Executes a POST request on server.

      + + + public + post(string $endpoint[, array<string|int, mixed> $body = [] ][, array<string|int, mixed> $headers = [] ]) : ResponseInterface + +
      +
      + + +
      Parameters
      +
      +
      + $endpoint + : string +
      +
      +

      URI to make the request.

      +
      + +
      +
      + $body + : array<string|int, mixed> + = []
      +
      +

      The body content.

      +
      + +
      +
      + $headers + : array<string|int, mixed> + = []
      +
      +

      Additional headers to send on request.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException + + +
      +
      + + + +
      +
      Return values
      + ResponseInterface +
      + +
      +
      +

      + put() + + +

      + + +

      Executes a PUT request on server.

      + + + public + put(string $endpoint[, array<string|int, mixed> $body = [] ][, array<string|int, mixed> $headers = [] ]) : ResponseInterface + +
      +
      + + +
      Parameters
      +
      +
      + $endpoint + : string +
      +
      +

      URI to make the request.

      +
      + +
      +
      + $body + : array<string|int, mixed> + = []
      +
      +

      The body content.

      +
      + +
      +
      + $headers + : array<string|int, mixed> + = []
      +
      +

      Additional headers to send on request.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException + + +
      +
      + + + +
      +
      Return values
      + ResponseInterface +
      + +
      +
      +

      + setDefaultHeaders() + + +

      + + +

      Set the connection default headers.

      + + + public + setDefaultHeaders(array<string|int, mixed> $headers) : void + +
      +
      + + +
      Parameters
      +
      +
      + $headers + : array<string|int, mixed> +
      +
      +

      The default array to add on all requests.

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

      + authenticate() + + +

      + + +

      Authenticates a user on ArangoDB Server

      + + + protected + authenticate(array<string|int, mixed> $credentials) : void + +
      +
      + + +
      Parameters
      +
      +
      + $credentials + : array<string|int, mixed> +
      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + RequestException|AuthException|GuzzleException|ConnectionException + + +
      +
      + + + + +
      +
      +

      + getAuthorizationHeader() + + +

      + + +

      Return the authorization header

      + + + protected + getAuthorizationHeader() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      -
      @@ -423,10 +1784,43 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Connection-ManagesConnection.html b/docs/classes/ArangoDB-Connection-ManagesConnection.html index 68d8899..7fe7fdb 100644 --- a/docs/classes/ArangoDB-Connection-ManagesConnection.html +++ b/docs/classes/ArangoDB-Connection-ManagesConnection.html @@ -318,15 +318,192 @@

      +

      + Properties + +

      +
      +
      + $connection + +  : Connection +
      +
      Connection to access the server
      +
      + +

      + Methods + + +

      +
      +
      + getConnection() + +  : Connection +
      +
      Return the connection object
      + +
      + setConnection() + +  : void +
      +
      Sets a connection for class.
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $connection + + + + +

      + + +

      Connection to access the server

      + + + + protected + Connection + $connection + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      + +
      +

      + setConnection() + + +

      + + +

      Sets a connection for class.

      + + + public + setConnection(Connection $connection) : void + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to use.

      +
      + +
      +
      + + + + + + +
      +
      +
      @@ -432,10 +609,25 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Connection-ManagesConnectionInterface.html b/docs/classes/ArangoDB-Connection-ManagesConnectionInterface.html index 8b26992..adf8fa6 100644 --- a/docs/classes/ArangoDB-Connection-ManagesConnectionInterface.html +++ b/docs/classes/ArangoDB-Connection-ManagesConnectionInterface.html @@ -298,13 +298,127 @@

      +

      + Methods + +

      +
      +
      + getConnection() + +  : Connection +
      +
      Return the connection object
      + +
      + setConnection() + +  : void +
      +
      Set a connection object for the class
      + +
      - + +
      +

      + Methods + + +

      + +
      +

      + setConnection() + + +

      + + +

      Set a connection object for the class

      + + + public + setConnection(Connection $connection) : void + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      + +
      +
      + + + + + + +
      +
      +
      @@ -414,6 +528,13 @@

    • Methods
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Cursor-Base.html b/docs/classes/ArangoDB-Cursor-Base.html index e168edf..016033f 100644 --- a/docs/classes/ArangoDB-Cursor-Base.html +++ b/docs/classes/ArangoDB-Cursor-Base.html @@ -316,17 +316,1283 @@

      +

      + Constants + +

      +
      +
      + BASE_URL + +  = 'baseurl' +
      +
      Cursor baseUrl entry
      + +
      + CACHE + +  = 'cache' +
      +
      Cursor cache entry
      + +
      + CACHED + +  = 'cached' +
      +
      Cursor cached entry
      + +
      + COUNT + +  = 'count' +
      +
      Cursor count entry
      + +
      + EXTRA + +  = 'extra' +
      +
      Cursor extra entry
      + +
      + FULL_COUNT + +  = 'fullCount' +
      +
      Cursor fullCount entry
      + +
      + HAS_MORE + +  = 'hasMore' +
      +
      'hasMore' flag
      + +
      + ID + +  = 'id' +
      +
      Cursor ID entry
      + +
      + RESULT + +  = 'result' +
      +
      Cursor result entry
      + +
      + SANITIZE + +  = '_sanitize' +
      +
      Cursor sanitize option
      + +
      + STATS + +  = 'stats' +
      +
      Cursor stats entry
      + +
      + TYPE + +  = 'objectType' +
      +
      Cursor type entry
      + +
      + + +

      + Properties + + +

      +
      +
      + $cached + +  : bool +
      +
      If the result query was served from cached results
      + +
      + $connection + +  : Connection +
      +
      Connection object
      + +
      + $count + +  : int +
      +
      Number of documents in cursor,
      + +
      + $data + +  : ArrayList +
      +
      Result data
      + +
      + $extra + +  : array<string|int, mixed> +
      +
      Extra data (stats)
      + +
      + $fetches + +  : int +
      +
      Number of HTTP calls made to build the cursor
      + +
      + $fullCount + +  : int +
      +
      Full cont of the result set
      + +
      + $hasMore + +  : bool +
      +
      'hasMore' indicator
      + +
      + $id + +  : mixed +
      +
      Cursor id
      + +
      + $length + +  : int +
      +
      Total length of current set
      + +
      + $options + +  : array<string|int, mixed> +
      +
      Cursor Options
      + +
      + $position + +  : int +
      +
      Current position
      + +
      + $result + +  : ArrayList +
      +
      Result set
      + +
      + +

      + Methods + + +

      +
      +
      + getId() + +  : mixed +
      +
      Returns the cursor ID
      + +
      + isCached() + +  : bool +
      +
      Return if the Cursor has cached results on server
      + +
      + fetch() + +  : void +
      +
      Fetch more results from the server
      + +
      + + + + +
      +

      + Constants + + +

      +
      +

      + BASE_URL + + +

      + + + +

      Cursor baseUrl entry

      + + + + protected + mixed + BASE_URL + = 'baseurl' + + + + + + + + + +
      +
      +

      + CACHE + + +

      + + + +

      Cursor cache entry

      + + + + protected + mixed + CACHE + = 'cache' + + + + + + + + + +
      +
      +

      + CACHED + + +

      + + + +

      Cursor cached entry

      + + + + protected + mixed + CACHED + = 'cached' + + + + + + + + + +
      +
      +

      + COUNT + + +

      + + + +

      Cursor count entry

      + + + + protected + mixed + COUNT + = 'count' + + + + + + + + + +
      +
      +

      + EXTRA + + +

      + + + +

      Cursor extra entry

      + + + + protected + mixed + EXTRA + = 'extra' + + + + + + + + + +
      +
      +

      + FULL_COUNT + + +

      + + + +

      Cursor fullCount entry

      + + + + protected + mixed + FULL_COUNT + = 'fullCount' + + + + + + + + + +
      +
      +

      + HAS_MORE + + +

      + + + +

      'hasMore' flag

      + + + + protected + mixed + HAS_MORE + = 'hasMore' + + + + + + + + + +
      +
      +

      + ID + + +

      + + + +

      Cursor ID entry

      + + + + protected + mixed + ID + = 'id' + + + + + + + + + +
      +
      +

      + RESULT + + +

      + + + +

      Cursor result entry

      + + + + protected + mixed + RESULT + = 'result' + + + + + + + + + +
      +
      +

      + SANITIZE + + +

      + + + +

      Cursor sanitize option

      + + + + protected + mixed + SANITIZE + = '_sanitize' + + + + + + + + + +
      +
      +

      + STATS + + +

      + + + +

      Cursor stats entry

      + + + + protected + mixed + STATS + = 'stats' + + + + + + + + + +
      +
      +

      + TYPE + + +

      + + + +

      Cursor type entry

      + + + + protected + mixed + TYPE + = 'objectType' + + + + + + + + + +
      +
      + + +
      +

      + Properties + + +

      +
      +

      + $cached + + + + +

      + + +

      If the result query was served from cached results

      + + + + protected + bool + $cached + = false + + + + + + + + + +
      +
      +

      + $connection + + + + +

      + + +

      Connection object

      + + + + protected + Connection + $connection + + + + + + + + + +
      +
      +

      + $count + + + +

      + +

      Number of documents in cursor,

      - + + + protected + int + $count + - + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Result data

      + + + + protected + ArrayList + $data + + + + + + + + + + +
      +
      +

      + $extra + + + + +

      + + +

      Extra data (stats)

      + + + + protected + array<string|int, mixed> + $extra + + + + + + + + + + +
      +
      +

      + $fetches + + + + +

      + + +

      Number of HTTP calls made to build the cursor

      + + + + protected + int + $fetches + = 0 + + + + + + + + + +
      +
      +

      + $fullCount + + + + +

      + + +

      Full cont of the result set

      + + + + protected + int + $fullCount + + + + + + + + + + +
      +
      +

      + $hasMore + + + + +

      + + +

      'hasMore' indicator

      + + + + protected + bool + $hasMore + + + + + + + + + + +
      +
      +

      + $id + + + + +

      + + +

      Cursor id

      + + + + protected + mixed + $id + + + + + + + + + + +
      +
      +

      + $length + + + + +

      + + +

      Total length of current set

      + + + + protected + int + $length + + + + + + + + + + +
      +
      +

      + $options + + + + +

      + + +

      Cursor Options

      + + + + protected + array<string|int, mixed> + $options + + + + + + + + + + +
      +
      +

      + $position + + + + +

      + + +

      Current position

      + + + + protected + int + $position + = 0 + + + + + + + + + +
      +
      +

      + $result + + + + +

      + + +

      Result set

      + + + + protected + ArrayList + $result + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + getId() + + +

      + + +

      Returns the cursor ID

      + + + public + getId() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + isCached() + + +

      + + +

      Return if the Cursor has cached results on server

      + + + public + isCached() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + fetch() + + +

      + + +

      Fetch more results from the server

      + + + protected + abstract fetch() : void + +
      +
      + + + + + + + + +
      +
      -
      @@ -432,10 +1698,56 @@

    • Table Of Contents
      • -
      +
    • Constants
    • +
    • Properties
    • +
    • Methods
    • + +
    • Constants
    • +
    • + +
    • +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Cursor-CollectionCursor.html b/docs/classes/ArangoDB-Cursor-CollectionCursor.html index 6f16c8e..aa2fcc6 100644 --- a/docs/classes/ArangoDB-Cursor-CollectionCursor.html +++ b/docs/classes/ArangoDB-Cursor-CollectionCursor.html @@ -307,17 +307,2145 @@

      +

      + Constants + +

      +
      +
      + BASE_URL + +  = 'baseurl' +
      +
      Cursor baseUrl entry
      + +
      + CACHE + +  = 'cache' +
      +
      Cursor cache entry
      + +
      + CACHED + +  = 'cached' +
      +
      Cursor cached entry
      + +
      + COUNT + +  = 'count' +
      +
      Cursor count entry
      + +
      + EXTRA + +  = 'extra' +
      +
      Cursor extra entry
      + +
      + FULL_COUNT + +  = 'fullCount' +
      +
      Cursor fullCount entry
      + +
      + HAS_MORE + +  = 'hasMore' +
      +
      'hasMore' flag
      + +
      + ID + +  = 'id' +
      +
      Cursor ID entry
      + +
      + RESULT + +  = 'result' +
      +
      Cursor result entry
      + +
      + SANITIZE + +  = '_sanitize' +
      +
      Cursor sanitize option
      + +
      + STATS + +  = 'stats' +
      +
      Cursor stats entry
      + +
      + TYPE + +  = 'objectType' +
      +
      Cursor type entry
      + +
      + + +

      + Properties + + +

      +
      +
      + $cached + +  : bool +
      +
      If the result query was served from cached results
      + +
      + $collection + +  : Collection +
      +
      Collection object
      + +
      + $connection + +  : Connection +
      +
      Connection object
      + +
      + $count + +  : int +
      +
      Number of documents in cursor,
      + +
      + $data + +  : ArrayList +
      +
      Result data
      + +
      + $defaultOptions + +  : array<string|int, mixed> +
      +
      Default options query for the cursor.<br> +<b>count</b>, <b>batchSize</b> and <b>options</b> are, by default, leaved for the server defaults.
      + +
      + $extra + +  : array<string|int, mixed> +
      +
      Extra data (stats)
      + +
      + $fetches + +  : int +
      +
      Number of HTTP calls made to build the cursor
      + +
      + $fullCount + +  : int +
      +
      Full cont of the result set
      + +
      + $hasMore + +  : bool +
      +
      'hasMore' indicator
      + +
      + $id + +  : mixed +
      +
      Cursor id
      + +
      + $length + +  : int +
      +
      Total length of current set
      + +
      + $options + +  : array<string|int, mixed> +
      +
      Cursor Options
      + +
      + $position + +  : int +
      +
      Current position
      + +
      + $result + +  : ArrayList +
      +
      Result set
      + +
      + $statement + +  : StatementInterface +
      +
      Statement to execute.
      + +
      + $uri + +  : string +
      +
      URI to manage the cursor.
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      CollectionCursor constructor.
      + +
      + __toString() + +  : string +
      +
      Return a string representation of document.
      + +
      + count() + +  : int +
      + +
      + current() + +  : Document|mixed +
      +
      Return the current element.
      + +
      + delete() + +  : bool +
      +
      Deletes the cursor and frees the resources associated with it.
      + +
      + fetch() + +  : void +
      +
      Fetch more results from the server.
      + +
      + getId() + +  : mixed +
      +
      Returns the cursor ID
      + +
      + isCached() + +  : bool +
      +
      Return if the Cursor has cached results on server
      + +
      + key() + +  : mixed +
      +
      Return the key of the current element.
      + +
      + next() + +  : void +
      +
      Move forward to next element.
      + +
      + rewind() + +  : void +
      +
      Rewind the Iterator to the first element.
      + +
      + valid() + +  : bool +
      +
      Checks if current position is valid.
      + +
      + appendResults() + +  : void +
      +
      Append the results.
      + +
      + create() + +  : void +
      +
      Create/initialize the cursor.
      + +
      + getBody() + +  : array<string|int, mixed> +
      +
      Return body for creating cursor.
      + +
      + + + + +
      +

      + Constants + + +

      +
      +

      + BASE_URL + + +

      + + + +

      Cursor baseUrl entry

      + + + + protected + mixed + BASE_URL + = 'baseurl' + + + + + + + + + +
      +
      +

      + CACHE + + +

      + + + +

      Cursor cache entry

      + + + + protected + mixed + CACHE + = 'cache' + + + + + + + + + +
      +
      +

      + CACHED + + +

      + + + +

      Cursor cached entry

      + + + + protected + mixed + CACHED + = 'cached' + + + + + + + + + +
      +
      +

      + COUNT + + +

      + + + +

      Cursor count entry

      + + + + protected + mixed + COUNT + = 'count' + + + + + + + + + +
      +
      +

      + EXTRA + + +

      + + + +

      Cursor extra entry

      + + + + protected + mixed + EXTRA + = 'extra' + + + + + + + + + +
      +
      +

      + FULL_COUNT + + +

      + + + +

      Cursor fullCount entry

      + + + + protected + mixed + FULL_COUNT + = 'fullCount' + + + + + + + + + +
      +
      +

      + HAS_MORE + + +

      + + + +

      'hasMore' flag

      + + + + protected + mixed + HAS_MORE + = 'hasMore' + + + + + + + + + +
      +
      +

      + ID + + +

      + + + +

      Cursor ID entry

      + + + + protected + mixed + ID + = 'id' + + + + + + + + + +
      +
      +

      + RESULT + + +

      + + + +

      Cursor result entry

      + + + + protected + mixed + RESULT + = 'result' + + + + + + + + + +
      +
      +

      + SANITIZE + + +

      + + + +

      Cursor sanitize option

      + + + + protected + mixed + SANITIZE + = '_sanitize' + + + + + + + + + +
      +
      +

      + STATS + + +

      + + + +

      Cursor stats entry

      + + + + protected + mixed + STATS + = 'stats' + + + + + + + + + +
      +
      +

      + TYPE + + +

      + + + +

      Cursor type entry

      + + + + protected + mixed + TYPE + = 'objectType' + + + + + + + + + +
      +
      + + +
      +

      + Properties + + +

      +
      +

      + $cached + + + + +

      + + +

      If the result query was served from cached results

      + + + + protected + bool + $cached + = false + + + + + + + + + +
      +
      +

      + $collection + + + + +

      + + +

      Collection object

      + + + + protected + Collection + $collection + + + + + + + + + + +
      +
      +

      + $connection + + + + +

      + + +

      Connection object

      + + + + protected + Connection + $connection + + + + + + + + + + +
      +
      +

      + $count + + + + +

      + + +

      Number of documents in cursor,

      + + + + protected + int + $count + + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Result data

      + + + + protected + ArrayList + $data + + + + + + + + + + +
      +
      +

      + $defaultOptions + + + + +

      + + +

      Default options query for the cursor.<br> +<b>count</b>, <b>batchSize</b> and <b>options</b> are, by default, leaved for the server defaults.

      + + + + protected + array<string|int, mixed> + $defaultOptions + = ['cache' => true, 'memoryLimit' => 0, 'ttl' => 60] + + + + + + + + + +
      +
      +

      + $extra + + + + +

      + + +

      Extra data (stats)

      + + + + protected + array<string|int, mixed> + $extra + + + + + + + + + + +
      +
      +

      + $fetches + + + + +

      + + +

      Number of HTTP calls made to build the cursor

      + + + + protected + int + $fetches + = 0 + + + + + + + + + +
      +
      +

      + $fullCount + + + + +

      + + +

      Full cont of the result set

      + + + + protected + int + $fullCount + + + + + + + + + + +
      +
      +

      + $hasMore + + + + +

      + + +

      'hasMore' indicator

      + + + + protected + bool + $hasMore + + + + + + + + + + +
      +
      +

      + $id + + + + +

      + + +

      Cursor id

      + + + + protected + mixed + $id + + + + + + + + + + +
      +
      +

      + $length + + + + +

      + + +

      Total length of current set

      + + + + protected + int + $length + + + + + + + + + + +
      +
      +

      + $options + + + + +

      + + +

      Cursor Options

      + + + + protected + array<string|int, mixed> + $options + + + + + + + + + + +
      +
      +

      + $position + + + + +

      + + +

      Current position

      + + + + protected + int + $position + = 0 + + + + + + + + + +
      +
      +

      + $result + + + + +

      + + +

      Result set

      + + + + protected + ArrayList + $result + + + + + + + + + + +
      +
      +

      + $statement + + + + +

      + + +

      Statement to execute.

      + + + + protected + StatementInterface + $statement + + + + + + + + + + +
      +
      +

      + $uri + + + + +

      + + +

      URI to manage the cursor.

      + + + + protected + string + $uri + = \ArangoDB\Http\Api::CURSOR + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      + +
      +

      + __toString() + + +

      + + +

      Return a string representation of document.

      + + + public + __toString() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + count() + + +

      + + + + + public + count() : int + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + inheritDoc +
      +
      + + +
      +
      + + +
      +
      Return values
      + int +
      +
      + +
      +

      + delete() + + +

      + + +

      Deletes the cursor and frees the resources associated with it.

      + + + public + delete() : bool + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException + + +
      +
      + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + fetch() + + +

      + + +

      Fetch more results from the server.

      + + + public + fetch() : void + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException + + +
      +
      + + + + +
      +
      +

      + getId() + + +

      + + +

      Returns the cursor ID

      + + + public + getId() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + isCached() + + +

      + + +

      Return if the Cursor has cached results on server

      + + + public + isCached() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + key() + + +

      + + +

      Return the key of the current element.

      + + + public + key() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + next() + + +

      + + +

      Move forward to next element.

      + + + public + next() : void + +
      +
      + + + + + + + + +
      +
      +

      + rewind() + + +

      + + +

      Rewind the Iterator to the first element.

      + + + public + rewind() : void + +
      +
      + + + + + + + + +
      +
      +

      + valid() + + +

      + + +

      Checks if current position is valid.

      + + + public + valid() : bool + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException + + +
      +
      + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + appendResults() + + +

      + + +

      Append the results.

      + + + protected + appendResults(array<string|int, mixed> $results) : void + +
      +
      + + +
      Parameters
      +
      +
      + $results + : array<string|int, mixed> +
      +
      + +
      +
      + + + + + + +
      +
      +

      + create() + + +

      + + +

      Create/initialize the cursor.

      + + + protected + create() : void + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException|GuzzleException + + +
      +
      + + + + +
      +
      +

      + getBody() + + +

      + + +

      Return body for creating cursor.

      + + + protected + getBody() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      -
      @@ -423,10 +2551,72 @@

    • Table Of Contents
      • -
      +
    • Constants
    • +
    • Properties
    • +
    • Methods
    • + +
    • Constants
    • +
    • + +
    • +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Cursor-Contracts-CursorInterface.html b/docs/classes/ArangoDB-Cursor-Contracts-CursorInterface.html index 3e5c19f..9f94145 100644 --- a/docs/classes/ArangoDB-Cursor-Contracts-CursorInterface.html +++ b/docs/classes/ArangoDB-Cursor-Contracts-CursorInterface.html @@ -303,13 +303,74 @@

      +

      + Methods + +

      +
      +
      + delete() + +  : bool +
      +
      Deletes the cursor and frees the resources associated with it.
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + delete() + + +

      + + +

      Deletes the cursor and frees the resources associated with it.

      + + + public + delete() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +
      @@ -419,6 +480,12 @@

    • Methods
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Cursor-Cursor.html b/docs/classes/ArangoDB-Cursor-Cursor.html index d2f22ae..4ec5683 100644 --- a/docs/classes/ArangoDB-Cursor-Cursor.html +++ b/docs/classes/ArangoDB-Cursor-Cursor.html @@ -307,17 +307,2089 @@

      +

      + Constants + +

      +
      +
      + BASE_URL + +  = 'baseurl' +
      +
      Cursor baseUrl entry
      + +
      + CACHE + +  = 'cache' +
      +
      Cursor cache entry
      + +
      + CACHED + +  = 'cached' +
      +
      Cursor cached entry
      + +
      + COUNT + +  = 'count' +
      +
      Cursor count entry
      + +
      + EXTRA + +  = 'extra' +
      +
      Cursor extra entry
      + +
      + FULL_COUNT + +  = 'fullCount' +
      +
      Cursor fullCount entry
      + +
      + HAS_MORE + +  = 'hasMore' +
      +
      'hasMore' flag
      + +
      + ID + +  = 'id' +
      +
      Cursor ID entry
      + +
      + RESULT + +  = 'result' +
      +
      Cursor result entry
      + +
      + SANITIZE + +  = '_sanitize' +
      +
      Cursor sanitize option
      + +
      + STATS + +  = 'stats' +
      +
      Cursor stats entry
      + +
      + TYPE + +  = 'objectType' +
      +
      Cursor type entry
      + +
      + + +

      + Properties + + +

      +
      +
      + $cached + +  : bool +
      +
      If the result query was served from cached results
      + +
      + $connection + +  : Connection +
      +
      Connection object
      + +
      + $count + +  : int +
      +
      Number of documents in cursor,
      + +
      + $data + +  : ArrayList +
      +
      Result data
      + +
      + $defaultOptions + +  : array<string|int, mixed> +
      +
      Default options query for the cursor.<br> +<b>count</b>, <b>batchSize</b> and <b>options</b> are, by default, leaved for the server defaults.
      + +
      + $extra + +  : array<string|int, mixed> +
      +
      Extra data (stats)
      + +
      + $fetches + +  : int +
      +
      Number of HTTP calls made to build the cursor
      + +
      + $fullCount + +  : int +
      +
      Full cont of the result set
      + +
      + $hasMore + +  : bool +
      +
      'hasMore' indicator
      + +
      + $id + +  : mixed +
      +
      Cursor id
      + +
      + $length + +  : int +
      +
      Total length of current set
      + +
      + $options + +  : array<string|int, mixed> +
      +
      Cursor Options
      + +
      + $position + +  : int +
      +
      Current position
      + +
      + $result + +  : ArrayList +
      +
      Result set
      + +
      + $statement + +  : StatementInterface +
      +
      Statement to execute.
      + +
      + $uri + +  : string +
      +
      URI to manage the cursor.
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Cursor constructor.
      + +
      + __toString() + +  : string +
      +
      Return a string representation of document.
      + +
      + count() + +  : int +
      + +
      + current() + +  : mixed +
      +
      Return the current element.
      + +
      + delete() + +  : bool +
      +
      Deletes the cursor and frees the resources associated with it.
      + +
      + fetch() + +  : void +
      +
      Fetch more results from the server.
      + +
      + getId() + +  : mixed +
      +
      Returns the cursor ID
      + +
      + isCached() + +  : bool +
      +
      Return if the Cursor has cached results on server
      + +
      + key() + +  : mixed +
      +
      Return the key of the current element.
      + +
      + next() + +  : void +
      +
      Move forward to next element.
      + +
      + rewind() + +  : void +
      +
      Rewind the Iterator to the first element.
      + +
      + valid() + +  : bool +
      +
      Checks if current position is valid.
      + +
      + appendResults() + +  : void +
      +
      Append the results.
      + +
      + create() + +  : void +
      +
      Create/initialize the cursor.
      + +
      + getBody() + +  : array<string|int, mixed> +
      +
      Return body for creating cursor.
      + +
      + + + + +
      +

      + Constants + + +

      +
      +

      + BASE_URL + + +

      + + + +

      Cursor baseUrl entry

      + + + + protected + mixed + BASE_URL + = 'baseurl' + + + + + + + + + +
      +
      +

      + CACHE + + +

      + + + +

      Cursor cache entry

      + + + + protected + mixed + CACHE + = 'cache' + + + + + + + + + +
      +
      +

      + CACHED + + +

      + + + +

      Cursor cached entry

      + + + + protected + mixed + CACHED + = 'cached' + + + + + + + + + +
      +
      +

      + COUNT + + +

      + + + +

      Cursor count entry

      + + + + protected + mixed + COUNT + = 'count' + + + + + + + + + +
      +
      +

      + EXTRA + + +

      + + + +

      Cursor extra entry

      + + + + protected + mixed + EXTRA + = 'extra' + + + + + + + + + +
      +
      +

      + FULL_COUNT + + +

      + + + +

      Cursor fullCount entry

      + + + + protected + mixed + FULL_COUNT + = 'fullCount' + + + + + + + + + +
      +
      +

      + HAS_MORE + + +

      + + + +

      'hasMore' flag

      + + + + protected + mixed + HAS_MORE + = 'hasMore' + + + + + + + + + +
      +
      +

      + ID + + +

      + + + +

      Cursor ID entry

      + + + + protected + mixed + ID + = 'id' + + + + + + + + + +
      +
      +

      + RESULT + + +

      + + + +

      Cursor result entry

      + + + + protected + mixed + RESULT + = 'result' + + + + + + + + + +
      +
      +

      + SANITIZE + + +

      + + + +

      Cursor sanitize option

      + + + + protected + mixed + SANITIZE + = '_sanitize' + + + + + + + + + +
      +
      +

      + STATS + + +

      + + + +

      Cursor stats entry

      + + + + protected + mixed + STATS + = 'stats' + + + + + + + + + +
      +
      +

      + TYPE + + +

      + + + +

      Cursor type entry

      + + + + protected + mixed + TYPE + = 'objectType' + + + + + + + + + +
      +
      + + +
      +

      + Properties + + +

      +
      +

      + $cached + + + + +

      + + +

      If the result query was served from cached results

      + + + + protected + bool + $cached + = false + + + + + + + + + +
      +
      +

      + $connection + + + + +

      + + +

      Connection object

      + + + + protected + Connection + $connection + + + + + + + + + + +
      +
      +

      + $count + + + + +

      + + +

      Number of documents in cursor,

      + + + + protected + int + $count + + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Result data

      + + + + protected + ArrayList + $data + + + + + + + + + + +
      +
      +

      + $defaultOptions + + + + +

      + + +

      Default options query for the cursor.<br> +<b>count</b>, <b>batchSize</b> and <b>options</b> are, by default, leaved for the server defaults.

      + + + + protected + array<string|int, mixed> + $defaultOptions + = ['cache' => true, 'memoryLimit' => 0, 'ttl' => 60] + + + + + + + + + +
      +
      +

      + $extra + + + + +

      + + +

      Extra data (stats)

      + + + + protected + array<string|int, mixed> + $extra + + + + + + + + + + +
      +
      +

      + $fetches + + + + +

      + + +

      Number of HTTP calls made to build the cursor

      + + + + protected + int + $fetches + = 0 + + + + + + + + + +
      +
      +

      + $fullCount + + + + +

      + + +

      Full cont of the result set

      + + + + protected + int + $fullCount + + + + + + + + + + +
      +
      +

      + $hasMore + + + + +

      + + +

      'hasMore' indicator

      + + + + protected + bool + $hasMore + + + + + + + + + + +
      +
      +

      + $id + + + + +

      + + +

      Cursor id

      + + + + protected + mixed + $id + + + + + + + + + + +
      +
      +

      + $length + + + + +

      + + +

      Total length of current set

      + + + + protected + int + $length + + + + + + + + + + +
      +
      +

      + $options + + + + +

      + + +

      Cursor Options

      + + + + protected + array<string|int, mixed> + $options + + + + + + + + + + +
      +
      +

      + $position + + + + +

      + + +

      Current position

      + + + + protected + int + $position + = 0 + + + + + + + + + +
      +
      +

      + $result + + + + +

      + + +

      Result set

      + + + + protected + ArrayList + $result + + + + + + + + + + +
      +
      +

      + $statement + + + + +

      + + +

      Statement to execute.

      + + + + protected + StatementInterface + $statement + + + + + + + + + + +
      +
      +

      + $uri + + + + +

      + + +

      URI to manage the cursor.

      + + + + protected + string + $uri + = \ArangoDB\Http\Api::CURSOR + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Cursor constructor.

      + + + public + __construct(Connection $connection, StatementInterface $statement[, array<string|int, mixed> $options = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to use.

      +
      + +
      +
      + $statement + : StatementInterface +
      +
      +

      Statement to perform on server.

      +
      + +
      +
      + $options + : array<string|int, mixed> + = []
      +
      +

      Options for cursor.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException|GuzzleException + + +
      +
      + + + + +
      +
      +

      + __toString() + + +

      + + +

      Return a string representation of document.

      + + + public + __toString() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + count() + + +

      + + + + + public + count() : int + +
      +
      + + + + +
      + Tags + +
      +
      +
      + inheritDoc +
      +
      + + +
      +
      + +
      +
      Return values
      + int +
      +
      +
      +

      + current() + - +

      + + +

      Return the current element.

      + + + public + current() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + delete() + + +

      + + +

      Deletes the cursor and frees the resources associated with it.

      + + + public + delete() : bool + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException + + +
      +
      + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + fetch() + + +

      + + +

      Fetch more results from the server.

      + + + public + fetch() : void + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException + + +
      +
      + + + + +
      +
      +

      + getId() + + +

      + + +

      Returns the cursor ID

      + + + public + getId() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + isCached() + + +

      + + +

      Return if the Cursor has cached results on server

      + + + public + isCached() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + key() + + +

      + + +

      Return the key of the current element.

      + + + public + key() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + next() + + +

      + + +

      Move forward to next element.

      + + + public + next() : void + +
      +
      + + + + + + + + +
      +
      +

      + rewind() + + +

      + + +

      Rewind the Iterator to the first element.

      + + + public + rewind() : void + +
      +
      + + + + + + + + +
      +
      +

      + valid() + + +

      + + +

      Checks if current position is valid.

      + + + public + valid() : bool + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException + + +
      +
      + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + appendResults() + + +

      + + +

      Append the results.

      + + + protected + appendResults(array<string|int, mixed> $results) : void + +
      +
      + + +
      Parameters
      +
      +
      + $results + : array<string|int, mixed> +
      +
      + +
      +
      + + + + + + +
      +
      +

      + create() + + +

      + + +

      Create/initialize the cursor.

      + + + protected + create() : void + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException|GuzzleException + + +
      +
      + + + + +
      +
      +

      + getBody() + + +

      + + +

      Return body for creating cursor.

      + + + protected + getBody() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      -
      @@ -423,10 +2495,71 @@

    • Table Of Contents
      • -
      +
    • Constants
    • +
    • Properties
    • +
    • Methods
    • + +
    • Constants
    • +
    • + +
    • +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Cursor-Exceptions-CursorException.html b/docs/classes/ArangoDB-Cursor-Exceptions-CursorException.html index c9ad114..418e9b5 100644 --- a/docs/classes/ArangoDB-Cursor-Exceptions-CursorException.html +++ b/docs/classes/ArangoDB-Cursor-Exceptions-CursorException.html @@ -312,14 +312,101 @@

      +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      Base exception constructor.
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Base exception constructor.

      + + + public + __construct(string $message[, Throwable|null $previous = null ][, int $code = 0 ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $message + : string +
      +
      +

      Exception message.

      +
      + +
      +
      + $previous + : Throwable|null + = null
      +
      +

      Previous exception or error.

      +
      + +
      +
      + $code + : int + = 0
      +
      +

      Error code.

      +
      + +
      +
      + + + + + + +
      +
      +
      @@ -425,10 +512,17 @@

    • Table Of Contents
      • -
      +
    • Methods
    • + +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Cursor-TraversalCursor.html b/docs/classes/ArangoDB-Cursor-TraversalCursor.html index 40a270e..fd173aa 100644 --- a/docs/classes/ArangoDB-Cursor-TraversalCursor.html +++ b/docs/classes/ArangoDB-Cursor-TraversalCursor.html @@ -307,17 +307,2114 @@

      +

      + Constants + +

      +
      +
      + BASE_URL + +  = 'baseurl' +
      +
      Cursor baseUrl entry
      + +
      + CACHE + +  = 'cache' +
      +
      Cursor cache entry
      + +
      + CACHED + +  = 'cached' +
      +
      Cursor cached entry
      + +
      + COUNT + +  = 'count' +
      +
      Cursor count entry
      + +
      + EXTRA + +  = 'extra' +
      +
      Cursor extra entry
      + +
      + FULL_COUNT + +  = 'fullCount' +
      +
      Cursor fullCount entry
      + +
      + HAS_MORE + +  = 'hasMore' +
      +
      'hasMore' flag
      + +
      + ID + +  = 'id' +
      +
      Cursor ID entry
      + +
      + RESULT + +  = 'result' +
      +
      Cursor result entry
      + +
      + SANITIZE + +  = '_sanitize' +
      +
      Cursor sanitize option
      + +
      + STATS + +  = 'stats' +
      +
      Cursor stats entry
      + +
      + TYPE + +  = 'objectType' +
      +
      Cursor type entry
      + +
      + + +

      + Properties + + +

      +
      +
      + $cached + +  : bool +
      +
      If the result query was served from cached results
      + +
      + $connection + +  : Connection +
      +
      Connection object
      + +
      + $count + +  : int +
      +
      Number of documents in cursor,
      + +
      + $data + +  : ArrayList +
      +
      Result data
      + +
      + $defaultOptions + +  : array<string|int, mixed> +
      +
      Default options query for the cursor.<br> +<b>count</b>, <b>batchSize</b> and <b>options</b> are, by default, leaved for the server defaults.
      + +
      + $extra + +  : array<string|int, mixed> +
      +
      Extra data (stats)
      + +
      + $fetches + +  : int +
      +
      Number of HTTP calls made to build the cursor
      + +
      + $fullCount + +  : int +
      +
      Full cont of the result set
      + +
      + $hasMore + +  : bool +
      +
      'hasMore' indicator
      + +
      + $id + +  : mixed +
      +
      Cursor id
      + +
      + $length + +  : int +
      +
      Total length of current set
      + +
      + $options + +  : array<string|int, mixed> +
      +
      Cursor Options
      + +
      + $position + +  : int +
      +
      Current position
      + +
      + $result + +  : ArrayList +
      +
      Result set
      + +
      + $statement + +  : StatementInterface +
      +
      Statement to execute.
      + +
      + $uri + +  : string +
      +
      URI to manage the cursor.
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Cursor constructor.
      + +
      + __toString() + +  : string +
      +
      Return a string representation of document.
      + +
      + count() + +  : int +
      + +
      + current() + +  : Edge|Vertex|Path +
      +
      May return a path, a edge or a vertex. This is defined on statement.
      + +
      + delete() + +  : bool +
      +
      Deletes the cursor and frees the resources associated with it.
      + +
      + fetch() + +  : void +
      +
      Fetch more results from the server.
      + +
      + getId() + +  : mixed +
      +
      Returns the cursor ID
      + +
      + isCached() + +  : bool +
      +
      Return if the Cursor has cached results on server
      + +
      + key() + +  : mixed +
      +
      Return the key of the current element.
      + +
      + next() + +  : void +
      +
      Move forward to next element.
      + +
      + rewind() + +  : void +
      +
      Rewind the Iterator to the first element.
      + +
      + valid() + +  : bool +
      +
      Checks if current position is valid.
      + +
      + appendResults() + +  : void +
      +
      Append the results.
      + +
      + create() + +  : void +
      +
      Create/initialize the cursor.
      + +
      + getBody() + +  : array<string|int, mixed> +
      +
      Return body for creating cursor.
      + +
      + + + + +
      +

      + Constants + + +

      +
      +

      + BASE_URL + + +

      + + + +

      Cursor baseUrl entry

      + + + + protected + mixed + BASE_URL + = 'baseurl' + + + + + + + + + +
      +
      +

      + CACHE + + +

      + + + +

      Cursor cache entry

      + + + + protected + mixed + CACHE + = 'cache' + + + + + + + + + +
      +
      +

      + CACHED + + +

      + + + +

      Cursor cached entry

      + + + + protected + mixed + CACHED + = 'cached' + + + + + + + + + +
      +
      +

      + COUNT + + +

      + + + +

      Cursor count entry

      + + + + protected + mixed + COUNT + = 'count' + + + + + + + + + +
      +
      +

      + EXTRA + + +

      + + + +

      Cursor extra entry

      + + + + protected + mixed + EXTRA + = 'extra' + + + + + + + + + +
      +
      +

      + FULL_COUNT + + +

      + + + +

      Cursor fullCount entry

      + + + + protected + mixed + FULL_COUNT + = 'fullCount' + + + + + + + + + +
      +
      +

      + HAS_MORE + + +

      + + + +

      'hasMore' flag

      + + + + protected + mixed + HAS_MORE + = 'hasMore' + + + + + + + + + +
      +
      +

      + ID + + +

      + + + +

      Cursor ID entry

      + + + + protected + mixed + ID + = 'id' + + + + + + + + + +
      +
      +

      + RESULT + + +

      + + + +

      Cursor result entry

      + + + + protected + mixed + RESULT + = 'result' + + + + + + + + + +
      +
      +

      + SANITIZE + + +

      + + + +

      Cursor sanitize option

      + + + + protected + mixed + SANITIZE + = '_sanitize' + + + + + + + + + +
      +
      +

      + STATS + + +

      + + + +

      Cursor stats entry

      + + + + protected + mixed + STATS + = 'stats' + + + + + + + + + +
      +
      +

      + TYPE + + +

      + + + +

      Cursor type entry

      + + + + protected + mixed + TYPE + = 'objectType' + + + + + + + + + +
      +
      + + +
      +

      + Properties + + +

      +
      +

      + $cached + + + + +

      + + +

      If the result query was served from cached results

      + + + + protected + bool + $cached + = false + + + + + + + + + +
      +
      +

      + $connection + + + + +

      + + +

      Connection object

      + + + + protected + Connection + $connection + + + + + + + + + + +
      +
      +

      + $count + + + + +

      + + +

      Number of documents in cursor,

      + + + + protected + int + $count + + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Result data

      + + + + protected + ArrayList + $data + + + + + + + + + + +
      +
      +

      + $defaultOptions + + + + +

      + + +

      Default options query for the cursor.<br> +<b>count</b>, <b>batchSize</b> and <b>options</b> are, by default, leaved for the server defaults.

      + + + + protected + array<string|int, mixed> + $defaultOptions + = ['cache' => true, 'memoryLimit' => 0, 'ttl' => 60] + + + + + + + + + +
      +
      +

      + $extra + + + + +

      + + +

      Extra data (stats)

      + + + + protected + array<string|int, mixed> + $extra + + + + + + + + + + +
      +
      +

      + $fetches + + + + +

      + + +

      Number of HTTP calls made to build the cursor

      + + + + protected + int + $fetches + = 0 + + + + + + + + + +
      +
      +

      + $fullCount + + + + +

      + + +

      Full cont of the result set

      + + + + protected + int + $fullCount + + + + + + + + + + +
      +
      +

      + $hasMore + + + + +

      + + +

      'hasMore' indicator

      + + + + protected + bool + $hasMore + + + + + + + + + + +
      +
      +

      + $id + + + + +

      + + +

      Cursor id

      + + + + protected + mixed + $id + + + + + + + + + + +
      +
      +

      + $length + + + + +

      + + +

      Total length of current set

      + + + + protected + int + $length + + + + + + + + + + +
      +
      +

      + $options + + + + +

      + + +

      Cursor Options

      + + + + protected + array<string|int, mixed> + $options + + + + + + + + + + +
      +
      +

      + $position + + + + +

      + + +

      Current position

      + + + + protected + int + $position + = 0 + + + + + + + + + +
      +
      +

      + $result + + + + +

      + + +

      Result set

      + + + + protected + ArrayList + $result + + + + + + + + + + +
      +
      +

      + $statement + + + + +

      + + +

      Statement to execute.

      + + + + protected + StatementInterface + $statement + + + + + + + + + + +
      +
      +

      + $uri + + + + +

      + + +

      URI to manage the cursor.

      + + + + protected + string + $uri + = \ArangoDB\Http\Api::CURSOR + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Cursor constructor.

      + + + public + __construct(Connection $connection, StatementInterface $statement[, array<string|int, mixed> $options = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to use.

      +
      + +
      +
      + $statement + : StatementInterface +
      +
      +

      Statement to perform on server.

      +
      + +
      +
      + $options + : array<string|int, mixed> + = []
      +
      +

      Options for cursor.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException|GuzzleException + + +
      +
      + + + + +
      +
      +

      + __toString() + + +

      + + +

      Return a string representation of document.

      + + + public + __toString() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + count() + + +

      + + + + + public + count() : int + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + inheritDoc +
      +
      + + +
      +
      + + +
      +
      Return values
      + int +
      +
      + +
      +

      + delete() + + +

      + + +

      Deletes the cursor and frees the resources associated with it.

      + + + public + delete() : bool + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException + + +
      +
      + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + fetch() + + +

      + + +

      Fetch more results from the server.

      + + + public + fetch() : void + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException + + +
      +
      + + + + +
      +
      +

      + getId() + + +

      + + +

      Returns the cursor ID

      + + + public + getId() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + isCached() + + +

      + + +

      Return if the Cursor has cached results on server

      + + + public + isCached() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + key() + + +

      + + +

      Return the key of the current element.

      + + + public + key() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + next() + + +

      + + +

      Move forward to next element.

      + + + public + next() : void + +
      +
      + + + + + + + + +
      +
      +

      + rewind() + + +

      + + +

      Rewind the Iterator to the first element.

      + + + public + rewind() : void + +
      +
      + + + + + + + + +
      +
      +

      + valid() + + +

      + + +

      Checks if current position is valid.

      + + + public + valid() : bool + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException + + +
      +
      + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + appendResults() + + +

      + + +

      Append the results.

      + + + protected + appendResults(array<string|int, mixed> $results) : void + +
      +
      + + +
      Parameters
      +
      +
      + $results + : array<string|int, mixed> +
      +
      + +
      +
      + + + + + + +
      +
      +

      + create() + + +

      + + +

      Create/initialize the cursor.

      + + + protected + create() : void + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException|GuzzleException + + +
      +
      + + + + +
      +
      +

      + getBody() + + +

      + + +

      Return body for creating cursor.

      + + + protected + getBody() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      -
      @@ -423,10 +2520,71 @@

    • Table Of Contents
      • -
      +
    • Constants
    • +
    • Properties
    • +
    • Methods
    • + +
    • Constants
    • +
    • + +
    • +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-DataStructures-ArrayList.html b/docs/classes/ArangoDB-DataStructures-ArrayList.html index 8fe480f..b78718b 100644 --- a/docs/classes/ArangoDB-DataStructures-ArrayList.html +++ b/docs/classes/ArangoDB-DataStructures-ArrayList.html @@ -319,15 +319,1077 @@

      +

      + Properties + +

      +
      +
      + $content + +  : array<string|int, mixed> +
      +
      List of data
      +
      + $position + +  : int +
      +
      Current index
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      ArrayList constructor.
      + +
      + __toString() + +  : false|string +
      +
      String representation of ArrayList
      + +
      + append() + +  : void +
      +
      Appends a list to another.
      + +
      + count() + +  : int +
      +
      Count elements of an object
      + +
      + current() + +  : mixed +
      +
      Return the current element
      + +
      + first() + +  : mixed +
      +
      Get the first value of list
      + +
      + get() + +  : mixed +
      +
      Get a value by its key
      + +
      + has() + +  : bool +
      +
      Check if a given key exists on list
      + +
      + jsonSerialize() + +  : array<string|int, mixed>|mixed +
      +
      Return a JSON representation of list
      + +
      + key() + +  : mixed +
      +
      Return the key of the current element
      + +
      + last() + +  : mixed +
      +
      Get the last value of list
      + +
      + next() + +  : void +
      +
      Move forward to next element
      + +
      + push() + +  : void +
      +
      Add a value to list
      + +
      + put() + +  : void +
      +
      Put a object into list on given key
      + +
      + remove() + +  : void +
      +
      Remove a value by its key on list
      + +
      + rewind() + +  : void +
      +
      Rewind the Iterator to the first element
      + +
      + toArray() + +  : array<string|int, mixed> +
      +
      Return an array representation for list
      + +
      + valid() + +  : bool +
      +
      Checks if current position is valid
      + +
      + values() + +  : array<string|int, mixed> +
      +
      Return an array with list values only
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $content + + + + +

      + + +

      List of data

      + + + + protected + array<string|int, mixed> + $content + + + + + + + + + + +
      +
      +

      + $position + + + + +

      + + +

      Current index

      + + + + protected + int + $position + = 0 + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      ArrayList constructor.

      + + + public + __construct([array<string|int, mixed> $content = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $content + : array<string|int, mixed> + = []
      +
      + +
      +
      + + + + + + +
      +
      +

      + __toString() + + +

      + + +

      String representation of ArrayList

      + + + public + __toString() : false|string + +
      +
      + + + + + + + +
      +
      Return values
      + false|string +
      + +
      +
      +

      + append() + + +

      + + +

      Appends a list to another.

      + + + public + append(ListInterface $list) : void + +
      +
      + + +
      Parameters
      +
      +
      + $list + : ListInterface +
      +
      +

      ListInterface object to append.

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

      + count() + + +

      + + +

      Count elements of an object

      + + + public + count() : int + +
      +
      + + + + + + + +
      +
      Return values
      + int +
      + +
      +
      +

      + current() + + +

      + + +

      Return the current element

      + + + public + current() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + first() + + +

      + + +

      Get the first value of list

      + + + public + first() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + get() + + +

      + + +

      Get a value by its key

      + + + public + get(int|string $key) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $key + : int|string +
      +
      +

      KeyType to verify on list.

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

      + has() + + +

      + + +

      Check if a given key exists on list

      + + + public + has(mixed $key) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $key + : mixed +
      +
      +

      int|string to verify on list.

      +
      + +
      +
      + + + + + +
      +
      Return values
      + bool + — +

      True if key exists, false otherwise.

      +
      + +
      + +
      +
      +

      + jsonSerialize() + + +

      + + +

      Return a JSON representation of list

      + + + public + jsonSerialize() : array<string|int, mixed>|mixed + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed>|mixed +
      + +
      +
      +

      + key() + + +

      + + +

      Return the key of the current element

      + + + public + key() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + last() + + +

      + + +

      Get the last value of list

      + + + public + last() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + next() + + +

      + + +

      Move forward to next element

      + + + public + next() : void + +
      +
      + + + + + + + + +
      +
      +

      + push() + + +

      + + +

      Add a value to list

      + + + public + push(mixed $value) : void + +
      +
      + + +
      Parameters
      +
      +
      + $value + : mixed +
      +
      +

      Value to add.

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

      + put() + + +

      + + +

      Put a object into list on given key

      + + + public + put(int|string $key, mixed $value) : void + +
      +
      + + +
      Parameters
      +
      +
      + $key + : int|string +
      +
      +

      KeyType for manage the value.

      +
      + +
      +
      + $value + : mixed +
      +
      +

      Value to add.

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

      + remove() + + +

      + + +

      Remove a value by its key on list

      + + + public + remove(mixed $key) : void + +
      +
      + + +
      Parameters
      +
      +
      + $key + : mixed +
      +
      +

      int|string to remove from list.

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

      + rewind() + + +

      + + +

      Rewind the Iterator to the first element

      + + + public + rewind() : void + +
      +
      + + + + + + + + +
      +
      +

      + toArray() + + +

      + + +

      Return an array representation for list

      + + + public + toArray() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + valid() + + +

      + + +

      Checks if current position is valid

      + + + public + valid() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + values() + + +

      + + +

      Return an array with list values only

      + + + public + values() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +
      @@ -433,10 +1495,43 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-DataStructures-Contracts-ListInterface.html b/docs/classes/ArangoDB-DataStructures-Contracts-ListInterface.html index 11402e3..54f285f 100644 --- a/docs/classes/ArangoDB-DataStructures-Contracts-ListInterface.html +++ b/docs/classes/ArangoDB-DataStructures-Contracts-ListInterface.html @@ -303,13 +303,554 @@

      +

      + Methods + +

      +
      +
      + append() + +  : void +
      +
      Appends a list to another.
      + +
      + first() + +  : mixed +
      +
      Get the first value of list
      + +
      + get() + +  : mixed +
      +
      Get a value by its key
      + +
      + has() + +  : bool +
      +
      Check if a given key exists on list
      + +
      + last() + +  : mixed +
      +
      Get the last value of list
      + +
      + push() + +  : void +
      +
      Add a value to list
      + +
      + put() + +  : void +
      +
      Put an object into list on given key
      + +
      + remove() + +  : void +
      +
      Remove a value by its key on list
      + +
      + toArray() + +  : array<string|int, mixed> +
      +
      Return an array representation for list
      + +
      + values() + +  : array<string|int, mixed> +
      +
      Return an array with list values only
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + append() + + +

      + + +

      Appends a list to another.

      + + + public + append(ListInterface $list) : void + +
      +
      + + +
      Parameters
      +
      +
      + $list + : ListInterface +
      +
      +

      ListInterface object to append.

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

      + first() + + +

      + + +

      Get the first value of list

      + + + public + first() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + get() + + +

      + + +

      Get a value by its key

      + + + public + get(int|string $key) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $key + : int|string +
      +
      +

      key to verify on list.

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

      + has() + + +

      + + +

      Check if a given key exists on list

      + + + public + has(int|string $key) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $key + : int|string +
      +
      +

      Key to verify on list.

      +
      + +
      +
      + + + + + +
      +
      Return values
      + bool + — +

      True if key exists, false otherwise.

      +
      + +
      + +
      +
      +

      + last() + + +

      + + +

      Get the last value of list

      + + + public + last() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + push() + + +

      + + +

      Add a value to list

      + + + public + push(mixed $value) : void + +
      +
      + + +
      Parameters
      +
      +
      + $value + : mixed +
      +
      +

      Value to add.

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

      + put() + + +

      + + +

      Put an object into list on given key

      + + + public + put(int|string $key, mixed $value) : void + +
      +
      + + +
      Parameters
      +
      +
      + $key + : int|string +
      +
      +

      KeyType for manage the value.

      +
      + +
      +
      + $value + : mixed +
      +
      +

      Value to add.

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

      + remove() + + +

      + + +

      Remove a value by its key on list

      + + + public + remove(int|string $key) : void + +
      +
      + + +
      Parameters
      +
      +
      + $key + : int|string +
      +
      +

      key to remove from list.

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

      + toArray() + + +

      + + +

      Return an array representation for list

      + + + public + toArray() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + values() + + +

      + + +

      Return an array with list values only

      + + + public + values() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +
      @@ -419,6 +960,21 @@

    • Methods
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-DataStructures-CountTrait.html b/docs/classes/ArangoDB-DataStructures-CountTrait.html index 08e0962..16fdc73 100644 --- a/docs/classes/ArangoDB-DataStructures-CountTrait.html +++ b/docs/classes/ArangoDB-DataStructures-CountTrait.html @@ -274,15 +274,76 @@

      +

      + Methods + +

      +
      +
      + count() + +  : int +
      +
      Count elements of an object
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + count() + + +

      + + +

      Count elements of an object

      + + + public + count() : int + +
      +
      + + + + + + + +
      +
      Return values
      + int +
      + +
      +
      +
      @@ -388,9 +449,16 @@

    • Table Of Contents
      • -
      +
    • Methods
    • + + +
    • Methods
    • +
    • +
    • - + diff --git a/docs/classes/ArangoDB-DataStructures-IteratorTrait.html b/docs/classes/ArangoDB-DataStructures-IteratorTrait.html index 2ec7fea..21c0035 100644 --- a/docs/classes/ArangoDB-DataStructures-IteratorTrait.html +++ b/docs/classes/ArangoDB-DataStructures-IteratorTrait.html @@ -274,15 +274,248 @@

      +

      + Methods + +

      +
      +
      + current() + +  : mixed +
      +
      Return the current element
      + +
      + key() + +  : mixed +
      +
      Return the key of the current element
      + +
      + next() + +  : void +
      +
      Move forward to next element
      + +
      + rewind() + +  : void +
      +
      Rewind the Iterator to the first element
      + +
      + valid() + +  : bool +
      +
      Checks if current position is valid
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + current() + + +

      + + +

      Return the current element

      + + + public + current() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + key() + + +

      + + +

      Return the key of the current element

      + + + public + key() : mixed + +
      +
      + + + + + + + + +
      +
      +

      + next() + + +

      + + +

      Move forward to next element

      + + + public + next() : void + +
      +
      + + + + + + + + +
      +
      +

      + rewind() + + +

      + + +

      Rewind the Iterator to the first element

      + + + public + rewind() : void + +
      +
      + + + + + + + + +
      +
      +

      + valid() + + +

      + + +

      Checks if current position is valid

      + + + public + valid() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +
      @@ -388,9 +621,20 @@

    • Table Of Contents
      • -
      +
    • Methods
    • + - +
    • Methods
    • +
    • + +
    • + diff --git a/docs/classes/ArangoDB-DataStructures-SerializeTrait.html b/docs/classes/ArangoDB-DataStructures-SerializeTrait.html index 98c7e97..357968e 100644 --- a/docs/classes/ArangoDB-DataStructures-SerializeTrait.html +++ b/docs/classes/ArangoDB-DataStructures-SerializeTrait.html @@ -274,15 +274,76 @@

      +

      + Methods + +

      +
      +
      + jsonSerialize() + +  : array<string|int, mixed>|mixed +
      +
      Return a JSON representation of list
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + jsonSerialize() + + +

      + + +

      Return a JSON representation of list

      + + + public + jsonSerialize() : array<string|int, mixed>|mixed + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed>|mixed +
      + +
      +
      +
      @@ -388,9 +449,16 @@

    • Table Of Contents
      • -
      +
    • Methods
    • + + +
    • Methods
    • +
    • +
    • - + diff --git a/docs/classes/ArangoDB-Database-Database.html b/docs/classes/ArangoDB-Database-Database.html index 18d22f7..cbf4ea2 100644 --- a/docs/classes/ArangoDB-Database-Database.html +++ b/docs/classes/ArangoDB-Database-Database.html @@ -309,15 +309,1576 @@

      +

      + Properties + +

      +
      +
      + $collections + +  : ArrayList +
      +
      Collections of database
      + +
      + $connection + +  : Connection +
      +
      Connection to use to manage database
      + +
      + $database + +  : string +
      +
      Database name
      + +
      + $info + +  : array<string|int, mixed> +
      +
      Information about database
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Database constructor.
      + +
      + create() + +  : bool +
      +
      Creates a new database on server
      + +
      + createCollection() + +  : Collection +
      +
      Create a new collection on database
      + +
      + current() + +  : array<string|int, mixed> +
      +
      Returns information about the current database
      + +
      + drop() + +  : bool +
      +
      Drops a database from server
      + +
      + dropCollection() + +  : bool +
      +
      Drops a given collection of database
      + +
      + getAllCollections() + +  : ArrayList +
      +
      Return all collections of database
      + +
      + getAllGraphs() + +  : ArrayList +
      +
      Lists all graphs stored in this database.
      + +
      + getCollection() + +  : Collection|bool +
      +
      Return the collection object for a given collection
      + +
      + getConnection() + +  : Connection +
      +
      Return the connection object
      + +
      + getDatabaseName() + +  : string +
      +
      Return the name of database handled
      + +
      + getGraph() + +  : Graph|false +
      +
      Check if database has a given graph
      + +
      + getInfo() + +  : array<string|int, mixed> +
      +
      Returns information about the current database
      + +
      + hasCollection() + +  : bool +
      +
      Check if database has given collection
      + +
      + list() + +  : ArrayList +
      +
      Lists databases that exists on server
      + +
      + setConnection() + +  : void +
      +
      Sets a connection for class.
      + +
      + userDatabases() + +  : ArrayList +
      +
      Lists the databases that current user has access
      + +
      + retrieveCollections() + +  : ArrayList +
      +
      Retrieve a list of collections of database
      + +
      + sync() + +  : mixed +
      +
      Synchronizes the object with database on server
      + +
      + + + + + + +
      +

      + Properties + + +

      +
      +

      + $collections + + + + +

      + + +

      Collections of database

      + + + + protected + ArrayList + $collections + + + + + + + + + + +
      +
      +

      + $connection + + + + +

      + + +

      Connection to use to manage database

      + + + + protected + Connection + $connection + + + + + + + + + + +
      +
      +

      + $database + + + + +

      + + +

      Database name

      + + + + protected + string + $database + + + + + + + + + + +
      +
      +

      + $info + + + + +

      + + +

      Information about database

      + + + + protected + array<string|int, mixed> + $info + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      + +
      +

      + create() + + +

      + + +

      Creates a new database on server

      + + + public + static create(Connection $connection, string $database) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to be used

      +
      + +
      +
      + $database + : string +
      +
      +

      Database name

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException|DatabaseException + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      True if database was successfully created on server. Throw an exception otherwise.

      +
      + +
      + +
      +
      +

      + createCollection() + + +

      + + +

      Create a new collection on database

      + + + public + createCollection(string $collection[, array<string|int, mixed> $attributes = [] ]) : Collection + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      Collection name

      +
      + +
      +
      + $attributes + : array<string|int, mixed> + = []
      +
      +

      If you want to specify some custom attribute to collection

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|InvalidParameterException|MissingParameterException + + +
      +
      + see +
      +
      + https://www.arangodb.com/docs/stable/http/collection-creating.html#create-collection + + +
      +
      + + + +
      +
      Return values
      + Collection + — +

      A Collection object if operation was successful, throws an exception otherwise

      +
      + +
      + +
      +
      +

      + current() + + +

      + + +

      Returns information about the current database

      + + + public + static current(Connection $connection) : array<string|int, mixed> + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to be used

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException|DatabaseException + + +
      +
      + see +
      +
      + https://docs.arangodb.com/3.12/develop/http-api/databases/#get-information-about-the-current-database + + +
      +
      + + + +
      +
      Return values
      + array<string|int, mixed> + — +

      An array with information about database.

      +
      + +
      + +
      +
      +

      + drop() + + +

      + + +

      Drops a database from server

      + + + public + static drop(Connection $connection, string $database) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to be used

      +
      + +
      +
      + $database + : string +
      +
      +

      Database name

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      True if database was successfully dropped on server. Throw an exception otherwise.

      +
      + +
      + +
      +
      +

      + dropCollection() + + +

      + + +

      Drops a given collection of database

      + + + public + dropCollection(string $collection) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      Collection name

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|InvalidParameterException|MissingParameterException + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      True if operation was successful, false otherwise

      +
      + +
      + +
      + + +
      +

      + getCollection() + + +

      + + +

      Return the collection object for a given collection

      + + + public + getCollection(string $collection) : Collection|bool + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      Collection name

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|InvalidParameterException|MissingParameterException + + +
      +
      + +
      +
      Return values
      + Collection|bool + — +

      Collection object. Return False if collection not exists on database

      +
      - +
      - +
      + +
      +

      + getDatabaseName() + + +

      + + +

      Return the name of database handled

      + + + public + getDatabaseName() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + getGraph() + + +

      + + +

      Check if database has a given graph

      + + + public + getGraph(string $graph) : Graph|false + +
      +
      + + +
      Parameters
      +
      +
      + $graph + : string +
      +
      +

      Graph name.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|Exception|GuzzleException|InvalidParameterException|MissingParameterException + + +
      +
      + + + +
      +
      Return values
      + Graph|false + — +

      Returns a Graph object if graph exists. Return False if graph not exists on database.

      +
      + +
      + +
      +
      +

      + getInfo() + + +

      + + +

      Returns information about the current database

      + + + public + getInfo() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + hasCollection() + + +

      + + +

      Check if database has given collection

      + + + public + hasCollection(string $collection) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      Collection name

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException|DatabaseException + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      True if operation was successful, false otherwise

      +
      + +
      + +
      +
      +

      + list() + + +

      + + +

      Lists databases that exists on server

      + + + public + static list(Connection $connection) : ArrayList + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to be used

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException|DatabaseException + + +
      +
      + + + +
      +
      Return values
      + ArrayList + — +

      A list with all databases on server.

      +
      + +
      + +
      +
      +

      + setConnection() + + +

      + + +

      Sets a connection for class.

      + + + public + setConnection(Connection $connection) : void + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to use.

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

      + userDatabases() + + +

      + + +

      Lists the databases that current user has access

      + + + public + static userDatabases(Connection $connection) : ArrayList + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to be used

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException|DatabaseException + + +
      +
      + + + +
      +
      Return values
      + ArrayList + — +

      A list with all databases on server that current user has access.

      +
      + +
      + +
      + + +
      -
      @@ -423,10 +1984,45 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Database-DatabaseHandler.html b/docs/classes/ArangoDB-Database-DatabaseHandler.html index 61cec63..9b12d65 100644 --- a/docs/classes/ArangoDB-Database-DatabaseHandler.html +++ b/docs/classes/ArangoDB-Database-DatabaseHandler.html @@ -311,15 +311,608 @@

      +

      + Properties + +

      +
      +
      + $connection + +  : Connection +
      +
      Connection to access the server
      +
      + +

      + Methods + + +

      +
      +
      + create() + +  : bool +
      +
      Creates a new database on server
      + +
      + current() + +  : array<string|int, mixed> +
      +
      Returns information about the current database
      + +
      + drop() + +  : bool +
      +
      Drops a database from server
      + +
      + getConnection() + +  : Connection +
      +
      Return the connection object
      + +
      + list() + +  : ArrayList +
      +
      Lists databases that exists on server
      + +
      + setConnection() + +  : void +
      +
      Sets a connection for class.
      + +
      + userDatabases() + +  : ArrayList +
      +
      Lists the databases that current user has access
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $connection + + + + +

      + + +

      Connection to access the server

      + + + + protected + Connection + $connection + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + create() + + +

      + + +

      Creates a new database on server

      + + + public + static create(Connection $connection, string $database) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to be used

      +
      + +
      +
      + $database + : string +
      +
      +

      Database name

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException|DatabaseException + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      True if database was successfully created on server. Throw an exception otherwise.

      +
      + +
      + +
      +
      +

      + current() + + +

      + + +

      Returns information about the current database

      + + + public + static current(Connection $connection) : array<string|int, mixed> + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to be used

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException|DatabaseException + + +
      +
      + see +
      +
      + https://docs.arangodb.com/3.12/develop/http-api/databases/#get-information-about-the-current-database + + +
      +
      + + + +
      +
      Return values
      + array<string|int, mixed> + — +

      An array with information about database.

      +
      + +
      + +
      +
      +

      + drop() + + +

      + + +

      Drops a database from server

      + + + public + static drop(Connection $connection, string $database) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to be used

      +
      + +
      +
      + $database + : string +
      +
      +

      Database name

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      True if database was successfully dropped on server. Throw an exception otherwise.

      +
      + +
      + +
      + +
      +

      + list() + + +

      + + +

      Lists databases that exists on server

      + + + public + static list(Connection $connection) : ArrayList + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to be used

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException|DatabaseException + + +
      +
      + + + +
      +
      Return values
      + ArrayList + — +

      A list with all databases on server.

      +
      + +
      + +
      +
      +

      + setConnection() + + +

      + + +

      Sets a connection for class.

      + + + public + setConnection(Connection $connection) : void + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to use.

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

      + userDatabases() + + +

      + + +

      Lists the databases that current user has access

      + + + public + static userDatabases(Connection $connection) : ArrayList + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to be used

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException|DatabaseException + + +
      +
      + + + +
      +
      Return values
      + ArrayList + — +

      A list with all databases on server that current user has access.

      +
      + +
      + +
      +
      +
      @@ -425,10 +1018,30 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Document-Document.html b/docs/classes/ArangoDB-Document-Document.html index 3d3ee37..8ff2792 100644 --- a/docs/classes/ArangoDB-Document-Document.html +++ b/docs/classes/ArangoDB-Document-Document.html @@ -316,15 +316,1567 @@

      +

      + Properties + +

      +
      +
      + $attributes + +  : array<string|int, mixed> +
      +
      Documents attributes
      + +
      + $collection + +  : Collection +
      +
      Collection where document belongs
      + +
      + $connection + +  : Connection +
      +
      Connection to be used
      + +
      + $id + +  : string +
      +
      Document ID
      + +
      + $isNew + +  : bool +
      +
      If document is a new one or a representation of existing document
      + +
      + $key + +  : string +
      +
      Document key
      + +
      + $patchDefaultOptions + +  : array<string|int, mixed> +
      +
      Default patch options
      + +
      + $revision + +  : string +
      +
      Document revision
      + +
      + $updateDefaultOptions + +  : array<string|int, mixed> +
      +
      Default update options
      + +
      + $validator + +  : RuleInterface +
      +
      Validate primitive types
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Document constructor.
      + +
      + __get() + +  : mixed|null +
      +
      Get some attribute.
      + +
      + __isset() + +  : bool +
      +
      Verifies if an attribute is set on document
      + +
      + __set() + +  : mixed +
      +
      Set a attribute
      + +
      + __toString() + +  : string +
      +
      Return a string representation of document.
      + +
      + __unset() + +  : mixed +
      +
      Unset the given attribute of document
      + +
      + delete() + +  : bool +
      +
      Removes a document on server, if possible
      + +
      + getCollection() + +  : Collection|null +
      +
      Returns the document collection
      + +
      + getId() + +  : string|null +
      +
      Returns the document Id
      + +
      + getKey() + +  : string|null +
      +
      Returns the document key
      + +
      + getRevision() + +  : string|null +
      +
      Returns the document revision
      + +
      + isNew() + +  : bool +
      +
      Returns true if is a new object
      + +
      + jsonSerialize() + +  : array<string|int, mixed>|mixed +
      + +
      + save() + +  : bool +
      +
      Save or update the document, if possible
      + +
      + setCollection() + +  : void +
      +
      Sets the collection to add this document
      + +
      + toArray() + +  : array<string|int, mixed> +
      +
      Returns a array representation of document
      + +
      + setDescriptors() + +  : void +
      +
      Set document descriptors
      + +
      + update() + +  : bool +
      +
      Update the document.
      + +
      + + + + + + +
      +

      + Properties + + +

      +
      +

      + $attributes + + + + +

      + + +

      Documents attributes

      + + + + protected + array<string|int, mixed> + $attributes + + + + + + + + + + +
      +
      +

      + $collection + + + + +

      + + +

      Collection where document belongs

      + + + + protected + Collection + $collection + + + + + + + + + + +
      +
      +

      + $connection + + + + +

      + + +

      Connection to be used

      + + + + protected + Connection + $connection + + + + + + + + + + +
      +
      +

      + $id + + + + +

      + + +

      Document ID

      + + + + protected + string + $id + = '' + + + + + + + + + +
      +
      +

      + $isNew + + + + +

      + + +

      If document is a new one or a representation of existing document

      + + + + protected + bool + $isNew + + + + + + + + + + +
      +
      +

      + $key + + + + +

      + + +

      Document key

      + + + + protected + string + $key + = '' + + + + + + + + + +
      +
      +

      + $patchDefaultOptions + + + + +

      + + +

      Default patch options

      + + + + protected + array<string|int, mixed> + $patchDefaultOptions + = ['keepNull' => false, 'mergeObjects' => true, 'waitForSync' => true, 'ignoreRevs' => true, 'returnOld' => false, 'returnNew' => true] + + + + + + + + + +
      +
      +

      + $revision + + + + +

      + + +

      Document revision

      + + + + protected + string + $revision + = '' + + + + + + + + + +
      +
      +

      + $updateDefaultOptions + + + + +

      + + +

      Default update options

      + + + + protected + array<string|int, mixed> + $updateDefaultOptions + = ['waitForSync' => true, 'ignoreRevs' => true, 'returnOld' => false, 'returnNew' => true, 'silent' => false] + + + + + + + + + +
      +
      +

      + $validator + + + + +

      + + +

      Validate primitive types

      + + + + protected + RuleInterface + $validator + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Document constructor.

      + + + public + __construct([array<string|int, mixed> $attributes = [] ][, Collection $collection = null ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $attributes + : array<string|int, mixed> + = []
      +
      +

      Document attributes

      +
      + +
      +
      + $collection + : Collection + = null
      +
      +

      Collection to add this document

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException + + +
      +
      + + + + +
      +
      +

      + __get() + + +

      + + +

      Get some attribute.

      + + + public + __get(string $name) : mixed|null + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      +

      Attribute name.

      +
      + +
      +
      + + + + + +
      +
      Return values
      + mixed|null + — +

      Attribute value.

      +
      + +
      + +
      +
      +

      + __isset() + + +

      + + +

      Verifies if an attribute is set on document

      + + + public + __isset(string $name) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      + +
      +
      + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + __set() + + +

      + + +

      Set a attribute

      + + + public + __set(string $name, mixed $value) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      + +
      +
      + $value + : mixed +
      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException + + +
      +
      + + + + +
      +
      +

      + __toString() + + +

      + + +

      Return a string representation of document.

      + + + public + __toString() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + __unset() + + +

      + + +

      Unset the given attribute of document

      + + + public + __unset(string $name) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      + +
      +
      + + + + + + +
      +
      +

      + delete() + + +

      + + +

      Removes a document on server, if possible

      + + + public + delete() : bool + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException + + +
      +
      + +
      +
      Return values
      + bool + — +

      true if operation was successful, false otherwise

      +
      - +
      - +
      +
      +

      + getCollection() + + +

      + + +

      Returns the document collection

      + + + public + getCollection() : Collection|null + +
      +
      + + + + + + + +
      +
      Return values
      + Collection|null + — +

      Collection object if is set. Null otherwise.

      +
      + +
      + +
      +
      +

      + getId() + + +

      + + +

      Returns the document Id

      + + + public + getId() : string|null + +
      +
      + + + + + + + +
      +
      Return values
      + string|null + — +

      String if document already exists. Null otherwise (e.g. a new document)

      +
      + +
      + +
      +
      +

      + getKey() + + +

      + + +

      Returns the document key

      + + + public + getKey() : string|null + +
      +
      + + + + + + + +
      +
      Return values
      + string|null + — +

      String if document already exists. Null otherwise (e.g. a new document)

      +
      + +
      + +
      +
      +

      + getRevision() + + +

      + + +

      Returns the document revision

      + + + public + getRevision() : string|null + +
      +
      + + + + + + + +
      +
      Return values
      + string|null + — +

      String if document already exists. Null otherwise (e.g. a new document)

      +
      + +
      + +
      +
      +

      + isNew() + + +

      + + +

      Returns true if is a new object

      + + + public + isNew() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + jsonSerialize() + + +

      + + + + + public + jsonSerialize() : array<string|int, mixed>|mixed + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + JsonSerializable::jsonSerialize() + + +
      +
      + + + +
      +
      Return values
      + array<string|int, mixed>|mixed +
      + +
      +
      +

      + save() + + +

      + + +

      Save or update the document, if possible

      + + + public + save([array<string|int, mixed> $options = [] ]) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $options + : array<string|int, mixed> + = []
      +
      +

      Optional array of options. Only used on update operations.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|InvalidParameterException|MissingParameterException + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      true if operation was successful. Throws an exceptions otherwise

      +
      + +
      + +
      +
      +

      + setCollection() + + +

      + + +

      Sets the collection to add this document

      + + + public + setCollection(Collection $collection) : void + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : Collection +
      +
      + +
      +
      + + + + + + +
      +
      +

      + toArray() + + +

      + + +

      Returns a array representation of document

      + + + public + toArray() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + setDescriptors() + + +

      + + +

      Set document descriptors

      + + + protected + setDescriptors(array<string|int, mixed> $descriptors) : void + +
      +
      + + +
      Parameters
      +
      +
      + $descriptors + : array<string|int, mixed> +
      +
      + +
      +
      + + + + + + +
      +
      +

      + update() + + +

      + + +

      Update the document.

      + + + protected + update([array<string|int, mixed> $options = [] ]) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $options + : array<string|int, mixed> + = []
      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|MissingParameterException|InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + bool +
      + +
      +
      -
      @@ -430,10 +1982,50 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Document-Edge.html b/docs/classes/ArangoDB-Document-Edge.html index cd69721..09f63cb 100644 --- a/docs/classes/ArangoDB-Document-Edge.html +++ b/docs/classes/ArangoDB-Document-Edge.html @@ -309,15 +309,1828 @@

      +

      + Properties + +

      +
      +
      + $attributes + +  : array<string|int, mixed> +
      +
      Documents attributes
      + +
      + $collection + +  : Collection +
      +
      Collection where document belongs
      + +
      + $connection + +  : Connection +
      +
      Connection to be used
      + +
      + $database + +  : Database +
      +
      Database object
      + +
      + $from + +  : string +
      +
      The edges '_from' attribute
      + +
      + $id + +  : string +
      +
      Document ID
      + +
      + $isNew + +  : bool +
      +
      If document is a new one or a representation of existing document
      + +
      + $key + +  : string +
      +
      Document key
      + +
      + $patchDefaultOptions + +  : array<string|int, mixed> +
      +
      Default patch options
      + +
      + $revision + +  : string +
      +
      Document revision
      + +
      + $to + +  : string +
      +
      The edges '_to' attribute
      + +
      + $updateDefaultOptions + +  : array<string|int, mixed> +
      +
      Default update options
      + +
      + $validator + +  : RuleInterface +
      +
      Validate primitive types
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Edge constructor.
      + +
      + __get() + +  : mixed|null +
      +
      Get some attribute.
      + +
      + __isset() + +  : bool +
      +
      Verifies if an attribute is set on document
      + +
      + __set() + +  : mixed +
      +
      Set a attribute
      + +
      + __toString() + +  : string +
      +
      Return a string representation of document.
      + +
      + __unset() + +  : mixed +
      +
      Unset the given attribute of document
      + +
      + delete() + +  : bool +
      +
      Removes a document on server, if possible
      + +
      + from() + +  : Vertex|false +
      +
      Return the '_from' document
      + +
      + getCollection() + +  : Collection|null +
      +
      Returns the document collection
      + +
      + getId() + +  : string|null +
      +
      Returns the document Id
      + +
      + getKey() + +  : string|null +
      +
      Returns the document key
      + +
      + getRevision() + +  : string|null +
      +
      Returns the document revision
      + +
      + isNew() + +  : bool +
      +
      Returns true if is a new object
      + +
      + jsonSerialize() + +  : array<string|int, mixed>|mixed +
      + +
      + save() + +  : bool +
      +
      Save or update the document, if possible
      + +
      + setCollection() + +  : void +
      +
      Sets the collection to add this document
      + +
      + to() + +  : Vertex|false +
      +
      Return the '_to' document
      + +
      + toArray() + +  : array<string|int, mixed> +
      +
      Returns a array representation of document
      + +
      + setDescriptors() + +  : void +
      +
      Set document descriptors
      + +
      + update() + +  : bool +
      +
      Update the document.
      + +
      + + + + + + +
      +

      + Properties + + +

      +
      +

      + $attributes + + + + +

      + + +

      Documents attributes

      + + + + protected + array<string|int, mixed> + $attributes + + + + + + + + + + +
      +
      +

      + $collection + + + + +

      + + +

      Collection where document belongs

      + + + + protected + Collection + $collection + + + + + + + + + + +
      +
      +

      + $connection + + + + +

      + + +

      Connection to be used

      + + + + protected + Connection + $connection + + + + + + + + + + +
      +
      +

      + $database + + + + +

      + + +

      Database object

      + + + + protected + Database + $database + + + + + + + + + + +
      +
      +

      + $from + + + + +

      + + +

      The edges '_from' attribute

      + + + + protected + string + $from + + + + + + + + + + +
      +
      +

      + $id + + + + +

      + + +

      Document ID

      + + + + protected + string + $id + = '' + + + + + + + + + +
      +
      +

      + $isNew + + + + +

      + + +

      If document is a new one or a representation of existing document

      + + + + protected + bool + $isNew + + + + + + + + + + +
      +
      +

      + $key + + + + +

      + + +

      Document key

      + + + + protected + string + $key + = '' + + + + + + + + + +
      +
      +

      + $patchDefaultOptions + + + + +

      + + +

      Default patch options

      + + + + protected + array<string|int, mixed> + $patchDefaultOptions + = ['keepNull' => false, 'mergeObjects' => true, 'waitForSync' => true, 'ignoreRevs' => true, 'returnOld' => false, 'returnNew' => true] + + + + + + + + + +
      +
      +

      + $revision + + + + +

      + + +

      Document revision

      + + + + protected + string + $revision + = '' + + + + + + + + + +
      +
      +

      + $to + + + + +

      + + +

      The edges '_to' attribute

      + + + + protected + string + $to + + + + + + + + + + +
      +
      +

      + $updateDefaultOptions + + + + +

      + + +

      Default update options

      + + + + protected + array<string|int, mixed> + $updateDefaultOptions + = ['waitForSync' => true, 'ignoreRevs' => true, 'returnOld' => false, 'returnNew' => true, 'silent' => false] + + + + + + + + + +
      +
      +

      + $validator + + + + +

      + + +

      Validate primitive types

      + + + + protected + RuleInterface + $validator + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Edge constructor.

      + + + public + __construct([array<string|int, mixed> $attributes = [] ][, Collection|null $collection = null ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $attributes + : array<string|int, mixed> + = []
      +
      + +
      +
      + $collection + : Collection|null + = null
      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException|MissingParameterException + + +
      +
      + + + + +
      +
      +

      + __get() + + +

      + + +

      Get some attribute.

      + + + public + __get(string $name) : mixed|null + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      +

      Attribute name.

      +
      + +
      +
      + + + + + +
      +
      Return values
      + mixed|null + — +

      Attribute value.

      +
      + +
      + +
      +
      +

      + __isset() + + +

      + + +

      Verifies if an attribute is set on document

      + + + public + __isset(string $name) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      + +
      +
      + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + __set() + + +

      + + +

      Set a attribute

      + + + public + __set(string $name, mixed $value) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      + +
      +
      + $value + : mixed +
      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException + + +
      +
      + + + + +
      +
      +

      + __toString() + + +

      + + +

      Return a string representation of document.

      + + + public + __toString() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + __unset() + + +

      + + +

      Unset the given attribute of document

      + + + public + __unset(string $name) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      + +
      +
      + + + + + + +
      +
      +

      + delete() + + +

      + + +

      Removes a document on server, if possible

      + + + public + delete() : bool + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      true if operation was successful, false otherwise

      +
      + +
      + +
      + +
      +

      + getCollection() + - +

      + + +

      Returns the document collection

      + + + public + getCollection() : Collection|null + +
      +
      + + + + + + + +
      +
      Return values
      + Collection|null + — +

      Collection object if is set. Null otherwise.

      +
      + +
      + +
      +
      +

      + getId() + + +

      + + +

      Returns the document Id

      + + + public + getId() : string|null + +
      +
      + + + + + + + +
      +
      Return values
      + string|null + — +

      String if document already exists. Null otherwise (e.g. a new document)

      +
      + +
      + +
      +
      +

      + getKey() + + +

      + + +

      Returns the document key

      + + + public + getKey() : string|null + +
      +
      + + + + + + + +
      +
      Return values
      + string|null + — +

      String if document already exists. Null otherwise (e.g. a new document)

      +
      + +
      + +
      +
      +

      + getRevision() + + +

      + + +

      Returns the document revision

      + + + public + getRevision() : string|null + +
      +
      + + + + + + + +
      +
      Return values
      + string|null + — +

      String if document already exists. Null otherwise (e.g. a new document)

      +
      + +
      + +
      +
      +

      + isNew() + + +

      + + +

      Returns true if is a new object

      + + + public + isNew() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + jsonSerialize() + + +

      + + + + + public + jsonSerialize() : array<string|int, mixed>|mixed + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + JsonSerializable::jsonSerialize() + + +
      +
      + + + +
      +
      Return values
      + array<string|int, mixed>|mixed +
      + +
      +
      +

      + save() + + +

      + + +

      Save or update the document, if possible

      + + + public + save([array<string|int, mixed> $options = [] ]) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $options + : array<string|int, mixed> + = []
      +
      +

      Optional array of options. Only used on update operations.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|InvalidParameterException|MissingParameterException + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      true if operation was successful. Throws an exceptions otherwise

      +
      + +
      + +
      +
      +

      + setCollection() + + +

      + + +

      Sets the collection to add this document

      + + + public + setCollection(Collection $collection) : void + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : Collection +
      +
      + +
      +
      + + + + + + +
      + +
      +

      + toArray() + + +

      + + +

      Returns a array representation of document

      + + + public + toArray() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + setDescriptors() + + +

      + + +

      Set document descriptors

      + + + protected + setDescriptors(array<string|int, mixed> $descriptors) : void + +
      +
      + + +
      Parameters
      +
      +
      + $descriptors + : array<string|int, mixed> +
      +
      + +
      +
      + + + + + + +
      +
      +

      + update() + + +

      + + +

      Update the document.

      + + + protected + update([array<string|int, mixed> $options = [] ]) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $options + : array<string|int, mixed> + = []
      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|MissingParameterException|InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + bool +
      + +
      +
      -
      @@ -423,10 +2236,55 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Document-Vertex.html b/docs/classes/ArangoDB-Document-Vertex.html index 6a38e95..4ed5ff6 100644 --- a/docs/classes/ArangoDB-Document-Vertex.html +++ b/docs/classes/ArangoDB-Document-Vertex.html @@ -309,15 +309,1567 @@

      +

      + Properties + +

      +
      +
      + $attributes + +  : array<string|int, mixed> +
      +
      Documents attributes
      + +
      + $collection + +  : Collection +
      +
      Collection where document belongs
      + +
      + $connection + +  : Connection +
      +
      Connection to be used
      + +
      + $id + +  : string +
      +
      Document ID
      + +
      + $isNew + +  : bool +
      +
      If document is a new one or a representation of existing document
      + +
      + $key + +  : string +
      +
      Document key
      + +
      + $patchDefaultOptions + +  : array<string|int, mixed> +
      +
      Default patch options
      + +
      + $revision + +  : string +
      +
      Document revision
      + +
      + $updateDefaultOptions + +  : array<string|int, mixed> +
      +
      Default update options
      + +
      + $validator + +  : RuleInterface +
      +
      Validate primitive types
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Document constructor.
      + +
      + __get() + +  : mixed|null +
      +
      Get some attribute.
      + +
      + __isset() + +  : bool +
      +
      Verifies if an attribute is set on document
      + +
      + __set() + +  : mixed +
      +
      Set a attribute
      + +
      + __toString() + +  : string +
      +
      Return a string representation of document.
      + +
      + __unset() + +  : mixed +
      +
      Unset the given attribute of document
      + +
      + delete() + +  : bool +
      +
      Removes a document on server, if possible
      + +
      + getCollection() + +  : Collection|null +
      +
      Returns the document collection
      + +
      + getId() + +  : string|null +
      +
      Returns the document Id
      + +
      + getKey() + +  : string|null +
      +
      Returns the document key
      + +
      + getRevision() + +  : string|null +
      +
      Returns the document revision
      + +
      + isNew() + +  : bool +
      +
      Returns true if is a new object
      + +
      + jsonSerialize() + +  : array<string|int, mixed>|mixed +
      + +
      + save() + +  : bool +
      +
      Save or update the document, if possible
      + +
      + setCollection() + +  : void +
      +
      Sets the collection to add this document
      + +
      + toArray() + +  : array<string|int, mixed> +
      +
      Returns a array representation of document
      + +
      + setDescriptors() + +  : void +
      +
      Set document descriptors
      + +
      + update() + +  : bool +
      +
      Update the document.
      + +
      + + + + + + +
      +

      + Properties + + +

      +
      +

      + $attributes + + + + +

      + + +

      Documents attributes

      + + + + protected + array<string|int, mixed> + $attributes + + + + + + + + + + +
      +
      +

      + $collection + + + + +

      + + +

      Collection where document belongs

      + + + + protected + Collection + $collection + + + + + + + + + + +
      +
      +

      + $connection + + + + +

      + + +

      Connection to be used

      + + + + protected + Connection + $connection + + + + + + + + + + +
      +
      +

      + $id + + + + +

      + + +

      Document ID

      + + + + protected + string + $id + = '' + + + + + + + + + +
      +
      +

      + $isNew + + + + +

      + + +

      If document is a new one or a representation of existing document

      + + + + protected + bool + $isNew + + + + + + + + + + +
      +
      +

      + $key + + + + +

      + + +

      Document key

      + + + + protected + string + $key + = '' + + + + + + + + + +
      +
      +

      + $patchDefaultOptions + + + + +

      + + +

      Default patch options

      + + + + protected + array<string|int, mixed> + $patchDefaultOptions + = ['keepNull' => false, 'mergeObjects' => true, 'waitForSync' => true, 'ignoreRevs' => true, 'returnOld' => false, 'returnNew' => true] + + + + + + + + + +
      +
      +

      + $revision + + + + +

      + + +

      Document revision

      + + + + protected + string + $revision + = '' + + + + + + + + + +
      +
      +

      + $updateDefaultOptions + + + + +

      + + +

      Default update options

      + + + + protected + array<string|int, mixed> + $updateDefaultOptions + = ['waitForSync' => true, 'ignoreRevs' => true, 'returnOld' => false, 'returnNew' => true, 'silent' => false] + + + + + + + + + +
      +
      +

      + $validator + + + + +

      + + +

      Validate primitive types

      + + + + protected + RuleInterface + $validator + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Document constructor.

      + + + public + __construct([array<string|int, mixed> $attributes = [] ][, Collection $collection = null ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $attributes + : array<string|int, mixed> + = []
      +
      +

      Document attributes

      +
      + +
      +
      + $collection + : Collection + = null
      +
      +

      Collection to add this document

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException + + +
      +
      + + + + +
      +
      +

      + __get() + + +

      + + +

      Get some attribute.

      + + + public + __get(string $name) : mixed|null + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      +

      Attribute name.

      +
      + +
      +
      + + + + + +
      +
      Return values
      + mixed|null + — +

      Attribute value.

      +
      + +
      + +
      +
      +

      + __isset() + + +

      + + +

      Verifies if an attribute is set on document

      + + + public + __isset(string $name) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      + +
      +
      + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + __set() + + +

      + + +

      Set a attribute

      + + + public + __set(string $name, mixed $value) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      + +
      +
      + $value + : mixed +
      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException + + +
      +
      + + + + +
      +
      +

      + __toString() + + +

      + + +

      Return a string representation of document.

      + + + public + __toString() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + __unset() + + +

      + + +

      Unset the given attribute of document

      + + + public + __unset(string $name) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      + +
      +
      + + + + +
      +
      +

      + delete() + - +

      + + +

      Removes a document on server, if possible

      + + + public + delete() : bool + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      true if operation was successful, false otherwise

      +
      + +
      + +
      +
      +

      + getCollection() + + +

      + + +

      Returns the document collection

      + + + public + getCollection() : Collection|null + +
      +
      + + + + + + + +
      +
      Return values
      + Collection|null + — +

      Collection object if is set. Null otherwise.

      +
      + +
      + +
      +
      +

      + getId() + + +

      + + +

      Returns the document Id

      + + + public + getId() : string|null + +
      +
      + + + + + + + +
      +
      Return values
      + string|null + — +

      String if document already exists. Null otherwise (e.g. a new document)

      +
      + +
      + +
      +
      +

      + getKey() + + +

      + + +

      Returns the document key

      + + + public + getKey() : string|null + +
      +
      + + + + + + + +
      +
      Return values
      + string|null + — +

      String if document already exists. Null otherwise (e.g. a new document)

      +
      + +
      + +
      +
      +

      + getRevision() + + +

      + + +

      Returns the document revision

      + + + public + getRevision() : string|null + +
      +
      + + + + + + + +
      +
      Return values
      + string|null + — +

      String if document already exists. Null otherwise (e.g. a new document)

      +
      + +
      + +
      +
      +

      + isNew() + + +

      + + +

      Returns true if is a new object

      + + + public + isNew() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + jsonSerialize() + + +

      + + + + + public + jsonSerialize() : array<string|int, mixed>|mixed + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + JsonSerializable::jsonSerialize() + + +
      +
      + + + +
      +
      Return values
      + array<string|int, mixed>|mixed +
      + +
      +
      +

      + save() + + +

      + + +

      Save or update the document, if possible

      + + + public + save([array<string|int, mixed> $options = [] ]) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $options + : array<string|int, mixed> + = []
      +
      +

      Optional array of options. Only used on update operations.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|InvalidParameterException|MissingParameterException + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      true if operation was successful. Throws an exceptions otherwise

      +
      + +
      + +
      +
      +

      + setCollection() + + +

      + + +

      Sets the collection to add this document

      + + + public + setCollection(Collection $collection) : void + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : Collection +
      +
      + +
      +
      + + + + + + +
      +
      +

      + toArray() + + +

      + + +

      Returns a array representation of document

      + + + public + toArray() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + setDescriptors() + + +

      + + +

      Set document descriptors

      + + + protected + setDescriptors(array<string|int, mixed> $descriptors) : void + +
      +
      + + +
      Parameters
      +
      +
      + $descriptors + : array<string|int, mixed> +
      +
      + +
      +
      + + + + + + +
      +
      +

      + update() + + +

      + + +

      Update the document.

      + + + protected + update([array<string|int, mixed> $options = [] ]) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $options + : array<string|int, mixed> + = []
      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|MissingParameterException|InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + bool +
      + +
      +
      -
      @@ -423,10 +1975,50 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Entity-Contracts-EntityInterface.html b/docs/classes/ArangoDB-Entity-Contracts-EntityInterface.html index a0af0f0..7b904a2 100644 --- a/docs/classes/ArangoDB-Entity-Contracts-EntityInterface.html +++ b/docs/classes/ArangoDB-Entity-Contracts-EntityInterface.html @@ -302,13 +302,223 @@

      +

      + Methods + +

      +
      +
      + delete() + +  : bool +
      +
      Removes a entity on server, if possible.
      + +
      + isNew() + +  : bool +
      +
      Returns true if is a new object.
      + +
      + save() + +  : bool +
      +
      Save a entity on server, if possible.
      + +
      + toArray() + +  : array<string|int, mixed> +
      +
      Returns a array representation of entity.
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + delete() + + +

      + + +

      Removes a entity on server, if possible.

      + + + public + delete() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool + — +

      True if operation was successful, false otherwise.

      +
      + +
      + +
      +
      +

      + isNew() + + +

      + + +

      Returns true if is a new object.

      + + + public + isNew() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + save() + + +

      + + +

      Save a entity on server, if possible.

      + + + public + save() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool + — +

      True if operation was successful, false otherwise.

      +
      + +
      + +
      +
      +

      + toArray() + + +

      + + +

      Returns a array representation of entity.

      + + + public + toArray() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +
      @@ -418,6 +628,15 @@

    • Methods
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Exceptions-BaseException.html b/docs/classes/ArangoDB-Exceptions-BaseException.html index 974aeb3..3f26120 100644 --- a/docs/classes/ArangoDB-Exceptions-BaseException.html +++ b/docs/classes/ArangoDB-Exceptions-BaseException.html @@ -312,14 +312,101 @@

      +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      Base exception constructor.
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Base exception constructor.

      + + + public + __construct(string $message[, Throwable|null $previous = null ][, int $code = 0 ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $message + : string +
      +
      +

      Exception message.

      +
      + +
      +
      + $previous + : Throwable|null + = null
      +
      +

      Previous exception or error.

      +
      + +
      +
      + $code + : int + = 0
      +
      +

      Error code.

      +
      + +
      +
      + + + + + + +
      +
      +
      @@ -425,10 +512,17 @@

    • Table Of Contents
      • -
      +
    • Methods
    • + +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Exceptions-ConnectionException.html b/docs/classes/ArangoDB-Exceptions-ConnectionException.html index f7f0088..459452a 100644 --- a/docs/classes/ArangoDB-Exceptions-ConnectionException.html +++ b/docs/classes/ArangoDB-Exceptions-ConnectionException.html @@ -311,14 +311,101 @@

      +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      Base exception constructor.
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Base exception constructor.

      + + + public + __construct(string $message[, Throwable|null $previous = null ][, int $code = 0 ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $message + : string +
      +
      +

      Exception message.

      +
      + +
      +
      + $previous + : Throwable|null + = null
      +
      +

      Previous exception or error.

      +
      + +
      +
      + $code + : int + = 0
      +
      +

      Error code.

      +
      + +
      +
      + + + + + + +
      +
      +
      @@ -424,10 +511,17 @@

    • Table Of Contents
      • -
      +
    • Methods
    • + +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Exceptions-Database-DatabaseException.html b/docs/classes/ArangoDB-Exceptions-Database-DatabaseException.html index 4b739e5..d8bbe6a 100644 --- a/docs/classes/ArangoDB-Exceptions-Database-DatabaseException.html +++ b/docs/classes/ArangoDB-Exceptions-Database-DatabaseException.html @@ -311,14 +311,101 @@

      +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      Base exception constructor.
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Base exception constructor.

      + + + public + __construct(string $message[, Throwable|null $previous = null ][, int $code = 0 ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $message + : string +
      +
      +

      Exception message.

      +
      + +
      +
      + $previous + : Throwable|null + = null
      +
      +

      Previous exception or error.

      +
      + +
      +
      + $code + : int + = 0
      +
      +

      Error code.

      +
      + +
      +
      + + + + + + +
      +
      +
      @@ -424,10 +511,17 @@

    • Table Of Contents
      • -
      +
    • Methods
    • + +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Exceptions-Exception.html b/docs/classes/ArangoDB-Exceptions-Exception.html index 9e48697..9158d96 100644 --- a/docs/classes/ArangoDB-Exceptions-Exception.html +++ b/docs/classes/ArangoDB-Exceptions-Exception.html @@ -310,14 +310,101 @@

      +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      Base exception constructor.
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Base exception constructor.

      + + + public + __construct(string $message[, Throwable|null $previous = null ][, int $code = 0 ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $message + : string +
      +
      +

      Exception message.

      +
      + +
      +
      + $previous + : Throwable|null + = null
      +
      +

      Previous exception or error.

      +
      + +
      +
      + $code + : int + = 0
      +
      +

      Error code.

      +
      + +
      +
      + + + + + + +
      +
      +
      @@ -423,10 +510,17 @@

    • Table Of Contents
      • -
      +
    • Methods
    • + +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Exceptions-IndexException.html b/docs/classes/ArangoDB-Exceptions-IndexException.html index eaf610c..e9f5577 100644 --- a/docs/classes/ArangoDB-Exceptions-IndexException.html +++ b/docs/classes/ArangoDB-Exceptions-IndexException.html @@ -310,14 +310,101 @@

      +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      Base exception constructor.
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Base exception constructor.

      + + + public + __construct(string $message[, Throwable|null $previous = null ][, int $code = 0 ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $message + : string +
      +
      +

      Exception message.

      +
      + +
      +
      + $previous + : Throwable|null + = null
      +
      +

      Previous exception or error.

      +
      + +
      +
      + $code + : int + = 0
      +
      +

      Error code.

      +
      + +
      +
      + + + + + + +
      +
      +
      @@ -423,10 +510,17 @@

    • Table Of Contents
      • -
      +
    • Methods
    • + +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Exceptions-ServerException.html b/docs/classes/ArangoDB-Exceptions-ServerException.html index b74d17d..e249e9b 100644 --- a/docs/classes/ArangoDB-Exceptions-ServerException.html +++ b/docs/classes/ArangoDB-Exceptions-ServerException.html @@ -310,14 +310,101 @@

      +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      Base exception constructor.
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Base exception constructor.

      + + + public + __construct(string $message[, Throwable|null $previous = null ][, int $code = 0 ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $message + : string +
      +
      +

      Exception message.

      +
      + +
      +
      + $previous + : Throwable|null + = null
      +
      +

      Previous exception or error.

      +
      + +
      +
      + $code + : int + = 0
      +
      +

      Error code.

      +
      + +
      +
      + + + + + + +
      +
      +
      @@ -423,10 +510,17 @@

    • Table Of Contents
      • -
      +
    • Methods
    • + +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Exceptions-TransactionException.html b/docs/classes/ArangoDB-Exceptions-TransactionException.html index 01c7b91..b3c9f9d 100644 --- a/docs/classes/ArangoDB-Exceptions-TransactionException.html +++ b/docs/classes/ArangoDB-Exceptions-TransactionException.html @@ -310,14 +310,101 @@

      +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      Base exception constructor.
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Base exception constructor.

      + + + public + __construct(string $message[, Throwable|null $previous = null ][, int $code = 0 ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $message + : string +
      +
      +

      Exception message.

      +
      + +
      +
      + $previous + : Throwable|null + = null
      +
      +

      Previous exception or error.

      +
      + +
      +
      + $code + : int + = 0
      +
      +

      Error code.

      +
      + +
      +
      + + + + + + +
      +
      +
      @@ -423,10 +510,17 @@

    • Table Of Contents
      • -
      +
    • Methods
    • + +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Graph-EdgeDefinition.html b/docs/classes/ArangoDB-Graph-EdgeDefinition.html index fd369a5..21ad330 100644 --- a/docs/classes/ArangoDB-Graph-EdgeDefinition.html +++ b/docs/classes/ArangoDB-Graph-EdgeDefinition.html @@ -306,15 +306,453 @@

      +

      + Properties + +

      +
      +
      + $collection + +  : string +
      +
      Name of the edge collection.
      + +
      + $from + +  : array<string|int, mixed> +
      +
      List of vertex collection names. <br> +Edges in collection can only be inserted if their _from is in any of the collections here.
      + +
      + $to + +  : array<string|int, mixed> +
      +
      List of vertex collection names. <br> +Edges in collection can only be inserted if their _to is in any of the collections here.
      + +
      + +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      EdgeDefinition constructor.
      + +
      + from() + +  : array<string|int, mixed> +
      +
      List of vertex collection names. <br> +Edges in collection can only be inserted if their _from is in any of the collections here.
      + +
      + getCollection() + +  : string +
      +
      Name of the edge collection.
      + +
      + to() + +  : array<string|int, mixed> +
      +
      List of vertex collection names. <br> +Edges in collection can only be inserted if their _to is in any of the collections here.
      + +
      + toArray() + +  : array<string|int, mixed> +
      +
      Array representation of edge definition.
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $collection + + + + +

      + + +

      Name of the edge collection.

      + + + + protected + string + $collection + + + + + + + + + + +
      +
      +

      + $from + + + + +

      + + +

      List of vertex collection names. <br> +Edges in collection can only be inserted if their _from is in any of the collections here.

      + + + + protected + array<string|int, mixed> + $from + = [] + + + + + + + + + +
      +
      +

      + $to + + + + +

      + + +

      List of vertex collection names. <br> +Edges in collection can only be inserted if their _to is in any of the collections here.

      + + + + protected + array<string|int, mixed> + $to + = [] + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      EdgeDefinition constructor.

      + + + public + __construct(string $collection, array<string|int, mixed> $from, array<string|int, mixed> $to) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      Edge collection name.

      +
      + +
      +
      + $from + : array<string|int, mixed> +
      +
      +

      List of vertex collection names.

      +
      + +
      +
      + $to + : array<string|int, mixed> +
      +
      +

      List of vertex collection names.

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

      + from() + + +

      + + +

      List of vertex collection names. <br> +Edges in collection can only be inserted if their _from is in any of the collections here.

      + + + public + from() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + getCollection() + + +

      + + +

      Name of the edge collection.

      + + + public + getCollection() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + to() + + +

      + + +

      List of vertex collection names. <br> +Edges in collection can only be inserted if their _to is in any of the collections here.

      + + + public + to() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + toArray() + + +

      + + +

      Array representation of edge definition.

      + + + public + toArray() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +
      @@ -420,10 +858,30 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Graph-Graph.html b/docs/classes/ArangoDB-Graph-Graph.html index cfa57c1..a6839f8 100644 --- a/docs/classes/ArangoDB-Graph-Graph.html +++ b/docs/classes/ArangoDB-Graph-Graph.html @@ -316,15 +316,2662 @@

      +

      + Properties + +

      +
      +
      + $database + +  : Database +
      +
      Database object of graph
      + +
      + $edgeDefinitions + +  : ArrayList +
      +
      An array of definitions for the relations of graph.
      + +
      + $id + +  : string +
      +
      The internal id of this graph.
      + +
      + $isNew + +  : bool +
      +
      If this graph is a new one or a representation of existing document.
      + +
      + $isSmart + +  : bool +
      +
      Flag if the graph is a smart graph.
      + +
      + $key + +  : string +
      +
      The name of graph.
      + +
      + $minReplicationFactor + +  : int +
      +
      The minimal replication factor used for every new collection in the graph.<br> +If one shard has less than minReplicationFactor copies, +we cannot write to this shard, but to all others.
      + +
      + $name + +  : string +
      +
      Graph name.
      + +
      + $numberOfShards + +  : int +
      +
      Number of shards created for every new collection in the graph.
      + +
      + $orphanCollections + +  : array<string|int, mixed> +
      +
      An array of additional vertex collections.<br> +Documents within these collections do not have edges within this graph.
      + +
      + $replicationFactor + +  : int +
      +
      The replication factor used for every new collection in the graph.
      + +
      + $revision + +  : string +
      +
      The revision of graph.
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Graph constructor.
      + +
      + __toString() + +  : string +
      +
      Returns a string representation of graph object.
      + +
      + addEdge() + +  : 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 +Furthermore, the edge has to be valid in the definition of the used.
      + +
      + addEdgeDefinition() + +  : bool +
      +
      Adds an edge definition to graph.
      + +
      + addVertex() + +  : bool +
      +
      Adds a vertex to graph.
      + +
      + addVertexCollection() + +  : bool +
      +
      Adds a vertex collection to the set of orphan collections of the graph.
      + +
      + delete() + +  : bool +
      +
      Removes a graph from server, if possible.
      + +
      + dropEdge() + +  : bool +
      +
      Drops an edge from graph.
      + +
      + dropEdgeDefinition() + +  : bool +
      +
      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.
      + +
      + dropVertex() + +  : bool +
      +
      Drops a vertex from graph.
      + +
      + dropVertexCollection() + +  : bool +
      +
      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.
      + +
      + getEdge() + +  : Edge|false +
      +
      Returns an edge document.
      + +
      + getEdgeDefinitions() + +  : ArrayList +
      +
      Return all edge definitions of graph.
      + +
      + getId() + +  : string +
      +
      Returns the graph ID.
      + +
      + getKey() + +  : string +
      +
      Returns the graph key.
      + +
      + getMinReplicationFactor() + +  : int +
      +
      Returns the minimal replication factor used for every new collection in the graph.
      + +
      + getName() + +  : string +
      +
      Gets the graph name.
      + +
      + getNumberOfShards() + +  : int +
      +
      Returns the number of shards that is used for every collection within this graph.
      + +
      + getOrphanCollections() + +  : array<string|int, mixed> +
      +
      Returns the orphan collections in the graph.
      + +
      + getReplicationFactor() + +  : int +
      +
      Returns the replication factor used when initially creating collections for this graph.
      + +
      + getRevision() + +  : string +
      +
      Gets the graph revision.
      + +
      + getVertex() + +  : Vertex|false +
      +
      Gets a vertex from the given collection.
      + +
      + getVertexCollections() + +  : ArrayList +
      +
      Lists all vertex collections within this graph.
      + +
      + isNew() + +  : bool +
      +
      Returns true if is a new graph.
      + +
      + isSmart() + +  : bool +
      +
      If this graph is a smartGraph.
      + +
      + jsonSerialize() + +  : array<string|int, mixed>|mixed +
      +
      Return a JSON representation of graph attributes.
      + +
      + save() + +  : bool +
      +
      Save the Graph on server, if possible.
      + +
      + toArray() + +  : array<string|int, mixed> +
      +
      Returns a array representation of graph.
      + +
      + traversal() + +  : Traversal +
      +
      Returns a graph traversal.
      + +
      + getCreateParameters() + +  : array<string|int, mixed> +
      +
      Return an array with parameters to create the graph.
      + +
      + + + + + + +
      +

      + Properties + + +

      +
      +

      + $database + + + + +

      + + +

      Database object of graph

      + + + + protected + Database + $database + + + + + + + + + + +
      +
      +

      + $edgeDefinitions + + + + +

      + + +

      An array of definitions for the relations of graph.

      + + + + protected + ArrayList + $edgeDefinitions + + + + + + + + + + +
      +
      +

      + $id + + + + +

      + + +

      The internal id of this graph.

      + + + + protected + string + $id + + + + + + + + + + +
      +
      +

      + $isNew + + + + +

      + + +

      If this graph is a new one or a representation of existing document.

      + + + + protected + bool + $isNew + + + + + + + + + + +
      +
      +

      + $isSmart + + + + +

      + + +

      Flag if the graph is a smart graph.

      + + + + protected + bool + $isSmart + + + + + + + + + + +
      +
      +

      + $key + + + + +

      + + +

      The name of graph.

      + + + + protected + string + $key + + + + + + + + + + +
      +
      +

      + $minReplicationFactor + + + + +

      + + +

      The minimal replication factor used for every new collection in the graph.<br> +If one shard has less than minReplicationFactor copies, +we cannot write to this shard, but to all others.

      + + + + protected + int + $minReplicationFactor + + + + + + + + + + +
      +
      +

      + $name + + + + +

      + + +

      Graph name.

      + + + + protected + string + $name + + + + + + + + + + +
      +
      +

      + $numberOfShards + + + + +

      + + +

      Number of shards created for every new collection in the graph.

      + + + + protected + int + $numberOfShards + + + + + + + + + + +
      +
      +

      + $orphanCollections + + + + +

      + + +

      An array of additional vertex collections.<br> +Documents within these collections do not have edges within this graph.

      + + + + protected + array<string|int, mixed> + $orphanCollections + = [] + + + + + + + + + +
      +
      +

      + $replicationFactor + + + + +

      + + +

      The replication factor used for every new collection in the graph.

      + + + + protected + int + $replicationFactor + + + + + + + + + + +
      +
      +

      + $revision + + + + +

      + + +

      The revision of graph.

      + + + + protected + string + $revision + + +

      Can be used to make sure to not override concurrent modifications to this graph.

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

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Graph constructor.

      + + + public + __construct(string $name[, array<string|int, mixed> $attributes = [] ][, Database|null $database = null ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      +

      Graph name.

      +
      + +
      +
      + $attributes + : array<string|int, mixed> + = []
      +
      +

      Graph optional attributes.

      +
      + +
      +
      + $database + : Database|null + = null
      +
      +

      Database object.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException|MissingParameterException|Exception + + +
      +
      + + + + +
      +
      +

      + __toString() + + +

      + + +

      Returns a string representation of graph object.

      + + + public + __toString() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + addEdge() + + +

      + + +

      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 +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 ]) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      The name of the edge collection the edge belongs to.

      +
      + +
      +
      + $attributes + : array<string|int, mixed> + = []
      +
      +

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

      +
      + +
      +
      + $waitForSync + : bool + = true
      +
      +

      Define if the request should wait until synced to disk. Default is true.

      +
      + +
      +
      + $returnNew + : bool + = false
      +
      +

      Define if the response should contain the complete new version of the document. Default is false.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|Exception + + +
      +
      + + + +
      +
      Return values
      + 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.

      +
      + +
      + +
      +
      +

      + addEdgeDefinition() + + +

      + + +

      Adds an edge definition to graph.

      + + + public + addEdgeDefinition(string $collection, array<string|int, mixed> $from, array<string|int, mixed> $to) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      Edge collection name.

      +
      + +
      +
      + $from + : array<string|int, mixed> +
      +
      +

      List of vertex collection names.

      +
      + +
      +
      + $to + : array<string|int, mixed> +
      +
      +

      List of vertex collection names.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException + + +
      +
      + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + addVertex() + + +

      + + +

      Adds a vertex to graph.

      + + + public + addVertex(string $collection[, array<string|int, mixed> $attributes = [] ][, bool $waitForSync = true ][, bool $returnNew = true ]) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      The name of the vertex collection the vertex should be inserted into.

      +
      + +
      +
      + $attributes + : array<string|int, mixed> + = []
      +
      +

      The object attributes to be stored.

      +
      + +
      +
      + $waitForSync + : bool + = true
      +
      +

      Define if the request should wait until synced to disk. Default is true.

      +
      + +
      +
      + $returnNew + : bool + = true
      +
      +

      Define if the response should contain the complete new version of the document. Default is true.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|Exception + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      True if the vertex could be added. False if no graph with this name could be found
      +or if a graph is found but the collection is not part of the graph.

      +
      + +
      + +
      +
      +

      + addVertexCollection() + + +

      + + +

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

      + + + public + addVertexCollection(string $collection) : bool + +
      +
      + +

      If the collection does not exist, it will be created.

      +
      + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      The name of the vertex collection.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|Exception + + +
      +
      + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + delete() + + +

      + + +

      Removes a graph from server, if possible.

      + + + public + delete([bool $dropCollections = false ]) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $dropCollections + : bool + = false
      +
      +

      If set true, drop collections of this graph as well.
      +Collections will only be dropped if they are not used in other graphs.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      True if operation was successful, false otherwise.

      +
      + +
      + +
      +
      +

      + dropEdge() + + +

      + + +

      Drops an edge from graph.

      + + + public + dropEdge(string $collection, string $edge[, bool $waitForSync = true ][, bool $returnOld = false ]) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      The name of the edge collection the edge belongs to.

      +
      + +
      +
      + $edge + : string +
      +
      +

      The _key attribute of the edge.

      +
      + +
      +
      + $waitForSync + : bool + = true
      +
      +

      Define if the request should wait until synced to disk. Default is true.

      +
      + +
      +
      + $returnOld + : bool + = false
      +
      +

      Define if the response should contain the complete new version of the document. Default is false.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|Exception + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      True if the edge could be removed. False if no graph with this name could be found
      +or if a graph is found but the collection is not part of the graph.

      +
      + +
      + +
      +
      +

      + dropEdgeDefinition() + + +

      + + +

      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.

      + + + public + dropEdgeDefinition(string $collection[, bool $dropCollection = false ][, bool $waitForSync = true ]) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      Edge collection name.

      +
      + +
      +
      + $dropCollection + : bool + = false
      +
      +

      Drop the collection as well. Collection will only be dropped if it is not used in other graphs.

      +
      + +
      +
      + $waitForSync + : bool + = true
      +
      +

      Define if the request should wait until synced to disk.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException + + +
      +
      + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + dropVertex() + + +

      + + +

      Drops a vertex from graph.

      + + + public + dropVertex(string $collection, string $vertex[, bool $waitForSync = true ][, bool $returnOld = false ]) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      The name of the vertex collection the vertex belongs to.

      +
      + +
      +
      + $vertex + : string +
      +
      +

      The _key attribute of the vertex.

      +
      + +
      +
      + $waitForSync + : bool + = true
      +
      +

      Define if the request should wait until synced to disk. Default is true.

      +
      + +
      +
      + $returnOld + : bool + = false
      +
      +

      Define if the response should contain the complete new version of the document. Default is false.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|Exception + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      True if the vertex could be removed. False if no graph with this name could be found
      +or if a graph is found but the collection is not part of the graph.

      +
      + +
      + +
      +
      +

      + dropVertexCollection() + + +

      + + +

      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.

      + + + public + dropVertexCollection(string $collection[, bool $dropCollection = false ]) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      The name of the vertex collection.

      +
      + +
      +
      + $dropCollection + : bool + = false
      +
      +

      Drop the collection as well. Collection will only be dropped if it is not used in other graphs.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|Exception + + +
      +
      + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + getEdge() + + +

      + + +

      Returns an edge document.

      + + + public + getEdge(string $collection, string $edge) : Edge|false + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      The name of the edge collection the edge belongs to.

      +
      + +
      +
      + $edge + : string +
      +
      +

      The _key attribute of the edge.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|Exception|MissingParameterException|InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + Edge|false + — +

      A Edge object if edge exists. False if no graph with this name could be found
      +or this collection is not part of the graph or the edge does not exist.

      +
      + +
      + +
      +
      +

      + getEdgeDefinitions() + + +

      + + +

      Return all edge definitions of graph.

      + + + public + getEdgeDefinitions() : ArrayList + +
      +
      + + + + + + + +
      +
      Return values
      + ArrayList +
      + +
      +
      +

      + getId() + + +

      + + +

      Returns the graph ID.

      + + + public + getId() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + getKey() + + +

      + + +

      Returns the graph key.

      + + + public + getKey() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + getMinReplicationFactor() + + +

      + + +

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

      + + + public + getMinReplicationFactor() : int + +
      +
      + + + + + + + +
      +
      Return values
      + int +
      + +
      +
      +

      + getName() + + +

      + + +

      Gets the graph name.

      + + + public + getName() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + getNumberOfShards() + + +

      + + +

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

      + + + public + getNumberOfShards() : int + +
      +
      + + + + + + + +
      +
      Return values
      + int +
      + +
      +
      +

      + getOrphanCollections() + + +

      + + +

      Returns the orphan collections in the graph.

      + + + public + getOrphanCollections() : array<string|int, mixed> + +
      +
      + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      +
      +
      +

      + getReplicationFactor() + - +

      + + +

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

      + + + public + getReplicationFactor() : int + +
      +
      + + + + + + + +
      +
      Return values
      + int +
      + +
      +
      +

      + getRevision() + + +

      + + +

      Gets the graph revision.

      + + + public + getRevision() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + getVertex() + + +

      + + +

      Gets a vertex from the given collection.

      + + + public + getVertex(string $collection, string $vertex) : Vertex|false + +
      +
      + + +
      Parameters
      +
      +
      + $collection + : string +
      +
      +

      The name of the vertex collection the vertex belongs to.

      +
      + +
      +
      + $vertex + : string +
      +
      +

      The _key attribute of the vertex.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|InvalidParameterException|MissingParameterException + + +
      +
      + + + +
      +
      Return values
      + Vertex|false + — +

      A Vertex object if vertex exists. False if no graph with this name could be found
      +or this collection is not part of the graph or the vertex does not exist.

      +
      + +
      + +
      +
      +

      + getVertexCollections() + + +

      + + +

      Lists all vertex collections within this graph.

      + + + public + getVertexCollections() : ArrayList + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|Exception + + +
      +
      + + + +
      +
      Return values
      + ArrayList +
      + +
      +
      +

      + isNew() + + +

      + + +

      Returns true if is a new graph.

      + + + public + isNew() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + isSmart() + + +

      + + +

      If this graph is a smartGraph.

      + + + public + isSmart() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +

      + jsonSerialize() + + +

      + + +

      Return a JSON representation of graph attributes.

      + + + public + jsonSerialize() : array<string|int, mixed>|mixed + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed>|mixed +
      + +
      +
      +

      + save() + + +

      + + +

      Save the Graph on server, if possible.

      + + + public + save() : bool + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + DatabaseException|GuzzleException|Exception + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      True if operation was successful, false otherwise.

      +
      + +
      + +
      +
      +

      + toArray() + + +

      + + +

      Returns a array representation of graph.

      + + + public + toArray() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + traversal() + + +

      + + +

      Returns a graph traversal.

      + + + public + traversal(Vertex $vertex[, string $direction = Traversal::GRAPH_DIRECTION_ANY ][, int $depth = 0 ]) : Traversal + +
      +
      + + +
      Parameters
      +
      +
      + $vertex + : Vertex +
      +
      +

      The start vertex.

      +
      + +
      +
      + $direction + : string + = Traversal::GRAPH_DIRECTION_ANY
      +
      +

      Direction for traversal. Must be either "outbound", "inbound", or "any".

      +
      + +
      +
      + $depth + : int + = 0
      +
      +

      Visits only nodes in at least the given depth.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException|GuzzleException|Exception + + +
      +
      + + + +
      +
      Return values
      + Traversal +
      + +
      +
      +

      + getCreateParameters() + + +

      + + +

      Return an array with parameters to create the graph.

      + + + private + getCreateParameters() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      -
      @@ -430,10 +3077,64 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Graph-Traversal-Path.html b/docs/classes/ArangoDB-Graph-Traversal-Path.html index 41a539d..1dc7c00 100644 --- a/docs/classes/ArangoDB-Graph-Traversal-Path.html +++ b/docs/classes/ArangoDB-Graph-Traversal-Path.html @@ -308,15 +308,310 @@

      +

      + Properties + +

      +
      +
      + $edges + +  : ArrayList +
      +
      ArrayList with path edges
      + +
      + $vertices + +  : ArrayList +
      +
      ArrayList with path vertices
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Path constructor.
      +
      + getEdges() + +  : ArrayList +
      +
      Return all the path edges
      + +
      + getVertices() + +  : ArrayList +
      +
      Return all the path vertices
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $edges + + + + +

      + + +

      ArrayList with path edges

      + + + + protected + ArrayList + $edges + + + + + + + + + + +
      +
      +

      + $vertices + + + + +

      + + +

      ArrayList with path vertices

      + + + + protected + ArrayList + $vertices + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Path constructor.

      + + + public + __construct(array<string|int, mixed> $edges, array<string|int, mixed> $vertices) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $edges + : array<string|int, mixed> +
      +
      +

      Path edges

      +
      + +
      +
      + $vertices + : array<string|int, mixed> +
      +
      +

      Path vertices

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException|MissingParameterException + + +
      +
      + + + + +
      +
      +

      + getEdges() + + +

      + + +

      Return all the path edges

      + + + public + getEdges() : ArrayList + +
      +
      + + + + + + + +
      +
      Return values
      + ArrayList +
      + +
      +
      +

      + getVertices() + + +

      + + +

      Return all the path vertices

      + + + public + getVertices() : ArrayList + +
      +
      + + + + + + + +
      +
      Return values
      + ArrayList +
      + +
      +
      +
      @@ -422,10 +717,27 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Graph-Traversal-Traversal.html b/docs/classes/ArangoDB-Graph-Traversal-Traversal.html index 30d8bbd..26bd73d 100644 --- a/docs/classes/ArangoDB-Graph-Traversal-Traversal.html +++ b/docs/classes/ArangoDB-Graph-Traversal-Traversal.html @@ -306,17 +306,566 @@

      +

      + Constants + +

      +
      +
      + GRAPH_DIRECTION_ANY + +  = 'ANY' +
      +
      Any graph direction.
      +
      + GRAPH_DIRECTION_INBOUND + +  = 'INBOUND' +
      +
      Inbound graph direction.
      +
      + GRAPH_DIRECTION_OUTBOUND + +  = 'OUTBOUND' +
      +
      Outbound graph direction.
      +
      + + +

      + Properties + + +

      +
      +
      + $connection + +  : Connection +
      +
      Connection to use to manage database
      + +
      + $cursor + +  : Cursor +
      +
      Cursor object
      + +
      + $statement + +  : Statement +
      +
      The traversal query
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Traversal constructor.
      + +
      + toAql() + +  : string +
      +
      Returns the query,
      + +
      + traversalQuery() + +  : Traversal +
      +
      Returns a default traversal
      + +
      - +
      +

      + Constants + + +

      +
      +

      + GRAPH_DIRECTION_ANY + + +

      + + + +

      Any graph direction.

      + + + + public + string + GRAPH_DIRECTION_ANY + = 'ANY' + + + + + + + + + +
      +
      +

      + GRAPH_DIRECTION_INBOUND + + +

      + + + +

      Inbound graph direction.

      + + + + public + string + GRAPH_DIRECTION_INBOUND + = 'INBOUND' + + + + + + + + + +
      +
      +

      + GRAPH_DIRECTION_OUTBOUND + + +

      + + + +

      Outbound graph direction.

      + + + + public + string + GRAPH_DIRECTION_OUTBOUND + = 'OUTBOUND' + + + + + + + + + +
      +
      +
      +

      + Properties + + +

      +
      +

      + $connection + + + + +

      + + +

      Connection to use to manage database

      + + + + protected + Connection + $connection + + + + + + + + + + +
      +
      +

      + $cursor + + + + +

      + + +

      Cursor object

      + + + + protected + Cursor + $cursor + + + + + + + + + + +
      +
      +

      + $statement + + + + +

      + + +

      The traversal query

      + + + + protected + Statement + $statement + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Traversal constructor.

      + + + public + __construct(Statement $statement[, Connection|null $connection = null ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $statement + : Statement +
      +
      +

      AQL Statement for traversal.

      +
      + +
      +
      + $connection + : Connection|null + = null
      +
      +

      The connection object to use.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException|GuzzleException + + +
      +
      + + + + +
      +
      +

      + toAql() + + +

      + + +

      Returns the query,

      + + + public + toAql() : string + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + StatementException + + +
      +
      + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + traversalQuery() + + +

      + + +

      Returns a default traversal

      + + + public + static traversalQuery(Vertex $vertex, string $graph[, string $direction = self::GRAPH_DIRECTION_ANY ][, int $depth = 0 ]) : Traversal + +
      +
      + + +
      Parameters
      +
      +
      + $vertex + : Vertex +
      +
      +

      Vertex to start graph traversal.

      +
      + +
      +
      + $graph + : string +
      +
      +

      The graph to traverse.

      +
      + +
      +
      + $direction + : string + = self::GRAPH_DIRECTION_ANY
      +
      +

      Direction for traversal.

      +
      + +
      +
      + $depth + : int + = 0
      +
      +

      Visits only nodes in at least the given depth.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + CursorException|GuzzleException|Exception + + +
      +
      + + + +
      +
      Return values
      + Traversal + — +

      Traversal object.

      +
      + +
      + +
      +
      +
      @@ -422,10 +971,37 @@

    • Table Of Contents
      • -
      +
    • Constants
    • +
    • Properties
    • +
    • Methods
    • + +
    • Constants
    • +
    • + +
    • +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Http-Api.html b/docs/classes/ArangoDB-Http-Api.html index ec5ff19..1f08057 100644 --- a/docs/classes/ArangoDB-Http-Api.html +++ b/docs/classes/ArangoDB-Http-Api.html @@ -306,17 +306,2736 @@

      +

      + Constants + + +

      +
      +
      + ADMIN_ENGINE + +  = "/_api/engine" +
      + +
      + ADMIN_FLUSH_WAL + +  = "/_admin/wal/flush" +
      + +
      + ADMIN_LOG + +  = "/_admin/log" +
      + +
      + ADMIN_LOG_LEVEL + +  = "/_admin/log/level" +
      + +
      + ADMIN_ROUTING_RELOAD + +  = "/_admin/routing/reload" +
      + +
      + ADMIN_SERVER_AVAILABILITY + +  = "/_admin/server/availability" +
      + +
      + ADMIN_SERVER_ROLE + +  = "/_admin/server/role" +
      + +
      + ADMIN_STATISTICS + +  = "/_admin/statistics" +
      + +
      + ADMIN_STATISTICS_DESCRIPTION + +  = "/_admin/statistics-description" +
      + +
      + ADMIN_TASKS + +  = "/_api/tasks" +
      + +
      + ADMIN_TIME + +  = "/_admin/time" +
      + +
      + ADMIN_VERSION + +  = "/_api/version" +
      + +
      + ADMIN_WAL_PROPERTIES + +  = "_admin/wal/properties" +
      + +
      + ADMIN_WAL_TRANSACTIONS + +  = "_admin/wal/transactions" +
      + +
      + ALL + +  = "/_api/simple/all" +
      + +
      + ALL_KEYS + +  = "/_api/simple/all" +
      + +
      + ANY + +  = "/_api/simple/any" +
      + +
      + AQL_USER_FUNCTION + +  = "/_api/aqlfunction" +
      + +
      + AUTH_BASE + +  = "/_open/auth" +
      + +
      + BATCH + +  = "/_api/batch" +
      + +
      + COLLECTION + +  = "/_api/collection" +
      + +
      + COLLECTION_CHECKSUM + +  = "/checksum" +
      + +
      + COLLECTION_COUNT + +  = "/count" +
      + +
      + COLLECTION_LOAD + +  = "/load" +
      + +
      + COLLECTION_PROPERTIES + +  = "/properties" +
      + +
      + COLLECTION_RECALCULATE_COUNT + +  = "/recalculateCount" +
      + +
      + COLLECTION_RENAME + +  = "/rename" +
      + +
      + COLLECTION_REVISION + +  = "/revision" +
      + +
      + COLLECTION_ROTATE + +  = "/rotate" +
      + +
      + COLLECTION_TRUNCATE + +  = "/truncate" +
      + +
      + CURRENT_DATABASE + +  = "/_api/database/current" +
      + +
      + CURSOR + +  = "/_api/cursor" +
      + +
      + DATABASE + +  = "/_api/database" +
      + +
      + DB + +  = "/_db/" +
      + +
      + DOCUMENT + +  = "/_api/document" +
      + +
      + EDGE + +  = "/_api/document" +
      + +
      + EDGES + +  = "/_api/edges" +
      + +
      + ENDPOINT + +  = "/_api/endpoint" +
      + +
      + EXAMPLE + +  = "/_api/simple/by-example" +
      + +
      + EXPLAIN + +  = "/_api/explain" +
      + +
      + FIRST_EXAMPLE + +  = "/_api/simple/first-example" +
      + +
      + FOXX + +  = "/_api/foxx" +
      + +
      + FOXX_SERVICE + +  = "/_api/foxx/service" +
      + +
      + FULLTEXT + +  = "/_api/simple/fulltext" +
      + +
      + GRAPH + +  = "/_api/gharial" +
      + +
      + IMPORT + +  = "/_api/import" +
      + +
      + INDEX + +  = "/_api/index" +
      + +
      + JWT_AUTH_BASE + +  = "/_open/auth" +
      + +
      + LOOKUP_BY_KEYS + +  = "/_api/simple/lookup-by_keys" +
      + +
      + PART_EDGE + +  = "vertex" +
      + +
      + PART_VERTEX + +  = "vertex" +
      + +
      + QUERY + +  = "/_api/query" +
      + +
      + QUERY_CACHE + +  = "/_api/query-cache" +
      + +
      + REMOVE_BY_EXAMPLE + +  = "/_api/simple/remove-by-example" +
      + +
      + REMOVE_BY_KEYS + +  = "/_api/simple/remove-by-keys" +
      + +
      + REPLACE_BY_EXAMPLE + +  = "/_api/simple/replace-by-example" +
      + +
      + TRANSACTION + +  = "/_api/transaction" +
      + +
      + TRANSACTION_BEGIN + +  = "/_api/transaction/begin" +
      + +
      + TRAVERSAL + +  = "/_api/traversal" +
      + +
      + UPDATE_BY_EXAMPLE + +  = "/_api/simple/update-by-example" +
      + +
      + UPLOAD + +  = "/_api/upload" +
      + +
      + USER + +  = "/_api/user" +
      + +
      + USER_DATABASES + +  = "/_api/database/user" +
      + +
      + + + +

      + Methods + + +

      +
      +
      + addQuery() + +  : string +
      +
      Add a URI query
      + +
      + addUriParam() + +  : string +
      +
      Add a param to the URI
      + +
      + buildDatabaseUri() + +  : string +
      +
      Builds URIs for access to Arango HTTP Interface
      + +
      + buildSystemUri() + +  : string +
      +
      Builds URIs for access some special endpoints on Arango HTTP Interface
      + +
      + + + + +
      +

      + Constants + + +

      +
      +

      + ADMIN_ENGINE + + +

      + + + + + + + public + mixed + ADMIN_ENGINE + = "/_api/engine" + + + + + + + + + +
      +
      +

      + ADMIN_FLUSH_WAL + + +

      + + + + + + + public + mixed + ADMIN_FLUSH_WAL + = "/_admin/wal/flush" + + + + + + + + + +
      +
      +

      + ADMIN_LOG + + +

      + + + + + + + public + mixed + ADMIN_LOG + = "/_admin/log" + + + + + + + + + +
      +
      +

      + ADMIN_LOG_LEVEL + + +

      + + + + + + + public + mixed + ADMIN_LOG_LEVEL + = "/_admin/log/level" + + + + + + + + + +
      +
      +

      + ADMIN_ROUTING_RELOAD + + +

      + + + + + + + public + mixed + ADMIN_ROUTING_RELOAD + = "/_admin/routing/reload" + + + + + + + + + +
      +
      +

      + ADMIN_SERVER_AVAILABILITY + + +

      + + + + + + + public + mixed + ADMIN_SERVER_AVAILABILITY + = "/_admin/server/availability" + + + + + + + + + +
      +
      +

      + ADMIN_SERVER_ROLE + + +

      + + + + + + + public + mixed + ADMIN_SERVER_ROLE + = "/_admin/server/role" + + + + + + + + + +
      +
      +

      + ADMIN_STATISTICS + + +

      + + + + + + + public + mixed + ADMIN_STATISTICS + = "/_admin/statistics" + + + + + + + + + +
      +
      +

      + ADMIN_STATISTICS_DESCRIPTION + + +

      + + + + + + + public + mixed + ADMIN_STATISTICS_DESCRIPTION + = "/_admin/statistics-description" + + + + + + + + + +
      +
      +

      + ADMIN_TASKS + + +

      + + + + + + + public + mixed + ADMIN_TASKS + = "/_api/tasks" + + + + + + + + + +
      +
      +

      + ADMIN_TIME + + +

      + + + + + + + public + mixed + ADMIN_TIME + = "/_admin/time" + + + + + + + + + +
      +
      +

      + ADMIN_VERSION + + +

      + + + + + + + public + mixed + ADMIN_VERSION + = "/_api/version" + + + + + + + + + +
      +
      +

      + ADMIN_WAL_PROPERTIES + + +

      + + + + + + + public + mixed + ADMIN_WAL_PROPERTIES + = "_admin/wal/properties" + + + + + + + + + +
      +
      +

      + ADMIN_WAL_TRANSACTIONS + + +

      + + + + + + + public + mixed + ADMIN_WAL_TRANSACTIONS + = "_admin/wal/transactions" + + + + + + + + + +
      +
      +

      + ALL + + +

      + + + + + + + public + mixed + ALL + = "/_api/simple/all" + + + + + + + + + +
      +
      +

      + ALL_KEYS + + +

      + + + + + + + public + mixed + ALL_KEYS + = "/_api/simple/all" + + + + + + + + + +
      +
      +

      + ANY + + +

      + + + + + + + public + mixed + ANY + = "/_api/simple/any" + + + + + + + + + +
      +
      +

      + AQL_USER_FUNCTION + + +

      + + + + + + + public + mixed + AQL_USER_FUNCTION + = "/_api/aqlfunction" + + + + + + + + + +
      +
      +

      + AUTH_BASE + + +

      + + + + + + + public + mixed + AUTH_BASE + = "/_open/auth" + + + + + + + + + +
      +
      +

      + BATCH + + +

      + + + + + + + public + mixed + BATCH + = "/_api/batch" + + + + + + + + + +
      +
      +

      + COLLECTION + + +

      + + + + + + + public + mixed + COLLECTION + = "/_api/collection" + + + + + + + + + +
      +
      +

      + COLLECTION_CHECKSUM + + +

      + + + + + + + public + mixed + COLLECTION_CHECKSUM + = "/checksum" + + + + + + + + + +
      +
      +

      + COLLECTION_COUNT + + +

      + + + + + + + public + mixed + COLLECTION_COUNT + = "/count" + + + + + + + + + +
      +
      +

      + COLLECTION_LOAD + + +

      + + + + + + + public + mixed + COLLECTION_LOAD + = "/load" + + + + + + + + + +
      +
      +

      + COLLECTION_PROPERTIES + + +

      + + + + + + + public + mixed + COLLECTION_PROPERTIES + = "/properties" + + + + + + + + + +
      +
      +

      + COLLECTION_RECALCULATE_COUNT + + +

      + + + + + + + public + mixed + COLLECTION_RECALCULATE_COUNT + = "/recalculateCount" + + + + + + + + + +
      +
      +

      + COLLECTION_RENAME + + +

      + + + + + + + public + mixed + COLLECTION_RENAME + = "/rename" + + + + + + + + + +
      +
      +

      + COLLECTION_REVISION + + +

      + + + + + + + public + mixed + COLLECTION_REVISION + = "/revision" + + + + + + + + + +
      +
      +

      + COLLECTION_ROTATE + + +

      + + + + + + + public + mixed + COLLECTION_ROTATE + = "/rotate" + + + + + + + + + +
      +
      +

      + COLLECTION_TRUNCATE + + +

      + + + + + + + public + mixed + COLLECTION_TRUNCATE + = "/truncate" + + + + + + + + + +
      +
      +

      + CURRENT_DATABASE + + +

      + + + + + + + public + mixed + CURRENT_DATABASE + = "/_api/database/current" + + + + + + + + + +
      +
      +

      + CURSOR + + +

      + + + + + + + public + mixed + CURSOR + = "/_api/cursor" + + + + + + + + + +
      +
      +

      + DATABASE + + +

      + + + + + + + public + mixed + DATABASE + = "/_api/database" + + + + + + + + + +
      +
      +

      + DB + + +

      + + + + + + + public + mixed + DB + = "/_db/" + + + + + + + + + +
      +
      +

      + DOCUMENT + + +

      + + + + + + + public + mixed + DOCUMENT + = "/_api/document" + + + + + + + + + +
      +
      +

      + EDGE + + +

      + + + + + + + public + mixed + EDGE + = "/_api/document" + + + + + + + + + +
      +
      +

      + EDGES + + +

      + + + + + + + public + mixed + EDGES + = "/_api/edges" + + + + + + + + + +
      +
      +

      + ENDPOINT + + +

      + + + + + + + public + mixed + ENDPOINT + = "/_api/endpoint" + + + + + + + + + +
      +
      +

      + EXAMPLE + + +

      + + + + + + + public + mixed + EXAMPLE + = "/_api/simple/by-example" + + + + + + + + + +
      +
      +

      + EXPLAIN + + +

      + + + + + + + public + mixed + EXPLAIN + = "/_api/explain" + + + + + + + + + +
      +
      +

      + FIRST_EXAMPLE + + +

      + + + + + + + public + mixed + FIRST_EXAMPLE + = "/_api/simple/first-example" + + + + + + + + + +
      +
      +

      + FOXX + + +

      + + + + + + + public + mixed + FOXX + = "/_api/foxx" + + + + + + + + + +
      +
      +

      + FOXX_SERVICE + + +

      + + + + + + + public + mixed + FOXX_SERVICE + = "/_api/foxx/service" + + + + + + + + + +
      +
      +

      + FULLTEXT + + +

      + + + + + + + public + mixed + FULLTEXT + = "/_api/simple/fulltext" + + + + + + + + + +
      +
      +

      + GRAPH + + +

      + + + + + + + public + mixed + GRAPH + = "/_api/gharial" + + + + + + + + + +
      +
      +

      + IMPORT + + +

      + + + + + + + public + mixed + IMPORT + = "/_api/import" + + + + + + + + + +
      +
      +

      + INDEX + + +

      + + + + + + + public + mixed + INDEX + = "/_api/index" + + + + + + + + + +
      +
      +

      + JWT_AUTH_BASE + + +

      + + + + + + + public + mixed + JWT_AUTH_BASE + = "/_open/auth" + + + + + + + + + +
      +
      +

      + LOOKUP_BY_KEYS + + +

      + + + + + + + public + mixed + LOOKUP_BY_KEYS + = "/_api/simple/lookup-by_keys" + + + + + + + + + +
      +
      +

      + PART_EDGE + + +

      + + + + + + + public + mixed + PART_EDGE + = "vertex" + + + + + + + + + +
      +
      +

      + PART_VERTEX + + +

      + + + + + + + public + mixed + PART_VERTEX + = "vertex" + + + + + + + + + +
      +
      +

      + QUERY + + +

      + + + + + + + public + mixed + QUERY + = "/_api/query" + + + + + + + + + +
      +
      +

      + QUERY_CACHE + + +

      + + + + + + + public + mixed + QUERY_CACHE + = "/_api/query-cache" + + + + + + + + + +
      +
      +

      + REMOVE_BY_EXAMPLE + + +

      + + + + + + + public + mixed + REMOVE_BY_EXAMPLE + = "/_api/simple/remove-by-example" + + + + + +
      +
      +

      + REMOVE_BY_KEYS + +

      - + + + + + + public + mixed + REMOVE_BY_KEYS + = "/_api/simple/remove-by-keys" + + + + + + + + + +
      +
      +

      + REPLACE_BY_EXAMPLE + + +

      + + + + + + + public + mixed + REPLACE_BY_EXAMPLE + = "/_api/simple/replace-by-example" + + + + + + + + + +
      +
      +

      + TRANSACTION + + +

      + + + + + + + public + mixed + TRANSACTION + = "/_api/transaction" + + + + + + + + + +
      +
      +

      + TRANSACTION_BEGIN + + +

      + + + + + + + public + mixed + TRANSACTION_BEGIN + = "/_api/transaction/begin" + + + + + + + + + +
      +
      +

      + TRAVERSAL + + +

      + + + + + + + public + mixed + TRAVERSAL + = "/_api/traversal" + + + + + + + + + +
      +
      +

      + UPDATE_BY_EXAMPLE + + +

      + + + + + + + public + mixed + UPDATE_BY_EXAMPLE + = "/_api/simple/update-by-example" + + + + + + + + + +
      +
      +

      + UPLOAD + + +

      + + + + + + + public + mixed + UPLOAD + = "/_api/upload" + + + + + + + + + +
      +
      +

      + USER + + +

      + + + + + + + public + mixed + USER + = "/_api/user" + + + + + + + + + +
      +
      +

      + USER_DATABASES + + +

      + + + + + + + public + mixed + USER_DATABASES + = "/_api/database/user" + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + addQuery() + + +

      + + +

      Add a URI query

      + + + public + static addQuery(string $baseUri[, array<string|int, mixed> $data = [] ]) : string + +
      +
      + + +
      Parameters
      +
      +
      + $baseUri + : string +
      +
      +

      Base URI to add a query.

      +
      + +
      +
      + $data + : array<string|int, mixed> + = []
      +
      +

      Query data.

      +
      + +
      +
      + + + + + +
      +
      Return values
      + string + — +

      The modified URI with the Query.

      +
      + +
      + +
      +
      +

      + addUriParam() + + +

      + + +

      Add a param to the URI

      + + + public + static addUriParam(string $baseUri, string|int $param) : string + +
      +
      + + +
      Parameters
      +
      +
      + $baseUri + : string +
      +
      +

      Base URI to add a parameter.

      +
      + +
      +
      + $param + : string|int +
      +
      +

      Parameter value.

      +
      + +
      +
      + + + + + +
      +
      Return values
      + string + — +

      The modified URI.

      +
      + +
      + +
      +
      +

      + buildDatabaseUri() + + +

      + + +

      Builds URIs for access to Arango HTTP Interface

      + + + public + static buildDatabaseUri(string $baseUri, string $database[, string $apiEndpoint = "" ]) : string + +
      +
      + + +
      Parameters
      +
      +
      + $baseUri + : string +
      +
      +

      Base URI to add a parameter.

      +
      + +
      +
      + $database + : string +
      +
      +

      Database name.

      +
      + +
      +
      + $apiEndpoint + : string + = ""
      +
      +

      Base Api endpoint (One of Api class public constants).

      +
      + +
      +
      + + + + + +
      +
      Return values
      + string + — +

      The modified database URI.

      +
      + +
      + +
      +
      +

      + buildSystemUri() + + +

      + + +

      Builds URIs for access some special endpoints on Arango HTTP Interface

      + + + public + static buildSystemUri(string $baseUri, string $endpoint) : string + +
      +
      + + +
      Parameters
      +
      +
      + $baseUri + : string +
      +
      +

      Base URI to add a parameter.

      +
      + +
      +
      + $endpoint + : string +
      +
      +

      One of Api class public constants.

      +
      + +
      +
      + + + + + +
      +
      Return values
      + string + — +

      The modified system URI.

      +
      + +
      + +
      +
      +
      @@ -422,10 +3141,89 @@

    • Table Of Contents
      • -
      +
    • Constants
    • +
    • Methods
    • + +
    • Constants
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Http-RestClient.html b/docs/classes/ArangoDB-Http-RestClient.html index 2c5236c..bd78cdc 100644 --- a/docs/classes/ArangoDB-Http-RestClient.html +++ b/docs/classes/ArangoDB-Http-RestClient.html @@ -306,15 +306,779 @@

      +

      + Properties + +

      +
      +
      + $baseUri + +  : string +
      +
      Base URI string.
      +
      + $httpClient + +  : Client +
      +
      Guzzle HTTP client.
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      RestClient constructor.
      + +
      + customHttpRequest() + +  : ResponseInterface +
      +
      Makes a custom HTTP request.
      + +
      + delete() + +  : ResponseInterface +
      +
      Performs a DELETE request.
      + +
      + get() + +  : ResponseInterface +
      +
      Performs a GET request.
      + +
      + patch() + +  : ResponseInterface +
      +
      Performs a PATCH request
      + +
      + post() + +  : ResponseInterface +
      +
      Performs a POST request.
      + +
      + put() + +  : mixed|ResponseInterface +
      +
      Performs a PUT request.
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $baseUri + + + + +

      + + +

      Base URI string.

      + + + + protected + string + $baseUri + + + + + + + + + + +
      +
      +

      + $httpClient + + + + +

      + + +

      Guzzle HTTP client.

      + + + + protected + Client + $httpClient + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      RestClient constructor.

      + + + public + __construct(string $baseUri[, array<string|int, mixed> $options = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $baseUri + : string +
      +
      +

      Base URI for all requests.

      +
      + +
      +
      + $options + : array<string|int, mixed> + = []
      +
      +

      Base options for all requests.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException + +

      If the base URI is invalid.

      +
      + +
      +
      + + + + +
      +
      +

      + customHttpRequest() + + +

      + + +

      Makes a custom HTTP request.

      + + + public + customHttpRequest(string $method, string $url[, string $body = "" ][, array<string|int, mixed> $headers = [] ]) : ResponseInterface + +
      +
      + + +
      Parameters
      +
      +
      + $method + : string +
      +
      +

      HTTP method to use.

      +
      + +
      +
      + $url + : string +
      +
      +

      URL to request.

      +
      + +
      +
      + $body + : string + = ""
      +
      +

      Body to be sent.

      +
      + +
      +
      + $headers + : array<string|int, mixed> + = []
      +
      +

      Additional headers.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException + + +
      +
      + + + +
      +
      Return values
      + ResponseInterface +
      + +
      +
      +

      + delete() + + +

      + + +

      Performs a DELETE request.

      + + + public + delete(string $url[, mixed $data = [] ][, array<string|int, mixed> $headers = [] ]) : ResponseInterface + +
      +
      + + +
      Parameters
      +
      +
      + $url + : string +
      +
      +

      URL to execute request.

      +
      + +
      +
      + $data + : mixed + = []
      +
      +

      Data to send.

      +
      + +
      +
      + $headers + : array<string|int, mixed> + = []
      +
      +

      Additional headers.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException + + +
      +
      + + + +
      +
      Return values
      + ResponseInterface +
      + +
      +
      +

      + get() + + +

      + + +

      Performs a GET request.

      + + + public + get(string $url[, mixed $data = [] ][, array<string|int, mixed> $headers = [] ]) : ResponseInterface + +
      +
      + + +
      Parameters
      +
      +
      + $url + : string +
      +
      +

      URL to execute request.

      +
      + +
      +
      + $data + : mixed + = []
      +
      +

      Data to send.

      +
      + +
      +
      + $headers + : array<string|int, mixed> + = []
      +
      +

      Additional headers.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException + + +
      +
      + + + +
      +
      Return values
      + ResponseInterface +
      + +
      +
      +

      + patch() + + +

      + + +

      Performs a PATCH request

      + + + public + patch(string $url[, mixed $data = [] ][, array<string|int, mixed> $headers = [] ]) : ResponseInterface + +
      +
      + + +
      Parameters
      +
      +
      + $url + : string +
      +
      +

      URL to execute request

      +
      + +
      +
      + $data + : mixed + = []
      +
      +

      Data to send

      +
      + +
      +
      + $headers + : array<string|int, mixed> + = []
      +
      +

      Additional headers.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException + + +
      +
      + + + +
      +
      Return values
      + ResponseInterface +
      + +
      +
      +

      + post() + + +

      + + +

      Performs a POST request.

      + + + public + post(string $url[, mixed $data = [] ][, array<string|int, mixed> $headers = [] ]) : ResponseInterface + +
      +
      + + +
      Parameters
      +
      +
      + $url + : string +
      +
      +

      URL to execute request.

      +
      + +
      +
      + $data + : mixed + = []
      +
      +

      Data to send.

      +
      + +
      +
      + $headers + : array<string|int, mixed> + = []
      +
      +

      Additional headers.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException + + +
      +
      + + + +
      +
      Return values
      + ResponseInterface +
      + +
      +
      +

      + put() + + +

      + + +

      Performs a PUT request.

      + + + public + put(string $url[, mixed $data = [] ][, array<string|int, mixed> $headers = [] ]) : mixed|ResponseInterface + +
      +
      + + +
      Parameters
      +
      +
      + $url + : string +
      +
      +

      URL to execute request.

      +
      + +
      +
      + $data + : mixed + = []
      +
      +

      Data to send.

      +
      + +
      +
      + $headers + : array<string|int, mixed> + = []
      +
      +

      Additional headers.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + GuzzleException + + +
      +
      + + + +
      +
      Return values
      + mixed|ResponseInterface +
      + +
      +
      +
      @@ -420,10 +1184,31 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Transaction-Contracts-Transaction.html b/docs/classes/ArangoDB-Transaction-Contracts-Transaction.html index 2fe0beb..64ce127 100644 --- a/docs/classes/ArangoDB-Transaction-Contracts-Transaction.html +++ b/docs/classes/ArangoDB-Transaction-Contracts-Transaction.html @@ -310,15 +310,269 @@

      +

      + Properties + +

      +
      +
      + $connection + +  : Connection +
      +
      Connection object
      + +
      + $defaultOptions + +  : array<string|int, mixed> +
      +
      Some default options for transaction +Sets by default, 32MB as transaction size limit and +waits server write all data on disk before return any response.
      + +
      + $options + +  : array<string|int, mixed> +
      +
      StreamTransaction options
      + +
      + +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      Transaction constructor.
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $connection + + + + +

      + + +

      Connection object

      + + + + protected + Connection + $connection + + + + + + + + + + +
      +
      +

      + $defaultOptions + + + + +

      + + +

      Some default options for transaction +Sets by default, 32MB as transaction size limit and +waits server write all data on disk before return any response.

      + + + + protected + array<string|int, mixed> + $defaultOptions + = ['maxTransactionSize' => 32000000, 'waitForSync' => true, 'allowImplicit' => false, 'lockTimeout' => 30] + +

      Also, set by default a lock timeout of 30 seconds.

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

      + $options + + + + +

      + + +

      StreamTransaction options

      + + + + protected + array<string|int, mixed> + $options + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Transaction constructor.

      + + + public + __construct(Connection $connection[, array<string|int, mixed> $options = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to use.

      +
      + +
      +
      + $options + : array<string|int, mixed> + = []
      +
      +

      Transaction options.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException|MissingParameterException + + +
      +
      + + + + +
      +
      +
      @@ -424,10 +678,26 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Transaction-JavascriptTransaction.html b/docs/classes/ArangoDB-Transaction-JavascriptTransaction.html index ed42de4..91450f5 100644 --- a/docs/classes/ArangoDB-Transaction-JavascriptTransaction.html +++ b/docs/classes/ArangoDB-Transaction-JavascriptTransaction.html @@ -311,15 +311,393 @@

      +

      + Properties + +

      +
      +
      + $action + +  : string +
      +
      Javascript code on a string to be executed on server
      + +
      + $connection + +  : Connection +
      +
      Connection object
      + +
      + $defaultOptions + +  : array<string|int, mixed> +
      +
      Some default options for transaction +Sets by default, 32MB as transaction size limit and +waits server write all data on disk before return any response.
      + +
      + $options + +  : array<string|int, mixed> +
      +
      StreamTransaction options
      + +
      + +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      JavascriptTransaction constructor.
      + +
      + execute() + +  : mixed +
      +
      Execute the transaction.
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $action + + + + +

      + + +

      Javascript code on a string to be executed on server

      + + + + protected + string + $action + + + + + + + + + + +
      +
      +

      + $connection + + + + +

      + + +

      Connection object

      + + + + protected + Connection + $connection + + + + + + + + + + +
      +
      +

      + $defaultOptions + + + + +

      + + +

      Some default options for transaction +Sets by default, 32MB as transaction size limit and +waits server write all data on disk before return any response.

      + + + + protected + array<string|int, mixed> + $defaultOptions + = ['maxTransactionSize' => 32000000, 'waitForSync' => true, 'allowImplicit' => false, 'lockTimeout' => 30] + +

      Also, set by default a lock timeout of 30 seconds.

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

      + $options + + + + +

      + + +

      StreamTransaction options

      + + + + protected + array<string|int, mixed> + $options + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      JavascriptTransaction constructor.

      + + + public + __construct(Connection $connection, string $action[, array<string|int, mixed> $options = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to use.

      +
      + +
      +
      + $action + : string +
      +
      +

      JavaScript code to execute on server

      +
      + +
      +
      + $options + : array<string|int, mixed> + = []
      +
      +

      Transaction options.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException|MissingParameterException + + +
      +
      + + + + +
      +
      +

      + execute() + + +

      + + +

      Execute the transaction.

      + + + public + execute() : mixed + +
      +
      + +

      Throws an exception if any error is detected.

      +
      + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + TransactionException|GuzzleException + + +
      +
      + + + +
      +
      Return values
      + mixed + — +

      The result value of transaction

      +
      + +
      + +
      +
      +
      @@ -425,10 +803,28 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Transaction-StreamTransaction.html b/docs/classes/ArangoDB-Transaction-StreamTransaction.html index cd20e15..255e555 100644 --- a/docs/classes/ArangoDB-Transaction-StreamTransaction.html +++ b/docs/classes/ArangoDB-Transaction-StreamTransaction.html @@ -295,15 +295,678 @@

      +

      + Properties + +

      +
      +
      + $connection + +  : Connection +
      +
      Connection object
      +
      + $defaultOptions + +  : array<string|int, mixed> +
      +
      Some default options for transaction +Sets by default, 32MB as transaction size limit and +waits server write all data on disk before return any response.
      + +
      + $id + +  : string +
      +
      Transaction Id
      + +
      + $options + +  : array<string|int, mixed> +
      +
      StreamTransaction options
      + +
      + $started + +  : bool +
      +
      If the transaction object is already started
      + +
      + $status + +  : string +
      +
      Transaction status
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      StreamTransaction constructor.
      + +
      + abort() + +  : void +
      +
      Abort transaction
      + +
      + begin() + +  : void +
      +
      Begin transaction
      + +
      + commit() + +  : void +
      +
      Commit transaction
      + +
      + getTransactionId() + +  : string +
      +
      Returns the transaction id
      + +
      + getTransactionStatus() + +  : string +
      +
      Returns the transaction status
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $connection + + + + +

      + + +

      Connection object

      + + + + protected + Connection + $connection + + + + + + + + + + +
      +
      +

      + $defaultOptions + + + + +

      + + +

      Some default options for transaction +Sets by default, 32MB as transaction size limit and +waits server write all data on disk before return any response.

      + + + + protected + array<string|int, mixed> + $defaultOptions + = ['maxTransactionSize' => 32000000, 'waitForSync' => true, 'allowImplicit' => false, 'lockTimeout' => 30] + +

      Also, set by default a lock timeout of 30 seconds.

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

      + $id + + + + +

      + + +

      Transaction Id

      + + + + protected + string + $id + + + + + + + + + + +
      +
      +

      + $options + + + + +

      + + +

      StreamTransaction options

      + + + + protected + array<string|int, mixed> + $options + + + + + + + + + + +
      +
      +

      + $started + + + + +

      + + +

      If the transaction object is already started

      + + + + protected + bool + $started + = false + + + + + + + + + +
      +
      +

      + $status + + + + +

      + + +

      Transaction status

      + + + + protected + string + $status + = '' + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      StreamTransaction constructor.

      + + + public + __construct(Connection $connection[, array<string|int, mixed> $options = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $connection + : Connection +
      +
      +

      Connection object to use.

      +
      + +
      +
      + $options + : array<string|int, mixed> + = []
      +
      +

      Transaction options.

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException|MissingParameterException + + +
      +
      + + + + +
      +
      +

      + abort() + + +

      + + +

      Abort transaction

      + + + public + abort() : void + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + TransactionException|BadResponseException|GuzzleException + + +
      +
      + + + + +
      +
      +

      + begin() + + +

      + + +

      Begin transaction

      + + + public + begin() : void + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + TransactionException|BadResponseException|GuzzleException + + +
      +
      + + + + +
      +
      +

      + commit() + + +

      + + +

      Commit transaction

      + + + public + commit() : void + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + TransactionException|BadResponseException|GuzzleException + + +
      +
      + + + + +
      +
      +

      + getTransactionId() + + +

      + + +

      Returns the transaction id

      + + + public + getTransactionId() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +

      + getTransactionStatus() + + +

      + + +

      Returns the transaction status

      + + + public + getTransactionStatus() : string + +
      +
      + + + + + + + +
      +
      Return values
      + string +
      + +
      +
      +
      @@ -409,10 +1072,34 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Admin-Task-TaskValidator.html b/docs/classes/ArangoDB-Validation-Admin-Task-TaskValidator.html index 1e47aa1..2eb5fae 100644 --- a/docs/classes/ArangoDB-Validation-Admin-Task-TaskValidator.html +++ b/docs/classes/ArangoDB-Validation-Admin-Task-TaskValidator.html @@ -313,15 +313,399 @@

      +

      + Properties + +

      +
      +
      + $canHave + +  : array<string|int, mixed> +
      +
      Optional keys
      + +
      + $data + +  : array<string|int, mixed> +
      +
      Data to validate.
      + +
      + $required + +  : array<string|int, mixed> +
      +
      Required keys
      + +
      + +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      Validator constructor.
      + +
      + rules() + +  : array<string|int, mixed> +
      +
      Rules for validation
      + +
      + validate() + +  : true +
      +
      Validate user data
      + +
      + validateParamsCallback() + +  : Closure +
      +
      Validate 'params' option.
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $canHave + + + + +

      + + +

      Optional keys

      + + + + protected + array<string|int, mixed> + $canHave + = ['id', 'type'] + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Data to validate.

      + + + + protected + array<string|int, mixed> + $data + = [] + + + + + + + + + +
      +
      +

      + $required + + + + +

      + + +

      Required keys

      + + + + protected + array<string|int, mixed> + $required + = ['params', 'offset', 'command', 'name', 'period'] + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Validator constructor.

      + + + public + __construct([array<string|int, mixed> $data = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $data + : array<string|int, mixed> + = []
      +
      +

      Attributes to validate.

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

      + rules() + + +

      + + +

      Rules for validation

      + + + public + rules() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + validate() + + +

      + + +

      Validate user data

      + + + public + validate() : true + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + MissingParameterException|InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + true + — +

      if validation is successful, throw an exception otherwise.

      +
      + +
      + +
      +
      +

      + validateParamsCallback() + + +

      + + +

      Validate 'params' option.

      + + + private + validateParamsCallback() : Closure + +
      +
      + + + + + + + +
      +
      Return values
      + Closure +
      + +
      +
      +
      @@ -427,10 +811,29 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Auth-UserValidator.html b/docs/classes/ArangoDB-Validation-Auth-UserValidator.html index ee2ff35..0edc7d0 100644 --- a/docs/classes/ArangoDB-Validation-Auth-UserValidator.html +++ b/docs/classes/ArangoDB-Validation-Auth-UserValidator.html @@ -312,15 +312,352 @@

      +

      + Properties + +

      +
      +
      + $canHave + +  : array<string|int, mixed> +
      +
      Users array can have these keys.
      + +
      + $data + +  : array<string|int, mixed> +
      +
      Data to validate.
      + +
      + $required + +  : array<string|int, mixed> +
      +
      Required keys in users arrays.
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Validator constructor.
      +
      + rules() + +  : array<string|int, mixed> +
      +
      Rules for user.
      + +
      + validate() + +  : true +
      +
      Validate user data
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $canHave + + + + +

      + + +

      Users array can have these keys.

      + + + + protected + array<string|int, mixed> + $canHave + = ['password', 'extra'] + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Data to validate.

      + + + + protected + array<string|int, mixed> + $data + = [] + + + + + + + + + +
      +
      +

      + $required + + + + +

      + + +

      Required keys in users arrays.

      + + + + protected + array<string|int, mixed> + $required + = ['user', 'active'] + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Validator constructor.

      + + + public + __construct([array<string|int, mixed> $data = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $data + : array<string|int, mixed> + = []
      +
      +

      Attributes to validate.

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

      + rules() + + +

      + + +

      Rules for user.

      + + + public + rules() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + validate() + + +

      + + +

      Validate user data

      + + + public + validate() : true + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + MissingParameterException|InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + true + — +

      if validation is successful, throw an exception otherwise.

      +
      + +
      + +
      +
      +
      @@ -426,10 +763,28 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Collection-CollectionValidator.html b/docs/classes/ArangoDB-Validation-Collection-CollectionValidator.html index 28b95d0..0a698fb 100644 --- a/docs/classes/ArangoDB-Validation-Collection-CollectionValidator.html +++ b/docs/classes/ArangoDB-Validation-Collection-CollectionValidator.html @@ -312,15 +312,399 @@

      +

      + Properties + +

      +
      +
      + $canHave + +  : array<string|int, mixed> +
      +
      Optional keys.
      + +
      + $data + +  : array<string|int, mixed> +
      +
      Data to validate.
      + +
      + $required + +  : array<string|int, mixed> +
      +
      Required keys.
      + +
      + +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      Validator constructor.
      + +
      + rules() + +  : array<string|int, mixed> +
      +
      Rules for validation.
      + +
      + validate() + +  : true +
      +
      Validate user data
      + +
      + validateKeyOptions() + +  : Closure +
      +
      Validate key options for collection creation
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $canHave + + + + +

      + + +

      Optional keys.

      + + + + protected + array<string|int, mixed> + $canHave + = [] + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Data to validate.

      + + + + protected + array<string|int, mixed> + $data + = [] + + + + + + + + + +
      +
      +

      + $required + + + + +

      + + +

      Required keys.

      + + + + protected + array<string|int, mixed> + $required + = ['name'] + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Validator constructor.

      + + + public + __construct([array<string|int, mixed> $data = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $data + : array<string|int, mixed> + = []
      +
      +

      Attributes to validate.

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

      + rules() + + +

      + + +

      Rules for validation.

      + + + public + rules() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + validate() + + +

      + + +

      Validate user data

      + + + public + validate() : true + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + MissingParameterException|InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + true + — +

      if validation is successful, throw an exception otherwise.

      +
      + +
      + +
      +
      +

      + validateKeyOptions() + + +

      + + +

      Validate key options for collection creation

      + + + private + static validateKeyOptions() : Closure + +
      +
      + + + + + + + +
      +
      Return values
      + Closure +
      + +
      +
      +
      @@ -426,10 +810,29 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Connection-ConnectionOptionsValidator.html b/docs/classes/ArangoDB-Validation-Connection-ConnectionOptionsValidator.html index c7c2182..f20d5c3 100644 --- a/docs/classes/ArangoDB-Validation-Connection-ConnectionOptionsValidator.html +++ b/docs/classes/ArangoDB-Validation-Connection-ConnectionOptionsValidator.html @@ -311,15 +311,399 @@

      +

      + Properties + +

      +
      +
      + $canHave + +  : array<string|int, mixed> +
      +
      The connection array can have these keys.
      + +
      + $data + +  : array<string|int, mixed> +
      +
      Data to validate.
      + +
      + $required + +  : array<string|int, mixed> +
      +
      Required keys in connections arrays.
      + +
      + +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      ConnectionOptionsValidator constructor.
      + +
      + getConnectionOptions() + +  : array<string|int, mixed> +
      +
      Return all connection options.
      + +
      + rules() + +  : array<string|int, mixed> +
      +
      Rules for connection
      + +
      + validate() + +  : true +
      +
      Validate user data
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $canHave + + + + +

      + + +

      The connection array can have these keys.

      + + + + protected + array<string|int, mixed> + $canHave + = ['connection', 'timeout', 'reconnect', 'create', 'policy', 'host', 'port'] + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Data to validate.

      + + + + protected + array<string|int, mixed> + $data + = [] + + + + + + + + + +
      +
      +

      + $required + + + + +

      + + +

      Required keys in connections arrays.

      + + + + protected + array<string|int, mixed> + $required + = ['endpoint', 'database', 'username', 'password'] + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      ConnectionOptionsValidator constructor.

      + + + public + __construct([array<string|int, mixed> $data = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $data + : array<string|int, mixed> + = []
      +
      +

      Attributes to validate.

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

      + getConnectionOptions() + + +

      + + +

      Return all connection options.

      + + + public + getConnectionOptions() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + rules() + + +

      + + +

      Rules for connection

      + + + public + rules() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + validate() + + +

      + + +

      Validate user data

      + + + public + validate() : true + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + MissingParameterException|InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + true + — +

      if validation is successful, throw an exception otherwise.

      +
      + +
      + +
      +
      +
      @@ -425,10 +809,29 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Document-DocumentValidator.html b/docs/classes/ArangoDB-Validation-Document-DocumentValidator.html index ba281bb..2e54521 100644 --- a/docs/classes/ArangoDB-Validation-Document-DocumentValidator.html +++ b/docs/classes/ArangoDB-Validation-Document-DocumentValidator.html @@ -312,15 +312,566 @@

      +

      + Properties + +

      +
      +
      + $canHave + +  : array<string|int, mixed> +
      +
      Optional keys.
      +
      + $data + +  : array<string|int, mixed> +
      +
      Data to validate.
      + +
      + $required + +  : array<string|int, mixed> +
      +
      Required keys.
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Validator constructor.
      + +
      + getAttributes() + +  : array<string|int, mixed> +
      +
      Return document data
      + +
      + getDescriptorsAttributes() + +  : array<string|int, mixed> +
      +
      Return document descriptors attributes.
      + +
      + hasDescriptors() + +  : bool +
      +
      Check if this document validator has document descriptors.
      + +
      + rules() + +  : array<string|int, mixed> +
      +
      Rules for validation.
      + +
      + setAttributes() + +  : mixed +
      +
      Set the data for validation
      + +
      + validate() + +  : true +
      +
      Validate document data.
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $canHave + + + + +

      + + +

      Optional keys.

      + + + + protected + array<string|int, mixed> + $canHave + = [] + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Data to validate.

      + + + + protected + array<string|int, mixed> + $data + = [] + + + + + + + + + +
      +
      +

      + $required + + + + +

      + + +

      Required keys.

      + + + + protected + array<string|int, mixed> + $required + = [] + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Validator constructor.

      + + + public + __construct([array<string|int, mixed> $data = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $data + : array<string|int, mixed> + = []
      +
      +

      Attributes to validate.

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

      + getAttributes() + + +

      + + +

      Return document data

      + + + public + getAttributes() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + getDescriptorsAttributes() + + +

      + + +

      Return document descriptors attributes.

      + + + public + getDescriptorsAttributes() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + hasDescriptors() + + +

      + + +

      Check if this document validator has document descriptors.

      + + + public + hasDescriptors() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool + — +

      Returns true if has some descriptor, false otherwise.

      +
      + +
      + +
      +
      +

      + rules() + + +

      + + +

      Rules for validation.

      + + + public + rules() : array<string|int, mixed> + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + codeCoverageIgnore +
      +
      + + +
      +
      + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + setAttributes() + + +

      + + +

      Set the data for validation

      + + + public + setAttributes(array<string|int, mixed> $attributes) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $attributes + : array<string|int, mixed> +
      +
      +

      Attributes to validate.

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

      + validate() + + +

      + + +

      Validate document data.

      + + + public + validate() : true + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + true + — +

      if validation is successful, throw an exception otherwise.

      +
      + +
      + +
      +
      +
      @@ -426,10 +977,32 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Document-EdgeValidator.html b/docs/classes/ArangoDB-Validation-Document-EdgeValidator.html index b0b73fb..e177dbd 100644 --- a/docs/classes/ArangoDB-Validation-Document-EdgeValidator.html +++ b/docs/classes/ArangoDB-Validation-Document-EdgeValidator.html @@ -311,15 +311,624 @@

      +

      + Properties + +

      +
      +
      + $canHave + +  : array<string|int, mixed> +
      +
      Optional keys.
      +
      + $data + +  : array<string|int, mixed> +
      +
      Data to validate.
      + +
      + $required + +  : array<string|int, mixed> +
      +
      Required keys
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Validator constructor.
      + +
      + getAttributes() + +  : array<string|int, mixed> +
      +
      Return document data
      + +
      + getDescriptorsAttributes() + +  : array<string|int, mixed> +
      +
      Return document descriptors attributes.
      + +
      + hasDescriptors() + +  : bool +
      +
      Check if this document validator has document descriptors.
      + +
      + rules() + +  : array<string|int, mixed> +
      +
      Rules for validation.
      + +
      + setAttributes() + +  : mixed +
      +
      Set the data for validation
      + +
      + validate() + +  : bool +
      +
      Validate document data.
      + +
      + validateGraphParams() + +  : mixed +
      +
      Validate graph parameters.
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $canHave + + + + +

      + + +

      Optional keys.

      + + + + protected + array<string|int, mixed> + $canHave + = [] + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Data to validate.

      + + + + protected + array<string|int, mixed> + $data + = [] + + + + + + + + + +
      +
      +

      + $required + + + + +

      + + +

      Required keys

      + + + + protected + array<string|int, mixed> + $required + = ['_to', '_from'] + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Validator constructor.

      + + + public + __construct([array<string|int, mixed> $data = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $data + : array<string|int, mixed> + = []
      +
      +

      Attributes to validate.

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

      + getAttributes() + + +

      + + +

      Return document data

      + + + public + getAttributes() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + getDescriptorsAttributes() + + +

      + + +

      Return document descriptors attributes.

      + + + public + getDescriptorsAttributes() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + hasDescriptors() + + +

      + + +

      Check if this document validator has document descriptors.

      + + + public + hasDescriptors() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool + — +

      Returns true if has some descriptor, false otherwise.

      +
      + +
      + +
      +
      +

      + rules() + + +

      + + +

      Rules for validation.

      + + + public + rules() : array<string|int, mixed> + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + codeCoverageIgnore +
      +
      + + +
      +
      + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + setAttributes() + + +

      + + +

      Set the data for validation

      + + + public + setAttributes(array<string|int, mixed> $attributes) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $attributes + : array<string|int, mixed> +
      +
      +

      Attributes to validate.

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

      + validate() + + +

      + + +

      Validate document data.

      + + + public + validate() : bool + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidParameterException|MissingParameterException + + +
      +
      + + + +
      +
      Return values
      + bool + — +

      True if validation is successful, throw an exception otherwise.

      +
      + +
      + +
      + +
      +
      @@ -425,10 +1034,33 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Document-PatchOptionsValidator.html b/docs/classes/ArangoDB-Validation-Document-PatchOptionsValidator.html index b00f500..5e55421 100644 --- a/docs/classes/ArangoDB-Validation-Document-PatchOptionsValidator.html +++ b/docs/classes/ArangoDB-Validation-Document-PatchOptionsValidator.html @@ -311,15 +311,352 @@

      +

      + Properties + +

      +
      +
      + $canHave + +  : array<string|int, mixed> +
      +
      Optional keys.
      + +
      + $data + +  : array<string|int, mixed> +
      +
      Data to validate.
      + +
      + $required + +  : array<string|int, mixed> +
      +
      Required keys.
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Validator constructor.
      +
      + rules() + +  : array<string|int, mixed> +
      +
      Rules for validation.
      + +
      + validate() + +  : true +
      +
      Validate user data
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $canHave + + + + +

      + + +

      Optional keys.

      + + + + protected + array<string|int, mixed> + $canHave + = ['keepNull', 'mergeObjects', 'waitForSync', 'ignoreRevs', 'returnOld', 'returnNew'] + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Data to validate.

      + + + + protected + array<string|int, mixed> + $data + = [] + + + + + + + + + +
      +
      +

      + $required + + + + +

      + + +

      Required keys.

      + + + + protected + array<string|int, mixed> + $required + = [] + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Validator constructor.

      + + + public + __construct([array<string|int, mixed> $data = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $data + : array<string|int, mixed> + = []
      +
      +

      Attributes to validate.

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

      + rules() + + +

      + + +

      Rules for validation.

      + + + public + rules() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + validate() + + +

      + + +

      Validate user data

      + + + public + validate() : true + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + MissingParameterException|InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + true + — +

      if validation is successful, throw an exception otherwise.

      +
      + +
      + +
      +
      +
      @@ -425,10 +762,28 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Document-UpdateOptionsValidator.html b/docs/classes/ArangoDB-Validation-Document-UpdateOptionsValidator.html index 90f6982..7f8b90d 100644 --- a/docs/classes/ArangoDB-Validation-Document-UpdateOptionsValidator.html +++ b/docs/classes/ArangoDB-Validation-Document-UpdateOptionsValidator.html @@ -311,15 +311,350 @@

      +

      + Properties + +

      +
      +
      + $canHave + +  : array<string|int, mixed> +
      +
      Optional keys.
      + +
      + $data + +  : array<string|int, mixed> +
      +
      Data to validate.
      + +
      + $required + +  : array<string|int, mixed> +
      +
      Required keys.
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      UpdateOptionsValidator constructor.
      +
      + rules() + +  : array<string|int, mixed> +
      +
      Rules for validation
      + +
      + validate() + +  : true +
      +
      Validate user data
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $canHave + + + + +

      + + +

      Optional keys.

      + + + + protected + array<string|int, mixed> + $canHave + = ['waitForSync', 'ignoreRevs', 'returnOld', 'returnNew'] + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Data to validate.

      + + + + protected + array<string|int, mixed> + $data + = [] + + + + + + + + + +
      +
      +

      + $required + + + + +

      + + +

      Required keys.

      + + + + protected + array<string|int, mixed> + $required + = [] + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      UpdateOptionsValidator constructor.

      + + + public + __construct([array<string|int, mixed> $options = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $options + : array<string|int, mixed> + = []
      +
      + +
      +
      + + + + + + +
      +
      +

      + rules() + + +

      + + +

      Rules for validation

      + + + public + rules() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + validate() + + +

      + + +

      Validate user data

      + + + public + validate() : true + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + MissingParameterException|InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + true + — +

      if validation is successful, throw an exception otherwise.

      +
      + +
      + +
      +
      +
      @@ -425,10 +760,28 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Exceptions-InvalidKeyOptionException.html b/docs/classes/ArangoDB-Validation-Exceptions-InvalidKeyOptionException.html index d4fa530..517ee25 100644 --- a/docs/classes/ArangoDB-Validation-Exceptions-InvalidKeyOptionException.html +++ b/docs/classes/ArangoDB-Validation-Exceptions-InvalidKeyOptionException.html @@ -311,15 +311,210 @@

      +

      + Properties + +

      +
      +
      + $parameter + +  : string +
      +
      Parameter name.
      + +
      + $type + +  : string +
      +
      Parameter value.
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      InvalidKeyOptionException constructor.
      +
      - +
      +

      + Properties + + +

      +
      +

      + $parameter + + + + +

      + + +

      Parameter name.

      + + + + protected + string + $parameter + + + + + + + + + + +
      +
      +

      + $type + + + + +

      + + +

      Parameter value.

      + + + + protected + string + $type + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      InvalidKeyOptionException constructor.

      + + + public + __construct(string $parameter, string $value[, Throwable|null $previous = null ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $parameter + : string +
      +
      +

      Parameter name.

      +
      + +
      +
      + $value + : string +
      +
      +

      Parameter value.

      +
      + +
      +
      + $previous + : Throwable|null + = null
      +
      +

      Previous exception or error.

      +
      + +
      +
      + + + + + + +
      +
      +
      @@ -425,10 +620,25 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Exceptions-InvalidParameterException.html b/docs/classes/ArangoDB-Validation-Exceptions-InvalidParameterException.html index d049f2c..dbcf967 100644 --- a/docs/classes/ArangoDB-Validation-Exceptions-InvalidParameterException.html +++ b/docs/classes/ArangoDB-Validation-Exceptions-InvalidParameterException.html @@ -311,15 +311,210 @@

      +

      + Properties + +

      +
      +
      + $parameter + +  : string|int +
      +
      Parameter name.
      + +
      + $value + +  : mixed +
      +
      Parameter value.
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      InvalidParameterException constructor.
      +
      - +
      +

      + Properties + + +

      +
      +

      + $parameter + + + + +

      + + +

      Parameter name.

      + + + + protected + string|int + $parameter + + + + + + + + + + +
      +
      +

      + $value + + + + +

      + + +

      Parameter value.

      + + + + protected + mixed + $value + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      InvalidParameterException constructor.

      + + + public + __construct(string|int $parameter, mixed $value[, Throwable|null $previous = null ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $parameter + : string|int +
      +
      +

      Parameter name.

      +
      + +
      +
      + $value + : mixed +
      +
      +

      Parameter value.

      +
      + +
      +
      + $previous + : Throwable|null + = null
      +
      +

      Previous exception or error.

      +
      + +
      +
      + + + + + + +
      +
      +
      @@ -425,10 +620,25 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Exceptions-MissingParameterException.html b/docs/classes/ArangoDB-Validation-Exceptions-MissingParameterException.html index 4ffd0bd..29d643e 100644 --- a/docs/classes/ArangoDB-Validation-Exceptions-MissingParameterException.html +++ b/docs/classes/ArangoDB-Validation-Exceptions-MissingParameterException.html @@ -311,15 +311,154 @@

      +

      + Properties + +

      +
      +
      + $parameter + +  : string +
      +
      Parameter name.
      +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      MissingParameterException constructor.
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $parameter + + + + +

      + + +

      Parameter name.

      + + + + protected + string + $parameter + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      MissingParameterException constructor.

      + + + public + __construct(string $parameter[, Throwable|null $previous = null ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $parameter + : string +
      +
      +

      Parameter name.

      +
      + +
      +
      + $previous + : Throwable|null + = null
      +
      +

      Previous exception or error.

      +
      + +
      +
      + + + + + + +
      +
      +
      @@ -425,10 +564,24 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Graph-GraphValidator.html b/docs/classes/ArangoDB-Validation-Graph-GraphValidator.html index 3699eee..ea4f3e3 100644 --- a/docs/classes/ArangoDB-Validation-Graph-GraphValidator.html +++ b/docs/classes/ArangoDB-Validation-Graph-GraphValidator.html @@ -312,15 +312,399 @@

      +

      + Properties + +

      +
      +
      + $canHave + +  : array<string|int, mixed> +
      +
      Optional keys.
      + +
      + $data + +  : array<string|int, mixed> +
      +
      Data to validate.
      + +
      + $required + +  : array<string|int, mixed> +
      +
      Required keys.
      + +
      + +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      Validator constructor.
      + +
      + rules() + +  : array<string|int, mixed> +
      +
      Rules for validation.
      + +
      + validate() + +  : true +
      +
      Validate user data
      + +
      + validateEdgeDefinitionsParameter() + +  : Closure +
      +
      Validate 'edgeDefinitions' param
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $canHave + + + + +

      + + +

      Optional keys.

      + + + + protected + array<string|int, mixed> + $canHave + = ['_id', '_rev', '_key', 'numberOfShards', 'replicationFactor', 'minReplicationFactor', 'isSmart'] + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Data to validate.

      + + + + protected + array<string|int, mixed> + $data + = [] + + + + + + + + + +
      +
      +

      + $required + + + + +

      + + +

      Required keys.

      + + + + protected + array<string|int, mixed> + $required + = ['edgeDefinitions'] + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Validator constructor.

      + + + public + __construct([array<string|int, mixed> $data = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $data + : array<string|int, mixed> + = []
      +
      +

      Attributes to validate.

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

      + rules() + + +

      + + +

      Rules for validation.

      + + + public + rules() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + validate() + + +

      + + +

      Validate user data

      + + + public + validate() : true + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + MissingParameterException|InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + true + — +

      if validation is successful, throw an exception otherwise.

      +
      + +
      + +
      +
      +

      + validateEdgeDefinitionsParameter() + + +

      + + +

      Validate 'edgeDefinitions' param

      + + + private + static validateEdgeDefinitionsParameter() : Closure + +
      +
      + + + + + + + +
      +
      Return values
      + Closure +
      + +
      +
      +
      @@ -426,10 +810,29 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Rules-RuleInterface.html b/docs/classes/ArangoDB-Validation-Rules-RuleInterface.html index 194bc08..67e21c4 100644 --- a/docs/classes/ArangoDB-Validation-Rules-RuleInterface.html +++ b/docs/classes/ArangoDB-Validation-Rules-RuleInterface.html @@ -300,13 +300,90 @@

      +

      + Methods + +

      +
      +
      + isValid() + +  : bool +
      +
      Check if a given value is valid.
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + isValid() + + +

      + + +

      Check if a given value is valid.

      + + + public + isValid(mixed $value) : bool + +
      +
      + + +
      Parameters
      +
      +
      + $value + : mixed +
      +
      +

      Value to validate.

      +
      + +
      +
      + + + + + +
      +
      Return values
      + bool + — +

      True if value is valid, false otherwise.

      +
      + +
      + +
      +
      +
      @@ -416,6 +493,12 @@

    • Methods
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Rules-Rules.html b/docs/classes/ArangoDB-Validation-Rules-Rules.html index 57f947f..ee2ca93 100644 --- a/docs/classes/ArangoDB-Validation-Rules-Rules.html +++ b/docs/classes/ArangoDB-Validation-Rules-Rules.html @@ -310,14 +310,549 @@

      +

      + Methods + +

      +
      +
      + arr() + +  : RuleInterface +
      +
      Is array rule.
      + +
      + boolean() + +  : RuleInterface +
      +
      Is boolean rule.
      + +
      + callbackValidation() + +  : RuleInterface +
      +
      Validate through a callback
      + +
      + equalsOrGreaterThan() + +  : RuleInterface +
      +
      If a value is equals to or greater than some given value.
      + +
      + in() + +  : RuleInterface +
      +
      Verify if a value is in a set of given values.
      + +
      + integer() + +  : RuleInterface +
      +
      Is integer rule.
      + +
      + isPrimitive() + +  : RuleInterface +
      +
      Is a primitive type rule.
      + +
      + numeric() + +  : RuleInterface +
      +
      Is numeric rule.
      + +
      + string() + +  : RuleInterface +
      +
      Is string rule.
      + +
      + uri() + +  : RuleInterface +
      +
      Is an URI
      + +
      - + +
      +

      + Methods + + +

      + +
      +

      + boolean() + + +

      + + +

      Is boolean rule.

      + + + public + static boolean() : RuleInterface + +
      +
      + + + + + + + +
      +
      Return values
      + RuleInterface +
      + +
      +
      +

      + callbackValidation() + + +

      + + +

      Validate through a callback

      + + + public + static callbackValidation(callable $callback) : RuleInterface + +
      +
      + + +
      Parameters
      +
      +
      + $callback + : callable +
      +
      +

      Callback with validation logic.

      +
      + +
      +
      + + + + + +
      +
      Return values
      + RuleInterface +
      + +
      +
      +

      + equalsOrGreaterThan() + + +

      + + +

      If a value is equals to or greater than some given value.

      + + + public + static equalsOrGreaterThan(int $reference) : RuleInterface + +
      +
      + + +
      Parameters
      +
      +
      + $reference + : int +
      +
      +

      Reference value.

      +
      + +
      +
      + + + + + +
      +
      Return values
      + RuleInterface +
      + +
      +
      +

      + in() + + +

      + + +

      Verify if a value is in a set of given values.

      + + + public + static in(array<string|int, mixed> $values) : RuleInterface + +
      +
      + + +
      Parameters
      +
      +
      + $values + : array<string|int, mixed> +
      +
      +

      Acceptable values.

      +
      + +
      +
      + + + + + +
      +
      Return values
      + RuleInterface +
      + +
      +
      +

      + integer() + + +

      + + +

      Is integer rule.

      + + + public + static integer() : RuleInterface + +
      +
      + + + + + + + +
      +
      Return values
      + RuleInterface +
      + +
      + +
      +

      + numeric() + + +

      + + +

      Is numeric rule.

      + + + public + static numeric() : RuleInterface + +
      +
      + + + + + + + +
      +
      Return values
      + RuleInterface +
      + +
      +
      +

      + string() + + +

      + + +

      Is string rule.

      + + + public + static string() : RuleInterface + +
      +
      + + + + + + + +
      +
      Return values
      + RuleInterface +
      + +
      + +
      +
      @@ -423,10 +958,26 @@

    • Table Of Contents
      • -
      +
    • Methods
    • + +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Transaction-TransactionOptionsValidator.html b/docs/classes/ArangoDB-Validation-Transaction-TransactionOptionsValidator.html index a02d33c..5f4120f 100644 --- a/docs/classes/ArangoDB-Validation-Transaction-TransactionOptionsValidator.html +++ b/docs/classes/ArangoDB-Validation-Transaction-TransactionOptionsValidator.html @@ -296,15 +296,399 @@

      +

      + Properties + +

      +
      +
      + $canHave + +  : array<string|int, mixed> +
      +
      Optional keys
      + +
      + $data + +  : array<string|int, mixed> +
      +
      Data to validate.
      + +
      + $required + +  : array<string|int, mixed> +
      +
      Required keys
      + +
      + +

      + Methods + +

      +
      +
      + __construct() + +  : mixed +
      +
      Validator constructor.
      + +
      + rules() + +  : array<string|int, mixed> +
      +
      Rules for connection.
      + +
      + validate() + +  : true +
      +
      Validate user data
      + +
      + validateCollectionsParameter() + +  : Closure +
      +
      Validate 'collections' param
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $canHave + + + + +

      + + +

      Optional keys

      + + + + protected + array<string|int, mixed> + $canHave + = ['maxTransactionSize', 'waitForSync', 'allowImplicit', 'lockTimeout'] + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Data to validate.

      + + + + protected + array<string|int, mixed> + $data + = [] + + + + + + + + + +
      +
      +

      + $required + + + + +

      + + +

      Required keys

      + + + + protected + array<string|int, mixed> + $required + = ['collections'] + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Validator constructor.

      + + + public + __construct([array<string|int, mixed> $data = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $data + : array<string|int, mixed> + = []
      +
      +

      Attributes to validate.

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

      + rules() + + +

      + + +

      Rules for connection.

      + + + public + rules() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + validate() + + +

      + + +

      Validate user data

      + + + public + validate() : true + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + MissingParameterException|InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + true + — +

      if validation is successful, throw an exception otherwise.

      +
      + +
      + +
      +
      +

      + validateCollectionsParameter() + + +

      + + +

      Validate 'collections' param

      + + + private + static validateCollectionsParameter() : Closure + +
      +
      + + + + + + + +
      +
      Return values
      + Closure +
      + +
      +
      +
      @@ -410,10 +794,29 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-Validator.html b/docs/classes/ArangoDB-Validation-Validator.html index 502fbcd..3e933b5 100644 --- a/docs/classes/ArangoDB-Validation-Validator.html +++ b/docs/classes/ArangoDB-Validation-Validator.html @@ -319,15 +319,305 @@

      +

      + Properties + +

      +
      +
      + $canHave + +  : array<string|int, mixed> +
      +
      Optional keys.
      + +
      + $data + +  : array<string|int, mixed> +
      +
      Data to validate.
      + +
      + $required + +  : array<string|int, mixed> +
      +
      Required keys.
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      Validator constructor.
      +
      + validate() + +  : true +
      +
      Validate user data
      + +
      - +
      +

      + Properties + + +

      +
      +

      + $canHave + + + + +

      + + +

      Optional keys.

      + + + + protected + array<string|int, mixed> + $canHave + = [] + + + + + + + + + +
      +
      +

      + $data + + + + +

      + + +

      Data to validate.

      + + + + protected + array<string|int, mixed> + $data + = [] + + + + + + + + + +
      +
      +

      + $required + + + + +

      + + +

      Required keys.

      + + + + protected + array<string|int, mixed> + $required + = [] + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Validator constructor.

      + + + public + __construct([array<string|int, mixed> $data = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $data + : array<string|int, mixed> + = []
      +
      +

      Attributes to validate.

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

      + validate() + + +

      + + +

      Validate user data

      + + + public + validate() : true + +
      +
      + + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + MissingParameterException|InvalidParameterException + + +
      +
      + + + +
      +
      Return values
      + true + — +

      if validation is successful, throw an exception otherwise.

      +
      + +
      + +
      +
      +
      @@ -433,10 +723,27 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-Validation-ValidatorInterface.html b/docs/classes/ArangoDB-Validation-ValidatorInterface.html index fde7233..4d1509f 100644 --- a/docs/classes/ArangoDB-Validation-ValidatorInterface.html +++ b/docs/classes/ArangoDB-Validation-ValidatorInterface.html @@ -298,13 +298,121 @@

      +

      + Methods + +

      +
      +
      + rules() + +  : array<string|int, mixed> +
      +
      Rules for validation.
      + +
      + validate() + +  : bool +
      +
      Validate data.
      + +
      - + +
      +

      + Methods + + +

      +
      +

      + rules() + + +

      + + +

      Rules for validation.

      + + + public + rules() : array<string|int, mixed> + +
      +
      + + + + + + + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + validate() + + +

      + + +

      Validate data.

      + + + public + validate() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +
      @@ -414,6 +522,13 @@

    • Methods
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/classes/ArangoDB-View-View.html b/docs/classes/ArangoDB-View-View.html index 3286178..e32ef33 100644 --- a/docs/classes/ArangoDB-View-View.html +++ b/docs/classes/ArangoDB-View-View.html @@ -306,15 +306,603 @@

      +

      + Properties + +

      +
      +
      + $attributes + +  : array<string|int, mixed> +
      +
      View properties.
      +
      + $defaults + +  : array<string|int, mixed> +
      +
      View properties default values.
      + +
      + $globallyUniqueId + +  : string +
      +
      Globally unique ID.
      + +
      + $id + +  : string +
      +
      View ID.
      + +
      + $isNew + +  : bool +
      +
      If the View is a new one or a representation of an existing view on server.
      + +
      + $links + +  : mixed +
      +
      The view links
      + +
      + $name + +  : string +
      +
      The name of the View.
      + +
      + $type + +  : string +
      +
      The type of View
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      View constructor.
      + +
      + isNew() + +  : bool +
      +
      Returns true if is a new object
      + +
      - +
      +

      + Properties + + +

      + +
      +

      + $defaults + + + + +

      + + +

      View properties default values.

      + + + + protected + array<string|int, mixed> + $defaults + = ['writebufferActive' => 0, 'writebufferSizeMax' => 33554432, 'writebufferIdle' => 64, 'commitIntervalMsec' => 1000, 'consolidationIntervalMsec' => 10000, 'consolidationPolicy' => [], 'cleanupIntervalStep' => 2] + +

      Check ArangoDB Server documentation for more details.

      +
      + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + https://www.arangodb.com/docs/stable/arangosearch-views.html#view-properties + + +
      +
      + + + + + +
      +
      +

      + $globallyUniqueId + + + + +

      + + +

      Globally unique ID.

      + + + + protected + string + $globallyUniqueId + + + + + + + + + + +
      +
      +

      + $id + + + + +

      + + +

      View ID.

      + + + + protected + string + $id + + + + + + + + + + +
      +
      +

      + $isNew + + + + +

      + + +

      If the View is a new one or a representation of an existing view on server.

      + + + + protected + bool + $isNew + + + + + + + + + + +
      + +
      +

      + $name + + + + +

      + + +

      The name of the View.

      + + + + protected + string + $name + + + + + + + + + + +
      +
      +

      + $type + + + + +

      + + +

      The type of View

      + + + + protected + string + $type + + + + + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      View constructor.

      + + + public + __construct(string $name[, string $type = "arangosearch" ][, array<string|int, mixed> $attributes = [] ]) : mixed + +
      +
      + + +
      Parameters
      +
      +
      + $name + : string +
      +
      +

      The name of View

      +
      + +
      +
      + $type + : string + = "arangosearch"
      +
      +

      The type of View

      +
      + +
      +
      + $attributes + : array<string|int, mixed> + = []
      +
      +

      View attributes

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + see +
      +
      + https://docs.arangodb.com/3.12/index-and-search/arangosearch/arangosearch-views-reference/#view-properties + + +
      +
      + + + + +
      +
      +

      + isNew() + + +

      + + +

      Returns true if is a new object

      + + + public + isNew() : bool + +
      +
      + + + + + + + +
      +
      Return values
      + bool +
      + +
      +
      +
      @@ -420,10 +1008,32 @@

    • Table Of Contents
      • -
      +
    • Properties
    • +
    • Methods
    • + +
    • Properties
    • +
    • + +
    • +
    • Methods
    • +
    • + +
    • diff --git a/docs/files/src-collection-indexabletrait.html b/docs/files/src-collection-indexabletrait.html new file mode 100644 index 0000000..ece1fcc --- /dev/null +++ b/docs/files/src-collection-indexabletrait.html @@ -0,0 +1,415 @@ + + + + + Arango PHP ODM + + + + + + + + + + + + + + + + + + + + + +
      +

      Arango PHP ODM

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

      IndexableTrait.php

      + + + + + + + + +

      + Table of Contents + + +

      + + + + + +

      + Traits + + +

      +
      +
      IndexableTrait
      Indexable trait
      + + + + + + + + + + + +
      +
      +
      +
      +
      
      +        
      + +
      +
      + + + +
      +
      +
      + +
      + On this page + +
        +
      • Table Of Contents
      • +
      • + +
      • + + +
      +
      + +
      +
      +
      +
      +
      +

      Search results

      + +
      +
      +
        +
        +
        +
        +
        + + +
        + + + + + + + + diff --git a/docs/files/src/Collection/Collection.php.txt b/docs/files/src/Collection/Collection.php.txt index e4a6c08..6bb0ae4 100644 --- a/docs/files/src/Collection/Collection.php.txt +++ b/docs/files/src/Collection/Collection.php.txt @@ -4,26 +4,23 @@ declare(strict_types=1); namespace ArangoDB\Collection; +use JsonSerializable; use ArangoDB\Http\Api; use ArangoDB\Document\Edge; use ArangoDB\Document\Vertex; use ArangoDB\Document\Document; use ArangoDB\Database\Database; +use ArangoDB\Exceptions\Exception; use ArangoDB\Connection\Connection; use ArangoDB\Cursor\CollectionCursor; -use ArangoDB\Collection\Index\Factory; -use ArangoDB\DataStructures\ArrayList; -use ArangoDB\Exceptions\IndexException; use GuzzleHttp\Exception\ClientException; use GuzzleHttp\Exception\GuzzleException; use ArangoDB\Cursor\Contracts\CursorInterface; use ArangoDB\Cursor\Exceptions\CursorException; -use ArangoDB\Collection\Contracts\IndexInterface; use ArangoDB\Exceptions\Database\DatabaseException; use ArangoDB\Validation\Collection\CollectionValidator; use ArangoDB\Validation\Exceptions\InvalidParameterException; use ArangoDB\Validation\Exceptions\MissingParameterException; -use JsonSerializable; /** * Represents an ArangoDB collection @@ -33,23 +30,33 @@ use JsonSerializable; */ class Collection implements JsonSerializable { + use IndexableTrait; + /** * Attributes of collection + * + * @var array */ protected array $attributes; /** * If the collection is a new one or a representation of an existing collection on server + * + * @var bool */ protected bool $isNew; /** * Database object + * + * @var Database */ protected Database $database; /** * Connection object + * + * @var Connection */ protected Connection $connection; @@ -82,6 +89,8 @@ class Collection implements JsonSerializable /** * Status descriptions + * + * @var array */ protected array $statusStrings = [ 0 => 'unknown', @@ -190,13 +199,13 @@ class Collection implements JsonSerializable } /** - * Set a attribute + * Set an attribute * * @param string $name * @param mixed $value - * @throws \Exception + * @throws Exception */ - public function __set(string $name, $value) + public function __set(string $name, mixed $value) { // Allow defaults attributes to be set. if (array_key_exists($name, $this->attributes)) { @@ -204,7 +213,7 @@ class Collection implements JsonSerializable return; } - throw new \Exception("Non-default collection property with name: ($name)"); + throw new Exception("Non-default collection property with name: ($name)"); } /** @@ -383,34 +392,6 @@ class Collection implements JsonSerializable } } - /** - * Return all indexes of collection - * - * @return ArrayList - * @throws DatabaseException|GuzzleException|InvalidParameterException|IndexException|MissingParameterException - */ - public function getIndexes(): ArrayList - { - try { - if ($this->isNew()) { - return new ArrayList(); - } - - $uri = Api::addQuery(Api::INDEX, ['collection' => $this->getName()]); - $response = $this->connection->get($uri); - $data = json_decode((string)$response->getBody(), true); - $indexes = new ArrayList(); - foreach ($data['indexes'] as $index) { - $indexes->push(Factory::factory($index)); - } - - return $indexes; - } catch (ClientException $exception) { - $response = json_decode((string)$exception->getResponse()->getBody(), true); - throw new DatabaseException($response['errorMessage'], $exception, $response['errorNum']); - } - } - /** * Return the revision of collection * @@ -435,65 +416,6 @@ class Collection implements JsonSerializable } } - /** - * Create a index for collection - * @param IndexInterface $index - * - * @return bool - * @throws DatabaseException|GuzzleException - */ - public function addIndex(IndexInterface $index): bool - { - try { - // If the collection is a new one, - // we cannot add indexes on server. - if ($this->isNew()) { - return false; - } - - $uri = Api::addQuery(Api::INDEX, ['collection' => $this->getName()]); - $response = $this->connection->post($uri, $index->getCreateData()); - - json_decode((string)$response->getBody(), true); - return true; - } catch (ClientException $exception) { - $response = json_decode((string)$exception->getResponse()->getBody(), true); - throw new DatabaseException($response['errorMessage'], $exception, $response['errorNum']); - } - } - - /** - * Drops a index of collection - * @param IndexInterface $index - * - * @return bool - * @throws DatabaseException|GuzzleException - */ - public function dropIndex(IndexInterface $index): bool - { - try { - // If the collection is a new one, or the index, - // we cannot drop it on server. - if ($this->isNew() || $index->isNew()) { - return false; - } - - $uri = Api::addUriParam(Api::INDEX, $index->getId()); - $response = $this->connection->delete($uri); - $data = json_decode((string)$response->getBody(), true); - return !$data['error']; - } catch (ClientException $exception) { - $response = json_decode((string)$exception->getResponse()->getBody(), true); - $databaseException = new DatabaseException($response['errorMessage'], $exception, $response['errorNum']); - - if ($exception->getResponse()->getStatusCode() === 404) { - return false; - } - - throw $databaseException; - } - } - /** * Saves or update the collection. * Except for 'waitForSync' and 'name', a collection can not be modified after creation. @@ -587,9 +509,7 @@ class Collection implements JsonSerializable $response = $this->connection->get(sprintf("%s/%s", $uri, $handle)); $data = json_decode((string)$response->getBody(), true); $document = $this->isGraph() ? new Edge($data, $this) : new Document($data, $this); - $document = $isVertex ? new Vertex($data, $this) : $document; - - return $document; + return $isVertex ? new Vertex($data, $this) : $document; } catch (ClientException $exception) { $response = json_decode((string)$exception->getResponse()->getBody(), true); @@ -665,7 +585,7 @@ class Collection implements JsonSerializable } /** - * @see \JsonSerializable::jsonSerialize() + * @see JsonSerializable::jsonSerialize */ public function jsonSerialize(): mixed { diff --git a/docs/files/src/Collection/Index/Index.php.txt b/docs/files/src/Collection/Index/Index.php.txt index 904d4a2..0e0fec1 100644 --- a/docs/files/src/Collection/Index/Index.php.txt +++ b/docs/files/src/Collection/Index/Index.php.txt @@ -98,15 +98,14 @@ class Index implements IndexInterface } $fieldNames = []; - foreach ($fields as $key => $field) { if (is_string($field)) { - array_push($fieldNames, $field); + $fieldNames[] = $field; continue; } if (is_array($field)) { - array_push($fieldNames, $field['name']); + $fieldNames[] = $field['name']; continue; } @@ -114,7 +113,7 @@ class Index implements IndexInterface } $this->type = $type; - $this->fields = $fields; + $this->fields = $fieldNames; // Default values; $this->id = $attributes['id'] ?? ''; diff --git a/docs/files/src/Collection/Index/InvertedIndex.php.txt b/docs/files/src/Collection/Index/InvertedIndex.php.txt index adc0e3a..80278a4 100644 --- a/docs/files/src/Collection/Index/InvertedIndex.php.txt +++ b/docs/files/src/Collection/Index/InvertedIndex.php.txt @@ -5,11 +5,11 @@ namespace ArangoDB\Collection\Index; use ArangoDB\Validation\Exceptions\InvalidParameterException; /** -* Inverted index representation -* -* @package ArangoDB\Collection\Index -* @author Lucas S. Vieira -*/ + * Inverted index representation + * + * @package ArangoDB\Collection\Index + * @author Lucas S. Vieira + */ final class InvertedIndex extends Index { /** @@ -35,6 +35,7 @@ final class InvertedIndex extends Index */ public function __construct(array $fields, array $attributes = []) { + $attributes = array_merge($this->defaultOptions, $attributes); parent::__construct('inverted', $fields, $attributes); } } diff --git a/docs/files/src/Collection/IndexableTrait.php.txt b/docs/files/src/Collection/IndexableTrait.php.txt new file mode 100644 index 0000000..d04890e --- /dev/null +++ b/docs/files/src/Collection/IndexableTrait.php.txt @@ -0,0 +1,112 @@ +isNew()) { + return new ArrayList(); + } + + $uri = Api::addQuery(Api::INDEX, ['collection' => $this->getName()]); + $response = $this->connection->get($uri); + $data = json_decode((string)$response->getBody(), true); + $indexes = new ArrayList(); + foreach ($data['indexes'] as $index) { + $indexes->push(Factory::factory($index)); + } + + return $indexes; + } catch (ClientException $exception) { + $response = json_decode((string)$exception->getResponse()->getBody(), true); + throw new DatabaseException($response['errorMessage'], $exception, $response['errorNum']); + } + } + + /** + * Create an index for collection + * @param IndexInterface $index + * + * @return bool + * @throws DatabaseException|GuzzleException + */ + public function addIndex(IndexInterface $index): bool + { + try { + // If the collection is a new one, + // we cannot add indexes on server. + if ($this->isNew()) { + return false; + } + + $uri = Api::addQuery(Api::INDEX, ['collection' => $this->getName()]); + $response = $this->connection->post($uri, $index->getCreateData()); + + json_decode((string)$response->getBody(), true); + return true; + } catch (ClientException $exception) { + $response = json_decode((string)$exception->getResponse()->getBody(), true); + throw new DatabaseException($response['errorMessage'], $exception, $response['errorNum']); + } + } + + /** + * Drops an index of collection + * @param IndexInterface $index + * + * @return bool + * @throws DatabaseException|GuzzleException + */ + public function dropIndex(IndexInterface $index): bool + { + try { + // If the collection is a new one, or the index, + // we cannot drop it on server. + if ($this->isNew() || $index->isNew()) { + return false; + } + + $uri = Api::addUriParam(Api::INDEX, $index->getId()); + $response = $this->connection->delete($uri); + $data = json_decode((string)$response->getBody(), true); + return !$data['error']; + } catch (ClientException $exception) { + $response = json_decode((string)$exception->getResponse()->getBody(), true); + $databaseException = new DatabaseException($response['errorMessage'], $exception, $response['errorNum']); + + if ($exception->getResponse()->getStatusCode() === 404) { + return false; + } + + throw $databaseException; + } + } +} diff --git a/docs/indices/files.html b/docs/indices/files.html index 742ab17..1ad3d3f 100644 --- a/docs/indices/files.html +++ b/docs/indices/files.html @@ -304,6 +304,7 @@

        I

      • Index.php
      • IndexException.php
      • IndexInterface.php
      • +
      • IndexableTrait.php
      • InvalidKeyOptionException.php
      • InvalidParameterException.php
      • InvertedIndex.php
      • diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js index 9c59ffc..fc63acd 100644 --- a/docs/js/searchIndex.js +++ b/docs/js/searchIndex.js @@ -5,36 +5,256 @@ Search.appendIndex( "name": "Admin", "summary": "Manages\u0020some\u0020Admin\u0020features.", "url": "classes/ArangoDB-Admin-Admin.html" + }, { + "fqsen": "\\ArangoDB\\Admin\\Admin\u003A\u003Auser\u0028\u0029", + "name": "user", + "summary": "Finds\u0020a\u0020user\u0020on\u0020server.", + "url": "classes/ArangoDB-Admin-Admin.html#method_user" + }, { + "fqsen": "\\ArangoDB\\Admin\\Admin\u003A\u003Astatistics\u0028\u0029", + "name": "statistics", + "summary": "Returns\u0020the\u0020statistics\u0020information.", + "url": "classes/ArangoDB-Admin-Admin.html#method_statistics" + }, { + "fqsen": "\\ArangoDB\\Admin\\Admin\u003A\u003Atime\u0028\u0029", + "name": "time", + "summary": "Returns\u0020the\u0020system\u0020time.", + "url": "classes/ArangoDB-Admin-Admin.html#method_time" + }, { + "fqsen": "\\ArangoDB\\Admin\\Admin\u003A\u003Atasks\u0028\u0029", + "name": "tasks", + "summary": "Returns\u0020all\u0020tasks\u0020of\u0020server\u0020information.", + "url": "classes/ArangoDB-Admin-Admin.html#method_tasks" + }, { + "fqsen": "\\ArangoDB\\Admin\\Admin\u003A\u003AflushWal\u0028\u0029", + "name": "flushWal", + "summary": "Flushes\u0020the\u0020\u003Cb\u003Ewrite\u002Dahead\u0020log\u003C\/b\u003E.\u0020By\u0020flushing\u0020the\u0020currently\u0020active\u0020write\u002Dahead\nlogfile,\u0020the\u0020data\u0020in\u0020it\u0020can\u0020be\u0020transferred\u0020to\u0020collection\u0020journals\u0020and\ndatafiles.\u0020This\u0020is\u0020useful\u0020to\u0020ensure\u0020that\u0020all\u0020data\u0020for\u0020a\u0020collection\u0020is\npresent\u0020in\u0020the\u0020collection\u0020journals\u0020and\u0020datafiles,\u0020for\u0020example,\u0020when\u0020dumping\nthe\u0020data\u0020of\u0020a\u0020collection.", + "url": "classes/ArangoDB-Admin-Admin.html#method_flushWal" + }, { + "fqsen": "\\ArangoDB\\Admin\\Admin\u003A\u003AwalProperties\u0028\u0029", + "name": "walProperties", + "summary": "Retrieves\u0020the\u0020configuration\u0020of\u0020the\u0020\u003Cb\u003Ewrite\u002Dahead\u0020log\u003C\/b\u003E.", + "url": "classes/ArangoDB-Admin-Admin.html#method_walProperties" + }, { + "fqsen": "\\ArangoDB\\Admin\\Admin\u003A\u003AwalTransactions\u0028\u0029", + "name": "walTransactions", + "summary": "Returns\u0020information\u0020about\u0020the\u0020currently\u0020running\u0020transactions.", + "url": "classes/ArangoDB-Admin-Admin.html#method_walTransactions" }, { "fqsen": "\\ArangoDB\\Admin\\Server", "name": "Server", "summary": "Manages\u0020some\u0020server\u0020admin\u0020features.", "url": "classes/ArangoDB-Admin-Server.html" + }, { + "fqsen": "\\ArangoDB\\Admin\\Server\u003A\u003Aversion\u0028\u0029", + "name": "version", + "summary": "Returns\u0020the\u0020Arango\u0020server\u0020version.", + "url": "classes/ArangoDB-Admin-Server.html#method_version" + }, { + "fqsen": "\\ArangoDB\\Admin\\Server\u003A\u003Aengine\u0028\u0029", + "name": "engine", + "summary": "Returns\u0020the\u0020storage\u0020engine\u0020the\u0020server\u0020is\u0020configured\u0020to\u0020use.", + "url": "classes/ArangoDB-Admin-Server.html#method_engine" + }, { + "fqsen": "\\ArangoDB\\Admin\\Server\u003A\u003Arole\u0028\u0029", + "name": "role", + "summary": "Returns\u0020the\u0020role\u0020of\u0020a\u0020server\u0020in\u0020a\u0020cluster.", + "url": "classes/ArangoDB-Admin-Server.html#method_role" + }, { + "fqsen": "\\ArangoDB\\Admin\\Server\u003A\u003AisAvailable\u0028\u0029", + "name": "isAvailable", + "summary": "Checks\u0020if\u0020the\u0020Arango\u0020server\u0020is\u0020available\u0020for\u0020arbitrary\u0020operations.\u003Cbr\u003E\n\u0028e.g\u0020Is\u0020not\u0020set\u0020to\u0020read\u002Donly\u0020mode\u0020and\u0020isn\u0027t\u0020a\u0020follower\u0020on\u0020failover\u0020setups\u0029\u003Cbr\u003E\nIf\u0020server\u0020during\u0020startup\u0020or\u0020during\u0020shutdown\u0020returns\u0020false.", + "url": "classes/ArangoDB-Admin-Server.html#method_isAvailable" + }, { + "fqsen": "\\ArangoDB\\Admin\\Server\u003A\u003AlogLevel\u0028\u0029", + "name": "logLevel", + "summary": "Returns\u0020the\u0020server\u0027s\u0020current\u0020log\u0020level\u0020settings.", + "url": "classes/ArangoDB-Admin-Server.html#method_logLevel" }, { "fqsen": "\\ArangoDB\\Admin\\Task\\Task", "name": "Task", "summary": "Represents\u0020an\u0020user\u0020defined\u0020task\u0020on\u0020server.", "url": "classes/ArangoDB-Admin-Task-Task.html" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Task\u0020constructor.", + "url": "classes/ArangoDB-Admin-Task-Task.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003A\u0024isNew", + "name": "isNew", + "summary": "If\u0020the\u0020entity\u0020is\u0020not\u0020an\u0020representation\u0020of\u0020a\u0020existing\u0020task\u0020on\u0020server,\nthis\u0020property\u0020is\u0020true.", + "url": "classes/ArangoDB-Admin-Task-Task.html#property_isNew" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003AgetId\u0028\u0029", + "name": "getId", + "summary": "Return\u0020the\u0020Task\u0020id.", + "url": "classes/ArangoDB-Admin-Task-Task.html#method_getId" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003AgetType\u0028\u0029", + "name": "getType", + "summary": "Return\u0020the\u0020task\u0020type.", + "url": "classes/ArangoDB-Admin-Task-Task.html#method_getType" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003AgetCommand\u0028\u0029", + "name": "getCommand", + "summary": "Returns\u0020the\u0020command.", + "url": "classes/ArangoDB-Admin-Task-Task.html#method_getCommand" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020task.", + "url": "classes/ArangoDB-Admin-Task-Task.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003AhasConnection\u0028\u0029", + "name": "hasConnection", + "summary": "If\u0020this\u0020task\u0020has\u0020a\u0020connection\u0020set\u0020or\u0020not.", + "url": "classes/ArangoDB-Admin-Task-Task.html#method_hasConnection" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003AsetId\u0028\u0029", + "name": "setId", + "summary": "Sets\u0020a\u0020custom\u0020id\u0020for\u0020task.", + "url": "classes/ArangoDB-Admin-Task-Task.html#method_setId" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003AsetCommand\u0028\u0029", + "name": "setCommand", + "summary": "Sets\u0020the\u0020command\u0020to\u0020task.", + "url": "classes/ArangoDB-Admin-Task-Task.html#method_setCommand" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003AsetConnection\u0028\u0029", + "name": "setConnection", + "summary": "Sets\u0020a\u0020connection\u0020to\u0020use.", + "url": "classes/ArangoDB-Admin-Task-Task.html#method_setConnection" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003Asave\u0028\u0029", + "name": "save", + "summary": "Saves\u0020this\u0020task\u0020on\u0020server,\u0020if\u0020possible", + "url": "classes/ArangoDB-Admin-Task-Task.html#method_save" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "Removes\u0020a\u0020task\u0020from\u0020server,\u0020if\u0020possible.", + "url": "classes/ArangoDB-Admin-Task-Task.html#method_delete" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "Return\u0020a\u0020JSON\u0020representation\u0020of\u0020Task\u0020object.", + "url": "classes/ArangoDB-Admin-Task-Task.html#method_jsonSerialize" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003A\u0024id", + "name": "id", + "summary": "Task\u0020id.", + "url": "classes/ArangoDB-Admin-Task-Task.html#property_id" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003A\u0024type", + "name": "type", + "summary": "Task\u0020type.", + "url": "classes/ArangoDB-Admin-Task-Task.html#property_type" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003A\u0024attributes", + "name": "attributes", + "summary": "Attributes\u0020of\u0020task.", + "url": "classes/ArangoDB-Admin-Task-Task.html#property_attributes" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003A\u0024connection", + "name": "connection", + "summary": "Connection\u0020object.", + "url": "classes/ArangoDB-Admin-Task-Task.html#property_connection" + }, { + "fqsen": "\\ArangoDB\\Admin\\Task\\Task\u003A\u003A\u0024defaultOptions", + "name": "defaultOptions", + "summary": "Default\u0020options.", + "url": "classes/ArangoDB-Admin-Task-Task.html#property_defaultOptions" }, { "fqsen": "\\ArangoDB\\AQL\\AQL", "name": "AQL", "summary": "Manages\u0020some\u0020AQL\u0020features", "url": "classes/ArangoDB-AQL-AQL.html" + }, { + "fqsen": "\\ArangoDB\\AQL\\AQL\u003A\u003AvalidateQuery\u0028\u0029", + "name": "validateQuery", + "summary": "Validates\u0020a\u0020given\u0020AQL\u0020statement", + "url": "classes/ArangoDB-AQL-AQL.html#method_validateQuery" + }, { + "fqsen": "\\ArangoDB\\AQL\\AQL\u003A\u003Afunctions\u0028\u0029", + "name": "functions", + "summary": "Returns\u0020all\u0020registered\u0020AQL\u0020user\u0020functions.", + "url": "classes/ArangoDB-AQL-AQL.html#method_functions" }, { "fqsen": "\\ArangoDB\\AQL\\BindContainer", "name": "BindContainer", "summary": "Manager\u0020parameters\/values\u0020binding\u0020to\u0020statements", "url": "classes/ArangoDB-AQL-BindContainer.html" + }, { + "fqsen": "\\ArangoDB\\AQL\\BindContainer\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "BindContainer\u0020constructor.", + "url": "classes/ArangoDB-AQL-BindContainer.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\AQL\\BindContainer\u003A\u003Aput\u0028\u0029", + "name": "put", + "summary": "Add\u0020validation\u0020to\u0020value\u0020being\u0020set.", + "url": "classes/ArangoDB-AQL-BindContainer.html#method_put" + }, { + "fqsen": "\\ArangoDB\\AQL\\BindContainer\u003A\u003AgetAll\u0028\u0029", + "name": "getAll", + "summary": "Get\u0020the\u0020stored\u0020vars", + "url": "classes/ArangoDB-AQL-BindContainer.html#method_getAll" + }, { + "fqsen": "\\ArangoDB\\AQL\\BindContainer\u003A\u003A\u0024validator", + "name": "validator", + "summary": "Validate\u0020input\u0020data", + "url": "classes/ArangoDB-AQL-BindContainer.html#property_validator" }, { "fqsen": "\\ArangoDB\\AQL\\Contracts\\QueryInterface", "name": "QueryInterface", "summary": "QueryInterface", "url": "classes/ArangoDB-AQL-Contracts-QueryInterface.html" + }, { + "fqsen": "\\ArangoDB\\AQL\\Contracts\\QueryInterface\u003A\u003Aquery\u0028\u0029", + "name": "query", + "summary": "Instantiate\u0020a\u0020new\u0020StatementInterface\u0020object\u0020with\u0020the\u0020specified\u0020query", + "url": "classes/ArangoDB-AQL-Contracts-QueryInterface.html#method_query" + }, { + "fqsen": "\\ArangoDB\\AQL\\Contracts\\QueryInterface\u003A\u003Aexecute\u0028\u0029", + "name": "execute", + "summary": "Execute\u0020an\u0020statment\u0020on\u0020server\u0020and\u0020returns\u0020a\u0020cursor", + "url": "classes/ArangoDB-AQL-Contracts-QueryInterface.html#method_execute" }, { "fqsen": "\\ArangoDB\\AQL\\Contracts\\StatementInterface", "name": "StatementInterface", "summary": "StatementInterface", "url": "classes/ArangoDB-AQL-Contracts-StatementInterface.html" + }, { + "fqsen": "\\ArangoDB\\AQL\\Contracts\\StatementInterface\u003A\u003A__toString\u0028\u0029", + "name": "__toString", + "summary": "Get\u0020the\u0020string\u0020representation\u0020of\u0020query", + "url": "classes/ArangoDB-AQL-Contracts-StatementInterface.html#method___toString" + }, { + "fqsen": "\\ArangoDB\\AQL\\Contracts\\StatementInterface\u003A\u003AbindValue\u0028\u0029", + "name": "bindValue", + "summary": "Binds\u0020a\u0020value\u0020to\u0020specified\u0020parameter\u0020name.", + "url": "classes/ArangoDB-AQL-Contracts-StatementInterface.html#method_bindValue" + }, { + "fqsen": "\\ArangoDB\\AQL\\Contracts\\StatementInterface\u003A\u003AhasAliases\u0028\u0029", + "name": "hasAliases", + "summary": "If\u0020the\u0020query\u0020has\u0020some\u0020alias\u0020\u0028e.g\u003A\u0020\u0022\u0040myparam\u0022\u0020\u0029\non\u0020it\u0020to\u0020receive\u0020a\u0020value\u0020after\u0020through\u0020binding", + "url": "classes/ArangoDB-AQL-Contracts-StatementInterface.html#method_hasAliases" + }, { + "fqsen": "\\ArangoDB\\AQL\\Contracts\\StatementInterface\u003A\u003AgetQuery\u0028\u0029", + "name": "getQuery", + "summary": "Returns\u0020the\u0020query\u0020string", + "url": "classes/ArangoDB-AQL-Contracts-StatementInterface.html#method_getQuery" + }, { + "fqsen": "\\ArangoDB\\AQL\\Contracts\\StatementInterface\u003A\u003AgetBindVars\u0028\u0029", + "name": "getBindVars", + "summary": "Get\u0020the\u0020bind\u0020vars", + "url": "classes/ArangoDB-AQL-Contracts-StatementInterface.html#method_getBindVars" + }, { + "fqsen": "\\ArangoDB\\AQL\\Contracts\\StatementInterface\u003A\u003AtoAql\u0028\u0029", + "name": "toAql", + "summary": "\u0027Resolves\u0027\u0020the\u0020query,\u0020returning\u0020the\u0020string\u0020after\u0020bind\u0020all\u0020params\u0020and\u0020values", + "url": "classes/ArangoDB-AQL-Contracts-StatementInterface.html#method_toAql" }, { "fqsen": "\\ArangoDB\\AQL\\Exceptions\\AQLException", "name": "AQLException", @@ -50,31 +270,341 @@ Search.appendIndex( "name": "AQLFunction", "summary": "Represents\u0020a\u0020user\u0020defined\u0020AQL\u0020function\u0020on\u0020server.", "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "AQLFunction\u0020constructor.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003A\u0024isNew", + "name": "isNew", + "summary": "If\u0020the\u0020entity\u0020is\u0020not\u0020a\u0020representation\u0020of\u0020an\u0020existing\u0020user\u0020function\u0020on\u0020server,\nthis\u0020property\u0020is\u0020true.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#property_isNew" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003AgetName\u0028\u0029", + "name": "getName", + "summary": "Returns\u0020the\u0020AQL\u0020function\u0020name.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#method_getName" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003AgetCode\u0028\u0029", + "name": "getCode", + "summary": "Returns\u0020the\u0020AQL\u0020function\u0020code.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#method_getCode" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003A\u0024isDeterministic", + "name": "isDeterministic", + "summary": "An\u0020optional\u0020boolean\u0020value\u0020to\u0020indicate\u0020whether\u0020the\u0020function\u0020results\u0020are\u0020fully\u0020deterministic.\u0020\u003Cbr\u003E\n\u0028function\u0020return\u0020value\u0020solely\u0020depends\u0020on\u0020the\u0020input\u0020value\u0020and\u0020return\u0020value\u0020is\u0020the\u0020same\u0020for\u0020repeated\u0020calls\u0020with\u0020same\u0020input\u0029", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#property_isDeterministic" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003AgetDeletionData\u0028\u0029", + "name": "getDeletionData", + "summary": "If\u0020the\u0020object\u0020has\u0020performed\u0020a\u0020delete\u0020operation,\u0020this\u0020method\u0020will\u0020return\u0020the\u0020deletion\u0020data.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#method_getDeletionData" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003AsetConnection\u0028\u0029", + "name": "setConnection", + "summary": "Sets\u0020a\u0020connection\u0020to\u0020use.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#method_setConnection" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003Asave\u0028\u0029", + "name": "save", + "summary": "Saves\u0020the\u0020AQL\u0020function\u0020on\u0020server.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#method_save" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003AhasConnection\u0028\u0029", + "name": "hasConnection", + "summary": "If\u0020this\u0020AQL\u0020function\u0020has\u0020a\u0020connection\u0020set\u0020or\u0020not.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#method_hasConnection" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020AQL\u0020function\u0020object.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "Removes\u0020an\u0020AQL\u0020function\u0020from\u0020server,\u0020if\u0020possible", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#method_delete" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "Return\u0020a\u0020JSON\u0020representation\u0020of\u0020AQL\u0020function\u0020object.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#method_jsonSerialize" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003A\u0024name", + "name": "name", + "summary": "Fully\u0020qualified\u0020name\u0020of\u0020user\u0020function.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#property_name" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003A\u0024code", + "name": "code", + "summary": "String\u0020representation\u0020of\u0020function\u0020body.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#property_code" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003A\u0024connection", + "name": "connection", + "summary": "Connection\u0020object.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#property_connection" + }, { + "fqsen": "\\ArangoDB\\AQL\\Functions\\AQLFunction\u003A\u003A\u0024deletion", + "name": "deletion", + "summary": "Stores\u0020the\u0020deletion\u0020data\u0020for\u0020an\u0020AQLFunction\u0020object.", + "url": "classes/ArangoDB-AQL-Functions-AQLFunction.html#property_deletion" }, { "fqsen": "\\ArangoDB\\AQL\\Statement", "name": "Statement", "summary": "Represents\u0020a\u0020prepared\u0020AQL\u0020Statement", "url": "classes/ArangoDB-AQL-Statement.html" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Statement\u0020constructor.", + "url": "classes/ArangoDB-AQL-Statement.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003A__toString\u0028\u0029", + "name": "__toString", + "summary": "String\u0020representation\u0020of\u0020query", + "url": "classes/ArangoDB-AQL-Statement.html#method___toString" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003AbindValue\u0028\u0029", + "name": "bindValue", + "summary": "Binds\u0020a\u0020value\u0020to\u0020specified\u0020parameter\u0020name.", + "url": "classes/ArangoDB-AQL-Statement.html#method_bindValue" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003AhasAliases\u0028\u0029", + "name": "hasAliases", + "summary": "If\u0020the\u0020query\u0020has\u0020some\u0020alias\u0020on\u0020it\u0020to\u0020receive\u0020an\u0020value\u0020after\u0020through\u0020binding", + "url": "classes/ArangoDB-AQL-Statement.html#method_hasAliases" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003AgetQuery\u0028\u0029", + "name": "getQuery", + "summary": "Returns\u0020the\u0020query\u0020string", + "url": "classes/ArangoDB-AQL-Statement.html#method_getQuery" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003AgetBindVars\u0028\u0029", + "name": "getBindVars", + "summary": "Get\u0020the\u0020bind\u0020vars", + "url": "classes/ArangoDB-AQL-Statement.html#method_getBindVars" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003AtoAql\u0028\u0029", + "name": "toAql", + "summary": "\u0027Resolves\u0027\u0020the\u0020query,\u0020returning\u0020the\u0020string\u0020after\u0020bind\u0020all\u0020params\u0020and\u0020values", + "url": "classes/ArangoDB-AQL-Statement.html#method_toAql" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003Aoutput\u0028\u0029", + "name": "output", + "summary": "Returns\u0020the\u0020proper\u0020output\u0020formatted\u0020given\u0020parameter", + "url": "classes/ArangoDB-AQL-Statement.html#method_output" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003AhasParam\u0028\u0029", + "name": "hasParam", + "summary": "Check\u0020if\u0020parameter\u0020exists", + "url": "classes/ArangoDB-AQL-Statement.html#method_hasParam" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003AprocessQueryParameters\u0028\u0029", + "name": "processQueryParameters", + "summary": "Find\u0020occurrences\u0020of\u0020bind\u0020params\u0020in\u0020query\u0020string", + "url": "classes/ArangoDB-AQL-Statement.html#method_processQueryParameters" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003AisCollectionAlias\u0028\u0029", + "name": "isCollectionAlias", + "summary": "Verify\u0020if\u0020an\u0020alias\u0020is\u0020defined\u0020for\u0020collection\u0020aliasing", + "url": "classes/ArangoDB-AQL-Statement.html#method_isCollectionAlias" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003A\u0024query", + "name": "query", + "summary": "The\u0020query\u0020string", + "url": "classes/ArangoDB-AQL-Statement.html#property_query" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003A\u0024collectionAlias", + "name": "collectionAlias", + "summary": "If\u0020the\u0020statement\u0020use\u0020an\u0020alias\u0020for\u0020collection,\nstore\u0020the\u0020alias\u0020here\n\u0028e.g\u0020\u0022\u0040collection\u0022,\u0020\u0022\u0040coll\u0022\u0029", + "url": "classes/ArangoDB-AQL-Statement.html#property_collectionAlias" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003A\u0024validator", + "name": "validator", + "summary": "Validator\u0020for\u0020binding\u0020values\u0020or\u0020params", + "url": "classes/ArangoDB-AQL-Statement.html#property_validator" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003A\u0024queryParameters", + "name": "queryParameters", + "summary": "Parameters\u0020set\u0020with\u0020\u0027\u0040\u0027\u0020in\u0020query", + "url": "classes/ArangoDB-AQL-Statement.html#property_queryParameters" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003A\u0024container", + "name": "container", + "summary": "Contains\u0020all\u0020references\u0020calling\u0020\u0027bindValue\u0027\u0020method", + "url": "classes/ArangoDB-AQL-Statement.html#property_container" + }, { + "fqsen": "\\ArangoDB\\AQL\\Statement\u003A\u003A\u0024formats", + "name": "formats", + "summary": "Formats\u0020to\u0020format\u0020output\u0020string", + "url": "classes/ArangoDB-AQL-Statement.html#property_formats" }, { "fqsen": "\\ArangoDB\\Auth\\Authenticable", "name": "Authenticable", "summary": "Class\u0020Authenticable", "url": "classes/ArangoDB-Auth-Authenticable.html" + }, { + "fqsen": "\\ArangoDB\\Auth\\Authenticable\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Authenticable\u0020constructor.", + "url": "classes/ArangoDB-Auth-Authenticable.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Auth\\Authenticable\u003A\u003Aauthenticate\u0028\u0029", + "name": "authenticate", + "summary": "Authenticates\u0020a\u0020user\u0020on\u0020ArangoDB\u0020Server", + "url": "classes/ArangoDB-Auth-Authenticable.html#method_authenticate" + }, { + "fqsen": "\\ArangoDB\\Auth\\Authenticable\u003A\u003AgetAuthorizationHeader\u0028\u0029", + "name": "getAuthorizationHeader", + "summary": "Return\u0020the\u0020authorization\u0020header", + "url": "classes/ArangoDB-Auth-Authenticable.html#method_getAuthorizationHeader" + }, { + "fqsen": "\\ArangoDB\\Auth\\Authenticable\u003A\u003AgetCredentials\u0028\u0029", + "name": "getCredentials", + "summary": "Return\u0020authentication\u0020credentials", + "url": "classes/ArangoDB-Auth-Authenticable.html#method_getCredentials" + }, { + "fqsen": "\\ArangoDB\\Auth\\Authenticable\u003A\u003AgetAuthenticationEndpoint\u0028\u0029", + "name": "getAuthenticationEndpoint", + "summary": "Authentication\u0020endpoint\u0020for\u0020a\u0020given\u0020database", + "url": "classes/ArangoDB-Auth-Authenticable.html#method_getAuthenticationEndpoint" + }, { + "fqsen": "\\ArangoDB\\Auth\\Authenticable\u003A\u003A\u0024options", + "name": "options", + "summary": "", + "url": "classes/ArangoDB-Auth-Authenticable.html#property_options" + }, { + "fqsen": "\\ArangoDB\\Auth\\Authenticable\u003A\u003A\u0024authToken", + "name": "authToken", + "summary": "", + "url": "classes/ArangoDB-Auth-Authenticable.html#property_authToken" + }, { + "fqsen": "\\ArangoDB\\Auth\\Authenticable\u003A\u003A\u0024restClient", + "name": "restClient", + "summary": "", + "url": "classes/ArangoDB-Auth-Authenticable.html#property_restClient" }, { "fqsen": "\\ArangoDB\\Auth\\Exceptions\\AuthException", "name": "AuthException", "summary": "AuthException", "url": "classes/ArangoDB-Auth-Exceptions-AuthException.html" + }, { + "fqsen": "\\ArangoDB\\Auth\\Exceptions\\AuthException\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "AuthException\u0020constructor.", + "url": "classes/ArangoDB-Auth-Exceptions-AuthException.html#method___construct" }, { "fqsen": "\\ArangoDB\\Auth\\Exceptions\\UserException", "name": "UserException", "summary": "UserException", "url": "classes/ArangoDB-Auth-Exceptions-UserException.html" + }, { + "fqsen": "\\ArangoDB\\Auth\\Exceptions\\UserException\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "UserException\u0020constructor.", + "url": "classes/ArangoDB-Auth-Exceptions-UserException.html#method___construct" }, { "fqsen": "\\ArangoDB\\Auth\\User", "name": "User", "summary": "Represents\u0020a\u0020user\u0020in\u0020server.", "url": "classes/ArangoDB-Auth-User.html" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "User\u0020constructor.", + "url": "classes/ArangoDB-Auth-User.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003A__debugInfo\u0028\u0029", + "name": "__debugInfo", + "summary": "Proper\u0020debug\u0020dump\u0020for\u0020User\u0020objects.", + "url": "classes/ArangoDB-Auth-User.html#method___debugInfo" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003A__toString\u0028\u0029", + "name": "__toString", + "summary": "String\u0020representation\u0020of\u0020User\u0020object.", + "url": "classes/ArangoDB-Auth-User.html#method___toString" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003A__get\u0028\u0029", + "name": "__get", + "summary": "Get\u0020some\u0020attribute.", + "url": "classes/ArangoDB-Auth-User.html#method___get" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003AisActive\u0028\u0029", + "name": "isActive", + "summary": "Get\u0020the\u0020activation\u0020status\u0020of\u0020the\u0020user.", + "url": "classes/ArangoDB-Auth-User.html#method_isActive" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003A\u0024isNew", + "name": "isNew", + "summary": "If\u0020user\u0020is\u0020a\u0020new\u0020User\u0020or\u0020an\u0020existing\u0020one.", + "url": "classes/ArangoDB-Auth-User.html#property_isNew" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003AsetActive\u0028\u0029", + "name": "setActive", + "summary": "Set\u0020the\u0020activation\u0020status\u0020of\u0020the\u0020user.", + "url": "classes/ArangoDB-Auth-User.html#method_setActive" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003AgetUsername\u0028\u0029", + "name": "getUsername", + "summary": "Returns\u0020the\u0020username.", + "url": "classes/ArangoDB-Auth-User.html#method_getUsername" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003AgetExtra\u0028\u0029", + "name": "getExtra", + "summary": "Returns\u0020extra\u0020data\u0020about\u0020user.", + "url": "classes/ArangoDB-Auth-User.html#method_getExtra" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003AsetExtra\u0028\u0029", + "name": "setExtra", + "summary": "Set\u0020extra\u0020data\u0020for\u0020user.", + "url": "classes/ArangoDB-Auth-User.html#method_setExtra" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020user", + "url": "classes/ArangoDB-Auth-User.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003Asave\u0028\u0029", + "name": "save", + "summary": "Saves\u0020\u0028or\u0020update\u0029\u0020a\u0020user\u0020on\u0020server", + "url": "classes/ArangoDB-Auth-User.html#method_save" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "Removes\u0020an\u0020user\u0020from\u0020server.", + "url": "classes/ArangoDB-Auth-User.html#method_delete" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "Return\u0020a\u0020JSON\u0020representation\u0020of\u0020list.", + "url": "classes/ArangoDB-Auth-User.html#method_jsonSerialize" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003A\u0024user", + "name": "user", + "summary": "Name\u0020of\u0020user\u0020on\u0020server.", + "url": "classes/ArangoDB-Auth-User.html#property_user" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003A\u0024password", + "name": "password", + "summary": "Password\u0020of\u0020user.", + "url": "classes/ArangoDB-Auth-User.html#property_password" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003A\u0024active", + "name": "active", + "summary": "If\u0020user\u0020is\u0020active\u0020or\u0020not\u0020on\u0020database.", + "url": "classes/ArangoDB-Auth-User.html#property_active" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003A\u0024extra", + "name": "extra", + "summary": "Extra\u0020data\u0020about\u0020the\u0020user.", + "url": "classes/ArangoDB-Auth-User.html#property_extra" + }, { + "fqsen": "\\ArangoDB\\Auth\\User\u003A\u003A\u0024connection", + "name": "connection", + "summary": "Connection\u0020object\u0020to\u0020use.", + "url": "classes/ArangoDB-Auth-User.html#property_connection" }, { "fqsen": "\\ArangoDB\\Batch\\Batch", "name": "Batch", @@ -85,111 +615,1031 @@ Search.appendIndex( "name": "Import", "summary": "Allow\u0020import\u0020multiple\u0020documents\u0020to\u0020a\u0020collection", "url": "classes/ArangoDB-Batch-Import.html" + }, { + "fqsen": "\\ArangoDB\\Batch\\Import\u003A\u003AimportJsonDocuments\u0028\u0029", + "name": "importJsonDocuments", + "summary": "Import\u0020multiple\u0020documents\u0020from\u0020a\u0020JSON\u0020document", + "url": "classes/ArangoDB-Batch-Import.html#method_importJsonDocuments" + }, { + "fqsen": "\\ArangoDB\\Batch\\Import\u003A\u003AimportArrayDocuments\u0028\u0029", + "name": "importArrayDocuments", + "summary": "Import\u0020multiple\u0020documents\u0020from\u0020a\u0020array\u0020document", + "url": "classes/ArangoDB-Batch-Import.html#method_importArrayDocuments" }, { "fqsen": "\\ArangoDB\\Collection\\Collection", "name": "Collection", "summary": "Represents\u0020an\u0020ArangoDB\u0020collection", "url": "classes/ArangoDB-Collection-Collection.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Collection\u0020constructor.", + "url": "classes/ArangoDB-Collection-Collection.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A__toString\u0028\u0029", + "name": "__toString", + "summary": "Return\u0020a\u0020string\u0020representation\u0020of\u0020document", + "url": "classes/ArangoDB-Collection-Collection.html#method___toString" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A__get\u0028\u0029", + "name": "__get", + "summary": "Get\u0020some\u0020attribute", + "url": "classes/ArangoDB-Collection-Collection.html#method___get" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A__set\u0028\u0029", + "name": "__set", + "summary": "Set\u0020an\u0020attribute", + "url": "classes/ArangoDB-Collection-Collection.html#method___set" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003Aall\u0028\u0029", + "name": "all", + "summary": "Returns\u0020a\u0020cursor\u0020for\u0020access\u0020all\u0020documents\u0020on\u0020this\u0020Collection", + "url": "classes/ArangoDB-Collection-Collection.html#method_all" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AgetAttributes\u0028\u0029", + "name": "getAttributes", + "summary": "Return\u0020the\u0020collection\u0020attributes\u0020on\u0020array", + "url": "classes/ArangoDB-Collection-Collection.html#method_getAttributes" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AsetAttributes\u0028\u0029", + "name": "setAttributes", + "summary": "Set\u0020collection\u0020attributes", + "url": "classes/ArangoDB-Collection-Collection.html#method_setAttributes" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AgetDatabase\u0028\u0029", + "name": "getDatabase", + "summary": "Returns\u0020the\u0020database\u0020where\u0020collection\u0020belongs", + "url": "classes/ArangoDB-Collection-Collection.html#method_getDatabase" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AgetName\u0028\u0029", + "name": "getName", + "summary": "Return\u0020the\u0020name\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#method_getName" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AgetId\u0028\u0029", + "name": "getId", + "summary": "Return\u0020the\u0020ID\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#method_getId" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AgetGloballyUniqueId\u0028\u0029", + "name": "getGloballyUniqueId", + "summary": "Return\u0020the\u0020globally\u0020Unique\u0020ID\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#method_getGloballyUniqueId" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AgetStatus\u0028\u0029", + "name": "getStatus", + "summary": "Return\u0020the\u0020status\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#method_getStatus" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AgetStatusDescription\u0028\u0029", + "name": "getStatusDescription", + "summary": "Return\u0020a\u0020string\u0020description\u0020of\u0020status", + "url": "classes/ArangoDB-Collection-Collection.html#method_getStatusDescription" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AgetType\u0028\u0029", + "name": "getType", + "summary": "Return\u0020the\u0020collection\u0020type", + "url": "classes/ArangoDB-Collection-Collection.html#method_getType" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AisSystem\u0028\u0029", + "name": "isSystem", + "summary": "Checks\u0020if\u0020the\u0020collection\u0020is\u0020a\u0020system\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#method_isSystem" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024isNew", + "name": "isNew", + "summary": "If\u0020the\u0020collection\u0020is\u0020a\u0020new\u0020one\u0020or\u0020a\u0020representation\u0020of\u0020an\u0020existing\u0020collection\u0020on\u0020server", + "url": "classes/ArangoDB-Collection-Collection.html#property_isNew" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AisGraph\u0028\u0029", + "name": "isGraph", + "summary": "Return\u0020if\u0020the\u0020collection\u0020is\u0020a\u0020graph\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#method_isGraph" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Return\u0020an\u0020array\u0020representation\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AgetChecksum\u0028\u0029", + "name": "getChecksum", + "summary": "Return\u0020the\u0020checksum\u0020of\u0020collection\u0020metadata", + "url": "classes/ArangoDB-Collection-Collection.html#method_getChecksum" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AgetRevision\u0028\u0029", + "name": "getRevision", + "summary": "Return\u0020the\u0020revision\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#method_getRevision" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003Asave\u0028\u0029", + "name": "save", + "summary": "Saves\u0020or\u0020update\u0020the\u0020collection.", + "url": "classes/ArangoDB-Collection-Collection.html#method_save" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003Adrop\u0028\u0029", + "name": "drop", + "summary": "Drops\u0020the\u0020collection\u0020on\u0020database", + "url": "classes/ArangoDB-Collection-Collection.html#method_drop" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003Atruncate\u0028\u0029", + "name": "truncate", + "summary": "Truncate\u0020the\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#method_truncate" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AfindByKey\u0028\u0029", + "name": "findByKey", + "summary": "Find\u0020a\u0020document\u0020by\u0020its\u0020key", + "url": "classes/ArangoDB-Collection-Collection.html#method_findByKey" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003Acount\u0028\u0029", + "name": "count", + "summary": "Return\u0020the\u0020number\u0020of\u0020documents\u0020in\u0020a\u0020collection.", + "url": "classes/ArangoDB-Collection-Collection.html#method_count" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003ArecalculateCount\u0028\u0029", + "name": "recalculateCount", + "summary": "Recalculates\u0020the\u0020document\u0020count\u0020of\u0020a\u0020collection,\u0020if\u0020it\u0020ever\u0020becomes\u0020inconsistent.", + "url": "classes/ArangoDB-Collection-Collection.html#method_recalculateCount" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003Arename\u0028\u0029", + "name": "rename", + "summary": "Renames\u0020the\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#method_rename" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "", + "url": "classes/ArangoDB-Collection-Collection.html#method_jsonSerialize" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AgetCreateParameters\u0028\u0029", + "name": "getCreateParameters", + "summary": "Return\u0020only\u0020fields\u0020to\u0020be\u0020sent\u0020on\u0020a\u0020POST\u0020request", + "url": "classes/ArangoDB-Collection-Collection.html#method_getCreateParameters" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003AgetUpdateParameters\u0028\u0029", + "name": "getUpdateParameters", + "summary": "Return\u0020only\u0020fields\u0020to\u0020update\u0020this\u0020collection.", + "url": "classes/ArangoDB-Collection-Collection.html#method_getUpdateParameters" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003Aupdate\u0028\u0029", + "name": "update", + "summary": "Update\u0020collection.", + "url": "classes/ArangoDB-Collection-Collection.html#method_update" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024attributes", + "name": "attributes", + "summary": "Attributes\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#property_attributes" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024database", + "name": "database", + "summary": "Database\u0020object", + "url": "classes/ArangoDB-Collection-Collection.html#property_database" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024connection", + "name": "connection", + "summary": "Connection\u0020object", + "url": "classes/ArangoDB-Collection-Collection.html#property_connection" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024descriptorAttributes", + "name": "descriptorAttributes", + "summary": "Fields\u0020to\u0020be\u0020set\u0020directly", + "url": "classes/ArangoDB-Collection-Collection.html#property_descriptorAttributes" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024typeStrings", + "name": "typeStrings", + "summary": "Type\u0020descriptions", + "url": "classes/ArangoDB-Collection-Collection.html#property_typeStrings" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024statusStrings", + "name": "statusStrings", + "summary": "Status\u0020descriptions", + "url": "classes/ArangoDB-Collection-Collection.html#property_statusStrings" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024unknownStatus", + "name": "unknownStatus", + "summary": "Unknown\u0020status\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#property_unknownStatus" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024unloadedStatus", + "name": "unloadedStatus", + "summary": "Unloaded\u0020status\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#property_unloadedStatus" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024loadedStatus", + "name": "loadedStatus", + "summary": "Loaded\u0020status\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#property_loadedStatus" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024deletedStatus", + "name": "deletedStatus", + "summary": "Deleted\u0020status\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#property_deletedStatus" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024loadingStatus", + "name": "loadingStatus", + "summary": "Loading\u0020status\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#property_loadingStatus" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024unloadingStatus", + "name": "unloadingStatus", + "summary": "Unloading\u0020status\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-Collection.html#property_unloadingStatus" + }, { + "fqsen": "\\ArangoDB\\Collection\\Collection\u003A\u003A\u0024defaults", + "name": "defaults", + "summary": "Default\u0020values\u0020when\u0020creating\u0020collections", + "url": "classes/ArangoDB-Collection-Collection.html#property_defaults" }, { "fqsen": "\\ArangoDB\\Collection\\Contracts\\IndexInterface", "name": "IndexInterface", "summary": "Interface\u0020IndexInterface", "url": "classes/ArangoDB-Collection-Contracts-IndexInterface.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\Contracts\\IndexInterface\u003A\u003AisNew\u0028\u0029", + "name": "isNew", + "summary": "If\u0020the\u0020index\u0020is\u0020a\u0020new\u0020one", + "url": "classes/ArangoDB-Collection-Contracts-IndexInterface.html#method_isNew" + }, { + "fqsen": "\\ArangoDB\\Collection\\Contracts\\IndexInterface\u003A\u003AisUnique\u0028\u0029", + "name": "isUnique", + "summary": "If\u0020index\u0020was\u0020set\u0020to\u0020use\u0020\u0027unique\u0027\u0020constraint", + "url": "classes/ArangoDB-Collection-Contracts-IndexInterface.html#method_isUnique" + }, { + "fqsen": "\\ArangoDB\\Collection\\Contracts\\IndexInterface\u003A\u003AisSparse\u0028\u0029", + "name": "isSparse", + "summary": "If\u0020index\u0020is\u0020sparse", + "url": "classes/ArangoDB-Collection-Contracts-IndexInterface.html#method_isSparse" + }, { + "fqsen": "\\ArangoDB\\Collection\\Contracts\\IndexInterface\u003A\u003AgetId\u0028\u0029", + "name": "getId", + "summary": "Returns\u0020the\u0020index\u0020id", + "url": "classes/ArangoDB-Collection-Contracts-IndexInterface.html#method_getId" + }, { + "fqsen": "\\ArangoDB\\Collection\\Contracts\\IndexInterface\u003A\u003AgetName\u0028\u0029", + "name": "getName", + "summary": "Returns\u0020the\u0020index\u0020name", + "url": "classes/ArangoDB-Collection-Contracts-IndexInterface.html#method_getName" + }, { + "fqsen": "\\ArangoDB\\Collection\\Contracts\\IndexInterface\u003A\u003AgetType\u0028\u0029", + "name": "getType", + "summary": "Returns\u0020the\u0020index\u0020type", + "url": "classes/ArangoDB-Collection-Contracts-IndexInterface.html#method_getType" + }, { + "fqsen": "\\ArangoDB\\Collection\\Contracts\\IndexInterface\u003A\u003AgetCreateData\u0028\u0029", + "name": "getCreateData", + "summary": "Return\u0020data\u0020for\u0020create\u0020index\u0020on\u0020server", + "url": "classes/ArangoDB-Collection-Contracts-IndexInterface.html#method_getCreateData" + }, { + "fqsen": "\\ArangoDB\\Collection\\Contracts\\IndexInterface\u003A\u003AgetCollection\u0028\u0029", + "name": "getCollection", + "summary": "Returns\u0020the\u0020collection\u0020where\u0020the\u0020index\u0020belongs\u0020to", + "url": "classes/ArangoDB-Collection-Contracts-IndexInterface.html#method_getCollection" }, { "fqsen": "\\ArangoDB\\Collection\\Index\\EdgeIndex", "name": "EdgeIndex", "summary": "Represents\u0020an\u0020edge\u0020index\u0020on\u0020a\u0020collection", "url": "classes/ArangoDB-Collection-Index-EdgeIndex.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\EdgeIndex\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "EdgeIndex\u0020constructor.", + "url": "classes/ArangoDB-Collection-Index-EdgeIndex.html#method___construct" }, { "fqsen": "\\ArangoDB\\Collection\\Index\\Factory", "name": "Factory", "summary": "Index\u0020Factory\u0020class", "url": "classes/ArangoDB-Collection-Index-Factory.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Factory\u003A\u003Afactory\u0028\u0029", + "name": "factory", + "summary": "", + "url": "classes/ArangoDB-Collection-Index-Factory.html#method_factory" }, { "fqsen": "\\ArangoDB\\Collection\\Index\\FullTextIndex", "name": "FullTextIndex", "summary": "Represents\u0020a\u0020fulltext\u0020index", "url": "classes/ArangoDB-Collection-Index-FullTextIndex.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\FullTextIndex\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "FullTextIndex\u0020constructor.", + "url": "classes/ArangoDB-Collection-Index-FullTextIndex.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\FullTextIndex\u003A\u003AgetMinLength\u0028\u0029", + "name": "getMinLength", + "summary": "Return\u0020index\u0020minimum\u0020length", + "url": "classes/ArangoDB-Collection-Index-FullTextIndex.html#method_getMinLength" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\FullTextIndex\u003A\u003AgetCreateData\u0028\u0029", + "name": "getCreateData", + "summary": "Return\u0020data\u0020for\u0020create\u0020index\u0020on\u0020server", + "url": "classes/ArangoDB-Collection-Index-FullTextIndex.html#method_getCreateData" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\FullTextIndex\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020index", + "url": "classes/ArangoDB-Collection-Index-FullTextIndex.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\FullTextIndex\u003A\u003A\u0024minLength", + "name": "minLength", + "summary": "Minimum\u0020length\u0020of\u0020index", + "url": "classes/ArangoDB-Collection-Index-FullTextIndex.html#property_minLength" }, { "fqsen": "\\ArangoDB\\Collection\\Index\\GeoSpatialIndex", "name": "GeoSpatialIndex", "summary": "Represents\u0020a\u0020geo\u002Dspatial\u0020index\u0020on\u0020a\u0020collection", "url": "classes/ArangoDB-Collection-Index-GeoSpatialIndex.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\GeoSpatialIndex\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "GeoSpatialIndex\u0020constructor.", + "url": "classes/ArangoDB-Collection-Index-GeoSpatialIndex.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\GeoSpatialIndex\u003A\u003AisGeoJson\u0028\u0029", + "name": "isGeoJson", + "summary": "If\u0020the\u0020index\u0020is\u0020a\u0020GeoJson.", + "url": "classes/ArangoDB-Collection-Index-GeoSpatialIndex.html#method_isGeoJson" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\GeoSpatialIndex\u003A\u003AgetCreateData\u0028\u0029", + "name": "getCreateData", + "summary": "Return\u0020data\u0020for\u0020create\u0020index\u0020on\u0020server", + "url": "classes/ArangoDB-Collection-Index-GeoSpatialIndex.html#method_getCreateData" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\GeoSpatialIndex\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020index", + "url": "classes/ArangoDB-Collection-Index-GeoSpatialIndex.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\GeoSpatialIndex\u003A\u003A\u0024geoJson", + "name": "geoJson", + "summary": "If\u0020a\u0020geo\u002Dspatial\u0020index\u0020on\u0020a\u0020location\u0020is\u0020constructed\nand\u0020geoJson\u0020is\u0020true,\u0020then\u0020the\u0020order\u0020within\u0020the\u0020array\u0020is\u0020longitude\nfollowed\u0020by\u0020latitude.", + "url": "classes/ArangoDB-Collection-Index-GeoSpatialIndex.html#property_geoJson" }, { "fqsen": "\\ArangoDB\\Collection\\Index\\HashIndex", "name": "HashIndex", "summary": "Represents\u0020a\u0020hash\u0020index\u0020on\u0020a\u0020collection", "url": "classes/ArangoDB-Collection-Index-HashIndex.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\HashIndex\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "HashIndex\u0020constructor.", + "url": "classes/ArangoDB-Collection-Index-HashIndex.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\HashIndex\u003A\u003AisDeduplicate\u0028\u0029", + "name": "isDeduplicate", + "summary": "Return\u0020the\u0020deduplicate\u0020parameter", + "url": "classes/ArangoDB-Collection-Index-HashIndex.html#method_isDeduplicate" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\HashIndex\u003A\u003AgetCreateData\u0028\u0029", + "name": "getCreateData", + "summary": "Return\u0020data\u0020for\u0020create\u0020index\u0020on\u0020server", + "url": "classes/ArangoDB-Collection-Index-HashIndex.html#method_getCreateData" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\HashIndex\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020index", + "url": "classes/ArangoDB-Collection-Index-HashIndex.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\HashIndex\u003A\u003A\u0024deduplicate", + "name": "deduplicate", + "summary": "If\u0020set\u0020to\u0020false,\u0020the\u0020deduplication\u0020of\u0020array\u0020values\u0020is\u0020turned\u0020off", + "url": "classes/ArangoDB-Collection-Index-HashIndex.html#property_deduplicate" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\HashIndex\u003A\u003A\u0024defaultsOptions", + "name": "defaultsOptions", + "summary": "Default\u0020options\u0020for\u0020hash\u0020index", + "url": "classes/ArangoDB-Collection-Index-HashIndex.html#property_defaultsOptions" }, { "fqsen": "\\ArangoDB\\Collection\\Index\\Index", "name": "Index", "summary": "Represents\u0020a\u0020collection\u0020index.", "url": "classes/ArangoDB-Collection-Index-Index.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Index\u0020constructor.", + "url": "classes/ArangoDB-Collection-Index-Index.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003A__toString\u0028\u0029", + "name": "__toString", + "summary": "String\u0020representation\u0020of\u0020index", + "url": "classes/ArangoDB-Collection-Index-Index.html#method___toString" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003A\u0024isNew", + "name": "isNew", + "summary": "If\u0020the\u0020index\u0020is\u0020a\u0020new\u0020one\u0020or\na\u0020representation\u0020of\u0020an\u0020existing\u0020index", + "url": "classes/ArangoDB-Collection-Index-Index.html#property_isNew" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003AisUnique\u0028\u0029", + "name": "isUnique", + "summary": "If\u0020index\u0020has\u0020\u0027unique\u0027\u0020constraint", + "url": "classes/ArangoDB-Collection-Index-Index.html#method_isUnique" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003AisSparse\u0028\u0029", + "name": "isSparse", + "summary": "If\u0020the\u0020index\u0020is\u0020sparse", + "url": "classes/ArangoDB-Collection-Index-Index.html#method_isSparse" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003AgetId\u0028\u0029", + "name": "getId", + "summary": "Index\u0020Id", + "url": "classes/ArangoDB-Collection-Index-Index.html#method_getId" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003AgetName\u0028\u0029", + "name": "getName", + "summary": "Returns\u0020index\u0020name", + "url": "classes/ArangoDB-Collection-Index-Index.html#method_getName" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003AgetType\u0028\u0029", + "name": "getType", + "summary": "Returns\u0020index\u0020type", + "url": "classes/ArangoDB-Collection-Index-Index.html#method_getType" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003AgetFields\u0028\u0029", + "name": "getFields", + "summary": "Returns\u0020index\u0020fields", + "url": "classes/ArangoDB-Collection-Index-Index.html#method_getFields" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003AgetCollection\u0028\u0029", + "name": "getCollection", + "summary": "Returns\u0020the\u0020collection\u0020where\u0020index\u0020belong\u0020to", + "url": "classes/ArangoDB-Collection-Index-Index.html#method_getCollection" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003AsetCollection\u0028\u0029", + "name": "setCollection", + "summary": "Set\u0020the\u0020collection\u0020where\u0020the\u0020index\u0020belongs\u0020to", + "url": "classes/ArangoDB-Collection-Index-Index.html#method_setCollection" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020entity", + "url": "classes/ArangoDB-Collection-Index-Index.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003AgetCreateData\u0028\u0029", + "name": "getCreateData", + "summary": "Return\u0020data\u0020for\u0020create\u0020index\u0020on\u0020server", + "url": "classes/ArangoDB-Collection-Index-Index.html#method_getCreateData" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "", + "url": "classes/ArangoDB-Collection-Index-Index.html#method_jsonSerialize" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003A\u0024id", + "name": "id", + "summary": "Index\u0020Id.", + "url": "classes/ArangoDB-Collection-Index-Index.html#property_id" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003A\u0024name", + "name": "name", + "summary": "Index\u0020name.", + "url": "classes/ArangoDB-Collection-Index-Index.html#property_name" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003A\u0024sparse", + "name": "sparse", + "summary": "Sparse", + "url": "classes/ArangoDB-Collection-Index-Index.html#property_sparse" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003A\u0024type", + "name": "type", + "summary": "Index\u0020type", + "url": "classes/ArangoDB-Collection-Index-Index.html#property_type" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003A\u0024unique", + "name": "unique", + "summary": "Unique\u0020constraint", + "url": "classes/ArangoDB-Collection-Index-Index.html#property_unique" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003A\u0024fields", + "name": "fields", + "summary": "Fields\u0020of\u0020index", + "url": "classes/ArangoDB-Collection-Index-Index.html#property_fields" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003A\u0024collection", + "name": "collection", + "summary": "Collection\u0020where\u0020the\u0020index\u0020belongs\u0020to", + "url": "classes/ArangoDB-Collection-Index-Index.html#property_collection" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\Index\u003A\u003A\u0024indexTypes", + "name": "indexTypes", + "summary": "Valid\u0020indexes\u0020types", + "url": "classes/ArangoDB-Collection-Index-Index.html#property_indexTypes" }, { "fqsen": "\\ArangoDB\\Collection\\Index\\InvertedIndex", "name": "InvertedIndex", "summary": "Inverted\u0020index\u0020representation", "url": "classes/ArangoDB-Collection-Index-InvertedIndex.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\InvertedIndex\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "InvertedIndex\u0020constructor", + "url": "classes/ArangoDB-Collection-Index-InvertedIndex.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\InvertedIndex\u003A\u003A\u0024defaultOptions", + "name": "defaultOptions", + "summary": "Default\u0020options\u0020for\u0020inverted\u0020index", + "url": "classes/ArangoDB-Collection-Index-InvertedIndex.html#property_defaultOptions" }, { "fqsen": "\\ArangoDB\\Collection\\Index\\PersistentIndex", "name": "PersistentIndex", "summary": "Represents\u0020a\u0020persistent\u0020index\u0020on\u0020a\u0020collection", "url": "classes/ArangoDB-Collection-Index-PersistentIndex.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\PersistentIndex\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "PersistentIndex\u0020constructor.", + "url": "classes/ArangoDB-Collection-Index-PersistentIndex.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\PersistentIndex\u003A\u003AgetCreateData\u0028\u0029", + "name": "getCreateData", + "summary": "Return\u0020data\u0020for\u0020create\u0020index\u0020on\u0020server", + "url": "classes/ArangoDB-Collection-Index-PersistentIndex.html#method_getCreateData" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\PersistentIndex\u003A\u003A\u0024defaultsOptions", + "name": "defaultsOptions", + "summary": "Default\u0020options\u0020for\u0020persistent\u0020index", + "url": "classes/ArangoDB-Collection-Index-PersistentIndex.html#property_defaultsOptions" }, { "fqsen": "\\ArangoDB\\Collection\\Index\\PrimaryIndex", "name": "PrimaryIndex", "summary": "Represents\u0020a\u0020primary\u0020index\u0020on\u0020a\u0020collection", "url": "classes/ArangoDB-Collection-Index-PrimaryIndex.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\PrimaryIndex\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "PrimaryIndex\u0020constructor.", + "url": "classes/ArangoDB-Collection-Index-PrimaryIndex.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\PrimaryIndex\u003A\u003AgetCreateData\u0028\u0029", + "name": "getCreateData", + "summary": "This\u0020type\u0020of\u0020Index\u0020cannot\u0020be\u0020create\/deleted\u0020explicitly\u0020by\u0020user.", + "url": "classes/ArangoDB-Collection-Index-PrimaryIndex.html#method_getCreateData" }, { "fqsen": "\\ArangoDB\\Collection\\Index\\SkipListIndex", "name": "SkipListIndex", "summary": "Represents\u0020a\u0020skip\u002Dlist\u0020index\u0020on\u0020a\u0020collection", "url": "classes/ArangoDB-Collection-Index-SkipListIndex.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\SkipListIndex\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "SkipListIndex\u0020constructor.", + "url": "classes/ArangoDB-Collection-Index-SkipListIndex.html#method___construct" }, { "fqsen": "\\ArangoDB\\Collection\\Index\\TTLIndex", "name": "TTLIndex", "summary": "Represents\u0020a\u0020TTL\u0020index\u0020on\u0020a\u0020collection", "url": "classes/ArangoDB-Collection-Index-TTLIndex.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\TTLIndex\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "TTLIndex\u0020constructor.", + "url": "classes/ArangoDB-Collection-Index-TTLIndex.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\TTLIndex\u003A\u003AexpireAfter\u0028\u0029", + "name": "expireAfter", + "summary": "Return\u0020time\u0020\u0028in\u0020seconds\u0029\u0020to\u0020expire\u0020documents\u0020on\u0020index", + "url": "classes/ArangoDB-Collection-Index-TTLIndex.html#method_expireAfter" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\TTLIndex\u003A\u003AgetCreateData\u0028\u0029", + "name": "getCreateData", + "summary": "Return\u0020data\u0020for\u0020create\u0020index\u0020on\u0020server", + "url": "classes/ArangoDB-Collection-Index-TTLIndex.html#method_getCreateData" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\TTLIndex\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020index", + "url": "classes/ArangoDB-Collection-Index-TTLIndex.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\Collection\\Index\\TTLIndex\u003A\u003A\u0024expiresAfter", + "name": "expiresAfter", + "summary": "Time\u0020\u0028in\u0020seconds\u0029\u0020after\u0020a\u0020document\u0027s\u0020creation\u0020after\u0020which\u0020the\u0020documents\u0020counts\u0020as\u0020expired", + "url": "classes/ArangoDB-Collection-Index-TTLIndex.html#property_expiresAfter" + }, { + "fqsen": "\\ArangoDB\\Collection\\IndexableTrait", + "name": "IndexableTrait", + "summary": "Indexable\u0020trait", + "url": "classes/ArangoDB-Collection-IndexableTrait.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\IndexableTrait\u003A\u003AgetIndexes\u0028\u0029", + "name": "getIndexes", + "summary": "Return\u0020all\u0020indexes\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-IndexableTrait.html#method_getIndexes" + }, { + "fqsen": "\\ArangoDB\\Collection\\IndexableTrait\u003A\u003AaddIndex\u0028\u0029", + "name": "addIndex", + "summary": "Create\u0020an\u0020index\u0020for\u0020collection", + "url": "classes/ArangoDB-Collection-IndexableTrait.html#method_addIndex" + }, { + "fqsen": "\\ArangoDB\\Collection\\IndexableTrait\u003A\u003AdropIndex\u0028\u0029", + "name": "dropIndex", + "summary": "Drops\u0020an\u0020index\u0020of\u0020collection", + "url": "classes/ArangoDB-Collection-IndexableTrait.html#method_dropIndex" }, { "fqsen": "\\ArangoDB\\Collection\\KeyType", "name": "KeyType", "summary": "Groups\u0020the\u0020available\u0020key\u0020generations\u0020for\u0020new\u0020collections", "url": "classes/ArangoDB-Collection-KeyType.html" + }, { + "fqsen": "\\ArangoDB\\Collection\\KeyType\u003A\u003ATRADITIONAL", + "name": "TRADITIONAL", + "summary": "", + "url": "classes/ArangoDB-Collection-KeyType.html#constant_TRADITIONAL" + }, { + "fqsen": "\\ArangoDB\\Collection\\KeyType\u003A\u003AAUTOINCREMENT", + "name": "AUTOINCREMENT", + "summary": "", + "url": "classes/ArangoDB-Collection-KeyType.html#constant_AUTOINCREMENT" + }, { + "fqsen": "\\ArangoDB\\Collection\\KeyType\u003A\u003APADDED", + "name": "PADDED", + "summary": "", + "url": "classes/ArangoDB-Collection-KeyType.html#constant_PADDED" + }, { + "fqsen": "\\ArangoDB\\Collection\\KeyType\u003A\u003AUUID", + "name": "UUID", + "summary": "", + "url": "classes/ArangoDB-Collection-KeyType.html#constant_UUID" }, { "fqsen": "\\ArangoDB\\Connection\\Connection", "name": "Connection", "summary": "Represents\u0020a\u0020connection\u0020with\u0020an\u0020ArangoDB\u0020database.", "url": "classes/ArangoDB-Connection-Connection.html" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Connection\u0020constructor.", + "url": "classes/ArangoDB-Connection-Connection.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003A__debugInfo\u0028\u0029", + "name": "__debugInfo", + "summary": "Proper\u0020debug\u0020dump\u0020for\u0020connection\u0020objects.", + "url": "classes/ArangoDB-Connection-Connection.html#method___debugInfo" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003AisAuthenticated\u0028\u0029", + "name": "isAuthenticated", + "summary": "If\u0020connection\u0020is\u0020authenticated.", + "url": "classes/ArangoDB-Connection-Connection.html#method_isAuthenticated" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003AgetDefaultHeaders\u0028\u0029", + "name": "getDefaultHeaders", + "summary": "Return\u0020the\u0020connection\u0020default\u0020headers.", + "url": "classes/ArangoDB-Connection-Connection.html#method_getDefaultHeaders" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003AsetDefaultHeaders\u0028\u0029", + "name": "setDefaultHeaders", + "summary": "Set\u0020the\u0020connection\u0020default\u0020headers.", + "url": "classes/ArangoDB-Connection-Connection.html#method_setDefaultHeaders" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003AgetBaseUri\u0028\u0029", + "name": "getBaseUri", + "summary": "Return\u0020the\u0020base\u0020endpoint\u0020URI.", + "url": "classes/ArangoDB-Connection-Connection.html#method_getBaseUri" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003AgetDatabase\u0028\u0029", + "name": "getDatabase", + "summary": "Return\u0020the\u0020database\u0020object\u0020for\u0020this\u0020connection", + "url": "classes/ArangoDB-Connection-Connection.html#method_getDatabase" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003AgetDatabaseName\u0028\u0029", + "name": "getDatabaseName", + "summary": "Return\u0020the\u0020name\u0020of\u0020database\u0020handled", + "url": "classes/ArangoDB-Connection-Connection.html#method_getDatabaseName" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003AgetUsername\u0028\u0029", + "name": "getUsername", + "summary": "Returns\u0020the\u0020name\u0020of\u0020user\u0020on\u0020server", + "url": "classes/ArangoDB-Connection-Connection.html#method_getUsername" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003Aget\u0028\u0029", + "name": "get", + "summary": "Executes\u0020a\u0020GET\u0020request\u0020on\u0020server.", + "url": "classes/ArangoDB-Connection-Connection.html#method_get" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003Apost\u0028\u0029", + "name": "post", + "summary": "Executes\u0020a\u0020POST\u0020request\u0020on\u0020server.", + "url": "classes/ArangoDB-Connection-Connection.html#method_post" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003Aput\u0028\u0029", + "name": "put", + "summary": "Executes\u0020a\u0020PUT\u0020request\u0020on\u0020server.", + "url": "classes/ArangoDB-Connection-Connection.html#method_put" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003Apatch\u0028\u0029", + "name": "patch", + "summary": "Executes\u0020a\u0020PATCH\u0020request\u0020on\u0020server.", + "url": "classes/ArangoDB-Connection-Connection.html#method_patch" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "Executes\u0020a\u0020DELETE\u0020request\u0020on\u0020server.", + "url": "classes/ArangoDB-Connection-Connection.html#method_delete" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003AcustomHttpRequest\u0028\u0029", + "name": "customHttpRequest", + "summary": "Makes\u0020a\u0020custom\u0020HTTP\u0020request.", + "url": "classes/ArangoDB-Connection-Connection.html#method_customHttpRequest" + }, { + "fqsen": "\\ArangoDB\\Connection\\Connection\u003A\u003A\u0024defaultHeaders", + "name": "defaultHeaders", + "summary": "Default\u0020headers\u0020to\u0020send\u0020to\u0020server.", + "url": "classes/ArangoDB-Connection-Connection.html#property_defaultHeaders" }, { "fqsen": "\\ArangoDB\\Connection\\ManagesConnection", "name": "ManagesConnection", "summary": "Basic\u0020connection\u0020management\u0020class", "url": "classes/ArangoDB-Connection-ManagesConnection.html" + }, { + "fqsen": "\\ArangoDB\\Connection\\ManagesConnection\u003A\u003AsetConnection\u0028\u0029", + "name": "setConnection", + "summary": "Sets\u0020a\u0020connection\u0020for\u0020class.", + "url": "classes/ArangoDB-Connection-ManagesConnection.html#method_setConnection" + }, { + "fqsen": "\\ArangoDB\\Connection\\ManagesConnection\u003A\u003AgetConnection\u0028\u0029", + "name": "getConnection", + "summary": "Return\u0020the\u0020connection\u0020object", + "url": "classes/ArangoDB-Connection-ManagesConnection.html#method_getConnection" + }, { + "fqsen": "\\ArangoDB\\Connection\\ManagesConnection\u003A\u003A\u0024connection", + "name": "connection", + "summary": "Connection\u0020to\u0020access\u0020the\u0020server", + "url": "classes/ArangoDB-Connection-ManagesConnection.html#property_connection" }, { "fqsen": "\\ArangoDB\\Connection\\ManagesConnectionInterface", "name": "ManagesConnectionInterface", "summary": "Interface\u0020for\u0020classes\u0020that\u0020use\u0020the\u0020Connection\u0020object", "url": "classes/ArangoDB-Connection-ManagesConnectionInterface.html" + }, { + "fqsen": "\\ArangoDB\\Connection\\ManagesConnectionInterface\u003A\u003AsetConnection\u0028\u0029", + "name": "setConnection", + "summary": "Set\u0020a\u0020connection\u0020object\u0020for\u0020the\u0020class", + "url": "classes/ArangoDB-Connection-ManagesConnectionInterface.html#method_setConnection" + }, { + "fqsen": "\\ArangoDB\\Connection\\ManagesConnectionInterface\u003A\u003AgetConnection\u0028\u0029", + "name": "getConnection", + "summary": "Return\u0020the\u0020connection\u0020object", + "url": "classes/ArangoDB-Connection-ManagesConnectionInterface.html#method_getConnection" }, { "fqsen": "\\ArangoDB\\Cursor\\Base", "name": "Base", "summary": "Base\u0020class\u0020for\u0020Cursors", "url": "classes/ArangoDB-Cursor-Base.html" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003AisCached\u0028\u0029", + "name": "isCached", + "summary": "Return\u0020if\u0020the\u0020Cursor\u0020has\u0020cached\u0020results\u0020on\u0020server", + "url": "classes/ArangoDB-Cursor-Base.html#method_isCached" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003AgetId\u0028\u0029", + "name": "getId", + "summary": "Returns\u0020the\u0020cursor\u0020ID", + "url": "classes/ArangoDB-Cursor-Base.html#method_getId" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003Afetch\u0028\u0029", + "name": "fetch", + "summary": "Fetch\u0020more\u0020results\u0020from\u0020the\u0020server", + "url": "classes/ArangoDB-Cursor-Base.html#method_fetch" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003AID", + "name": "ID", + "summary": "Cursor\u0020ID\u0020entry", + "url": "classes/ArangoDB-Cursor-Base.html#constant_ID" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003AHAS_MORE", + "name": "HAS_MORE", + "summary": "\u0027hasMore\u0027\u0020flag", + "url": "classes/ArangoDB-Cursor-Base.html#constant_HAS_MORE" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003ARESULT", + "name": "RESULT", + "summary": "Cursor\u0020result\u0020entry", + "url": "classes/ArangoDB-Cursor-Base.html#constant_RESULT" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003AEXTRA", + "name": "EXTRA", + "summary": "Cursor\u0020extra\u0020entry", + "url": "classes/ArangoDB-Cursor-Base.html#constant_EXTRA" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003ASTATS", + "name": "STATS", + "summary": "Cursor\u0020stats\u0020entry", + "url": "classes/ArangoDB-Cursor-Base.html#constant_STATS" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003ACOUNT", + "name": "COUNT", + "summary": "Cursor\u0020count\u0020entry", + "url": "classes/ArangoDB-Cursor-Base.html#constant_COUNT" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003AFULL_COUNT", + "name": "FULL_COUNT", + "summary": "Cursor\u0020fullCount\u0020entry", + "url": "classes/ArangoDB-Cursor-Base.html#constant_FULL_COUNT" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003ACACHE", + "name": "CACHE", + "summary": "Cursor\u0020cache\u0020entry", + "url": "classes/ArangoDB-Cursor-Base.html#constant_CACHE" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003ACACHED", + "name": "CACHED", + "summary": "Cursor\u0020cached\u0020entry", + "url": "classes/ArangoDB-Cursor-Base.html#constant_CACHED" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003ATYPE", + "name": "TYPE", + "summary": "Cursor\u0020type\u0020entry", + "url": "classes/ArangoDB-Cursor-Base.html#constant_TYPE" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003ABASE_URL", + "name": "BASE_URL", + "summary": "Cursor\u0020baseUrl\u0020entry", + "url": "classes/ArangoDB-Cursor-Base.html#constant_BASE_URL" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003ASANITIZE", + "name": "SANITIZE", + "summary": "Cursor\u0020sanitize\u0020option", + "url": "classes/ArangoDB-Cursor-Base.html#constant_SANITIZE" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003A\u0024id", + "name": "id", + "summary": "Cursor\u0020id", + "url": "classes/ArangoDB-Cursor-Base.html#property_id" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003A\u0024data", + "name": "data", + "summary": "Result\u0020data", + "url": "classes/ArangoDB-Cursor-Base.html#property_data" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003A\u0024connection", + "name": "connection", + "summary": "Connection\u0020object", + "url": "classes/ArangoDB-Cursor-Base.html#property_connection" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003A\u0024options", + "name": "options", + "summary": "Cursor\u0020Options", + "url": "classes/ArangoDB-Cursor-Base.html#property_options" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003A\u0024result", + "name": "result", + "summary": "Result\u0020set", + "url": "classes/ArangoDB-Cursor-Base.html#property_result" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003A\u0024hasMore", + "name": "hasMore", + "summary": "\u0027hasMore\u0027\u0020indicator", + "url": "classes/ArangoDB-Cursor-Base.html#property_hasMore" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003A\u0024position", + "name": "position", + "summary": "Current\u0020position", + "url": "classes/ArangoDB-Cursor-Base.html#property_position" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003A\u0024length", + "name": "length", + "summary": "Total\u0020length\u0020of\u0020current\u0020set", + "url": "classes/ArangoDB-Cursor-Base.html#property_length" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003A\u0024fullCount", + "name": "fullCount", + "summary": "Full\u0020cont\u0020of\u0020the\u0020result\u0020set", + "url": "classes/ArangoDB-Cursor-Base.html#property_fullCount" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003A\u0024extra", + "name": "extra", + "summary": "Extra\u0020data\u0020\u0028stats\u0029", + "url": "classes/ArangoDB-Cursor-Base.html#property_extra" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003A\u0024fetches", + "name": "fetches", + "summary": "Number\u0020of\u0020HTTP\u0020calls\u0020made\u0020to\u0020build\u0020the\u0020cursor", + "url": "classes/ArangoDB-Cursor-Base.html#property_fetches" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003A\u0024cached", + "name": "cached", + "summary": "If\u0020the\u0020result\u0020query\u0020was\u0020served\u0020from\u0020cached\u0020results", + "url": "classes/ArangoDB-Cursor-Base.html#property_cached" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Base\u003A\u003A\u0024count", + "name": "count", + "summary": "Number\u0020of\u0020documents\u0020in\u0020cursor,", + "url": "classes/ArangoDB-Cursor-Base.html#property_count" }, { "fqsen": "\\ArangoDB\\Cursor\\CollectionCursor", "name": "CollectionCursor", "summary": "Represents\u0020an\u0020ArangoDB\u0020cursor\u0020for\u0020a\u0020collection", "url": "classes/ArangoDB-Cursor-CollectionCursor.html" + }, { + "fqsen": "\\ArangoDB\\Cursor\\CollectionCursor\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "CollectionCursor\u0020constructor.", + "url": "classes/ArangoDB-Cursor-CollectionCursor.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Cursor\\CollectionCursor\u003A\u003Acurrent\u0028\u0029", + "name": "current", + "summary": "Return\u0020the\u0020current\u0020element.", + "url": "classes/ArangoDB-Cursor-CollectionCursor.html#method_current" + }, { + "fqsen": "\\ArangoDB\\Cursor\\CollectionCursor\u003A\u003A\u0024collection", + "name": "collection", + "summary": "Collection\u0020object", + "url": "classes/ArangoDB-Cursor-CollectionCursor.html#property_collection" }, { "fqsen": "\\ArangoDB\\Cursor\\Contracts\\CursorInterface", "name": "CursorInterface", "summary": "Common\u0020interface\u0020for\u0020Cursors", "url": "classes/ArangoDB-Cursor-Contracts-CursorInterface.html" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Contracts\\CursorInterface\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "Deletes\u0020the\u0020cursor\u0020and\u0020frees\u0020the\u0020resources\u0020associated\u0020with\u0020it.", + "url": "classes/ArangoDB-Cursor-Contracts-CursorInterface.html#method_delete" }, { "fqsen": "\\ArangoDB\\Cursor\\Cursor", "name": "Cursor", "summary": "Represents\u0020an\u0020ArangoDB\u0020cursor.", "url": "classes/ArangoDB-Cursor-Cursor.html" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Cursor\u0020constructor.", + "url": "classes/ArangoDB-Cursor-Cursor.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003A__toString\u0028\u0029", + "name": "__toString", + "summary": "Return\u0020a\u0020string\u0020representation\u0020of\u0020document.", + "url": "classes/ArangoDB-Cursor-Cursor.html#method___toString" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003Acurrent\u0028\u0029", + "name": "current", + "summary": "Return\u0020the\u0020current\u0020element.", + "url": "classes/ArangoDB-Cursor-Cursor.html#method_current" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003Anext\u0028\u0029", + "name": "next", + "summary": "Move\u0020forward\u0020to\u0020next\u0020element.", + "url": "classes/ArangoDB-Cursor-Cursor.html#method_next" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003Akey\u0028\u0029", + "name": "key", + "summary": "Return\u0020the\u0020key\u0020of\u0020the\u0020current\u0020element.", + "url": "classes/ArangoDB-Cursor-Cursor.html#method_key" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003Avalid\u0028\u0029", + "name": "valid", + "summary": "Checks\u0020if\u0020current\u0020position\u0020is\u0020valid.", + "url": "classes/ArangoDB-Cursor-Cursor.html#method_valid" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003Arewind\u0028\u0029", + "name": "rewind", + "summary": "Rewind\u0020the\u0020Iterator\u0020to\u0020the\u0020first\u0020element.", + "url": "classes/ArangoDB-Cursor-Cursor.html#method_rewind" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "Deletes\u0020the\u0020cursor\u0020and\u0020frees\u0020the\u0020resources\u0020associated\u0020with\u0020it.", + "url": "classes/ArangoDB-Cursor-Cursor.html#method_delete" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003Acreate\u0028\u0029", + "name": "create", + "summary": "Create\/initialize\u0020the\u0020cursor.", + "url": "classes/ArangoDB-Cursor-Cursor.html#method_create" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003Afetch\u0028\u0029", + "name": "fetch", + "summary": "Fetch\u0020more\u0020results\u0020from\u0020the\u0020server.", + "url": "classes/ArangoDB-Cursor-Cursor.html#method_fetch" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003Acount\u0028\u0029", + "name": "count", + "summary": "", + "url": "classes/ArangoDB-Cursor-Cursor.html#method_count" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003AgetBody\u0028\u0029", + "name": "getBody", + "summary": "Return\u0020body\u0020for\u0020creating\u0020cursor.", + "url": "classes/ArangoDB-Cursor-Cursor.html#method_getBody" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003AappendResults\u0028\u0029", + "name": "appendResults", + "summary": "Append\u0020the\u0020results.", + "url": "classes/ArangoDB-Cursor-Cursor.html#method_appendResults" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003A\u0024uri", + "name": "uri", + "summary": "URI\u0020to\u0020manage\u0020the\u0020cursor.", + "url": "classes/ArangoDB-Cursor-Cursor.html#property_uri" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003A\u0024statement", + "name": "statement", + "summary": "Statement\u0020to\u0020execute.", + "url": "classes/ArangoDB-Cursor-Cursor.html#property_statement" + }, { + "fqsen": "\\ArangoDB\\Cursor\\Cursor\u003A\u003A\u0024defaultOptions", + "name": "defaultOptions", + "summary": "Default\u0020options\u0020query\u0020for\u0020the\u0020cursor.\u003Cbr\u003E\n\u003Cb\u003Ecount\u003C\/b\u003E,\u0020\u003Cb\u003EbatchSize\u003C\/b\u003E\u0020and\u0020\u003Cb\u003Eoptions\u003C\/b\u003E\u0020are,\u0020by\u0020default,\u0020leaved\u0020for\u0020the\u0020server\u0020defaults.", + "url": "classes/ArangoDB-Cursor-Cursor.html#property_defaultOptions" }, { "fqsen": "\\ArangoDB\\Cursor\\Exceptions\\CursorException", "name": "CursorException", @@ -200,51 +1650,471 @@ Search.appendIndex( "name": "TraversalCursor", "summary": "Represents\u0020an\u0020ArangoDB\u0020cursor\u0020for\u0020a\u0020Traversal\u0020query", "url": "classes/ArangoDB-Cursor-TraversalCursor.html" + }, { + "fqsen": "\\ArangoDB\\Cursor\\TraversalCursor\u003A\u003Acurrent\u0028\u0029", + "name": "current", + "summary": "May\u0020return\u0020a\u0020path,\u0020a\u0020edge\u0020or\u0020a\u0020vertex.\u0020This\u0020is\u0020defined\u0020on\u0020statement.", + "url": "classes/ArangoDB-Cursor-TraversalCursor.html#method_current" }, { "fqsen": "\\ArangoDB\\Database\\Database", "name": "Database", "summary": "Represents\u0020an\u0020ArangoDB\u0020database", "url": "classes/ArangoDB-Database-Database.html" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Database\u0020constructor.", + "url": "classes/ArangoDB-Database-Database.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003AgetDatabaseName\u0028\u0029", + "name": "getDatabaseName", + "summary": "Return\u0020the\u0020name\u0020of\u0020database\u0020handled", + "url": "classes/ArangoDB-Database-Database.html#method_getDatabaseName" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003AgetAllCollections\u0028\u0029", + "name": "getAllCollections", + "summary": "Return\u0020all\u0020collections\u0020of\u0020database", + "url": "classes/ArangoDB-Database-Database.html#method_getAllCollections" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003AhasCollection\u0028\u0029", + "name": "hasCollection", + "summary": "Check\u0020if\u0020database\u0020has\u0020given\u0020collection", + "url": "classes/ArangoDB-Database-Database.html#method_hasCollection" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003AgetCollection\u0028\u0029", + "name": "getCollection", + "summary": "Return\u0020the\u0020collection\u0020object\u0020for\u0020a\u0020given\u0020collection", + "url": "classes/ArangoDB-Database-Database.html#method_getCollection" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003AgetAllGraphs\u0028\u0029", + "name": "getAllGraphs", + "summary": "Lists\u0020all\u0020graphs\u0020stored\u0020in\u0020this\u0020database.", + "url": "classes/ArangoDB-Database-Database.html#method_getAllGraphs" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003AcreateCollection\u0028\u0029", + "name": "createCollection", + "summary": "Create\u0020a\u0020new\u0020collection\u0020on\u0020database", + "url": "classes/ArangoDB-Database-Database.html#method_createCollection" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003AgetGraph\u0028\u0029", + "name": "getGraph", + "summary": "Check\u0020if\u0020database\u0020has\u0020a\u0020given\u0020graph", + "url": "classes/ArangoDB-Database-Database.html#method_getGraph" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003AdropCollection\u0028\u0029", + "name": "dropCollection", + "summary": "Drops\u0020a\u0020given\u0020collection\u0020of\u0020database", + "url": "classes/ArangoDB-Database-Database.html#method_dropCollection" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003AgetInfo\u0028\u0029", + "name": "getInfo", + "summary": "Returns\u0020information\u0020about\u0020the\u0020current\u0020database", + "url": "classes/ArangoDB-Database-Database.html#method_getInfo" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003Async\u0028\u0029", + "name": "sync", + "summary": "Synchronizes\u0020the\u0020object\u0020with\u0020database\u0020on\u0020server", + "url": "classes/ArangoDB-Database-Database.html#method_sync" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003AretrieveCollections\u0028\u0029", + "name": "retrieveCollections", + "summary": "Retrieve\u0020a\u0020list\u0020of\u0020collections\u0020of\u0020database", + "url": "classes/ArangoDB-Database-Database.html#method_retrieveCollections" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003A\u0024database", + "name": "database", + "summary": "Database\u0020name", + "url": "classes/ArangoDB-Database-Database.html#property_database" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003A\u0024collections", + "name": "collections", + "summary": "Collections\u0020of\u0020database", + "url": "classes/ArangoDB-Database-Database.html#property_collections" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003A\u0024info", + "name": "info", + "summary": "Information\u0020about\u0020database", + "url": "classes/ArangoDB-Database-Database.html#property_info" + }, { + "fqsen": "\\ArangoDB\\Database\\Database\u003A\u003A\u0024connection", + "name": "connection", + "summary": "Connection\u0020to\u0020use\u0020to\u0020manage\u0020database", + "url": "classes/ArangoDB-Database-Database.html#property_connection" }, { "fqsen": "\\ArangoDB\\Database\\DatabaseHandler", "name": "DatabaseHandler", "summary": "Manages\u0020databases\u0020on\u0020Arango\u0020server", "url": "classes/ArangoDB-Database-DatabaseHandler.html" + }, { + "fqsen": "\\ArangoDB\\Database\\DatabaseHandler\u003A\u003Acreate\u0028\u0029", + "name": "create", + "summary": "Creates\u0020a\u0020new\u0020database\u0020on\u0020server", + "url": "classes/ArangoDB-Database-DatabaseHandler.html#method_create" + }, { + "fqsen": "\\ArangoDB\\Database\\DatabaseHandler\u003A\u003Adrop\u0028\u0029", + "name": "drop", + "summary": "Drops\u0020a\u0020database\u0020from\u0020server", + "url": "classes/ArangoDB-Database-DatabaseHandler.html#method_drop" + }, { + "fqsen": "\\ArangoDB\\Database\\DatabaseHandler\u003A\u003Alist\u0028\u0029", + "name": "list", + "summary": "Lists\u0020databases\u0020that\u0020exists\u0020on\u0020server", + "url": "classes/ArangoDB-Database-DatabaseHandler.html#method_list" + }, { + "fqsen": "\\ArangoDB\\Database\\DatabaseHandler\u003A\u003AuserDatabases\u0028\u0029", + "name": "userDatabases", + "summary": "Lists\u0020the\u0020databases\u0020that\u0020current\u0020user\u0020has\u0020access", + "url": "classes/ArangoDB-Database-DatabaseHandler.html#method_userDatabases" + }, { + "fqsen": "\\ArangoDB\\Database\\DatabaseHandler\u003A\u003Acurrent\u0028\u0029", + "name": "current", + "summary": "Returns\u0020information\u0020about\u0020the\u0020current\u0020database", + "url": "classes/ArangoDB-Database-DatabaseHandler.html#method_current" }, { "fqsen": "\\ArangoDB\\DataStructures\\ArrayList", "name": "ArrayList", "summary": "Class\u0020ArrayList", "url": "classes/ArangoDB-DataStructures-ArrayList.html" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "ArrayList\u0020constructor.", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003A__toString\u0028\u0029", + "name": "__toString", + "summary": "String\u0020representation\u0020of\u0020ArrayList", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#method___toString" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003Afirst\u0028\u0029", + "name": "first", + "summary": "Get\u0020the\u0020first\u0020value\u0020of\u0020list", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#method_first" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003Alast\u0028\u0029", + "name": "last", + "summary": "Get\u0020the\u0020last\u0020value\u0020of\u0020list", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#method_last" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003Aget\u0028\u0029", + "name": "get", + "summary": "Get\u0020a\u0020value\u0020by\u0020its\u0020key", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#method_get" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003Apush\u0028\u0029", + "name": "push", + "summary": "Add\u0020a\u0020value\u0020to\u0020list", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#method_push" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003Aput\u0028\u0029", + "name": "put", + "summary": "Put\u0020a\u0020object\u0020into\u0020list\u0020on\u0020given\u0020key", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#method_put" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003Ahas\u0028\u0029", + "name": "has", + "summary": "Check\u0020if\u0020a\u0020given\u0020key\u0020exists\u0020on\u0020list", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#method_has" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003Aremove\u0028\u0029", + "name": "remove", + "summary": "Remove\u0020a\u0020value\u0020by\u0020its\u0020key\u0020on\u0020list", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#method_remove" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Return\u0020an\u0020array\u0020representation\u0020for\u0020list", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003Avalues\u0028\u0029", + "name": "values", + "summary": "Return\u0020an\u0020array\u0020with\u0020list\u0020values\u0020only", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#method_values" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003Aappend\u0028\u0029", + "name": "append", + "summary": "Appends\u0020a\u0020list\u0020to\u0020another.", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#method_append" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003A\u0024content", + "name": "content", + "summary": "List\u0020of\u0020data", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#property_content" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\ArrayList\u003A\u003A\u0024position", + "name": "position", + "summary": "Current\u0020index", + "url": "classes/ArangoDB-DataStructures-ArrayList.html#property_position" }, { "fqsen": "\\ArangoDB\\DataStructures\\Contracts\\ListInterface", "name": "ListInterface", "summary": "ListInterface", "url": "classes/ArangoDB-DataStructures-Contracts-ListInterface.html" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\Contracts\\ListInterface\u003A\u003Afirst\u0028\u0029", + "name": "first", + "summary": "Get\u0020the\u0020first\u0020value\u0020of\u0020list", + "url": "classes/ArangoDB-DataStructures-Contracts-ListInterface.html#method_first" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\Contracts\\ListInterface\u003A\u003Alast\u0028\u0029", + "name": "last", + "summary": "Get\u0020the\u0020last\u0020value\u0020of\u0020list", + "url": "classes/ArangoDB-DataStructures-Contracts-ListInterface.html#method_last" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\Contracts\\ListInterface\u003A\u003Aget\u0028\u0029", + "name": "get", + "summary": "Get\u0020a\u0020value\u0020by\u0020its\u0020key", + "url": "classes/ArangoDB-DataStructures-Contracts-ListInterface.html#method_get" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\Contracts\\ListInterface\u003A\u003Apush\u0028\u0029", + "name": "push", + "summary": "Add\u0020a\u0020value\u0020to\u0020list", + "url": "classes/ArangoDB-DataStructures-Contracts-ListInterface.html#method_push" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\Contracts\\ListInterface\u003A\u003Aput\u0028\u0029", + "name": "put", + "summary": "Put\u0020an\u0020object\u0020into\u0020list\u0020on\u0020given\u0020key", + "url": "classes/ArangoDB-DataStructures-Contracts-ListInterface.html#method_put" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\Contracts\\ListInterface\u003A\u003Ahas\u0028\u0029", + "name": "has", + "summary": "Check\u0020if\u0020a\u0020given\u0020key\u0020exists\u0020on\u0020list", + "url": "classes/ArangoDB-DataStructures-Contracts-ListInterface.html#method_has" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\Contracts\\ListInterface\u003A\u003Aremove\u0028\u0029", + "name": "remove", + "summary": "Remove\u0020a\u0020value\u0020by\u0020its\u0020key\u0020on\u0020list", + "url": "classes/ArangoDB-DataStructures-Contracts-ListInterface.html#method_remove" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\Contracts\\ListInterface\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Return\u0020an\u0020array\u0020representation\u0020for\u0020list", + "url": "classes/ArangoDB-DataStructures-Contracts-ListInterface.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\Contracts\\ListInterface\u003A\u003Avalues\u0028\u0029", + "name": "values", + "summary": "Return\u0020an\u0020array\u0020with\u0020list\u0020values\u0020only", + "url": "classes/ArangoDB-DataStructures-Contracts-ListInterface.html#method_values" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\Contracts\\ListInterface\u003A\u003Aappend\u0028\u0029", + "name": "append", + "summary": "Appends\u0020a\u0020list\u0020to\u0020another.", + "url": "classes/ArangoDB-DataStructures-Contracts-ListInterface.html#method_append" }, { "fqsen": "\\ArangoDB\\DataStructures\\CountTrait", "name": "CountTrait", "summary": "", "url": "classes/ArangoDB-DataStructures-CountTrait.html" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\CountTrait\u003A\u003Acount\u0028\u0029", + "name": "count", + "summary": "Count\u0020elements\u0020of\u0020an\u0020object", + "url": "classes/ArangoDB-DataStructures-CountTrait.html#method_count" }, { "fqsen": "\\ArangoDB\\DataStructures\\IteratorTrait", "name": "IteratorTrait", "summary": "", "url": "classes/ArangoDB-DataStructures-IteratorTrait.html" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\IteratorTrait\u003A\u003Acurrent\u0028\u0029", + "name": "current", + "summary": "Return\u0020the\u0020current\u0020element", + "url": "classes/ArangoDB-DataStructures-IteratorTrait.html#method_current" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\IteratorTrait\u003A\u003Anext\u0028\u0029", + "name": "next", + "summary": "Move\u0020forward\u0020to\u0020next\u0020element", + "url": "classes/ArangoDB-DataStructures-IteratorTrait.html#method_next" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\IteratorTrait\u003A\u003Akey\u0028\u0029", + "name": "key", + "summary": "Return\u0020the\u0020key\u0020of\u0020the\u0020current\u0020element", + "url": "classes/ArangoDB-DataStructures-IteratorTrait.html#method_key" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\IteratorTrait\u003A\u003Avalid\u0028\u0029", + "name": "valid", + "summary": "Checks\u0020if\u0020current\u0020position\u0020is\u0020valid", + "url": "classes/ArangoDB-DataStructures-IteratorTrait.html#method_valid" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\IteratorTrait\u003A\u003Arewind\u0028\u0029", + "name": "rewind", + "summary": "Rewind\u0020the\u0020Iterator\u0020to\u0020the\u0020first\u0020element", + "url": "classes/ArangoDB-DataStructures-IteratorTrait.html#method_rewind" }, { "fqsen": "\\ArangoDB\\DataStructures\\SerializeTrait", "name": "SerializeTrait", "summary": "", "url": "classes/ArangoDB-DataStructures-SerializeTrait.html" + }, { + "fqsen": "\\ArangoDB\\DataStructures\\SerializeTrait\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "Return\u0020a\u0020JSON\u0020representation\u0020of\u0020list", + "url": "classes/ArangoDB-DataStructures-SerializeTrait.html#method_jsonSerialize" }, { "fqsen": "\\ArangoDB\\Document\\Document", "name": "Document", "summary": "Represents\u0020an\u0020ArangoDB\u0020document", "url": "classes/ArangoDB-Document-Document.html" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Document\u0020constructor.", + "url": "classes/ArangoDB-Document-Document.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A__toString\u0028\u0029", + "name": "__toString", + "summary": "Return\u0020a\u0020string\u0020representation\u0020of\u0020document.", + "url": "classes/ArangoDB-Document-Document.html#method___toString" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A__get\u0028\u0029", + "name": "__get", + "summary": "Get\u0020some\u0020attribute.", + "url": "classes/ArangoDB-Document-Document.html#method___get" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A__set\u0028\u0029", + "name": "__set", + "summary": "Set\u0020a\u0020attribute", + "url": "classes/ArangoDB-Document-Document.html#method___set" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A__isset\u0028\u0029", + "name": "__isset", + "summary": "Verifies\u0020if\u0020an\u0020attribute\u0020is\u0020set\u0020on\u0020document", + "url": "classes/ArangoDB-Document-Document.html#method___isset" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A__unset\u0028\u0029", + "name": "__unset", + "summary": "Unset\u0020the\u0020given\u0020attribute\u0020of\u0020document", + "url": "classes/ArangoDB-Document-Document.html#method___unset" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A\u0024isNew", + "name": "isNew", + "summary": "If\u0020document\u0020is\u0020a\u0020new\u0020one\u0020or\u0020a\u0020representation\u0020of\u0020existing\u0020document", + "url": "classes/ArangoDB-Document-Document.html#property_isNew" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003AgetId\u0028\u0029", + "name": "getId", + "summary": "Returns\u0020the\u0020document\u0020Id", + "url": "classes/ArangoDB-Document-Document.html#method_getId" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003AgetKey\u0028\u0029", + "name": "getKey", + "summary": "Returns\u0020the\u0020document\u0020key", + "url": "classes/ArangoDB-Document-Document.html#method_getKey" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003AgetRevision\u0028\u0029", + "name": "getRevision", + "summary": "Returns\u0020the\u0020document\u0020revision", + "url": "classes/ArangoDB-Document-Document.html#method_getRevision" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003AgetCollection\u0028\u0029", + "name": "getCollection", + "summary": "Returns\u0020the\u0020document\u0020collection", + "url": "classes/ArangoDB-Document-Document.html#method_getCollection" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003AsetCollection\u0028\u0029", + "name": "setCollection", + "summary": "Sets\u0020the\u0020collection\u0020to\u0020add\u0020this\u0020document", + "url": "classes/ArangoDB-Document-Document.html#method_setCollection" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003Asave\u0028\u0029", + "name": "save", + "summary": "Save\u0020or\u0020update\u0020the\u0020document,\u0020if\u0020possible", + "url": "classes/ArangoDB-Document-Document.html#method_save" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003Aupdate\u0028\u0029", + "name": "update", + "summary": "Update\u0020the\u0020document.", + "url": "classes/ArangoDB-Document-Document.html#method_update" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "Removes\u0020a\u0020document\u0020on\u0020server,\u0020if\u0020possible", + "url": "classes/ArangoDB-Document-Document.html#method_delete" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020document", + "url": "classes/ArangoDB-Document-Document.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "", + "url": "classes/ArangoDB-Document-Document.html#method_jsonSerialize" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003AsetDescriptors\u0028\u0029", + "name": "setDescriptors", + "summary": "Set\u0020document\u0020descriptors", + "url": "classes/ArangoDB-Document-Document.html#method_setDescriptors" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A\u0024id", + "name": "id", + "summary": "Document\u0020ID", + "url": "classes/ArangoDB-Document-Document.html#property_id" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A\u0024key", + "name": "key", + "summary": "Document\u0020key", + "url": "classes/ArangoDB-Document-Document.html#property_key" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A\u0024revision", + "name": "revision", + "summary": "Document\u0020revision", + "url": "classes/ArangoDB-Document-Document.html#property_revision" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A\u0024attributes", + "name": "attributes", + "summary": "Documents\u0020attributes", + "url": "classes/ArangoDB-Document-Document.html#property_attributes" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A\u0024connection", + "name": "connection", + "summary": "Connection\u0020to\u0020be\u0020used", + "url": "classes/ArangoDB-Document-Document.html#property_connection" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A\u0024collection", + "name": "collection", + "summary": "Collection\u0020where\u0020document\u0020belongs", + "url": "classes/ArangoDB-Document-Document.html#property_collection" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A\u0024validator", + "name": "validator", + "summary": "Validate\u0020primitive\u0020types", + "url": "classes/ArangoDB-Document-Document.html#property_validator" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A\u0024patchDefaultOptions", + "name": "patchDefaultOptions", + "summary": "Default\u0020patch\u0020options", + "url": "classes/ArangoDB-Document-Document.html#property_patchDefaultOptions" + }, { + "fqsen": "\\ArangoDB\\Document\\Document\u003A\u003A\u0024updateDefaultOptions", + "name": "updateDefaultOptions", + "summary": "Default\u0020update\u0020options", + "url": "classes/ArangoDB-Document-Document.html#property_updateDefaultOptions" }, { "fqsen": "\\ArangoDB\\Document\\Edge", "name": "Edge", "summary": "Represents\u0020an\u0020ArangoDB\u0020Edge\u0020document", "url": "classes/ArangoDB-Document-Edge.html" + }, { + "fqsen": "\\ArangoDB\\Document\\Edge\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Edge\u0020constructor.", + "url": "classes/ArangoDB-Document-Edge.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Document\\Edge\u003A\u003A\u0024to", + "name": "to", + "summary": "The\u0020edges\u0020\u0027_to\u0027\u0020attribute", + "url": "classes/ArangoDB-Document-Edge.html#property_to" + }, { + "fqsen": "\\ArangoDB\\Document\\Edge\u003A\u003A\u0024from", + "name": "from", + "summary": "The\u0020edges\u0020\u0027_from\u0027\u0020attribute", + "url": "classes/ArangoDB-Document-Edge.html#property_from" + }, { + "fqsen": "\\ArangoDB\\Document\\Edge\u003A\u003A\u0024database", + "name": "database", + "summary": "Database\u0020object", + "url": "classes/ArangoDB-Document-Edge.html#property_database" }, { "fqsen": "\\ArangoDB\\Document\\Vertex", "name": "Vertex", @@ -255,11 +2125,36 @@ Search.appendIndex( "name": "EntityInterface", "summary": "Entity\u0020interface.", "url": "classes/ArangoDB-Entity-Contracts-EntityInterface.html" + }, { + "fqsen": "\\ArangoDB\\Entity\\Contracts\\EntityInterface\u003A\u003AisNew\u0028\u0029", + "name": "isNew", + "summary": "Returns\u0020true\u0020if\u0020is\u0020a\u0020new\u0020object.", + "url": "classes/ArangoDB-Entity-Contracts-EntityInterface.html#method_isNew" + }, { + "fqsen": "\\ArangoDB\\Entity\\Contracts\\EntityInterface\u003A\u003Asave\u0028\u0029", + "name": "save", + "summary": "Save\u0020a\u0020entity\u0020on\u0020server,\u0020if\u0020possible.", + "url": "classes/ArangoDB-Entity-Contracts-EntityInterface.html#method_save" + }, { + "fqsen": "\\ArangoDB\\Entity\\Contracts\\EntityInterface\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "Removes\u0020a\u0020entity\u0020on\u0020server,\u0020if\u0020possible.", + "url": "classes/ArangoDB-Entity-Contracts-EntityInterface.html#method_delete" + }, { + "fqsen": "\\ArangoDB\\Entity\\Contracts\\EntityInterface\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020entity.", + "url": "classes/ArangoDB-Entity-Contracts-EntityInterface.html#method_toArray" }, { "fqsen": "\\ArangoDB\\Exceptions\\BaseException", "name": "BaseException", "summary": "Basic\u0020exception\u0020class\u0020for\u0020driver", "url": "classes/ArangoDB-Exceptions-BaseException.html" + }, { + "fqsen": "\\ArangoDB\\Exceptions\\BaseException\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Base\u0020exception\u0020constructor.", + "url": "classes/ArangoDB-Exceptions-BaseException.html#method___construct" }, { "fqsen": "\\ArangoDB\\Exceptions\\ConnectionException", "name": "ConnectionException", @@ -300,136 +2195,1261 @@ Search.appendIndex( "name": "EdgeDefinition", "summary": "Represents\u0020an\u0020edge\u0020definition\u0020for\u0020Graphs.", "url": "classes/ArangoDB-Graph-EdgeDefinition.html" + }, { + "fqsen": "\\ArangoDB\\Graph\\EdgeDefinition\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "EdgeDefinition\u0020constructor.", + "url": "classes/ArangoDB-Graph-EdgeDefinition.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Graph\\EdgeDefinition\u003A\u003A\u0024to", + "name": "to", + "summary": "List\u0020of\u0020vertex\u0020collection\u0020names.\u0020\u003Cbr\u003E\nEdges\u0020in\u0020collection\u0020can\u0020only\u0020be\u0020inserted\u0020if\u0020their\u0020_to\u0020is\u0020in\u0020any\u0020of\u0020the\u0020collections\u0020here.", + "url": "classes/ArangoDB-Graph-EdgeDefinition.html#property_to" + }, { + "fqsen": "\\ArangoDB\\Graph\\EdgeDefinition\u003A\u003A\u0024from", + "name": "from", + "summary": "List\u0020of\u0020vertex\u0020collection\u0020names.\u0020\u003Cbr\u003E\nEdges\u0020in\u0020collection\u0020can\u0020only\u0020be\u0020inserted\u0020if\u0020their\u0020_from\u0020is\u0020in\u0020any\u0020of\u0020the\u0020collections\u0020here.", + "url": "classes/ArangoDB-Graph-EdgeDefinition.html#property_from" + }, { + "fqsen": "\\ArangoDB\\Graph\\EdgeDefinition\u003A\u003AgetCollection\u0028\u0029", + "name": "getCollection", + "summary": "Name\u0020of\u0020the\u0020edge\u0020collection.", + "url": "classes/ArangoDB-Graph-EdgeDefinition.html#method_getCollection" + }, { + "fqsen": "\\ArangoDB\\Graph\\EdgeDefinition\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Array\u0020representation\u0020of\u0020edge\u0020definition.", + "url": "classes/ArangoDB-Graph-EdgeDefinition.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\Graph\\EdgeDefinition\u003A\u003A\u0024collection", + "name": "collection", + "summary": "Name\u0020of\u0020the\u0020edge\u0020collection.", + "url": "classes/ArangoDB-Graph-EdgeDefinition.html#property_collection" }, { "fqsen": "\\ArangoDB\\Graph\\Graph", "name": "Graph", "summary": "Represents\u0020an\u0020ArangoDB\u0020Graph.", "url": "classes/ArangoDB-Graph-Graph.html" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Graph\u0020constructor.", + "url": "classes/ArangoDB-Graph-Graph.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A__toString\u0028\u0029", + "name": "__toString", + "summary": "Returns\u0020a\u0020string\u0020representation\u0020of\u0020graph\u0020object.", + "url": "classes/ArangoDB-Graph-Graph.html#method___toString" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetId\u0028\u0029", + "name": "getId", + "summary": "Returns\u0020the\u0020graph\u0020ID.", + "url": "classes/ArangoDB-Graph-Graph.html#method_getId" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetKey\u0028\u0029", + "name": "getKey", + "summary": "Returns\u0020the\u0020graph\u0020key.", + "url": "classes/ArangoDB-Graph-Graph.html#method_getKey" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A\u0024isNew", + "name": "isNew", + "summary": "If\u0020this\u0020graph\u0020is\u0020a\u0020new\u0020one\u0020or\u0020a\u0020representation\u0020of\u0020existing\u0020document.", + "url": "classes/ArangoDB-Graph-Graph.html#property_isNew" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetName\u0028\u0029", + "name": "getName", + "summary": "Gets\u0020the\u0020graph\u0020name.", + "url": "classes/ArangoDB-Graph-Graph.html#method_getName" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A\u0024isSmart", + "name": "isSmart", + "summary": "Flag\u0020if\u0020the\u0020graph\u0020is\u0020a\u0020smart\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#property_isSmart" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetRevision\u0028\u0029", + "name": "getRevision", + "summary": "Gets\u0020the\u0020graph\u0020revision.", + "url": "classes/ArangoDB-Graph-Graph.html#method_getRevision" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetNumberOfShards\u0028\u0029", + "name": "getNumberOfShards", + "summary": "Returns\u0020the\u0020number\u0020of\u0020shards\u0020that\u0020is\u0020used\u0020for\u0020every\u0020collection\u0020within\u0020this\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#method_getNumberOfShards" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetReplicationFactor\u0028\u0029", + "name": "getReplicationFactor", + "summary": "Returns\u0020the\u0020replication\u0020factor\u0020used\u0020when\u0020initially\u0020creating\u0020collections\u0020for\u0020this\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#method_getReplicationFactor" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetMinReplicationFactor\u0028\u0029", + "name": "getMinReplicationFactor", + "summary": "Returns\u0020the\u0020minimal\u0020replication\u0020factor\u0020used\u0020for\u0020every\u0020new\u0020collection\u0020in\u0020the\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#method_getMinReplicationFactor" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetOrphanCollections\u0028\u0029", + "name": "getOrphanCollections", + "summary": "Returns\u0020the\u0020orphan\u0020collections\u0020in\u0020the\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#method_getOrphanCollections" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003Asave\u0028\u0029", + "name": "save", + "summary": "Save\u0020the\u0020Graph\u0020on\u0020server,\u0020if\u0020possible.", + "url": "classes/ArangoDB-Graph-Graph.html#method_save" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "Removes\u0020a\u0020graph\u0020from\u0020server,\u0020if\u0020possible.", + "url": "classes/ArangoDB-Graph-Graph.html#method_delete" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AtoArray\u0028\u0029", + "name": "toArray", + "summary": "Returns\u0020a\u0020array\u0020representation\u0020of\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#method_toArray" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetEdgeDefinitions\u0028\u0029", + "name": "getEdgeDefinitions", + "summary": "Return\u0020all\u0020edge\u0020definitions\u0020of\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#method_getEdgeDefinitions" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AaddEdgeDefinition\u0028\u0029", + "name": "addEdgeDefinition", + "summary": "Adds\u0020an\u0020edge\u0020definition\u0020to\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#method_addEdgeDefinition" + }, { + "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.", + "url": "classes/ArangoDB-Graph-Graph.html#method_dropEdgeDefinition" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetVertexCollections\u0028\u0029", + "name": "getVertexCollections", + "summary": "Lists\u0020all\u0020vertex\u0020collections\u0020within\u0020this\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#method_getVertexCollections" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AaddVertexCollection\u0028\u0029", + "name": "addVertexCollection", + "summary": "Adds\u0020a\u0020vertex\u0020collection\u0020to\u0020the\u0020set\u0020of\u0020orphan\u0020collections\u0020of\u0020the\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#method_addVertexCollection" + }, { + "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.", + "url": "classes/ArangoDB-Graph-Graph.html#method_dropVertexCollection" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetVertex\u0028\u0029", + "name": "getVertex", + "summary": "Gets\u0020a\u0020vertex\u0020from\u0020the\u0020given\u0020collection.", + "url": "classes/ArangoDB-Graph-Graph.html#method_getVertex" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AaddVertex\u0028\u0029", + "name": "addVertex", + "summary": "Adds\u0020a\u0020vertex\u0020to\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#method_addVertex" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AdropVertex\u0028\u0029", + "name": "dropVertex", + "summary": "Drops\u0020a\u0020vertex\u0020from\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#method_dropVertex" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetEdge\u0028\u0029", + "name": "getEdge", + "summary": "Returns\u0020an\u0020edge\u0020document.", + "url": "classes/ArangoDB-Graph-Graph.html#method_getEdge" + }, { + "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\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", + "name": "dropEdge", + "summary": "Drops\u0020an\u0020edge\u0020from\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#method_dropEdge" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003Atraversal\u0028\u0029", + "name": "traversal", + "summary": "Returns\u0020a\u0020graph\u0020traversal.", + "url": "classes/ArangoDB-Graph-Graph.html#method_traversal" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "Return\u0020a\u0020JSON\u0020representation\u0020of\u0020graph\u0020attributes.", + "url": "classes/ArangoDB-Graph-Graph.html#method_jsonSerialize" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003AgetCreateParameters\u0028\u0029", + "name": "getCreateParameters", + "summary": "Return\u0020an\u0020array\u0020with\u0020parameters\u0020to\u0020create\u0020the\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#method_getCreateParameters" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A\u0024id", + "name": "id", + "summary": "The\u0020internal\u0020id\u0020of\u0020this\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#property_id" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A\u0024key", + "name": "key", + "summary": "The\u0020name\u0020of\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#property_key" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A\u0024name", + "name": "name", + "summary": "Graph\u0020name.", + "url": "classes/ArangoDB-Graph-Graph.html#property_name" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A\u0024revision", + "name": "revision", + "summary": "The\u0020revision\u0020of\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#property_revision" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A\u0024numberOfShards", + "name": "numberOfShards", + "summary": "Number\u0020of\u0020shards\u0020created\u0020for\u0020every\u0020new\u0020collection\u0020in\u0020the\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#property_numberOfShards" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A\u0024replicationFactor", + "name": "replicationFactor", + "summary": "The\u0020replication\u0020factor\u0020used\u0020for\u0020every\u0020new\u0020collection\u0020in\u0020the\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#property_replicationFactor" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A\u0024minReplicationFactor", + "name": "minReplicationFactor", + "summary": "The\u0020minimal\u0020replication\u0020factor\u0020used\u0020for\u0020every\u0020new\u0020collection\u0020in\u0020the\u0020graph.\u003Cbr\u003E\nIf\u0020one\u0020shard\u0020has\u0020less\u0020than\u0020minReplicationFactor\u0020copies,\nwe\u0020cannot\u0020write\u0020to\u0020this\u0020shard,\u0020but\u0020to\u0020all\u0020others.", + "url": "classes/ArangoDB-Graph-Graph.html#property_minReplicationFactor" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A\u0024edgeDefinitions", + "name": "edgeDefinitions", + "summary": "An\u0020array\u0020of\u0020definitions\u0020for\u0020the\u0020relations\u0020of\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#property_edgeDefinitions" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A\u0024orphanCollections", + "name": "orphanCollections", + "summary": "An\u0020array\u0020of\u0020additional\u0020vertex\u0020collections.\u003Cbr\u003E\nDocuments\u0020within\u0020these\u0020collections\u0020do\u0020not\u0020have\u0020edges\u0020within\u0020this\u0020graph.", + "url": "classes/ArangoDB-Graph-Graph.html#property_orphanCollections" + }, { + "fqsen": "\\ArangoDB\\Graph\\Graph\u003A\u003A\u0024database", + "name": "database", + "summary": "Database\u0020object\u0020of\u0020graph", + "url": "classes/ArangoDB-Graph-Graph.html#property_database" }, { "fqsen": "\\ArangoDB\\Graph\\Traversal\\Path", "name": "Path", "summary": "Represents\u0020a\u0020traversal\u0020path.", "url": "classes/ArangoDB-Graph-Traversal-Path.html" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Path\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Path\u0020constructor.", + "url": "classes/ArangoDB-Graph-Traversal-Path.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Path\u003A\u003AgetEdges\u0028\u0029", + "name": "getEdges", + "summary": "Return\u0020all\u0020the\u0020path\u0020edges", + "url": "classes/ArangoDB-Graph-Traversal-Path.html#method_getEdges" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Path\u003A\u003AgetVertices\u0028\u0029", + "name": "getVertices", + "summary": "Return\u0020all\u0020the\u0020path\u0020vertices", + "url": "classes/ArangoDB-Graph-Traversal-Path.html#method_getVertices" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Path\u003A\u003A\u0024edges", + "name": "edges", + "summary": "ArrayList\u0020with\u0020path\u0020edges", + "url": "classes/ArangoDB-Graph-Traversal-Path.html#property_edges" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Path\u003A\u003A\u0024vertices", + "name": "vertices", + "summary": "ArrayList\u0020with\u0020path\u0020vertices", + "url": "classes/ArangoDB-Graph-Traversal-Path.html#property_vertices" }, { "fqsen": "\\ArangoDB\\Graph\\Traversal\\Traversal", "name": "Traversal", "summary": "Represents\u0020a\u0020graph\u0020traversal.", "url": "classes/ArangoDB-Graph-Traversal-Traversal.html" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Traversal\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Traversal\u0020constructor.", + "url": "classes/ArangoDB-Graph-Traversal-Traversal.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Traversal\u003A\u003AtoAql\u0028\u0029", + "name": "toAql", + "summary": "Returns\u0020the\u0020query,", + "url": "classes/ArangoDB-Graph-Traversal-Traversal.html#method_toAql" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Traversal\u003A\u003AtraversalQuery\u0028\u0029", + "name": "traversalQuery", + "summary": "Returns\u0020a\u0020default\u0020traversal", + "url": "classes/ArangoDB-Graph-Traversal-Traversal.html#method_traversalQuery" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Traversal\u003A\u003AGRAPH_DIRECTION_INBOUND", + "name": "GRAPH_DIRECTION_INBOUND", + "summary": "Inbound\u0020graph\u0020direction.", + "url": "classes/ArangoDB-Graph-Traversal-Traversal.html#constant_GRAPH_DIRECTION_INBOUND" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Traversal\u003A\u003AGRAPH_DIRECTION_OUTBOUND", + "name": "GRAPH_DIRECTION_OUTBOUND", + "summary": "Outbound\u0020graph\u0020direction.", + "url": "classes/ArangoDB-Graph-Traversal-Traversal.html#constant_GRAPH_DIRECTION_OUTBOUND" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Traversal\u003A\u003AGRAPH_DIRECTION_ANY", + "name": "GRAPH_DIRECTION_ANY", + "summary": "Any\u0020graph\u0020direction.", + "url": "classes/ArangoDB-Graph-Traversal-Traversal.html#constant_GRAPH_DIRECTION_ANY" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Traversal\u003A\u003A\u0024statement", + "name": "statement", + "summary": "The\u0020traversal\u0020query", + "url": "classes/ArangoDB-Graph-Traversal-Traversal.html#property_statement" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Traversal\u003A\u003A\u0024connection", + "name": "connection", + "summary": "Connection\u0020to\u0020use\u0020to\u0020manage\u0020database", + "url": "classes/ArangoDB-Graph-Traversal-Traversal.html#property_connection" + }, { + "fqsen": "\\ArangoDB\\Graph\\Traversal\\Traversal\u003A\u003A\u0024cursor", + "name": "cursor", + "summary": "Cursor\u0020object", + "url": "classes/ArangoDB-Graph-Traversal-Traversal.html#property_cursor" }, { "fqsen": "\\ArangoDB\\Http\\Api", "name": "Api", "summary": "API\u0020Helper\u0020to\u0020Arango\u0020HTTP\u0020Interface", "url": "classes/ArangoDB-Http-Api.html" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AaddUriParam\u0028\u0029", + "name": "addUriParam", + "summary": "Add\u0020a\u0020param\u0020to\u0020the\u0020URI", + "url": "classes/ArangoDB-Http-Api.html#method_addUriParam" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AaddQuery\u0028\u0029", + "name": "addQuery", + "summary": "Add\u0020a\u0020URI\u0020query", + "url": "classes/ArangoDB-Http-Api.html#method_addQuery" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AbuildDatabaseUri\u0028\u0029", + "name": "buildDatabaseUri", + "summary": "Builds\u0020URIs\u0020for\u0020access\u0020to\u0020Arango\u0020HTTP\u0020Interface", + "url": "classes/ArangoDB-Http-Api.html#method_buildDatabaseUri" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AbuildSystemUri\u0028\u0029", + "name": "buildSystemUri", + "summary": "Builds\u0020URIs\u0020for\u0020access\u0020some\u0020special\u0020endpoints\u0020on\u0020Arango\u0020HTTP\u0020Interface", + "url": "classes/ArangoDB-Http-Api.html#method_buildSystemUri" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ADOCUMENT", + "name": "DOCUMENT", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_DOCUMENT" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AEDGE", + "name": "EDGE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_EDGE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AEDGES", + "name": "EDGES", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_EDGES" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AGRAPH", + "name": "GRAPH", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_GRAPH" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AINDEX", + "name": "INDEX", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_INDEX" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ACURSOR", + "name": "CURSOR", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_CURSOR" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AIMPORT", + "name": "IMPORT", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_IMPORT" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AEXPLAIN", + "name": "EXPLAIN", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_EXPLAIN" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ABATCH", + "name": "BATCH", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_BATCH" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AQUERY", + "name": "QUERY", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_QUERY" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ATRANSACTION", + "name": "TRANSACTION", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_TRANSACTION" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ATRANSACTION_BEGIN", + "name": "TRANSACTION_BEGIN", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_TRANSACTION_BEGIN" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AAQL_USER_FUNCTION", + "name": "AQL_USER_FUNCTION", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_AQL_USER_FUNCTION" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ACOLLECTION", + "name": "COLLECTION", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_COLLECTION" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ACOLLECTION_LOAD", + "name": "COLLECTION_LOAD", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_COLLECTION_LOAD" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ACOLLECTION_COUNT", + "name": "COLLECTION_COUNT", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_COLLECTION_COUNT" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ACOLLECTION_RENAME", + "name": "COLLECTION_RENAME", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_COLLECTION_RENAME" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ACOLLECTION_ROTATE", + "name": "COLLECTION_ROTATE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_COLLECTION_ROTATE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ACOLLECTION_CHECKSUM", + "name": "COLLECTION_CHECKSUM", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_COLLECTION_CHECKSUM" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ACOLLECTION_REVISION", + "name": "COLLECTION_REVISION", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_COLLECTION_REVISION" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ACOLLECTION_TRUNCATE", + "name": "COLLECTION_TRUNCATE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_COLLECTION_TRUNCATE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ACOLLECTION_PROPERTIES", + "name": "COLLECTION_PROPERTIES", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_COLLECTION_PROPERTIES" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ACOLLECTION_RECALCULATE_COUNT", + "name": "COLLECTION_RECALCULATE_COUNT", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_COLLECTION_RECALCULATE_COUNT" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AUSER", + "name": "USER", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_USER" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ATRAVERSAL", + "name": "TRAVERSAL", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_TRAVERSAL" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AENDPOINT", + "name": "ENDPOINT", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ENDPOINT" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ADATABASE", + "name": "DATABASE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_DATABASE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ACURRENT_DATABASE", + "name": "CURRENT_DATABASE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_CURRENT_DATABASE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AUSER_DATABASES", + "name": "USER_DATABASES", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_USER_DATABASES" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AQUERY_CACHE", + "name": "QUERY_CACHE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_QUERY_CACHE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AUPLOAD", + "name": "UPLOAD", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_UPLOAD" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003APART_VERTEX", + "name": "PART_VERTEX", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_PART_VERTEX" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003APART_EDGE", + "name": "PART_EDGE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_PART_EDGE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ALOOKUP_BY_KEYS", + "name": "LOOKUP_BY_KEYS", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_LOOKUP_BY_KEYS" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AALL", + "name": "ALL", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ALL" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AALL_KEYS", + "name": "ALL_KEYS", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ALL_KEYS" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AANY", + "name": "ANY", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ANY" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AFULLTEXT", + "name": "FULLTEXT", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_FULLTEXT" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AREMOVE_BY_KEYS", + "name": "REMOVE_BY_KEYS", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_REMOVE_BY_KEYS" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AEXAMPLE", + "name": "EXAMPLE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_EXAMPLE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AFIRST_EXAMPLE", + "name": "FIRST_EXAMPLE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_FIRST_EXAMPLE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AUPDATE_BY_EXAMPLE", + "name": "UPDATE_BY_EXAMPLE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_UPDATE_BY_EXAMPLE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AREMOVE_BY_EXAMPLE", + "name": "REMOVE_BY_EXAMPLE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_REMOVE_BY_EXAMPLE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AREPLACE_BY_EXAMPLE", + "name": "REPLACE_BY_EXAMPLE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_REPLACE_BY_EXAMPLE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_TASKS", + "name": "ADMIN_TASKS", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_TASKS" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_VERSION", + "name": "ADMIN_VERSION", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_VERSION" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_ENGINE", + "name": "ADMIN_ENGINE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_ENGINE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_SERVER_ROLE", + "name": "ADMIN_SERVER_ROLE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_SERVER_ROLE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_SERVER_AVAILABILITY", + "name": "ADMIN_SERVER_AVAILABILITY", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_SERVER_AVAILABILITY" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_TIME", + "name": "ADMIN_TIME", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_TIME" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_LOG", + "name": "ADMIN_LOG", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_LOG" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_FLUSH_WAL", + "name": "ADMIN_FLUSH_WAL", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_FLUSH_WAL" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_WAL_PROPERTIES", + "name": "ADMIN_WAL_PROPERTIES", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_WAL_PROPERTIES" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_WAL_TRANSACTIONS", + "name": "ADMIN_WAL_TRANSACTIONS", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_WAL_TRANSACTIONS" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_LOG_LEVEL", + "name": "ADMIN_LOG_LEVEL", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_LOG_LEVEL" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_ROUTING_RELOAD", + "name": "ADMIN_ROUTING_RELOAD", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_ROUTING_RELOAD" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_STATISTICS", + "name": "ADMIN_STATISTICS", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_STATISTICS" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AADMIN_STATISTICS_DESCRIPTION", + "name": "ADMIN_STATISTICS_DESCRIPTION", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_ADMIN_STATISTICS_DESCRIPTION" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AFOXX", + "name": "FOXX", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_FOXX" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AFOXX_SERVICE", + "name": "FOXX_SERVICE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_FOXX_SERVICE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003ADB", + "name": "DB", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_DB" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AAUTH_BASE", + "name": "AUTH_BASE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_AUTH_BASE" + }, { + "fqsen": "\\ArangoDB\\Http\\Api\u003A\u003AJWT_AUTH_BASE", + "name": "JWT_AUTH_BASE", + "summary": "", + "url": "classes/ArangoDB-Http-Api.html#constant_JWT_AUTH_BASE" }, { "fqsen": "\\ArangoDB\\Http\\RestClient", "name": "RestClient", "summary": "RestClient.", "url": "classes/ArangoDB-Http-RestClient.html" + }, { + "fqsen": "\\ArangoDB\\Http\\RestClient\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "RestClient\u0020constructor.", + "url": "classes/ArangoDB-Http-RestClient.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Http\\RestClient\u003A\u003Aget\u0028\u0029", + "name": "get", + "summary": "Performs\u0020a\u0020GET\u0020request.", + "url": "classes/ArangoDB-Http-RestClient.html#method_get" + }, { + "fqsen": "\\ArangoDB\\Http\\RestClient\u003A\u003Apost\u0028\u0029", + "name": "post", + "summary": "Performs\u0020a\u0020POST\u0020request.", + "url": "classes/ArangoDB-Http-RestClient.html#method_post" + }, { + "fqsen": "\\ArangoDB\\Http\\RestClient\u003A\u003Aput\u0028\u0029", + "name": "put", + "summary": "Performs\u0020a\u0020PUT\u0020request.", + "url": "classes/ArangoDB-Http-RestClient.html#method_put" + }, { + "fqsen": "\\ArangoDB\\Http\\RestClient\u003A\u003Apatch\u0028\u0029", + "name": "patch", + "summary": "Performs\u0020a\u0020PATCH\u0020request", + "url": "classes/ArangoDB-Http-RestClient.html#method_patch" + }, { + "fqsen": "\\ArangoDB\\Http\\RestClient\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "Performs\u0020a\u0020DELETE\u0020request.", + "url": "classes/ArangoDB-Http-RestClient.html#method_delete" + }, { + "fqsen": "\\ArangoDB\\Http\\RestClient\u003A\u003AcustomHttpRequest\u0028\u0029", + "name": "customHttpRequest", + "summary": "Makes\u0020a\u0020custom\u0020HTTP\u0020request.", + "url": "classes/ArangoDB-Http-RestClient.html#method_customHttpRequest" + }, { + "fqsen": "\\ArangoDB\\Http\\RestClient\u003A\u003A\u0024baseUri", + "name": "baseUri", + "summary": "Base\u0020URI\u0020string.", + "url": "classes/ArangoDB-Http-RestClient.html#property_baseUri" + }, { + "fqsen": "\\ArangoDB\\Http\\RestClient\u003A\u003A\u0024httpClient", + "name": "httpClient", + "summary": "Guzzle\u0020HTTP\u0020client.", + "url": "classes/ArangoDB-Http-RestClient.html#property_httpClient" }, { "fqsen": "\\ArangoDB\\Transaction\\Contracts\\Transaction", "name": "Transaction", "summary": "Base\u0020Transaction\u0020class", "url": "classes/ArangoDB-Transaction-Contracts-Transaction.html" + }, { + "fqsen": "\\ArangoDB\\Transaction\\Contracts\\Transaction\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Transaction\u0020constructor.", + "url": "classes/ArangoDB-Transaction-Contracts-Transaction.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Transaction\\Contracts\\Transaction\u003A\u003A\u0024connection", + "name": "connection", + "summary": "Connection\u0020object", + "url": "classes/ArangoDB-Transaction-Contracts-Transaction.html#property_connection" + }, { + "fqsen": "\\ArangoDB\\Transaction\\Contracts\\Transaction\u003A\u003A\u0024options", + "name": "options", + "summary": "StreamTransaction\u0020options", + "url": "classes/ArangoDB-Transaction-Contracts-Transaction.html#property_options" + }, { + "fqsen": "\\ArangoDB\\Transaction\\Contracts\\Transaction\u003A\u003A\u0024defaultOptions", + "name": "defaultOptions", + "summary": "Some\u0020default\u0020options\u0020for\u0020transaction\nSets\u0020by\u0020default,\u002032MB\u0020as\u0020transaction\u0020size\u0020limit\u0020and\nwaits\u0020server\u0020write\u0020all\u0020data\u0020on\u0020disk\u0020before\u0020return\u0020any\u0020response.", + "url": "classes/ArangoDB-Transaction-Contracts-Transaction.html#property_defaultOptions" }, { "fqsen": "\\ArangoDB\\Transaction\\JavascriptTransaction", "name": "JavascriptTransaction", "summary": "Manages\u0020Javascript\u0020transactions", "url": "classes/ArangoDB-Transaction-JavascriptTransaction.html" + }, { + "fqsen": "\\ArangoDB\\Transaction\\JavascriptTransaction\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "JavascriptTransaction\u0020constructor.", + "url": "classes/ArangoDB-Transaction-JavascriptTransaction.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Transaction\\JavascriptTransaction\u003A\u003Aexecute\u0028\u0029", + "name": "execute", + "summary": "Execute\u0020the\u0020transaction.", + "url": "classes/ArangoDB-Transaction-JavascriptTransaction.html#method_execute" + }, { + "fqsen": "\\ArangoDB\\Transaction\\JavascriptTransaction\u003A\u003A\u0024action", + "name": "action", + "summary": "Javascript\u0020code\u0020on\u0020a\u0020string\u0020to\u0020be\u0020executed\u0020on\u0020server", + "url": "classes/ArangoDB-Transaction-JavascriptTransaction.html#property_action" }, { "fqsen": "\\ArangoDB\\Transaction\\StreamTransaction", "name": "StreamTransaction", "summary": "Manages\u0020stream\u0020transactions\u0020on\u0020ArangoDB\u0020server", "url": "classes/ArangoDB-Transaction-StreamTransaction.html" + }, { + "fqsen": "\\ArangoDB\\Transaction\\StreamTransaction\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "StreamTransaction\u0020constructor.", + "url": "classes/ArangoDB-Transaction-StreamTransaction.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Transaction\\StreamTransaction\u003A\u003AgetTransactionId\u0028\u0029", + "name": "getTransactionId", + "summary": "Returns\u0020the\u0020transaction\u0020id", + "url": "classes/ArangoDB-Transaction-StreamTransaction.html#method_getTransactionId" + }, { + "fqsen": "\\ArangoDB\\Transaction\\StreamTransaction\u003A\u003AgetTransactionStatus\u0028\u0029", + "name": "getTransactionStatus", + "summary": "Returns\u0020the\u0020transaction\u0020status", + "url": "classes/ArangoDB-Transaction-StreamTransaction.html#method_getTransactionStatus" + }, { + "fqsen": "\\ArangoDB\\Transaction\\StreamTransaction\u003A\u003Abegin\u0028\u0029", + "name": "begin", + "summary": "Begin\u0020transaction", + "url": "classes/ArangoDB-Transaction-StreamTransaction.html#method_begin" + }, { + "fqsen": "\\ArangoDB\\Transaction\\StreamTransaction\u003A\u003Acommit\u0028\u0029", + "name": "commit", + "summary": "Commit\u0020transaction", + "url": "classes/ArangoDB-Transaction-StreamTransaction.html#method_commit" + }, { + "fqsen": "\\ArangoDB\\Transaction\\StreamTransaction\u003A\u003Aabort\u0028\u0029", + "name": "abort", + "summary": "Abort\u0020transaction", + "url": "classes/ArangoDB-Transaction-StreamTransaction.html#method_abort" + }, { + "fqsen": "\\ArangoDB\\Transaction\\StreamTransaction\u003A\u003A\u0024id", + "name": "id", + "summary": "Transaction\u0020Id", + "url": "classes/ArangoDB-Transaction-StreamTransaction.html#property_id" + }, { + "fqsen": "\\ArangoDB\\Transaction\\StreamTransaction\u003A\u003A\u0024status", + "name": "status", + "summary": "Transaction\u0020status", + "url": "classes/ArangoDB-Transaction-StreamTransaction.html#property_status" + }, { + "fqsen": "\\ArangoDB\\Transaction\\StreamTransaction\u003A\u003A\u0024started", + "name": "started", + "summary": "If\u0020the\u0020transaction\u0020object\u0020is\u0020already\u0020started", + "url": "classes/ArangoDB-Transaction-StreamTransaction.html#property_started" }, { "fqsen": "\\ArangoDB\\Validation\\Admin\\Task\\TaskValidator", "name": "TaskValidator", "summary": "Validates\u0020Task\u0020data", "url": "classes/ArangoDB-Validation-Admin-Task-TaskValidator.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Admin\\Task\\TaskValidator\u003A\u003Arules\u0028\u0029", + "name": "rules", + "summary": "Rules\u0020for\u0020validation", + "url": "classes/ArangoDB-Validation-Admin-Task-TaskValidator.html#method_rules" + }, { + "fqsen": "\\ArangoDB\\Validation\\Admin\\Task\\TaskValidator\u003A\u003AvalidateParamsCallback\u0028\u0029", + "name": "validateParamsCallback", + "summary": "Validate\u0020\u0027params\u0027\u0020option.", + "url": "classes/ArangoDB-Validation-Admin-Task-TaskValidator.html#method_validateParamsCallback" + }, { + "fqsen": "\\ArangoDB\\Validation\\Admin\\Task\\TaskValidator\u003A\u003A\u0024required", + "name": "required", + "summary": "Required\u0020keys", + "url": "classes/ArangoDB-Validation-Admin-Task-TaskValidator.html#property_required" + }, { + "fqsen": "\\ArangoDB\\Validation\\Admin\\Task\\TaskValidator\u003A\u003A\u0024canHave", + "name": "canHave", + "summary": "Optional\u0020keys", + "url": "classes/ArangoDB-Validation-Admin-Task-TaskValidator.html#property_canHave" }, { "fqsen": "\\ArangoDB\\Validation\\Auth\\UserValidator", "name": "UserValidator", "summary": "Validates\u0020user\u0020data\u0020\u003Cbr\u003E\nUsed\u0020for\u0020avoid\u0020client\u0020errors\u0020when\u0020creating\u0020new\u0020users\u0020or\u0020granting\u0020access\u0020to\u0020databases.", "url": "classes/ArangoDB-Validation-Auth-UserValidator.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Auth\\UserValidator\u003A\u003Arules\u0028\u0029", + "name": "rules", + "summary": "Rules\u0020for\u0020user.", + "url": "classes/ArangoDB-Validation-Auth-UserValidator.html#method_rules" + }, { + "fqsen": "\\ArangoDB\\Validation\\Auth\\UserValidator\u003A\u003A\u0024required", + "name": "required", + "summary": "Required\u0020keys\u0020in\u0020users\u0020arrays.", + "url": "classes/ArangoDB-Validation-Auth-UserValidator.html#property_required" + }, { + "fqsen": "\\ArangoDB\\Validation\\Auth\\UserValidator\u003A\u003A\u0024canHave", + "name": "canHave", + "summary": "Users\u0020array\u0020can\u0020have\u0020these\u0020keys.", + "url": "classes/ArangoDB-Validation-Auth-UserValidator.html#property_canHave" }, { "fqsen": "\\ArangoDB\\Validation\\Collection\\CollectionValidator", "name": "CollectionValidator", "summary": "Validate\u0020the\u0020collection\u0020options\u0020values.\u0020\u003Cbr\u003E\nUsed\u0020for\u0020avoid\u0020client\u0020errors\u0020when\u0020creating\u0020or\u0020updating\u0020collections.", "url": "classes/ArangoDB-Validation-Collection-CollectionValidator.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Collection\\CollectionValidator\u003A\u003Arules\u0028\u0029", + "name": "rules", + "summary": "Rules\u0020for\u0020validation.", + "url": "classes/ArangoDB-Validation-Collection-CollectionValidator.html#method_rules" + }, { + "fqsen": "\\ArangoDB\\Validation\\Collection\\CollectionValidator\u003A\u003AvalidateKeyOptions\u0028\u0029", + "name": "validateKeyOptions", + "summary": "Validate\u0020key\u0020options\u0020for\u0020collection\u0020creation", + "url": "classes/ArangoDB-Validation-Collection-CollectionValidator.html#method_validateKeyOptions" + }, { + "fqsen": "\\ArangoDB\\Validation\\Collection\\CollectionValidator\u003A\u003A\u0024required", + "name": "required", + "summary": "Required\u0020keys.", + "url": "classes/ArangoDB-Validation-Collection-CollectionValidator.html#property_required" + }, { + "fqsen": "\\ArangoDB\\Validation\\Collection\\CollectionValidator\u003A\u003A\u0024canHave", + "name": "canHave", + "summary": "Optional\u0020keys.", + "url": "classes/ArangoDB-Validation-Collection-CollectionValidator.html#property_canHave" }, { "fqsen": "\\ArangoDB\\Validation\\Connection\\ConnectionOptionsValidator", "name": "ConnectionOptionsValidator", "summary": "Validate\u0020the\u0020connection\u0020options\u0020to\u0020access\u0020the\u0020database.", "url": "classes/ArangoDB-Validation-Connection-ConnectionOptionsValidator.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Connection\\ConnectionOptionsValidator\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "ConnectionOptionsValidator\u0020constructor.", + "url": "classes/ArangoDB-Validation-Connection-ConnectionOptionsValidator.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Validation\\Connection\\ConnectionOptionsValidator\u003A\u003Arules\u0028\u0029", + "name": "rules", + "summary": "Rules\u0020for\u0020connection", + "url": "classes/ArangoDB-Validation-Connection-ConnectionOptionsValidator.html#method_rules" + }, { + "fqsen": "\\ArangoDB\\Validation\\Connection\\ConnectionOptionsValidator\u003A\u003AgetConnectionOptions\u0028\u0029", + "name": "getConnectionOptions", + "summary": "Return\u0020all\u0020connection\u0020options.", + "url": "classes/ArangoDB-Validation-Connection-ConnectionOptionsValidator.html#method_getConnectionOptions" + }, { + "fqsen": "\\ArangoDB\\Validation\\Connection\\ConnectionOptionsValidator\u003A\u003A\u0024required", + "name": "required", + "summary": "Required\u0020keys\u0020in\u0020connections\u0020arrays.", + "url": "classes/ArangoDB-Validation-Connection-ConnectionOptionsValidator.html#property_required" + }, { + "fqsen": "\\ArangoDB\\Validation\\Connection\\ConnectionOptionsValidator\u003A\u003A\u0024canHave", + "name": "canHave", + "summary": "The\u0020connection\u0020array\u0020can\u0020have\u0020these\u0020keys.", + "url": "classes/ArangoDB-Validation-Connection-ConnectionOptionsValidator.html#property_canHave" }, { "fqsen": "\\ArangoDB\\Validation\\Document\\DocumentValidator", "name": "DocumentValidator", "summary": "Validate\u0020the\u0020document\u0020values.\u0020\u003Cbr\u003E\nUsed\u0020for\u0020avoid\u0020client\u0020errors\u0020when\u0020creating\u0020or\u0020updating\u0020documents\u0020on\u0020collections.", "url": "classes/ArangoDB-Validation-Document-DocumentValidator.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\DocumentValidator\u003A\u003AsetAttributes\u0028\u0029", + "name": "setAttributes", + "summary": "Set\u0020the\u0020data\u0020for\u0020validation", + "url": "classes/ArangoDB-Validation-Document-DocumentValidator.html#method_setAttributes" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\DocumentValidator\u003A\u003AgetAttributes\u0028\u0029", + "name": "getAttributes", + "summary": "Return\u0020document\u0020data", + "url": "classes/ArangoDB-Validation-Document-DocumentValidator.html#method_getAttributes" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\DocumentValidator\u003A\u003AhasDescriptors\u0028\u0029", + "name": "hasDescriptors", + "summary": "Check\u0020if\u0020this\u0020document\u0020validator\u0020has\u0020document\u0020descriptors.", + "url": "classes/ArangoDB-Validation-Document-DocumentValidator.html#method_hasDescriptors" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\DocumentValidator\u003A\u003AgetDescriptorsAttributes\u0028\u0029", + "name": "getDescriptorsAttributes", + "summary": "Return\u0020document\u0020descriptors\u0020attributes.", + "url": "classes/ArangoDB-Validation-Document-DocumentValidator.html#method_getDescriptorsAttributes" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\DocumentValidator\u003A\u003Arules\u0028\u0029", + "name": "rules", + "summary": "Rules\u0020for\u0020validation.", + "url": "classes/ArangoDB-Validation-Document-DocumentValidator.html#method_rules" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\DocumentValidator\u003A\u003Avalidate\u0028\u0029", + "name": "validate", + "summary": "Validate\u0020document\u0020data.", + "url": "classes/ArangoDB-Validation-Document-DocumentValidator.html#method_validate" }, { "fqsen": "\\ArangoDB\\Validation\\Document\\EdgeValidator", "name": "EdgeValidator", "summary": "Validate\u0020the\u0020edge\u0020values.", "url": "classes/ArangoDB-Validation-Document-EdgeValidator.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\EdgeValidator\u003A\u003Avalidate\u0028\u0029", + "name": "validate", + "summary": "Validate\u0020document\u0020data.", + "url": "classes/ArangoDB-Validation-Document-EdgeValidator.html#method_validate" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\EdgeValidator\u003A\u003AvalidateGraphParams\u0028\u0029", + "name": "validateGraphParams", + "summary": "Validate\u0020graph\u0020parameters.", + "url": "classes/ArangoDB-Validation-Document-EdgeValidator.html#method_validateGraphParams" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\EdgeValidator\u003A\u003A\u0024required", + "name": "required", + "summary": "Required\u0020keys", + "url": "classes/ArangoDB-Validation-Document-EdgeValidator.html#property_required" }, { "fqsen": "\\ArangoDB\\Validation\\Document\\PatchOptionsValidator", "name": "PatchOptionsValidator", "summary": "Class\u0020PatchOptionsValidator", "url": "classes/ArangoDB-Validation-Document-PatchOptionsValidator.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\PatchOptionsValidator\u003A\u003Arules\u0028\u0029", + "name": "rules", + "summary": "Rules\u0020for\u0020validation.", + "url": "classes/ArangoDB-Validation-Document-PatchOptionsValidator.html#method_rules" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\PatchOptionsValidator\u003A\u003A\u0024canHave", + "name": "canHave", + "summary": "Optional\u0020keys.", + "url": "classes/ArangoDB-Validation-Document-PatchOptionsValidator.html#property_canHave" }, { "fqsen": "\\ArangoDB\\Validation\\Document\\UpdateOptionsValidator", "name": "UpdateOptionsValidator", "summary": "Class\u0020UpdateOptionsValidator", "url": "classes/ArangoDB-Validation-Document-UpdateOptionsValidator.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\UpdateOptionsValidator\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "UpdateOptionsValidator\u0020constructor.", + "url": "classes/ArangoDB-Validation-Document-UpdateOptionsValidator.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\UpdateOptionsValidator\u003A\u003Arules\u0028\u0029", + "name": "rules", + "summary": "Rules\u0020for\u0020validation", + "url": "classes/ArangoDB-Validation-Document-UpdateOptionsValidator.html#method_rules" + }, { + "fqsen": "\\ArangoDB\\Validation\\Document\\UpdateOptionsValidator\u003A\u003A\u0024canHave", + "name": "canHave", + "summary": "Optional\u0020keys.", + "url": "classes/ArangoDB-Validation-Document-UpdateOptionsValidator.html#property_canHave" }, { "fqsen": "\\ArangoDB\\Validation\\Exceptions\\InvalidKeyOptionException", "name": "InvalidKeyOptionException", "summary": "Invalid\u0020collection\u0020key\u0020option\u0020exception.", "url": "classes/ArangoDB-Validation-Exceptions-InvalidKeyOptionException.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Exceptions\\InvalidKeyOptionException\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "InvalidKeyOptionException\u0020constructor.", + "url": "classes/ArangoDB-Validation-Exceptions-InvalidKeyOptionException.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Validation\\Exceptions\\InvalidKeyOptionException\u003A\u003A\u0024parameter", + "name": "parameter", + "summary": "Parameter\u0020name.", + "url": "classes/ArangoDB-Validation-Exceptions-InvalidKeyOptionException.html#property_parameter" + }, { + "fqsen": "\\ArangoDB\\Validation\\Exceptions\\InvalidKeyOptionException\u003A\u003A\u0024type", + "name": "type", + "summary": "Parameter\u0020value.", + "url": "classes/ArangoDB-Validation-Exceptions-InvalidKeyOptionException.html#property_type" }, { "fqsen": "\\ArangoDB\\Validation\\Exceptions\\InvalidParameterException", "name": "InvalidParameterException", "summary": "Invalid\u0020parameter\u0020exception.", "url": "classes/ArangoDB-Validation-Exceptions-InvalidParameterException.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Exceptions\\InvalidParameterException\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "InvalidParameterException\u0020constructor.", + "url": "classes/ArangoDB-Validation-Exceptions-InvalidParameterException.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Validation\\Exceptions\\InvalidParameterException\u003A\u003A\u0024parameter", + "name": "parameter", + "summary": "Parameter\u0020name.", + "url": "classes/ArangoDB-Validation-Exceptions-InvalidParameterException.html#property_parameter" + }, { + "fqsen": "\\ArangoDB\\Validation\\Exceptions\\InvalidParameterException\u003A\u003A\u0024value", + "name": "value", + "summary": "Parameter\u0020value.", + "url": "classes/ArangoDB-Validation-Exceptions-InvalidParameterException.html#property_value" }, { "fqsen": "\\ArangoDB\\Validation\\Exceptions\\MissingParameterException", "name": "MissingParameterException", "summary": "Missing\u0020parameter\u0020exception", "url": "classes/ArangoDB-Validation-Exceptions-MissingParameterException.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Exceptions\\MissingParameterException\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "MissingParameterException\u0020constructor.", + "url": "classes/ArangoDB-Validation-Exceptions-MissingParameterException.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Validation\\Exceptions\\MissingParameterException\u003A\u003A\u0024parameter", + "name": "parameter", + "summary": "Parameter\u0020name.", + "url": "classes/ArangoDB-Validation-Exceptions-MissingParameterException.html#property_parameter" }, { "fqsen": "\\ArangoDB\\Validation\\Graph\\GraphValidator", "name": "GraphValidator", "summary": "Validate\u0020the\u0020graph\u0020options\u0020values.\u0020\u003Cbr\u003E\nUsed\u0020for\u0020avoid\u0020client\u0020errors\u0020when\u0020creating\u0020or\u0020updating\u0020graphs", "url": "classes/ArangoDB-Validation-Graph-GraphValidator.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Graph\\GraphValidator\u003A\u003Arules\u0028\u0029", + "name": "rules", + "summary": "Rules\u0020for\u0020validation.", + "url": "classes/ArangoDB-Validation-Graph-GraphValidator.html#method_rules" + }, { + "fqsen": "\\ArangoDB\\Validation\\Graph\\GraphValidator\u003A\u003AvalidateEdgeDefinitionsParameter\u0028\u0029", + "name": "validateEdgeDefinitionsParameter", + "summary": "Validate\u0020\u0027edgeDefinitions\u0027\u0020param", + "url": "classes/ArangoDB-Validation-Graph-GraphValidator.html#method_validateEdgeDefinitionsParameter" + }, { + "fqsen": "\\ArangoDB\\Validation\\Graph\\GraphValidator\u003A\u003A\u0024required", + "name": "required", + "summary": "Required\u0020keys.", + "url": "classes/ArangoDB-Validation-Graph-GraphValidator.html#property_required" + }, { + "fqsen": "\\ArangoDB\\Validation\\Graph\\GraphValidator\u003A\u003A\u0024canHave", + "name": "canHave", + "summary": "Optional\u0020keys.", + "url": "classes/ArangoDB-Validation-Graph-GraphValidator.html#property_canHave" }, { "fqsen": "\\ArangoDB\\Validation\\Rules\\RuleInterface", "name": "RuleInterface", "summary": "Basic\u0020interface\u0020for\u0020validation\u0020rule.", "url": "classes/ArangoDB-Validation-Rules-RuleInterface.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Rules\\RuleInterface\u003A\u003AisValid\u0028\u0029", + "name": "isValid", + "summary": "Check\u0020if\u0020a\u0020given\u0020value\u0020is\u0020valid.", + "url": "classes/ArangoDB-Validation-Rules-RuleInterface.html#method_isValid" }, { "fqsen": "\\ArangoDB\\Validation\\Rules\\Rules", "name": "Rules", "summary": "Provides\u0020validation\u0020rules\u0020for\u0020inputs\u0020data.", "url": "classes/ArangoDB-Validation-Rules-Rules.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Rules\\Rules\u003A\u003Aarr\u0028\u0029", + "name": "arr", + "summary": "Is\u0020array\u0020rule.", + "url": "classes/ArangoDB-Validation-Rules-Rules.html#method_arr" + }, { + "fqsen": "\\ArangoDB\\Validation\\Rules\\Rules\u003A\u003Astring\u0028\u0029", + "name": "string", + "summary": "Is\u0020string\u0020rule.", + "url": "classes/ArangoDB-Validation-Rules-Rules.html#method_string" + }, { + "fqsen": "\\ArangoDB\\Validation\\Rules\\Rules\u003A\u003Anumeric\u0028\u0029", + "name": "numeric", + "summary": "Is\u0020numeric\u0020rule.", + "url": "classes/ArangoDB-Validation-Rules-Rules.html#method_numeric" + }, { + "fqsen": "\\ArangoDB\\Validation\\Rules\\Rules\u003A\u003Ainteger\u0028\u0029", + "name": "integer", + "summary": "Is\u0020integer\u0020rule.", + "url": "classes/ArangoDB-Validation-Rules-Rules.html#method_integer" + }, { + "fqsen": "\\ArangoDB\\Validation\\Rules\\Rules\u003A\u003Aboolean\u0028\u0029", + "name": "boolean", + "summary": "Is\u0020boolean\u0020rule.", + "url": "classes/ArangoDB-Validation-Rules-Rules.html#method_boolean" + }, { + "fqsen": "\\ArangoDB\\Validation\\Rules\\Rules\u003A\u003AisPrimitive\u0028\u0029", + "name": "isPrimitive", + "summary": "Is\u0020a\u0020primitive\u0020type\u0020rule.", + "url": "classes/ArangoDB-Validation-Rules-Rules.html#method_isPrimitive" + }, { + "fqsen": "\\ArangoDB\\Validation\\Rules\\Rules\u003A\u003AequalsOrGreaterThan\u0028\u0029", + "name": "equalsOrGreaterThan", + "summary": "If\u0020a\u0020value\u0020is\u0020equals\u0020to\u0020or\u0020greater\u0020than\u0020some\u0020given\u0020value.", + "url": "classes/ArangoDB-Validation-Rules-Rules.html#method_equalsOrGreaterThan" + }, { + "fqsen": "\\ArangoDB\\Validation\\Rules\\Rules\u003A\u003Auri\u0028\u0029", + "name": "uri", + "summary": "Is\u0020an\u0020URI", + "url": "classes/ArangoDB-Validation-Rules-Rules.html#method_uri" + }, { + "fqsen": "\\ArangoDB\\Validation\\Rules\\Rules\u003A\u003Ain\u0028\u0029", + "name": "in", + "summary": "Verify\u0020if\u0020a\u0020value\u0020is\u0020in\u0020a\u0020set\u0020of\u0020given\u0020values.", + "url": "classes/ArangoDB-Validation-Rules-Rules.html#method_in" + }, { + "fqsen": "\\ArangoDB\\Validation\\Rules\\Rules\u003A\u003AcallbackValidation\u0028\u0029", + "name": "callbackValidation", + "summary": "Validate\u0020through\u0020a\u0020callback", + "url": "classes/ArangoDB-Validation-Rules-Rules.html#method_callbackValidation" }, { "fqsen": "\\ArangoDB\\Validation\\Transaction\\TransactionOptionsValidator", "name": "TransactionOptionsValidator", "summary": "Validate\u0020transactions\u0020options\u0020values.\u0020\u003Cbr\u003E\nUsed\u0020for\u0020avoid\u0020client\u0020errors\u0020when\u0020running\u0020javascript\u0020or\u0020stream\u0020transactions.", "url": "classes/ArangoDB-Validation-Transaction-TransactionOptionsValidator.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Transaction\\TransactionOptionsValidator\u003A\u003Arules\u0028\u0029", + "name": "rules", + "summary": "Rules\u0020for\u0020connection.", + "url": "classes/ArangoDB-Validation-Transaction-TransactionOptionsValidator.html#method_rules" + }, { + "fqsen": "\\ArangoDB\\Validation\\Transaction\\TransactionOptionsValidator\u003A\u003AvalidateCollectionsParameter\u0028\u0029", + "name": "validateCollectionsParameter", + "summary": "Validate\u0020\u0027collections\u0027\u0020param", + "url": "classes/ArangoDB-Validation-Transaction-TransactionOptionsValidator.html#method_validateCollectionsParameter" + }, { + "fqsen": "\\ArangoDB\\Validation\\Transaction\\TransactionOptionsValidator\u003A\u003A\u0024required", + "name": "required", + "summary": "Required\u0020keys", + "url": "classes/ArangoDB-Validation-Transaction-TransactionOptionsValidator.html#property_required" + }, { + "fqsen": "\\ArangoDB\\Validation\\Transaction\\TransactionOptionsValidator\u003A\u003A\u0024canHave", + "name": "canHave", + "summary": "Optional\u0020keys", + "url": "classes/ArangoDB-Validation-Transaction-TransactionOptionsValidator.html#property_canHave" }, { "fqsen": "\\ArangoDB\\Validation\\Validator", "name": "Validator", "summary": "Validator\u0020base\u0020class.\u003Cbr\u003E\nImplements\u0020a\u0020default\u0020validate\u0020method.", "url": "classes/ArangoDB-Validation-Validator.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\Validator\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Validator\u0020constructor.", + "url": "classes/ArangoDB-Validation-Validator.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\Validation\\Validator\u003A\u003Avalidate\u0028\u0029", + "name": "validate", + "summary": "Validate\u0020user\u0020data", + "url": "classes/ArangoDB-Validation-Validator.html#method_validate" + }, { + "fqsen": "\\ArangoDB\\Validation\\Validator\u003A\u003A\u0024data", + "name": "data", + "summary": "Data\u0020to\u0020validate.", + "url": "classes/ArangoDB-Validation-Validator.html#property_data" + }, { + "fqsen": "\\ArangoDB\\Validation\\Validator\u003A\u003A\u0024required", + "name": "required", + "summary": "Required\u0020keys.", + "url": "classes/ArangoDB-Validation-Validator.html#property_required" + }, { + "fqsen": "\\ArangoDB\\Validation\\Validator\u003A\u003A\u0024canHave", + "name": "canHave", + "summary": "Optional\u0020keys.", + "url": "classes/ArangoDB-Validation-Validator.html#property_canHave" }, { "fqsen": "\\ArangoDB\\Validation\\ValidatorInterface", "name": "ValidatorInterface", "summary": "Validator\u0020interface.", "url": "classes/ArangoDB-Validation-ValidatorInterface.html" + }, { + "fqsen": "\\ArangoDB\\Validation\\ValidatorInterface\u003A\u003Arules\u0028\u0029", + "name": "rules", + "summary": "Rules\u0020for\u0020validation.", + "url": "classes/ArangoDB-Validation-ValidatorInterface.html#method_rules" + }, { + "fqsen": "\\ArangoDB\\Validation\\ValidatorInterface\u003A\u003Avalidate\u0028\u0029", + "name": "validate", + "summary": "Validate\u0020data.", + "url": "classes/ArangoDB-Validation-ValidatorInterface.html#method_validate" }, { "fqsen": "\\ArangoDB\\View\\View", "name": "View", "summary": "Represents\u0020a\u0020View\u0020on\u0020ArangoDB\u0020server.", "url": "classes/ArangoDB-View-View.html" + }, { + "fqsen": "\\ArangoDB\\View\\View\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "View\u0020constructor.", + "url": "classes/ArangoDB-View-View.html#method___construct" + }, { + "fqsen": "\\ArangoDB\\View\\View\u003A\u003A\u0024isNew", + "name": "isNew", + "summary": "If\u0020the\u0020View\u0020is\u0020a\u0020new\u0020one\u0020or\u0020a\u0020representation\u0020of\u0020an\u0020existing\u0020view\u0020on\u0020server.", + "url": "classes/ArangoDB-View-View.html#property_isNew" + }, { + "fqsen": "\\ArangoDB\\View\\View\u003A\u003A\u0024id", + "name": "id", + "summary": "View\u0020ID.", + "url": "classes/ArangoDB-View-View.html#property_id" + }, { + "fqsen": "\\ArangoDB\\View\\View\u003A\u003A\u0024globallyUniqueId", + "name": "globallyUniqueId", + "summary": "Globally\u0020unique\u0020ID.", + "url": "classes/ArangoDB-View-View.html#property_globallyUniqueId" + }, { + "fqsen": "\\ArangoDB\\View\\View\u003A\u003A\u0024name", + "name": "name", + "summary": "The\u0020name\u0020of\u0020the\u0020View.", + "url": "classes/ArangoDB-View-View.html#property_name" + }, { + "fqsen": "\\ArangoDB\\View\\View\u003A\u003A\u0024type", + "name": "type", + "summary": "The\u0020type\u0020of\u0020View", + "url": "classes/ArangoDB-View-View.html#property_type" + }, { + "fqsen": "\\ArangoDB\\View\\View\u003A\u003A\u0024links", + "name": "links", + "summary": "The\u0020view\u0020links", + "url": "classes/ArangoDB-View-View.html#property_links" + }, { + "fqsen": "\\ArangoDB\\View\\View\u003A\u003A\u0024attributes", + "name": "attributes", + "summary": "View\u0020properties.", + "url": "classes/ArangoDB-View-View.html#property_attributes" + }, { + "fqsen": "\\ArangoDB\\View\\View\u003A\u003A\u0024defaults", + "name": "defaults", + "summary": "View\u0020properties\u0020default\u0020values.", + "url": "classes/ArangoDB-View-View.html#property_defaults" }, { "fqsen": "\\", "name": "\\", diff --git a/docs/namespaces/arangodb-collection.html b/docs/namespaces/arangodb-collection.html index 80291e4..9cf9505 100644 --- a/docs/namespaces/arangodb-collection.html +++ b/docs/namespaces/arangodb-collection.html @@ -266,6 +266,13 @@

        Collection
        Represents an ArangoDB collection
        KeyType
        Groups the available key generations for new collections
        +

        + Traits + + +

        +
        +
        IndexableTrait
        Indexable trait
        @@ -382,7 +389,8 @@

      • +
      • Traits
      • + diff --git a/docs/packages/ArangoDB-Collection.html b/docs/packages/ArangoDB-Collection.html index 4684e40..f00c850 100644 --- a/docs/packages/ArangoDB-Collection.html +++ b/docs/packages/ArangoDB-Collection.html @@ -266,6 +266,13 @@

        Collection
        Represents an ArangoDB collection
        Index
        Represents a collection index.
        KeyType
        Groups the available key generations for new collections
        +

        + Traits + + +

        +
        +
        IndexableTrait
        Indexable trait
        @@ -382,7 +389,8 @@

      • +
      • Traits
      • + diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml index b1504c7..8db64e1 100644 --- a/phpdoc.dist.xml +++ b/phpdoc.dist.xml @@ -10,7 +10,6 @@ src/ - api