diff --git a/CHANGELOG.md b/CHANGELOG.md index 037cf174..7e75ddc2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -41,8 +41,11 @@ In addition, the `save` method of `DocumentHandler` will now understand the `ove option, which will turn an insert into a replace operation in case the insert fails with a unique constraint violation error on the primary key. -The method `insert` was introduced in `DocumentHandler` as an alias for `save` for consistency -with the server-side naming. +The method `insert` was introduced in `DocumentHandler` as an alias for the existing `save` +method to be consistent with the server-side method naming. + +Basic support for arangosearch views was added in 3.4.0, via the `View` and `ViewHandler` +classes. Release notes for the ArangoDB-PHP driver 3.3.x diff --git a/README.md b/README.md index cd90902e..fbe690d6 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ The official ArangoDB PHP Driver. 3.2: [![Build Status](https://travis-ci.org/arangodb/arangodb-php.png?branch=3.2)](https://travis-ci.org/arangodb/arangodb-php) 3.3: [![Build Status](https://travis-ci.org/arangodb/arangodb-php.png?branch=3.3)](https://travis-ci.org/arangodb/arangodb-php) +3.4: [![Build Status](https://travis-ci.org/arangodb/arangodb-php.png?branch=3.4)](https://travis-ci.org/arangodb/arangodb-php) devel: [![Build Status](https://travis-ci.org/arangodb/arangodb-php.png?branch=devel)](https://travis-ci.org/arangodb/arangodb-php) - [Getting Started](docs/Drivers/PHP/GettingStarted/README.md) diff --git a/docs/Drivers/PHP/Tutorial/README.md b/docs/Drivers/PHP/Tutorial/README.md index bb9b06ec..b0aae139 100644 --- a/docs/Drivers/PHP/Tutorial/README.md +++ b/docs/Drivers/PHP/Tutorial/README.md @@ -277,7 +277,7 @@ object(ArangoDBClient\Document)##6 (4) { */ ``` -Whenever the document id is yet unknown, but you want to fetch a document from the server by any of its other properties, you can use the CollectionHandler->byExample() method. It allows you to provide an example of the document that you are looking for. The example should either be a Document object with the relevant properties set, or, a PHP array with the propeties that you are looking for: +Whenever the document id is yet unknown, but you want to fetch a document from the server by any of its other properties, you can use the CollectionHandler->byExample() method. It allows you to provide an example of the document that you are looking for. The example should either be a Document object with the relevant properties set, or, a PHP array with the properties that you are looking for: ```php // get a document list back from the server, using a document example @@ -287,7 +287,7 @@ Whenever the document id is yet unknown, but you want to fetch a document from t ``` This will return all documents from the specified collection (here: "users") with the properties provided in the example (here: that have an attribute "name" with a value of "John"). The result is a cursor which can be iterated sequentially or completely. We have chosen to get the complete result set above by calling the cursor's getAll() method. -Note that CollectionHandler->byExample() might return multiple documents if the example is ambigious. +Note that CollectionHandler->byExample() might return multiple documents if the example is ambiguous. ## Updating a document diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 00000000..c4192631 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-cayman \ No newline at end of file diff --git a/docs/classes.svg b/docs/classes.svg index fba77b91..10d07f74 100644 --- a/docs/classes.svg +++ b/docs/classes.svg @@ -1,390 +1,537 @@ - - - + + G - -cluster_Global - -Global + + +cluster_Global + +Global -cluster_\ArangoDBClient - -ArangoDBClient + +cluster_\ArangoDBClient + +ArangoDBClient - -\\ArangoDBClient\\AqlUserFunction - -AqlUserFunction + + +\\ArangoDBClient\\Edge + +Edge - -\\ArangoDBClient\\BatchPart - -BatchPart + + +\\ArangoDBClient\\Document + +Document - -\\ArangoDBClient\\UserHandler - -UserHandler + + +\\ArangoDBClient\\Edge->\\ArangoDBClient\\Document + + - -\\ArangoDBClient\\Handler - -«abstract» -Handler + + +\\ArangoDBClient\\Transaction + +Transaction + + + +\\ArangoDBClient\\TransactionBase + +TransactionBase + + + +\\ArangoDBClient\\Transaction->\\ArangoDBClient\\TransactionBase + + + + + +\\ArangoDBClient\\StreamingTransaction + +StreamingTransaction + + + +\\ArangoDBClient\\StreamingTransaction->\\ArangoDBClient\\TransactionBase + + - -\\ArangoDBClient\\UserHandler->\\ArangoDBClient\\Handler - - + + +\\ArangoDBClient\\UrlHelper + +«abstract» +UrlHelper - -\\ArangoDBClient\\Document - -Document + + +\\ArangoDBClient\\Endpoint + +Endpoint - -\\JsonSerializable - -\JsonSerializable + + +\\ArangoDBClient\\Batch + +Batch - -\\ArangoDBClient\\Document->\\JsonSerializable - - + + +\\ArangoDBClient\\ExportCursor + +ExportCursor - -\\ArangoDBClient\\ConnectionOptions - -ConnectionOptions + + +\\ArangoDBClient\\FailoverException + +FailoverException - -\\ArrayAccess - -\ArrayAccess + + +\\ArangoDBClient\\Exception + +Exception - -\\ArangoDBClient\\ConnectionOptions->\\ArrayAccess - - + + +\\ArangoDBClient\\FailoverException->\\ArangoDBClient\\Exception + + - -\\ArangoDBClient\\Connection - -Connection + + +\\ArangoDBClient\\ConnectException + +ConnectException - -\\ArangoDBClient\\Transaction - -Transaction + + +\\ArangoDBClient\\ConnectException->\\ArangoDBClient\\Exception + + - -\\ArangoDBClient\\ExportCursor - -ExportCursor + + +\\ArangoDBClient\\Collection + +Collection - -\\ArangoDBClient\\UrlHelper - -«abstract» -UrlHelper + + +\\ArangoDBClient\\TraceRequest + +TraceRequest - -\\ArangoDBClient\\QueryCacheHandler - -QueryCacheHandler + + +\\ArangoDBClient\\AqlUserFunction + +AqlUserFunction - -\\ArangoDBClient\\QueryCacheHandler->\\ArangoDBClient\\Handler - - + + +\\ArangoDBClient\\Traversal + +Traversal - -\\ArangoDBClient\\DocumentHandler - -DocumentHandler + + +\\ArangoDBClient\\View + +View - -\\ArangoDBClient\\DocumentHandler->\\ArangoDBClient\\Handler - - + + +\\ArangoDBClient\\DefaultValues + +«abstract» +DefaultValues - -\\ArangoDBClient\\Edge - -Edge + + +\\ArangoDBClient\\User + +User - -\\ArangoDBClient\\Edge->\\ArangoDBClient\\Document - - + + +\\ArangoDBClient\\User->\\ArangoDBClient\\Document + + - -\\ArangoDBClient\\Cursor - -Cursor + + +\\ArangoDBClient\\CollectionHandler + +CollectionHandler - -\\Iterator - -\Iterator + + +\\ArangoDBClient\\Handler + +«abstract» +Handler - -\\ArangoDBClient\\Cursor->\\Iterator - - + + +\\ArangoDBClient\\CollectionHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\Database - -Database - - -\\ArangoDBClient\\FailoverException - -FailoverException + +\\ArangoDBClient\\Database + +Database + + + +\\ArangoDBClient\\StreamingTransactionHandler + +StreamingTransactionHandler + + + +\\ArangoDBClient\\StreamingTransactionHandler->\\ArangoDBClient\\Handler + + - -\\ArangoDBClient\\Exception - -Exception - - -\\ArangoDBClient\\FailoverException->\\ArangoDBClient\\Exception - - - - -\\ArangoDBClient\\Batch - -Batch + + +\\ArangoDBClient\\BatchPart + +BatchPart - -\\ArangoDBClient\\TraceRequest - -TraceRequest + + +\\ArangoDBClient\\FoxxHandler + +FoxxHandler - -\\ArangoDBClient\\ConnectException - -ConnectException + + +\\ArangoDBClient\\FoxxHandler->\\ArangoDBClient\\Handler + + - -\\ArangoDBClient\\ConnectException->\\ArangoDBClient\\Exception - - + + +\\ArangoDBClient\\Connection + +Connection - -\\ArangoDBClient\\ValueValidator - -ValueValidator + + +\\ArangoDBClient\\TraceResponse + +TraceResponse -\\ArangoDBClient\\Autoloader - -Autoloader + +\\ArangoDBClient\\Autoloader + +Autoloader - -\\ArangoDBClient\\ClientException - -ClientException + + +\\ArangoDBClient\\ServerException + +ServerException - -\\ArangoDBClient\\ClientException->\\ArangoDBClient\\Exception - - + + +\\ArangoDBClient\\ServerException->\\ArangoDBClient\\Exception + + - -\\ArangoDBClient\\FoxxHandler - -FoxxHandler + + +\\ArangoDBClient\\UserHandler + +UserHandler - -\\ArangoDBClient\\FoxxHandler->\\ArangoDBClient\\Handler - - + + +\\ArangoDBClient\\UserHandler->\\ArangoDBClient\\Handler + + - -\\ArangoDBClient\\User - -User + + +\\ArangoDBClient\\QueryCacheHandler + +QueryCacheHandler - -\\ArangoDBClient\\User->\\ArangoDBClient\\Document - - + + +\\ArangoDBClient\\QueryCacheHandler->\\ArangoDBClient\\Handler + + - -\\ArangoDBClient\\BindVars - -BindVars + + +\\ArangoDBClient\\HttpHelper + +HttpHelper + + + +\\ArangoDBClient\\ViewHandler + +ViewHandler + + + +\\ArangoDBClient\\ViewHandler->\\ArangoDBClient\\Handler + + - -\\ArangoDBClient\\CollectionHandler - -CollectionHandler + + +\\ArangoDBClient\\Cursor + +Cursor - -\\ArangoDBClient\\CollectionHandler->\\ArangoDBClient\\Handler - - + + +\\Iterator + +\Iterator + + + +\\ArangoDBClient\\Cursor->\\Iterator + + -\\ArangoDBClient\\Graph - -Graph + +\\ArangoDBClient\\Graph + +Graph -\\ArangoDBClient\\Graph->\\ArangoDBClient\\Document - - + +\\ArangoDBClient\\Graph->\\ArangoDBClient\\Document + + - -\\ArangoDBClient\\EdgeDefinition - -EdgeDefinition + + +\\JsonSerializable + +\JsonSerializable + + + +\\ArangoDBClient\\Document->\\JsonSerializable + + -\\ArangoDBClient\\Vertex - -Vertex + +\\ArangoDBClient\\Vertex + +Vertex -\\ArangoDBClient\\Vertex->\\ArangoDBClient\\Document - - + +\\ArangoDBClient\\Vertex->\\ArangoDBClient\\Document + + - -\\ArangoDBClient\\Collection - -Collection + + +\\ArangoDBClient\\QueryHandler + +QueryHandler - -\\ArangoDBClient\\HttpResponse - -HttpResponse + + +\\ArangoDBClient\\QueryHandler->\\ArangoDBClient\\Handler + + - -\\ArangoDBClient\\HttpHelper - -HttpHelper + + +\\ArangoDBClient\\DocumentHandler + +DocumentHandler - -\\ArangoDBClient\\UpdatePolicy - -UpdatePolicy + + +\\ArangoDBClient\\DocumentHandler->\\ArangoDBClient\\Handler + + + + + +\\ArangoDBClient\\Statement + +Statement -\\Exception - -\Exception + +\\Exception + +\Exception -\\ArangoDBClient\\Exception->\\Exception - - + +\\ArangoDBClient\\Exception->\\Exception + + - -\\ArangoDBClient\\Endpoint - -Endpoint + + +\\ArangoDBClient\\VertexHandler + +VertexHandler - -\\ArangoDBClient\\QueryHandler - -QueryHandler + + +\\ArangoDBClient\\VertexHandler->\\ArangoDBClient\\DocumentHandler + + - -\\ArangoDBClient\\QueryHandler->\\ArangoDBClient\\Handler - - + + +\\ArangoDBClient\\HttpResponse + +HttpResponse - -\\ArangoDBClient\\ServerException - -ServerException + + +\\ArangoDBClient\\BindVars + +BindVars - -\\ArangoDBClient\\ServerException->\\ArangoDBClient\\Exception - - + + +\\ArangoDBClient\\UpdatePolicy + +UpdatePolicy - -\\ArangoDBClient\\Traversal - -Traversal + + +\\ArangoDBClient\\Urls + +«abstract» +Urls - -\\ArangoDBClient\\VertexHandler - -VertexHandler + + +\\ArangoDBClient\\EdgeDefinition + +EdgeDefinition - -\\ArangoDBClient\\VertexHandler->\\ArangoDBClient\\DocumentHandler - - + + +\\ArangoDBClient\\ClientException + +ClientException - -\\ArangoDBClient\\Statement - -Statement + + +\\ArangoDBClient\\ClientException->\\ArangoDBClient\\Exception + + - -\\ArangoDBClient\\Urls - -«abstract» -Urls + + +\\ArangoDBClient\\Export + +Export - -\\ArangoDBClient\\TraceResponse - -TraceResponse + + +\\ArangoDBClient\\ValueValidator + +ValueValidator + + + +\\ArangoDBClient\\GraphHandler + +GraphHandler + + + +\\ArangoDBClient\\GraphHandler->\\ArangoDBClient\\Handler + + + + + +\\ArangoDBClient\\StreamingTransactionCollection + +StreamingTransactionCollection + + + +\\ArangoDBClient\\StreamingTransactionCollection->\\ArangoDBClient\\Collection + + -\\ArangoDBClient\\AdminHandler - -AdminHandler + +\\ArangoDBClient\\AdminHandler + +AdminHandler -\\ArangoDBClient\\AdminHandler->\\ArangoDBClient\\Handler - - + +\\ArangoDBClient\\AdminHandler->\\ArangoDBClient\\Handler + + -\\ArangoDBClient\\EdgeHandler - -EdgeHandler + +\\ArangoDBClient\\EdgeHandler + +EdgeHandler -\\ArangoDBClient\\EdgeHandler->\\ArangoDBClient\\DocumentHandler - - + +\\ArangoDBClient\\EdgeHandler->\\ArangoDBClient\\DocumentHandler + + - -\\ArangoDBClient\\Export - -Export - - -\\ArangoDBClient\\GraphHandler - -GraphHandler + + +\\ArangoDBClient\\ConnectionOptions + +ConnectionOptions - -\\ArangoDBClient\\GraphHandler->\\ArangoDBClient\\Handler - - + + +\\ArrayAccess + +\ArrayAccess - -\\ArangoDBClient\\DefaultValues - -«abstract» -DefaultValues + + +\\ArangoDBClient\\ConnectionOptions->\\ArrayAccess + + + + + +\\ArangoDBClient\\DocumentClassable + +DocumentClassable diff --git a/docs/classes/ArangoDBClient.AdminHandler.html b/docs/classes/ArangoDBClient.AdminHandler.html index 47c5a0c1..9615fe59 100644 --- a/docs/classes/ArangoDBClient.AdminHandler.html +++ b/docs/classes/ArangoDBClient.AdminHandler.html @@ -31,11 +31,11 @@ Reports @@ -77,10 +77,12 @@ The call triggers a reload of the routing information from the _routing collection">Reload the server's routing information The call triggers a reload of the routing information from the _routing collection
reloadServerRouting()
  • Sets the document class to use
    setDocumentClass()
    • +
  • Sets the edge class to use
    setEdgeClass()
  • » Protected @@ -65,7 +65,6 @@
  • Get an attribute, magic method
    __get()
  • Is triggered by calling isset() or empty() on inaccessible properties.
    __isset()
  • Set an attribute, magic method
    __set()
    • -
  • Returns the action string
    __toString()
  • Build the object's attributes from a given array
    buildAttributesFromArray()
  • Get an attribute
    get()
  • Get user function code
    getCode()
    • @@ -84,16 +83,12 @@
  •  Properties
  • » Protected - +
  • » Private @@ -255,21 +250,6 @@

    Exceptions

    -
    -

    Returns the action string

    -
    __toString() : string
    -
    -
    -
    - - - -
    magic
    -

    Returns

    -
    -string- the current action string
    -
    -

    Build the object's attributes from a given array

    buildAttributesFromArray($options) 
    @@ -472,28 +452,6 @@

    Returns

     Properties

    - 
    -

    _action

    -
     : string
    -
    -

    Default

    -
    -
    -
    -
    -
    - - - - - - - - - -
    magic
    property_action
    -
    -
     

    - The code of the user function

    $code : string
    @@ -538,18 +496,8 @@

    Default

    - 
    -

    The transaction's action.

    -
    $_action : string
    -
    -

    Default

    -
    ''
    -
    -
    -
    -
     
    -

    The transaction's attributes.

    +

    The function's attributes.

    $attributes : array

    Default

    @@ -589,7 +537,7 @@

    Collections index

    + generated on 2019-08-19T13:30:48+02:00.
    diff --git a/docs/classes/ArangoDBClient.Autoloader.html b/docs/classes/ArangoDBClient.Autoloader.html index f18c3d11..e7ad8a95 100644 --- a/docs/classes/ArangoDBClient.Autoloader.html +++ b/docs/classes/ArangoDBClient.Autoloader.html @@ -31,11 +31,11 @@ Reports
    • @@ -178,7 +178,7 @@

    Class file extension

    + generated on 2019-08-19T13:30:48+02:00.
    diff --git a/docs/classes/ArangoDBClient.Batch.html b/docs/classes/ArangoDBClient.Batch.html index 5e3e9825..93fffb0d 100644 --- a/docs/classes/ArangoDBClient.Batch.html +++ b/docs/classes/ArangoDBClient.Batch.html @@ -31,11 +31,11 @@ Reports @@ -80,7 +80,8 @@
  • Sets the batch active in its associated connection.
    setActive()
  • Sets the batch's associated connection into capture mode.
    setCapture()
  • Sets the connection for he current batch. (mostly internal function)
    setConnection()
    • -
  • Sets the document class to use
    setDocumentClass()
    • +
  • Sets the document class to use
    setDocumentClass()
    • +
  • Sets the edge class to use
    setEdgeClass()
  • Split batch request and use ContentId as array key
    splitWithContentIdKey()
  • Start capturing requests. To stop capturing, use stopCapture()
    startCapture()
  • Stop capturing requests. If the batch has not been processed yet, more requests can be appended by calling startCapture() again.
    stopCapture()
    • @@ -97,7 +98,10 @@
  • » Protected - +
  • » Private +
    +

    Set the replicationFactor value

    +
    setReplicationFactor(mixed $value) : void
    +
    +
    +
    +

    Parameters

    +
    +

    $value

    +mixed
      +
    • replicationFactor value (either a number, or "satellite")
      • +
    +
    +

    Set the shardKeys value

    setShardKeys(array $value) : void
    @@ -532,6 +649,34 @@

    $value

    +
    +

    Set the shardingStrategy value

    +
    setShardingStrategy(string $value) : void
    +
    +
    +
    +

    Parameters

    +
    +

    $value

    +string
      +
    • shardingStrategy value
      • +
    +
    +
    +
    +

    Set the smart join attribute value

    +
    setSmartJoinAttribute(string $value) : void
    +
    +
    +
    +

    Parameters

    +
    +

    $value

    +string
      +
    • smartJoinAttribute value
      • +
    +
    +

    Set the collection status.

    setStatus(integer $status) : void
    @@ -609,6 +754,16 @@

    Returns

     Properties

    + 
    +

    The distributeShardsLike value (might be NULL for new collections)

    +
    $_distributeShardsLike : mixed
    +
    +

    Default

    +
    +
    +
    +
    +
     

    The collection id (might be NULL for new collections)

    $_id : mixed
    @@ -659,6 +814,16 @@

    Default

    + 
    +

    The minimum replicationFactor value for writes to be successful

    +
    $_minReplicationFactor : mixed
    +
    +

    Default

    +
    +
    +
    +
    +
     

    The collection name (might be NULL for new collections)

    $_name : string
    @@ -671,7 +836,17 @@

    Default

     

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

    -
    $_numberOfShards : integer
    +
    $_numberOfShards : mixed
    +
    +

    Default

    +
    +
    +
    +
    +
    + 
    +

    The replicationFactor value (might be NULL for new collections)

    +
    $_replicationFactor : mixed

    Default

    @@ -689,6 +864,26 @@

    Default

    + 
    +

    The shardingStrategy value (might be NULL for new collections)

    +
    $_shardingStrategy : mixed
    +
    +

    Default

    +
    +
    +
    +
    +
    + 
    +

    The smartJoinAttribute value (might be NULL for new collections)

    +
    $_smartJoinAttribute : mixed
    +
    +

    Default

    +
    +
    +
    +
    +
     

    The collection status value

    $_status : integer
    @@ -721,6 +916,12 @@

    Default

     Constants

    + 
    +

    Collection 'distributeShardsLike' index

    +
    ENTRY_DISTRIBUTE_SHARDS_LIKE = 'distributeShardsLike' 
    +
    +
    +
     

    Collection id index

    ENTRY_ID = 'id' 
    @@ -751,6 +952,12 @@

    Collection 'keyOptions' index

    + 
    +

    Collection 'minReplicationFactor' index

    +
    ENTRY_MIN_REPLICATION_FACTOR = 'minReplicationFactor' 
    +
    +
    +
     

    Collection name index

    ENTRY_NAME = 'name' 
    @@ -763,12 +970,30 @@

    Collection 'numberOfShards' index

    + 
    +

    Collection 'replicationFactor' index

    +
    ENTRY_REPLICATION_FACTOR = 'replicationFactor' 
    +
    +
    +
    + 
    +

    Collection 'shardingStrategy' index

    +
    ENTRY_SHARDING_STRATEGY = 'shardingStrategy' 
    +
    +
    +
     

    Collection 'shardKeys' index

    ENTRY_SHARD_KEYS = 'shardKeys' 
    + 
    +

    Collection 'smartJoinAttribute' index

    +
    ENTRY_SMART_JOIN_ATTRIBUTE = 'smartJoinAttribute' 
    +
    +
    +
     

    Collection 'status' index

    ENTRY_STATUS = 'status' 
    @@ -842,7 +1067,7 @@

    edge collection type

    + generated on 2019-08-19T13:30:48+02:00.
    diff --git a/docs/classes/ArangoDBClient.CollectionHandler.html b/docs/classes/ArangoDBClient.CollectionHandler.html index c5cedc78..ceb8ce23 100644 --- a/docs/classes/ArangoDBClient.CollectionHandler.html +++ b/docs/classes/ArangoDBClient.CollectionHandler.html @@ -31,11 +31,11 @@ Reports
    • @@ -70,8 +70,10 @@
  • Create a fulltext index
    createFulltextIndex()
  • Create a geo index
    createGeoIndex()
  • Create a hash index
    createHashIndex()
    • +
  • Creates an index on a collection on the server
    createIndex()
  • Create a persistent index
    createPersistentIndex()
  • Create a skip-list index
    createSkipListIndex()
    • +
  • Create a TTL index
    createTtlIndex()
  • Drop a collection
    drop()
  • Drop an index
    dropIndex()
  • Get figures for a collection
    figures()
    • @@ -86,7 +88,9 @@
  • Get the information about an index in a collection
    getIndex()
  • Get indexes of a collection
    getIndexes()
  • Get properties of a collection
    getProperties()
    • +
  • Get the responsible shard for a document
    getResponsibleShard()
  • Returns the Collections revision ID
    getRevision()
    • +
  • Get the shards of a collection
    getShards()
  • Check if a collection exists
    has()
  • Import documents into a collection
    import()
  • Import documents from a file
    importFromFile()
    • @@ -101,6 +105,7 @@
  • Rename a collection
    rename()
  • Replace document(s) matching a given example
    replaceByExample()
  • Sets the document class to use
    setDocumentClass()
    • +
  • Sets the edge class to use
    setEdgeClass()
  • Truncate a collection
    truncate()
  • Unload a collection from the server's memory
    unload()
  • Update document(s) matching a given example
    updateByExample()
    • @@ -109,6 +114,7 @@
  • » Protected
  • » Private - +
  •  Properties
  • » Protected - +
  • » Private @@ -140,20 +149,20 @@
  • checksum option
    OPTION_CHECKSUM
  • closed parameter
    OPTION_CLOSED
  • collection parameter
    OPTION_COLLECTION
    • -
  • constraint option
    OPTION_CONSTRAINT
  • count option
    OPTION_COUNT
  • example parameter
    OPTION_CREATE_COLLECTION
  • distance parameter
    OPTION_DISTANCE
  • example parameter
    OPTION_EXAMPLE
  • exclude system collections
    OPTION_EXCLUDE_SYSTEM
    • +
  • expireAfter option
    OPTION_EXPIRE_AFTER
  • fields
    OPTION_FIELDS
  • figures option
    OPTION_FIGURES
  • fulltext index option
    OPTION_FULLTEXT_INDEX
  • geoJson option
    OPTION_GEOJSON
  • geo index option
    OPTION_GEO_INDEX
  • hash index option
    OPTION_HASH_INDEX
    • -
  • ignoreNull option
    OPTION_IGNORE_NULL
  • index parameter
    OPTION_INDEX
    • +
  • inBackground option
    OPTION_IN_BACKGROUND
  • keys parameter
    OPTION_KEYS
  • latitude parameter
    OPTION_LATITUDE
  • left parameter
    OPTION_LEFT
    • @@ -167,13 +176,17 @@
  • query option
    OPTION_QUERY
  • radius parameter
    OPTION_RADIUS
  • rename option
    OPTION_RENAME
    • +
  • responsible shard option
    OPTION_RESPONSIBLE_SHARD
  • revision option
    OPTION_REVISION
  • right parameter
    OPTION_RIGHT
    • +
  • shards option
    OPTION_SHARDS
  • size option
    OPTION_SIZE
  • skip parameter
    OPTION_SKIP
  • skiplist index option
    OPTION_SKIPLIST_INDEX
  • sparse index option
    OPTION_SPARSE
    • +
  • stream parameter
    OPTION_STREAM
  • truncate option
    OPTION_TRUNCATE
    • +
  • ttl index option
    OPTION_TTL_INDEX
  • type
    OPTION_TYPE
  • unique
    OPTION_UNIQUE
  • unload option
    OPTION_UNLOAD
    • @@ -228,15 +241,15 @@

    $connection

    Returns all documents of a collection

    -
    all(mixed $collectionId, array $options = array()) : \ArangoDBClient\Cursor
    +
    all(mixed $collection, array $options = array()) : \ArangoDBClient\Cursor

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as string or number
      • +
    • collection as string or object

    $options

    @@ -274,7 +287,7 @@

    Returns

    Get a random document from the collection.

    -
    any(mixed $collectionId) : \ArangoDBClient\Document
    +
    any(mixed $collection) : \ArangoDBClient\Document

    This will throw if the document cannot be fetched from the server

    @@ -284,9 +297,9 @@

    Get a random document from the collection.

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as string or number
      • +
    • collection as string or object

    Exceptions

    @@ -300,15 +313,15 @@

    Returns

    Get document(s) by specifying an example

    -
    byExample(mixed $collectionId, mixed $document, array $options = array()) : \ArangoDBClient\cursor
    +
    byExample(mixed $collection, mixed $document, array $options = array()) : \ArangoDBClient\cursor

    This will throw if the list cannot be fetched from the server

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as string or number
      • +
    • collection as string or object

    $document

    @@ -384,13 +397,19 @@

    $options

    array
    • an array of options.

      Options are :
      -

    • 'type' - 2 -> normal collection, 3 -> edge-collection
      • -
    • 'waitForSync' - if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.
      • -
    • 'journalSize' - journalSize value.
      • -
    • 'isSystem' - false->user collection(default), true->system collection .
      • -
    • 'isVolatile' - false->persistent collection(default), true->volatile (in-memory) collection .
      • -
    • 'numberOfShards' - number of shards for the collection.
      • -
    • 'shardKeys' - list of shard key attributes.
      • +
    • 'type' - 2 -> normal collection, 3 -> edge-collection
      • +
    • 'waitForSync' - if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.
      • +
    • 'journalSize' - journalSize value.
      • +
    • 'isSystem' - false->user collection(default), true->system collection .
      • +
    • 'isVolatile' - false->persistent collection(default), true->volatile (in-memory) collection .
      • +
    • 'keyOptions' - key options to use.
      • +
    • 'distributeShardsLike' - name of prototype collection for identical sharding.
      • +
    • 'numberOfShards' - number of shards for the collection.
      • +
    • 'replicationFactor' - number of replicas to keep (default: 1).
      • +
    • 'minReplicationFactor' - minimum number of replicas to be successful when writing (default: 1).
      • +
    • 'shardKeys' - array of shard key attributes.
      • +
    • 'shardingStrategy' - sharding strategy to use in cluster.
      • +
    • 'smartJoinAttribute' - attribute name for smart joins (if not shard key).

    Exceptions

    @@ -405,19 +424,19 @@

    Returns

    Create a fulltext index

    -
    createFulltextIndex(string $collectionId, array $fields, integer $minLength = null) : array
    +
    createFulltextIndex(mixed $collection, array $fields, integer $minLength = null, boolean $inBackground = false) : array
    - - + +
    linkhttps://docs.arangodb.com/HTTP/Indexes/Fulltext.htmldeprecateduse CollectionHandler::createIndex instead

    Parameters

    -

    $collectionId

    -string
      -
    • the collection id
      • +

      $collection

      +mixed
        +
      • collection as string or object

    $fields

    @@ -429,6 +448,11 @@

    $minLength

    integer
    • the minimum length of words to index
    +
    +

    $inBackground

    +boolean
      +
    • true if index shall be created in background
      • +

    Exceptions

    @@ -441,19 +465,19 @@

    Returns

    Create a geo index

    -
    createGeoIndex(string $collectionId, array $fields, boolean $geoJson = null, boolean $constraint = null, boolean $ignoreNull = null) : array
    +
    createGeoIndex(mixed $collection, array $fields, boolean $geoJson = null, boolean $inBackground = false) : array
    \ArangoDBClient\Exception
    - - + +
    linkhttps://docs.arangodb.com/HTTP/Indexes/Geo.htmldeprecateduse CollectionHandler::createIndex instead

    Parameters

    -

    $collectionId

    -string
      -
    • the collection id
      • +

      $collection

      +mixed
        +
      • collection as string or object

    $fields

    @@ -466,14 +490,9 @@

    $geoJson

  • whether to use geoJson or not
    • -

    $constraint

    -boolean
      -
    • whether this is a constraint or not
      • -
    -
    -

    $ignoreNull

    +

    $inBackground

    boolean
      -
    • whether to ignore null
      • +
    • true if index shall be created in background

    Exceptions

    @@ -487,19 +506,19 @@

    Returns

    Create a hash index

    -
    createHashIndex(string $collectionId, array $fields, boolean $unique = null, boolean $sparse = null) : array
    +
    createHashIndex(mixed $collection, array $fields, boolean $unique = null, boolean $sparse = null, boolean $inBackground = false) : array
    - - + +
    linkhttps://docs.arangodb.com/HTTP/Indexes/Hash.htmldeprecateduse CollectionHandler::createIndex instead

    Parameters

    -

    $collectionId

    -string
      -
    • the collection id
      • +

      $collection

      +mixed
        +
      • the collection as name or object

    $fields

    @@ -516,6 +535,43 @@

    $sparse

    boolean
    • whether the index should be sparse
    +
    +

    $inBackground

    +boolean
      +
    • true if index shall be created in background
      • +
    +

    Exceptions

    + + + +
    \ArangoDBClient\Exception
    +

    Returns

    +
    +array- server response of the created index
    +
    +
    +
    +

    Creates an index on a collection on the server

    +
    createIndex(mixed $collection, array $indexOptions) : array
    +
    +
    +

    This will create an index on the collection on the server and return its id

    +

    This will throw if the index cannot be created

    + + + +
    since3.5
    +

    Parameters

    +
    +

    $collection

    +mixed
      +
    • collection as string or object
      • +
    +
    +

    $indexOptions

    +array
      +
    • an associative array of options for the index like array('type' => hash, 'fields' => ..., 'sparse' => false)
      • +

    Exceptions

    @@ -528,19 +584,19 @@

    Returns

    Create a persistent index

    -
    createPersistentIndex(string $collectionId, array $fields, boolean $unique = null, boolean $sparse = null) : array
    +
    createPersistentIndex(mixed $collection, array $fields, boolean $unique = null, boolean $sparse = null, boolean $inBackground = false) : array
    \ArangoDBClient\Exception
    - - + +
    linkhttps://docs.arangodb.com/HTTP/Indexes/Persistent.htmldeprecateduse CollectionHandler::createIndex instead

    Parameters

    -

    $collectionId

    -string
      -
    • the collection id
      • +

      $collection

      +mixed
        +
      • collection as string or object

    $fields

    @@ -557,6 +613,11 @@

    $sparse

    boolean
    • whether the index should be sparse
    +
    +

    $inBackground

    +boolean
      +
    • true if index shall be created in background
      • +

    Exceptions

    @@ -569,19 +630,19 @@

    Returns

    Create a skip-list index

    -
    createSkipListIndex(string $collectionId, array $fields, boolean $unique = null, boolean $sparse = null) : array
    +
    createSkipListIndex(mixed $collection, array $fields, boolean $unique = null, boolean $sparse = null, boolean $inBackground = false) : array
    \ArangoDBClient\Exception
    - - + +
    linkhttps://docs.arangodb.com/HTTP/Indexes/Skiplist.htmldeprecateduse CollectionHandler::createIndex instead

    Parameters

    -

    $collectionId

    -string
      -
    • the collection id
      • +

      $collection

      +mixed
        +
      • collection as string or object

    $fields

    @@ -598,6 +659,52 @@

    $sparse

    boolean
    • whether the index should be sparse
    +
    +

    $inBackground

    +boolean
      +
    • true if index shall be created in background
      • +
    +

    Exceptions

    + + + +
    \ArangoDBClient\Exception
    +

    Returns

    +
    +array- server response of the created index
    +
    +
    +
    +

    Create a TTL index

    +
    createTtlIndex(mixed $collection, array $fields, \ArangoDBClient\number $expireAfter, boolean $inBackground = false) : array
    +
    +
    +
    + + + +
    deprecateduse CollectionHandler::createIndex instead
    +

    Parameters

    +
    +

    $collection

    +mixed
      +
    • collection as string or object
      • +
    +
    +

    $fields

    +array
      +
    • an array of fields (only a single one allowed)
      • +
    +
    +

    $expireAfter

    +\ArangoDBClient\number
      +
    • number of seconds after index value after which documents expire
      • +
    +
    +

    $inBackground

    +boolean
      +
    • true if index shall be created in background
      • +

    Exceptions

    @@ -637,12 +744,17 @@

    Returns

    Drop an index

    -
    dropIndex(mixed $indexHandle) : boolean
    +
    dropIndex(mixed $collection, mixed $indexHandle = null) : boolean

    Parameters

    +

    $collection

    +mixed
      +
    • collection as string or object
      • +
    +

    $indexHandle

    mixed
    • index handle (collection name / index id)
      • @@ -681,7 +793,7 @@

      Returns

    Get the first document matching a given example.

    -
    firstExample(mixed $collectionId, mixed $document, array $options = array()) : \ArangoDBClient\Document
    +
    firstExample(mixed $collection, mixed $document, array $options = array()) : \ArangoDBClient\Document

    This will throw if the document cannot be fetched from the server

    @@ -691,9 +803,9 @@

    Get the first document matching a given example.

    \ArangoDBClient\Exception

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as string or number
      • +
    • collection as string or object

    $document

    @@ -732,6 +844,10 @@

    Get document(s) by a fulltext query

    This will find all documents from the collection that match the fulltext query specified in query. In order to use the fulltext operator, a fulltext index must be defined for the collection and the specified attribute.

    + + + +
    deprecateduse AQL queries instead

    Parameters

    $collection

    @@ -855,16 +971,16 @@

    Returns

    Calculate a checksum of the collection.

    -
    getChecksum(mixed $collectionId, boolean $withRevisions = false, boolean $withData = false) : array
    +
    getChecksum(mixed $collection, boolean $withRevisions = false, boolean $withData = false) : array

    Will calculate a checksum of the meta-data (keys and optionally revision ids) and optionally the document data in the collection.

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as a string or number
      • +
    • collection as string or object

    $withRevisions

    @@ -952,15 +1068,15 @@

    Returns

    Get indexes of a collection

    -
    getIndexes(mixed $collectionId) : array
    +
    getIndexes(mixed $collection) : array

    This will throw if the collection cannot be fetched from the server

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as a string or number
      • +
    • collection as string or object

    Exceptions

    @@ -994,18 +1110,49 @@

    Returns

    \ArangoDBClient\Collection- the collection fetched from the server +
    +

    Get the responsible shard for a document

    +
    getResponsibleShard(mixed $collection, mixed $document) : string
    +
    +
    +
    +
    + + +
    since3.5
    +

    Parameters

    +
    +

    $collection

    +mixed
      +
    • collection as string or object
      • +
    +
    +

    $document

    +mixed
      +
    • document
      • +
    +

    Exceptions

    + + + +
    \ArangoDBClient\Exception
    +

    Returns

    +
    +string- shard id
    +
    +

    Returns the Collections revision ID

    -
    getRevision(mixed $collectionId) : array
    +
    getRevision(mixed $collection) : array

    The revision id is a server-generated string that clients can use to check whether data in a collection has changed since the last revision check.

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as a string or number
      • +
    • collection as string or object

    Exceptions

    @@ -1017,6 +1164,32 @@

    Returns

    array- containing a key revision +
    +

    Get the shards of a collection

    +
    getShards(mixed $collection) : array
    +
    +
    +
    +
    + + +
    since3.5
    +

    Parameters

    +
    +

    $collection

    +mixed
      +
    • collection as string or object
      • +
    +

    Exceptions

    + + + +
    \ArangoDBClient\Exception
    +

    Returns

    +
    +array- array with shard ids
    +
    +

    Check if a collection exists

    has(mixed $collection) : boolean
    @@ -1051,7 +1224,7 @@

    Import documents into a collection

    Parameters

    -

    $collection

    mixed $collection - collection id as string or number

    +

    $collection

    mixed $collection - collection as string or object

    $importData

    stringarray
      @@ -1096,16 +1269,12 @@

      Returns

    Import documents from a file

    -
    importFromFile(mixed $collectionId, mixed $importFileName, array $options = array()) : array
    +
    importFromFile($collection, mixed $importFileName, array $options = array()) : array

    This will throw on all errors except insertion errors

    Parameters

    -
    -

    $collectionId

    -mixed
      -
    • collection id as string or number
      • -
    +

    $collection

    $importFileName

    mixed
      @@ -1140,21 +1309,25 @@

      Returns

    Creates an index on a collection on the server

    -
    index(mixed $collectionId, string $type = '', array $attributes = array(), boolean $unique = false, array $indexOptions = array()) : array
    +
    index(mixed $collection, string $type, array $attributes = array(), boolean $unique = false, array $indexOptions = array()) : array

    This will create an index on the collection on the server and return its id

    This will throw if the index cannot be created

    + + + +
    deprecateduse CollectionHandler::createIndex instead

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • The id of the collection where the index is to be created
      • +
    • collection as string or object

    $type

    string
      -
    • index type: hash, skiplist, geo, fulltext, or persistent
      • +
    • index type: hash, skiplist, geo, ttl, fulltext, or persistent

    $attributes

    @@ -1203,7 +1376,7 @@

    Parameters

    $collection

    mixed
      -
    • collection id as string or number or collection object
      • +
    • collection as string or object

    Exceptions

    @@ -1217,7 +1390,7 @@

    Returns

    Bulk lookup documents by specifying an array of keys

    -
    lookupByKeys(mixed $collectionId, array $keys, array $options = array()) : array
    +
    lookupByKeys(mixed $collection, array $keys, array $options = array()) : array

    This will throw on any error

    @@ -1227,9 +1400,9 @@

    Bulk lookup documents by specifying an array of keys

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as string or number
      • +
    • collection as string or object

    $keys

    @@ -1258,15 +1431,19 @@

    Returns

    Get document(s) by specifying near

    -
    near(mixed $collectionId, double $latitude, double $longitude, array $options = array()) : \ArangoDBClient\Cursor
    +
    near(mixed $collection, double $latitude, double $longitude, array $options = array()) : \ArangoDBClient\Cursor

    This will throw if the list cannot be fetched from the server

    + + + +
    deprecateduse AQL queries instead

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as string or number
      • +
    • collection as string or object

    $latitude

    @@ -1312,15 +1489,19 @@

    Returns

    Get document(s) by specifying range

    -
    range(mixed $collectionId, string $attribute, mixed $left, mixed $right, array $options = array()) : \ArangoDBClient\Cursor
    +
    range(mixed $collection, string $attribute, mixed $left, mixed $right, array $options = array()) : \ArangoDBClient\Cursor

    This will throw if the list cannot be fetched from the server

    + + + +
    deprecateduse AQL queries instead

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as string or number
      • +
    • collection as string or object

    $attribute

    @@ -1371,7 +1552,7 @@

    Returns

    Remove document(s) by specifying an example

    -
    removeByExample(mixed $collectionId, mixed $document, array $options = array()) : integer
    +
    removeByExample(mixed $collection, mixed $document, array $options = array()) : integer

    This will throw on any error

    @@ -1381,9 +1562,9 @@

    Remove document(s) by specifying an example

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as string or number
      • +
    • collection as string or object

    $document

    @@ -1414,7 +1595,7 @@

    Returns

    Remove document(s) by specifying an array of keys

    -
    removeByKeys(mixed $collectionId, array $keys, array $options = array()) : array
    +
    removeByKeys(mixed $collection, array $keys, array $options = array()) : array

    This will throw on any error

    @@ -1424,9 +1605,9 @@

    Remove document(s) by specifying an array of keys

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as string or number
      • +
    • collection as string or object

    $keys

    @@ -1464,7 +1645,7 @@

    Parameters

    $collection

    mixed
      -
    • collection id as string or number or collection object
      • +
    • collection as string or object

    $name

    @@ -1483,20 +1664,26 @@

    Returns

    Replace document(s) matching a given example

    -
    replaceByExample(mixed $collectionId, mixed $example, mixed $newValue, mixed $options = array()) : boolean
    +
    replaceByExample(mixed $collection, mixed $example, mixed $newValue, mixed $options = array()) : boolean

    This will replace the document(s) on the server

    This will throw if the document cannot be replaced

    - +
    + + + + + -
    deprecateduse AQL queries instead
    since 1.2
    + +

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as string or number
      • +
    • collection as string or object

    $example

    @@ -1530,7 +1717,7 @@

    Returns

    Sets the document class to use

    -
    setDocumentClass(string $class) : \ArangoDBClient\Handler
    +
    setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
    Inherited
    @@ -1539,7 +1726,21 @@

    Parameters

    $class

    string

    Document class to use

    Returns

    -
    \ArangoDBClient\Handler
    +
    \ArangoDBClient\DocumentClassable
    +
    +
    +
    +

    Sets the edge class to use

    +
    setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
    +
    Inherited
    +
    +
    +

    Parameters

    +
    +

    $class

    +string

    Edge class to use

    +

    Returns

    +
    \ArangoDBClient\DocumentClassable
    @@ -1574,7 +1775,7 @@

    Parameters

    $collection

    mixed
      -
    • collection id as string or number or collection object
      • +
    • collection as string or object

    Exceptions

    @@ -1588,20 +1789,26 @@

    Returns

    Update document(s) matching a given example

    -
    updateByExample(mixed $collectionId, mixed $example, mixed $newValue, mixed $options = array()) : boolean
    +
    updateByExample(mixed $collection, mixed $example, mixed $newValue, mixed $options = array()) : boolean

    This will update the document(s) on the server

    This will throw if the document cannot be updated

    -
    +
    + + + + + -
    deprecateduse AQL queries instead
    since 1.2
    + +

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as string or number
      • +
    • collection as string or number

    $example

    @@ -1635,15 +1842,19 @@

    Returns

    Get document(s) by specifying within

    -
    within(mixed $collectionId, double $latitude, double $longitude, integer $radius, array $options = array()) : \ArangoDBClient\Cursor
    +
    within(mixed $collection, double $latitude, double $longitude, integer $radius, array $options = array()) : \ArangoDBClient\Cursor

    This will throw if the list cannot be fetched from the server

    + + + +
    deprecateduse AQL queries instead

    Parameters

    -

    $collectionId

    +

    $collection

    mixed
      -
    • collection id as string or number
      • +
    • collection as string or object

    $latitude

    @@ -1692,6 +1903,25 @@

    Returns

    \ArangoDBClient\Cursor- documents matching the example [0...n]
    +
    +

    Add a transaction header to the array of headers in case this is a transactional operation

    +
    addTransactionHeader(array $headers, mixed $collection) 
    +
    Inherited
    +
    +
    +

    Parameters

    +
    +

    $headers

    +array
      +
    • already existing headers
      • +
    +
    +

    $collection

    +mixed
      +
    • any type of collection (can be StreamingTransactionCollection or other)
      • +
    +
    +

    Return the connection object

    getConnection() : \ArangoDBClient\Connection
    @@ -1797,10 +2027,10 @@

    Returns

    string- collection name
    -
    -

    createCollectionIfOptions() +
    +

    lazyCreateCollection()

    -
    createCollectionIfOptions($collection, $options) 
    +
    lazyCreateCollection($collection, $options) 
    @@ -1821,6 +2051,16 @@

    Default

    + 
    +

    Edge class to use

    +
    $_edgeClass : string
    +
    +

    Default

    +
    '\ArangoDBClient\Edge'
    +
    +
    +
    +
     

    Connection object

    $_connection 
    @@ -1869,12 +2109,6 @@

    collection parameter

    - 
    -

    constraint option

    -
    OPTION_CONSTRAINT = 'constraint' 
    -
    -
    -
     

    count option

    OPTION_COUNT = 'count' 
    @@ -1905,6 +2139,12 @@

    exclude system collections

    + 
    +

    expireAfter option

    +
    OPTION_EXPIRE_AFTER = 'expireAfter' 
    +
    +
    +
     

    fields

    OPTION_FIELDS = 'fields' 
    @@ -1941,18 +2181,18 @@

    hash index option

    - 
    -

    ignoreNull option

    -
    OPTION_IGNORE_NULL = 'ignoreNull' 
    -
    -
    -
     

    index parameter

    OPTION_INDEX = 'index' 
    + 
    +

    inBackground option

    +
    OPTION_IN_BACKGROUND = 'inBackground' 
    +
    +
    +
     

    keys parameter

    OPTION_KEYS = 'keys' 
    @@ -2031,6 +2271,12 @@

    rename option

    + 
    +

    responsible shard option

    +
    OPTION_RESPONSIBLE_SHARD = 'responsibleShard' 
    +
    +
    +
     

    revision option

    OPTION_REVISION = 'revision' 
    @@ -2043,6 +2289,12 @@

    right parameter

    + 
    +

    shards option

    +
    OPTION_SHARDS = 'shards' 
    +
    +
    +
     

    size option

    OPTION_SIZE = 'size' 
    @@ -2067,12 +2319,24 @@

    sparse index option

    + 
    +

    stream parameter

    +
    OPTION_STREAM = 'stream' 
    +
    +
    +
     

    truncate option

    OPTION_TRUNCATE = 'truncate' 
    + 
    +

    ttl index option

    +
    OPTION_TTL_INDEX = 'ttl' 
    +
    +
    +
     

    type

    OPTION_TYPE = 'type' 
    @@ -2098,7 +2362,7 @@

    unload option

    + generated on 2019-08-19T13:30:48+02:00.
    diff --git a/docs/classes/ArangoDBClient.ConnectException.html b/docs/classes/ArangoDBClient.ConnectException.html index acdc822b..36085006 100644 --- a/docs/classes/ArangoDBClient.ConnectException.html +++ b/docs/classes/ArangoDBClient.ConnectException.html @@ -31,11 +31,11 @@ Reports
    @@ -175,7 +175,7 @@

    Default

    + generated on 2019-08-19T13:30:48+02:00.
    diff --git a/docs/classes/ArangoDBClient.Connection.html b/docs/classes/ArangoDBClient.Connection.html index 57b352af..64d7bb6c 100644 --- a/docs/classes/ArangoDBClient.Connection.html +++ b/docs/classes/ArangoDBClient.Connection.html @@ -31,11 +31,11 @@ Reports
    @@ -882,7 +882,7 @@

    Default

    + generated on 2019-08-19T13:30:48+02:00.
    diff --git a/docs/classes/ArangoDBClient.ConnectionOptions.html b/docs/classes/ArangoDBClient.ConnectionOptions.html index 4c4dd956..0f6e77c7 100644 --- a/docs/classes/ArangoDBClient.ConnectionOptions.html +++ b/docs/classes/ArangoDBClient.ConnectionOptions.html @@ -31,11 +31,11 @@ Reports
    @@ -120,6 +120,7 @@
  • Batch flag
    OPTION_BATCH
  • Batchpart flag
    OPTION_BATCHPART
  • Batch size index constant
    OPTION_BATCHSIZE
    • +
  • "caFile" index constant
    OPTION_CA_FILE
  • UTF-8 CHeck Flag
    OPTION_CHECK_UTF8_CONFORM
  • ciphers allowed to be used in SSL
    OPTION_CIPHERS
  • Connection
    OPTION_CONNECTION
    • @@ -500,6 +501,12 @@

    Batch size index constant

    + 
    +

    "caFile" index constant

    +
    OPTION_CA_FILE = 'caFile' 
    +
    +
    +
     

    UTF-8 CHeck Flag

    OPTION_CHECK_UTF8_CONFORM = 'CheckUtf8Conform' 
    @@ -706,7 +713,7 @@

    Wait for sync index constant

    + generated on 2019-08-19T13:30:49+02:00.
    diff --git a/docs/classes/ArangoDBClient.Cursor.html b/docs/classes/ArangoDBClient.Cursor.html index dd778e77..59bfbfb8 100644 --- a/docs/classes/ArangoDBClient.Cursor.html +++ b/docs/classes/ArangoDBClient.Cursor.html @@ -31,11 +31,11 @@ Reports
    @@ -83,7 +83,8 @@
  • Return the index of the current result row, necessary for Iterator
    key()
  • Advance the cursor, necessary for Iterator
    next()
  • Rewind the cursor, necessary for Iterator
    rewind()
    • -
  • Sets the document class to use
    setDocumentClass()
    • +
  • Sets the document class to use
    setDocumentClass()
    • +
  • Sets the edge class to use
    setEdgeClass()
  • Check if cursor can be advanced further, necessary for Iterator
    valid()
    • @@ -112,7 +113,10 @@
    • » Protected - +
    • » Private
        @@ -416,10 +420,10 @@

        Rewind the cursor, necessary for Iterator

      • -
      +

      Sets the document class to use

      -
      setDocumentClass(string $class) : \ArangoDBClient\Cursor
      -
      +
      setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
      +
      Inherited

      Parameters

      @@ -427,7 +431,21 @@

      Parameters

      $class

      string

      Document class to use

      Returns

      -
      \ArangoDBClient\Cursor
      +
      \ArangoDBClient\DocumentClassable
      +
      +
      +
      +

      Sets the edge class to use

      +
      setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
      +
      Inherited
      +
      +
      +

      Parameters

      +
      +

      $class

      +string

      Edge class to use

      +

      Returns

      +
      \ArangoDBClient\DocumentClassable
      @@ -711,6 +729,16 @@

      Default

      + 
      +

      Edge class to use

      +
      $_edgeClass : string
      +
      +

      Default

      +
      '\ArangoDBClient\Edge'
      +
      +
      +
      +
       

      whether or not the query result was served from the AQL query result cache

      $_cached 
      @@ -922,7 +950,7 @@

      result entry for the full count (ignoring the outermost LIMIT)

      + generated on 2019-08-19T13:30:49+02:00.
      diff --git a/docs/classes/ArangoDBClient.Database.html b/docs/classes/ArangoDBClient.Database.html index 63337c2e..4ff338f7 100644 --- a/docs/classes/ArangoDBClient.Database.html +++ b/docs/classes/ArangoDBClient.Database.html @@ -31,11 +31,11 @@ Reports
      @@ -332,7 +332,7 @@

      Users index

      + generated on 2019-08-19T13:30:48+02:00.
      diff --git a/docs/classes/ArangoDBClient.DefaultValues.html b/docs/classes/ArangoDBClient.DefaultValues.html index ec532c4c..42003dd9 100644 --- a/docs/classes/ArangoDBClient.DefaultValues.html +++ b/docs/classes/ArangoDBClient.DefaultValues.html @@ -31,11 +31,11 @@ Reports
      @@ -225,7 +225,7 @@

      Default value for waitForSync (fsync all data to disk on document updates/in
      + generated on 2019-08-19T13:30:48+02:00.

      diff --git a/docs/classes/ArangoDBClient.Document.html b/docs/classes/ArangoDBClient.Document.html index 78b6fe50..bb9d6a8a 100644 --- a/docs/classes/ArangoDBClient.Document.html +++ b/docs/classes/ArangoDBClient.Document.html @@ -31,11 +31,11 @@ Reports
      @@ -131,6 +131,7 @@
    • isNew id index
      ENTRY_ISNEW
    • Document key index
      ENTRY_KEY
    • Revision id index
      ENTRY_REV
      • +
    • regular expression used for key validation
      KEY_REGEX_PART
    • keepNull option index
      OPTION_KEEPNULL
    • policy option index
      OPTION_POLICY
    • waitForSync option index
      OPTION_WAIT_FOR_SYNC
      • @@ -873,6 +874,12 @@

      Revision id index

      + 
      +

      regular expression used for key validation

      +
      KEY_REGEX_PART = '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' 
      +
      +
      +
       

      keepNull option index

      OPTION_KEEPNULL = 'keepNull' 
      @@ -898,7 +905,7 @@

      waitForSync option index

      + generated on 2019-08-19T13:30:49+02:00.
      diff --git a/docs/classes/ArangoDBClient.DocumentClassable.html b/docs/classes/ArangoDBClient.DocumentClassable.html new file mode 100644 index 00000000..7cdddc78 --- /dev/null +++ b/docs/classes/ArangoDBClient.DocumentClassable.html @@ -0,0 +1,166 @@ + + + + + +ArangoDB PHP client API » \ArangoDBClient\DocumentClassable + + + + + + + + + +
      +
      +ArangoDB PHP client API
      +
      +
      Back to top  
      +
      +
      + +
      +
      +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +

      Add functionality for $_documentClass

      +
      +
      + + + + + + + + + +
      packageArangoDBClient
      since3.4
      +

      + Methods

      +
      +

      Sets the document class to use

      +
      setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
      +
      +
      +
      +

      Parameters

      +
      +

      $class

      +string

      Document class to use

      +

      Returns

      +
      \ArangoDBClient\DocumentClassable
      +
      +
      +
      +

      Sets the edge class to use

      +
      setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
      +
      +
      +
      +

      Parameters

      +
      +

      $class

      +string

      Edge class to use

      +

      Returns

      +
      \ArangoDBClient\DocumentClassable
      +
      +
      +

      + Properties

      + 
      +

      Document class to use

      +
      $_documentClass : string
      +
      +

      Default

      +
      '\ArangoDBClient\Document'
      +
      +
      +
      +
      + 
      +

      Edge class to use

      +
      $_edgeClass : string
      +
      +

      Default

      +
      '\ArangoDBClient\Edge'
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      + + diff --git a/docs/classes/ArangoDBClient.DocumentHandler.html b/docs/classes/ArangoDBClient.DocumentHandler.html index c3029883..e3c28802 100644 --- a/docs/classes/ArangoDBClient.DocumentHandler.html +++ b/docs/classes/ArangoDBClient.DocumentHandler.html @@ -31,11 +31,11 @@ Reports
      @@ -66,12 +66,14 @@
    • Get a single document from a collection
      getById()
    • Gets information about a single documents from a collection
      getHead()
    • Check if a document exists
      has()
      • +
    • insert a document into a collection
      insert()
    • Remove a document from a collection, identified by the document itself
      remove()
    • Remove a document from a collection, identified by the collection id and document id
      removeById()
    • Replace an existing document in a collection, identified by the document itself
      replace()
    • Replace an existing document in a collection, identified by collection id and document id
      replaceById()
      • -
    • save a document to a collection
      save()
      • +
    • Insert a document into a collection
      save()
    • Sets the document class to use
      setDocumentClass()
      • +
    • Sets the edge class to use
      setEdgeClass()
    • Store a document to a collection
      store()
    • Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document.
      update()
    • » Protected
      • @@ -104,7 +107,10 @@
      • » Protected - +
      • » Private @@ -115,6 +121,9 @@
      • documents array index
        ENTRY_DOCUMENTS
      • collection parameter
        OPTION_COLLECTION
      • example parameter
        OPTION_EXAMPLE
        • +
      • overwrite option
        OPTION_OVERWRITE
        • +
      • option for returning the new document
        OPTION_RETURN_NEW
        • +
      • option for returning the old document
        OPTION_RETURN_OLD
        • @@ -306,6 +315,50 @@

        Returns

        boolean
        +
        +

        insert a document into a collection

        +
        insert(mixed $collection, \ArangoDBClient\Document|array $document, array $options = array()) : mixed
        +
        +
        +

        This will add the document to the collection and return the document's id

        +

        This will throw if the document cannot be saved

        + + + +
        since1.0
        +

        Parameters

        +
        +

        $collection

        +mixed
          +
        • collection id as string or number
          • +
        +
        +

        $document

        +\ArangoDBClient\Documentarray
          +
        • the document to be added, can be passed as a document or an array
          • +
        +
        +

        $options

        +array
          +
        • optional, array of options +

          Options are :
          +

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

          +
        +

        Exceptions

        + + + +
        \ArangoDBClient\Exception
        +

        Returns

        +
        +mixed- id of document created
        +
        +

        Remove a document from a collection, identified by the document itself

        remove(\ArangoDBClient\Document $document, array $options = array()) : boolean
        @@ -383,8 +436,8 @@

        Replace an existing document in a collection, identified by the document its 
        replace(\ArangoDBClient\Document $document, array $options = array()) : boolean
        -

        This will update the document on the server

        -

        This will throw if the document cannot be updated

        +

        This will replace the document on the server

        +

        This will throw if the document cannot be replaced

        If policy is set to error (locally or globally through the ConnectionOptions) and the passed document has a _rev value set, the database will check that the revision of the to-be-replaced document is the same as the one given.

        @@ -392,14 +445,14 @@

        Parameters

        $document

        \ArangoDBClient\Document
          -
        • document to be updated
          • +
        • document to be replaced

        $options

        array
        • optional, array of options

          Options are : -

        • 'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])
          • +
        • 'policy' - replace policy to be used in case of conflict ('error', 'last' or NULL [use default])
        • 'waitForSync' - can be used to force synchronisation of the document update operation to disk even in case that the waitForSync flag had been disabled for the entire collection

        @@ -459,49 +512,20 @@

        Returns

        -

        save a document to a collection

        -
        save(mixed $collection, \ArangoDBClient\Document|array $document, array $options = array()) : mixed
        +

        Insert a document into a collection

        +
        save($collection, $document, array $options = array()) 
        -

        This will add the document to the collection and return the document's id

        -

        This will throw if the document cannot be saved

        - - - -
        since1.0
        +

        This is an alias for insert().

        Parameters

        -
        -

        $collection

        -mixed
          -
        • collection id as string or number
          • -
        -
        -

        $document

        -\ArangoDBClient\Documentarray
          -
        • the document to be added, can be passed as a document or an array
          • -
        -
        -

        $options

        -array
          -
        • optional, array of options -

          Options are :
          -

        • 'createCollection' - create the collection if it does not yet exist.
          • -
        • 'waitForSync' - if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.
          • -

          -
        -

        Exceptions

        - - - -
        \ArangoDBClient\Exception
        -

        Returns

        -
        -mixed- id of document created
        +

        $collection

        +

        $document

        +

        $options

        Sets the document class to use

        -
        setDocumentClass(string $class) : \ArangoDBClient\Handler
        +
        setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
        Inherited
        @@ -510,7 +534,21 @@

        Parameters

        $class

        string

        Document class to use

        Returns

        -
        \ArangoDBClient\Handler
        +
        \ArangoDBClient\DocumentClassable
        +
        +

        +
        +

        Sets the edge class to use

        +
        setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $class

        +string

        Edge class to use

        +

        Returns

        +
        \ArangoDBClient\DocumentClassable
        @@ -639,25 +677,22 @@

        Returns

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

        createCollectionIfOptions() -

        -
        createCollectionIfOptions($collection, array $options) 
        -
        +
        +

        Add a transaction header to the array of headers in case this is a transactional operation

        +
        addTransactionHeader(array $headers, mixed $collection) 
        +
        Inherited

        Parameters

        -

        $collection

        mixed collection name or id

        -
        -

        $options

        +

        $headers

        array
          -
        • optional, array of options -

          Options are : -

        • 'createCollection' - true to create the collection if it does not exist
          • -
        • 'createCollectionType' - "document" or 2 for document collection
          • -
        • "edge" or 3 for edge collection
          • -

          +
        • already existing headers
          • +
        +
        +

        $collection

        +mixed
          +
        • any type of collection (can be StreamingTransactionCollection or other)
        @@ -762,6 +797,29 @@

        Returns

        string- json string of the body that was passed
        +
        +

        lazyCreateCollection() +

        +
        lazyCreateCollection(mixed $collection, array $options) 
        +
        +
        +
        +

        Parameters

        +
        +

        $collection

        +mixed

        collection name or id

        +
        +

        $options

        +array
          +
        • optional, array of options +

          Options are : +

        • 'createCollectionType' - "document" or 2 for document collection
          • +
        • "edge" or 3 for edge collection
          • +
        • 'waitForSync' - if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.
          • +

          +
        +
        +

        Turn a value into a collection name

        makeCollection(mixed $value) : string
        @@ -840,6 +898,16 @@

        Default

        + 
        +

        Edge class to use

        +
        $_edgeClass : string
        +
        +

        Default

        +
        '\ArangoDBClient\Edge'
        +
        +
        +
        +
         

        Connection object

        $_connection 
        @@ -876,6 +944,24 @@

        example parameter

        + 
        +

        overwrite option

        +
        OPTION_OVERWRITE = 'overwrite' 
        +
        +
        +
        + 
        +

        option for returning the new document

        +
        OPTION_RETURN_NEW = 'returnNew' 
        +
        +
        +
        + 
        +

        option for returning the old document

        +
        OPTION_RETURN_OLD = 'returnOld' 
        +
        +
        +
        @@ -883,7 +969,7 @@

        example parameter

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.Edge.html b/docs/classes/ArangoDBClient.Edge.html index 3591b43b..2c481437 100644 --- a/docs/classes/ArangoDBClient.Edge.html +++ b/docs/classes/ArangoDBClient.Edge.html @@ -31,11 +31,11 @@ Reports @@ -141,6 +141,7 @@
      • Document key index
        ENTRY_KEY
      • Revision id index
        ENTRY_REV
      • Revision _to index
        ENTRY_TO
        • +
      • regular expression used for key validation
        KEY_REGEX_PART
      • keepNull option index
        OPTION_KEEPNULL
      • policy option index
        OPTION_POLICY
      • waitForSync option index
        OPTION_WAIT_FOR_SYNC
        • @@ -1022,6 +1023,12 @@

        Revision _to index

        + 
        +

        regular expression used for key validation

        +
        KEY_REGEX_PART = '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' 
        +
        +
        +
         

        keepNull option index

        OPTION_KEEPNULL = 'keepNull' 
        @@ -1047,7 +1054,7 @@

        waitForSync option index

        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/classes/ArangoDBClient.EdgeDefinition.html b/docs/classes/ArangoDBClient.EdgeDefinition.html index 1bf5565a..7db695cf 100644 --- a/docs/classes/ArangoDBClient.EdgeDefinition.html +++ b/docs/classes/ArangoDBClient.EdgeDefinition.html @@ -31,11 +31,11 @@ Reports @@ -378,7 +378,7 @@

        Default

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.EdgeHandler.html b/docs/classes/ArangoDBClient.EdgeHandler.html index a9312230..0939493f 100644 --- a/docs/classes/ArangoDBClient.EdgeHandler.html +++ b/docs/classes/ArangoDBClient.EdgeHandler.html @@ -31,11 +31,11 @@ Reports @@ -61,6 +61,7 @@
      •  Methods @@ -166,6 +176,20 @@

         Methods

        +
        +

        Construct a new handler

        +
        __construct(\ArangoDBClient\Connection $connection) 
        +
        +
        +
        +

        Parameters

        +
        +

        $connection

        +\ArangoDBClient\Connection
          +
        • connection to be used
          • +
        +
        +

        Construct a new handler

        __construct(\ArangoDBClient\Connection $connection) 
        @@ -414,6 +438,50 @@

        Returns

        array- array of connected edges
        +
        +

        insert a document into a collection

        +
        insert(mixed $collection, \ArangoDBClient\Document|array $document, array $options = array()) : mixed
        +
        Inherited
        +
        +

        This will add the document to the collection and return the document's id

        +

        This will throw if the document cannot be saved

        + + + +
        since1.0
        +

        Parameters

        +
        +

        $collection

        +mixed
          +
        • collection id as string or number
          • +
        +
        +

        $document

        +\ArangoDBClient\Documentarray
          +
        • the document to be added, can be passed as a document or an array
          • +
        +
        +

        $options

        +array
          +
        • optional, array of options +

          Options are :
          +

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

          +
        +

        Exceptions

        + + + +
        \ArangoDBClient\Exception
        +

        Returns

        +
        +mixed- id of document created
        +
        +

        Get connected outbound edges for a given vertex

        outEdges(mixed $collection, mixed $vertexHandle) : array
        @@ -518,8 +586,8 @@

        Replace an existing document in a collection, identified by the document its 
        replace(\ArangoDBClient\Document $document, array $options = array()) : boolean
        Inherited
        -

        This will update the document on the server

        -

        This will throw if the document cannot be updated

        +

        This will replace the document on the server

        +

        This will throw if the document cannot be replaced

        If policy is set to error (locally or globally through the ConnectionOptions) and the passed document has a _rev value set, the database will check that the revision of the to-be-replaced document is the same as the one given.

        @@ -527,14 +595,14 @@

        Parameters

        $document

        \ArangoDBClient\Document
          -
        • document to be updated
          • +
        • document to be replaced

        $options

        array
        • optional, array of options

          Options are : -

        • 'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])
          • +
        • 'policy' - replace policy to be used in case of conflict ('error', 'last' or NULL [use default])
        • 'waitForSync' - can be used to force synchronisation of the document update operation to disk even in case that the waitForSync flag had been disabled for the entire collection

        @@ -594,44 +662,15 @@

        Returns

        -

        save a document to a collection

        -
        save(mixed $collection, \ArangoDBClient\Document|array $document, array $options = array()) : mixed
        +

        Insert a document into a collection

        +
        save($collection, $document, array $options = array()) 
        Inherited
        -

        This will add the document to the collection and return the document's id

        -

        This will throw if the document cannot be saved

        - - - -
        since1.0
        +

        This is an alias for insert().

        Parameters

        -
        -

        $collection

        -mixed
          -
        • collection id as string or number
          • -
        -
        -

        $document

        -\ArangoDBClient\Documentarray
          -
        • the document to be added, can be passed as a document or an array
          • -
        -
        -

        $options

        -array
          -
        • optional, array of options -

          Options are :
          -

        • 'createCollection' - create the collection if it does not yet exist.
          • -
        • 'waitForSync' - if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.
          • -

          -
        -

        Exceptions

        - - - -
        \ArangoDBClient\Exception
        -

        Returns

        -
        -mixed- id of document created
        +

        $collection

        +

        $document

        +

        $options

        @@ -688,7 +727,7 @@

        Returns

        Sets the document class to use

        -
        setDocumentClass(string $class) : \ArangoDBClient\Handler
        +
        setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
        Inherited
        @@ -697,7 +736,21 @@

        Parameters

        $class

        string

        Document class to use

        Returns

        -
        \ArangoDBClient\Handler
        +
        \ArangoDBClient\DocumentClassable
        +
        +

        +
        +

        Sets the edge class to use

        +
        setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $class

        +string

        Edge class to use

        +

        Returns

        +
        \ArangoDBClient\DocumentClassable
        @@ -826,51 +879,22 @@

        Returns

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

        createCollectionIfOptions() -

        -
        createCollectionIfOptions($collection, array $options) 
        -
        +
        +

        Add a transaction header to the array of headers in case this is a transactional operation

        +
        addTransactionHeader(array $headers, mixed $collection) 
        +
        Inherited
        - - - -
        inherited_from\ArangoDBClient\DocumentHandler::createCollectionIfOptions()

        Parameters

        -

        $collection

        mixed collection name or id

        -
        -

        $options

        +

        $headers

        array
          -
        • optional, array of options -

          Options are : -

        • 'createCollection' - true to create the collection if it does not exist
          • -
        • 'createCollectionType' - "document" or 2 for document collection
          • -
        • "edge" or 3 for edge collection
          • -

          +
        • already existing headers
        -
        -
        -
        -

        createCollectionIfOptions() -

        -
        createCollectionIfOptions($collection, array $options) 
        -
        Inherited
        -
        -
        -

        Parameters

        -

        $collection

        mixed collection name or id

        -
        -

        $options

        -array
          -
        • optional, array of options -

          Options are : -

        • 'createCollection' - true to create the collection if it does not exist
          • -
        • 'createCollectionType' - "document" or 2 for document collection
          • -
        • "edge" or 3 for edge collection
          • -

          +

          $collection

          +mixed
            +
          • any type of collection (can be StreamingTransactionCollection or other)
        @@ -975,6 +999,55 @@

        Returns

        string- json string of the body that was passed
        +
        +

        lazyCreateCollection() +

        +
        lazyCreateCollection(mixed $collection, array $options) 
        +
        +
        +
        + + + +
        inherited_from\ArangoDBClient\DocumentHandler::lazyCreateCollection()
        +

        Parameters

        +
        +

        $collection

        mixed collection name or id

        +
        +

        $options

        +array
          +
        • optional, array of options +

          Options are : +

        • 'createCollection' - true to create the collection if it does not exist
          • +
        • 'createCollectionType' - "document" or 2 for document collection
          • +
        • "edge" or 3 for edge collection
          • +

          +
        +
        +
        +
        +

        lazyCreateCollection() +

        +
        lazyCreateCollection(mixed $collection, array $options) 
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $collection

        +mixed

        collection name or id

        +
        +

        $options

        +array
          +
        • optional, array of options +

          Options are : +

        • 'createCollectionType' - "document" or 2 for document collection
          • +
        • "edge" or 3 for edge collection
          • +
        • 'waitForSync' - if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.
          • +

          +
        +
        +

        Turn a value into a collection name

        makeCollection(mixed $value) : string
        @@ -1053,6 +1126,16 @@

        Default

        + 
        +

        Edge class to use

        +
        $_edgeClass : string
        +
        +

        Default

        +
        '\ArangoDBClient\Edge'
        +
        +
        +
        +
         

        Connection object

        $_connection 
        @@ -1143,6 +1226,24 @@

        example parameter

        + 
        +

        overwrite option

        +
        OPTION_OVERWRITE = 'overwrite' 
        +
        +
        +
        + 
        +

        option for returning the new document

        +
        OPTION_RETURN_NEW = 'returnNew' 
        +
        +
        +
        + 
        +

        option for returning the old document

        +
        OPTION_RETURN_OLD = 'returnOld' 
        +
        +
        +
         

        example parameter

        OPTION_TO = 'to' 
        @@ -1162,7 +1263,7 @@

        vertex parameter

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.Endpoint.html b/docs/classes/ArangoDBClient.Endpoint.html index 40ef9b61..bc9c5fe1 100644 --- a/docs/classes/ArangoDBClient.Endpoint.html +++ b/docs/classes/ArangoDBClient.Endpoint.html @@ -31,11 +31,11 @@ Reports
        • @@ -340,7 +340,7 @@

        UNIX socket endpoint type

        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/classes/ArangoDBClient.Exception.html b/docs/classes/ArangoDBClient.Exception.html index 3d58f4b2..89e41224 100644 --- a/docs/classes/ArangoDBClient.Exception.html +++ b/docs/classes/ArangoDBClient.Exception.html @@ -31,11 +31,11 @@ Reports @@ -153,7 +153,7 @@

        Default

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.Export.html b/docs/classes/ArangoDBClient.Export.html index a09c285b..075bac23 100644 --- a/docs/classes/ArangoDBClient.Export.html +++ b/docs/classes/ArangoDBClient.Export.html @@ -31,11 +31,11 @@ Reports @@ -65,7 +65,8 @@
      • Execute the export
        execute()
      • Get the batch size for the export
        getBatchSize()
      • Set the batch size for the export
        setBatchSize()
        • -
      • Sets the document class to use
        setDocumentClass()
        • +
      • Sets the document class to use
        setDocumentClass()
        • +
      • Sets the edge class to use
        setEdgeClass()
      • » Protected @@ -79,7 +80,10 @@
      • » Protected - +
      • » Private @@ -67,7 +67,8 @@
      • Return the number of HTTP calls that were made to build the cursor result
        getFetches()
      • Return the cursor id, if any
        getId()
      • Get next results as an array
        getNextBatch()
        • -
      • Sets the document class to use
        setDocumentClass()
        • +
      • Sets the document class to use
        setDocumentClass()
        • +
      • Sets the edge class to use
        setEdgeClass()
      • » Private @@ -82,7 +83,10 @@
      • » Protected - +
      • » Private @@ -219,7 +219,7 @@

        Default

        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/classes/ArangoDBClient.FoxxHandler.html b/docs/classes/ArangoDBClient.FoxxHandler.html index 635a5929..88279972 100644 --- a/docs/classes/ArangoDBClient.FoxxHandler.html +++ b/docs/classes/ArangoDBClient.FoxxHandler.html @@ -31,11 +31,11 @@ Reports
        • @@ -65,10 +65,12 @@
      • Upload and install a foxx app.
        installFoxxZip()
      • Remove a foxx-app.
        removeFoxxApp()
      • Sets the document class to use
        setDocumentClass()
        • +
      • Sets the edge class to use
        setEdgeClass()
      • » Protected @@ -147,6 +147,7 @@
      • Graph orphan collections
        ENTRY_ORPHAN_COLLECTIONS
      • Revision id index
        ENTRY_REV
      • Graph edge definitions to collections
        ENTRY_TO
        • +
      • regular expression used for key validation
        KEY_REGEX_PART
      • keepNull option index
        OPTION_KEEPNULL
      • policy option index
        OPTION_POLICY
      • waitForSync option index
        OPTION_WAIT_FOR_SYNC
        • @@ -1092,6 +1093,12 @@

        Graph edge definitions to collections

        + 
        +

        regular expression used for key validation

        +
        KEY_REGEX_PART = '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' 
        +
        +
        +
         

        keepNull option index

        OPTION_KEEPNULL = 'keepNull' 
        @@ -1117,7 +1124,7 @@

        waitForSync option index

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.GraphHandler.html b/docs/classes/ArangoDBClient.GraphHandler.html index e578a8a9..a0540577 100644 --- a/docs/classes/ArangoDBClient.GraphHandler.html +++ b/docs/classes/ArangoDBClient.GraphHandler.html @@ -31,11 +31,11 @@ Reports @@ -90,6 +90,7 @@ 
        setCacheEnabled()
      • Sets the count for any method creating a cursor.
        setCount()
      • Sets the document class to use
        setDocumentClass()
        • +
      • Sets the edge class to use
        setEdgeClass()
      • Sets the limit for any method creating a cursor.
        setLimit()
      • Update an existing edge in a graph, identified by graph name and edge id
        updateEdge()
      • Update an existing vertex in a graph, identified by graph name and vertex id
        updateVertex()
        • @@ -97,6 +98,7 @@
      • » Protected @@ -62,11 +62,13 @@  Methods
      • » Protected -
        +

        Sets the document class to use

        -
        setDocumentClass(string $class) : \ArangoDBClient\Handler
        -
        +
        setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
        +
        Inherited

        Parameters

        @@ -139,7 +144,40 @@

        Parameters

        $class

        string

        Document class to use

        Returns

        -
        \ArangoDBClient\Handler
        +
        \ArangoDBClient\DocumentClassable
        +
        +
        +
        +

        Sets the edge class to use

        +
        setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $class

        +string

        Edge class to use

        +

        Returns

        +
        \ArangoDBClient\DocumentClassable
        +
        +
        +
        +

        Add a transaction header to the array of headers in case this is a transactional operation

        +
        addTransactionHeader(array $headers, mixed $collection) 
        +
        +
        +
        +

        Parameters

        +
        +

        $headers

        +array
          +
        • already existing headers
          • +
        +
        +

        $collection

        +mixed
          +
        • any type of collection (can be StreamingTransactionCollection or other)
          • +
        @@ -259,6 +297,16 @@

        Default

        + 
        +

        Edge class to use

        +
        $_edgeClass : string
        +
        +

        Default

        +
        '\ArangoDBClient\Edge'
        +
        +
        +
        +
         

        Connection object

        $_connection 
        @@ -282,7 +330,7 @@

        Default

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.HttpHelper.html b/docs/classes/ArangoDBClient.HttpHelper.html index fc0b170d..de403b04 100644 --- a/docs/classes/ArangoDBClient.HttpHelper.html +++ b/docs/classes/ArangoDBClient.HttpHelper.html @@ -31,11 +31,11 @@ Reports
        • @@ -359,7 +359,7 @@

        Separator between header and body

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.HttpResponse.html b/docs/classes/ArangoDBClient.HttpResponse.html index 22fb490e..71dedb7c 100644 --- a/docs/classes/ArangoDBClient.HttpResponse.html +++ b/docs/classes/ArangoDBClient.HttpResponse.html @@ -31,11 +31,11 @@ Reports @@ -374,7 +374,7 @@

        HTTP location header

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.QueryCacheHandler.html b/docs/classes/ArangoDBClient.QueryCacheHandler.html index ceac5571..7e99964b 100644 --- a/docs/classes/ArangoDBClient.QueryCacheHandler.html +++ b/docs/classes/ArangoDBClient.QueryCacheHandler.html @@ -31,11 +31,11 @@ Reports @@ -66,13 +66,16 @@
      • Globally turns off the AQL query result cache
        disable()
      • Globally turns on the AQL query result cache
        enable()
      • Globally sets the AQL query result cache to demand mode
        enableDemandMode()
        • +
      • Returns the entries from the query cache in current database
        getEntries()
      • Returns the AQL query result cache properties
        getProperties()
      • Sets the document class to use
        setDocumentClass()
        • +
      • Sets the edge class to use
        setEdgeClass()
      • Adjusts the global AQL query result cache properties
        setProperties()
      • » Protected @@ -67,10 +67,12 @@
      • Returns the list of slow queries
        getSlow()
      • Kills a specific query
        kill()
      • Sets the document class to use
        setDocumentClass()
        • +
      • Sets the edge class to use
        setEdgeClass()
      • » Protected @@ -275,7 +275,7 @@

        Error message index

        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/classes/ArangoDBClient.Statement.html b/docs/classes/ArangoDBClient.Statement.html index 29ba43a4..22b229a0 100644 --- a/docs/classes/ArangoDBClient.Statement.html +++ b/docs/classes/ArangoDBClient.Statement.html @@ -31,11 +31,11 @@ Reports
        • @@ -128,6 +128,7 @@ 
      • $_stream
        • +
      • $_trxId
      • $_ttl
        • @@ -145,6 +146,7 @@
      • Query string index
        ENTRY_QUERY
      • Retries index
        ENTRY_RETRIES
      • Stream attribute
        ENTRY_STREAM
        • +
      • transaction attribute (used internally)
        ENTRY_TRANSACTION
      • TTL attribute
        ENTRY_TTL
      • Full count option index
        FULL_COUNT
        • @@ -798,6 +800,16 @@

        Default

        + 
        +

        transaction id (used internally)

        +
        $_trxId : string
        +
        +

        Default

        +
        null
        +
        +
        +
        +
         

        Number of seconds the cursor will be kept on the server if the statement result is bigger than the initial batch size. The default value is a server-defined @@ -870,6 +882,12 @@

        Stream attribute

        + 
        +

        transaction attribute (used internally)

        +
        ENTRY_TRANSACTION = 'transaction' 
        +
        +
        +
         

        TTL attribute

        ENTRY_TTL = 'ttl' 
        @@ -889,7 +907,7 @@

        Full count option index

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.StreamingTransaction.html b/docs/classes/ArangoDBClient.StreamingTransaction.html new file mode 100644 index 00000000..13c391af --- /dev/null +++ b/docs/classes/ArangoDBClient.StreamingTransaction.html @@ -0,0 +1,679 @@ + + + + + +ArangoDB PHP client API » \ArangoDBClient\StreamingTransaction + + + + + + + + + +
        +
        +ArangoDB PHP client API
        +
        +
        Back to top  
        +
        +
        + +
        +
        +
        +
        + +
        +
        + +
        +
        + +
        +
        + +
        +

        Streaming transaction object

        +
        +
        + + + + + + + + + + + + + +
        packageArangoDBClient
        since3.5
        inherited_from\ArangoDBClient\TransactionBase
        +

        + Methods

        +
        +

        Constructs a streaming transaction object

        +
        __construct(\ArangoDBClient\Connection $connection, array $transactionArray = null) 
        +
        +
        +
        + + + +
        inherited_from\ArangoDBClient\TransactionBase::__construct()
        +

        Parameters

        +
        +

        $connection

        +\ArangoDBClient\Connection
          +
        • client connection
          • +
        +
        +

        $transactionArray

        +array
          +
        • array with collections used by the transaction
          • +
        +
        +
        +
        +

        Initialise the transaction object

        +
        __construct(\ArangoDBClient\Connection $connection) 
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $connection

        +\ArangoDBClient\Connection
          +
        • the connection to be used
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Get an attribute, magic method

        +
        __get(string $key) : mixed
        +
        Inherited
        +
        +

        This function is mapped to get() internally.

        + + + +
        magic
        +

        Parameters

        +
        +

        $key

        +string
          +
        • name of attribute
          • +
        +

        Returns

        +
        +mixed- value of attribute, NULL if attribute is not set
        +
        +
        +
        +

        Is triggered by calling isset() or empty() on inaccessible properties.

        +
        __isset(string $key) : boolean
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $key

        +string
          +
        • name of attribute
          • +
        +

        Returns

        +
        +booleanreturns true or false (set or not set)
        +
        +
        +
        +

        Set an attribute, magic method

        +
        __set(string $key, mixed $value) : void
        +
        Inherited
        +
        +

        This is a magic method that allows the object to be used without +declaring all document attributes first.

        + + + +
        magic
        +

        Parameters

        +
        +

        $key

        +string
          +
        • attribute name
          • +
        +
        +

        $value

        +mixed
          +
        • value for attribute
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Get an attribute

        +
        get(string $key) : mixed
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $key

        +string
          +
        • name of attribute
          • +
        +

        Returns

        +
        +mixed- value of attribute, NULL if attribute is not set
        +
        +
        +
        +

        Get a participating collection of the transaction by name +Will throw an exception if the collection is not part of the transaction

        +
        getCollection(string $name) : \ArangoDBClient\StreamingTransactionCollection
        +
        +
        +
        +

        Parameters

        +
        +

        $name

        +string
          +
        • name of the collection
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +

        Returns

        +
        +\ArangoDBClient\StreamingTransactionCollection- collection object
        +
        +
        +
        +

        Get collections array

        +
        getCollections() : array
        +
        Inherited
        +
        +

        This holds the read and write collections of the transaction

        +

        Returns

        +
        +array$value
        +
        +
        +
        +

        Convenience function to directly get exclusive-collections without having to access +them from the collections attribute.

        +
        getExclusiveCollections() : array
        +
        Inherited
        +
        +
        +

        Returns

        +
        +arrayparams
        +
        +
        +
        +

        Get the transaction's id

        +
        getId() : string
        +
        +
        +
        +

        Returns

        +
        +string- transaction id
        +
        +
        +
        +

        Get lockTimeout value

        +
        getLockTimeout() : integer
        +
        Inherited
        +
        +
        +

        Returns

        +
        +integerlockTimeout
        +
        +
        +
        +

        Convenience function to directly get read-collections without having to access +them from the collections attribute.

        +
        getReadCollections() : array
        +
        Inherited
        +
        +
        +

        Returns

        +
        +arrayparams
        +
        +
        +
        +

        get waitForSync value

        +
        getWaitForSync() : boolean
        +
        Inherited
        +
        +
        +

        Returns

        +
        +booleanwaitForSync
        +
        +
        +
        +

        Convenience function to directly get write-collections without having to access +them from the collections attribute.

        +
        getWriteCollections() : array
        +
        Inherited
        +
        +
        +

        Returns

        +
        +arrayparams
        +
        +
        +
        +

        Executes an AQL query inside the transaction

        +
        query(array $data) : \ArangoDBClient\Cursor
        +
        +
        +

        This is a shortcut for creating a new Statement and executing it.

        +

        Parameters

        +
        +

        $data

        +array
          +
        • query data, as is required by Statement::__construct()
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +

        Returns

        +
        +\ArangoDBClient\Cursor- query cursor, as returned by Statement::execute()
        +
        +
        +
        +

        Sets an attribute

        +
        set($key, $value) 
        +
        Inherited
        +
        +
        +

        Parameters

        +

        $key

        +

        $value

        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Set the collections array.

        +
        setCollections(array $value) 
        +
        Inherited
        +
        +

        The array should have 2 sub-arrays, namely 'read' and 'write' which should hold the respective collections +for the transaction

        +

        Parameters

        +
        +

        $value

        +array +
        +
        +
        +
        +

        Convenience function to directly set exclusive-collections without having to access +them from the collections attribute.

        +
        setExclusiveCollections(array $value) 
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +array +
        +
        +
        +
        +

        Set the transaction's id - this is used internally and should not be called by end users

        +
        setId(mixed $id) 
        +
        +
        +
        +

        Parameters

        +
        +

        $id

        +mixed
          +
        • transaction id as number or string
          • +
        +
        +
        +
        +

        Set lockTimeout value

        +
        setLockTimeout(integer $value) 
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +integer +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Convenience function to directly set read-collections without having to access +them from the collections attribute.

        +
        setReadCollections(array $value) 
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +array +
        +
        +
        +
        +

        set waitForSync value

        +
        setWaitForSync(boolean $value) 
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +boolean +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Convenience function to directly set write-collections without having to access +them from the collections attribute.

        +
        setWriteCollections(array $value) 
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +array +
        +
        +
        +
        +

        Build the object's attributes from a given array

        +
        buildTransactionAttributesFromArray($options) 
        +
        +
        +
        + + + +
        inherited_from\ArangoDBClient\TransactionBase::buildTransactionAttributesFromArray()
        +

        Parameters

        +

        $options

        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Build the object's attributes from a given array

        +
        buildTransactionAttributesFromArray($options) 
        +
        Inherited
        +
        +
        +

        Parameters

        +

        $options

        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Return the connection object

        +
        getConnection() : \ArangoDBClient\Connection
        +
        Inherited
        +
        +
        +

        Returns

        +
        +\ArangoDBClient\Connection- the connection object
        +
        +
        +

        + Properties

        + 
        +

        The transaction's attributes.

        +
        $attributes : array
        +
        +

        Default

        +
        array()
        +
        +
        +
        +
        + 
        +

        An array of collections used by this transaction

        +
        $_collections : array
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        The connection object

        +
        $_connection : \ArangoDBClient\Connection
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        The transaction id - assigned by the server

        +
        $_id : string
        +
        +

        Default

        +
        +
        +
        +
        +
        +

        + Constants

        + 
        +

        Collections index

        +
        ENTRY_COLLECTIONS = 'collections' 
        +
        +
        +
        + 
        +

        EXCLUSIVE index

        +
        ENTRY_EXCLUSIVE = 'exclusive' 
        +
        +
        +
        + 
        +

        class constant for id values

        +
        ENTRY_ID = 'id' 
        +
        +
        +
        + 
        +

        Lock timeout index

        +
        ENTRY_LOCK_TIMEOUT = 'lockTimeout' 
        +
        +
        +
        + 
        +

        Read index

        +
        ENTRY_READ = 'read' 
        +
        +
        +
        + 
        +

        WaitForSync index

        +
        ENTRY_WAIT_FOR_SYNC = 'waitForSync' 
        +
        +
        +
        + 
        +

        WRITE index

        +
        ENTRY_WRITE = 'write' 
        +
        +
        +
        +
        +
        +
        +
        +
        +
        + + diff --git a/docs/classes/ArangoDBClient.StreamingTransactionCollection.html b/docs/classes/ArangoDBClient.StreamingTransactionCollection.html new file mode 100644 index 00000000..12484b42 --- /dev/null +++ b/docs/classes/ArangoDBClient.StreamingTransactionCollection.html @@ -0,0 +1,1211 @@ + + + + + +ArangoDB PHP client API » \ArangoDBClient\StreamingTransactionCollection + + + + + + + + + +
        +
        +ArangoDB PHP client API
        +
        +
        Back to top  
        +
        +
        + +
        +
        +
        +
        + +
        +
        + +
        +
        + +
        +
        + +
        +

        Streaming transaction collection object

        +
        +


        + + + + + + + + + + + + + +
        packageArangoDBClient
        since3.5
        inherited_from\ArangoDBClient\Collection
        +

        + Methods

        +
        +

        Clone a collection

        +
        __clone() : void
        +
        Inherited
        +
        +

        Returns the clone

        + + + +
        magic
        +
        +
        +
        +

        Constructs a streaming transaction collection object

        +
        __construct(\ArangoDBClient\StreamingTransaction $trx, string $name, string $mode) 
        +
        +
        +
        + + + +
        inherited_from\ArangoDBClient\Collection::__construct()
        +

        Parameters

        +
        +

        $trx

        +\ArangoDBClient\StreamingTransaction
          +
        • the transaction
          • +
        +
        +

        $name

        +string
          +
        • collection name
          • +
        +
        +

        $mode

        +string
          +
        • lock mode, i.e. 'read', 'write', 'exclusive'
          • +
        +
        +
        +
        +

        Constructs an empty collection

        +
        __construct(string $name = null) 
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $name

        +string
          +
        • name for the collection
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Return the name of the collection

        +
        __toString() : string
        +
        +
        +

        Returns the collection as JSON-encoded string

        + + + + + + + + + +
        magic
        inherited_from\ArangoDBClient\Collection::__toString()
        +

        Returns

        +
        +string- collection name
        +
        +
        +
        +

        Get a string representation of the collection

        +
        __toString() : string
        +
        Inherited
        +
        +

        Returns the collection as JSON-encoded string

        + + + +
        magic
        +

        Returns

        +
        +string- JSON-encoded collection
        +
        +
        +
        +

        Factory method to construct a new collection

        +
        createFromArray(array $values) : \ArangoDBClient\Collection
        +
        +InheritedStatic +
        +
        +
        +

        Parameters

        +
        +

        $values

        +array
          +
        • initial values for collection
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +

        Returns

        +
        \ArangoDBClient\Collection
        +
        +
        +
        +

        Get all collection attributes

        +
        getAll() : array
        +
        Inherited
        +
        +
        +

        Returns

        +
        +array- array of all collection attributes
        +
        +
        +
        +

        Get the default collection type

        +
        getDefaultType() : string
        +
        +InheritedStatic +
        +
        +
        +

        Returns

        +
        +string- name
        +
        +
        +
        +

        Get the distributeShardsLike (if already known)

        +
        getDistributeShardsLike() : mixed
        +
        Inherited
        +
        +
        +

        Returns

        +
        +mixed- distributeShardsLike value
        +
        +
        +
        +

        Get the collection id (if already known)

        +
        getId() : mixed
        +
        Inherited
        +
        +

        Collection ids are generated on the server only.

        +

        Collection ids are numeric but might be bigger than PHP_INT_MAX. +To reliably store a collection id elsewhere, a PHP string should be used

        +

        Returns

        +
        +mixed- collection id, might be NULL if collection does not yet have an id
        +
        +
        +
        +

        Get the isSystem value (if already known)

        +
        getIsSystem() : boolean
        +
        Inherited
        +
        +
        +

        Returns

        +
        +boolean- isSystem value
        +
        +
        +
        +

        Get the isVolatile value (if already known)

        +
        getIsVolatile() : boolean
        +
        Inherited
        +
        +
        +

        Returns

        +
        +boolean- isVolatile value
        +
        +
        +
        +

        Get the journalSize value (if already known)

        +
        getJournalSize() : integer
        +
        Inherited
        +
        +
        +

        Returns

        +
        +integer- journalSize value
        +
        +
        +
        +

        Get the collection key options (if already known)

        +
        getKeyOptions() : array
        +
        Inherited
        +
        +
        +

        Returns

        +
        +array- keyOptions
        +
        +
        +
        +

        Get the minReplicationFactor value (if already known)

        +
        getMinReplicationFactor() : mixed
        +
        Inherited
        +
        +
        +

        Returns

        +
        +mixed- minReplicationFactor value
        +
        +
        +
        +

        Return the lock mode of the collection

        +
        getMode() : string
        +
        +
        +
        +

        Returns

        +
        +string- lock mode, i.e. 'read', 'write', 'exclusive'
        +
        +
        +
        +

        Return the name of the collection

        +
        getName() : string
        +
        +
        +
        + + + +
        inherited_from\ArangoDBClient\Collection::getName()
        +

        Returns

        +
        +string- collection name
        +
        +
        +
        +

        Get the collection name (if already known)

        +
        getName() : string
        +
        Inherited
        +
        +
        +

        Returns

        +
        +string- name
        +
        +
        +
        +

        Get the numberOfShards value (if already known)

        +
        getNumberOfShards() : mixed
        +
        Inherited
        +
        +
        +

        Returns

        +
        +mixed- numberOfShards value
        +
        +
        +
        +

        Get the replicationFactor value (if already known)

        +
        getReplicationFactor() : mixed
        +
        Inherited
        +
        +
        +

        Returns

        +
        +mixed- replicationFactor value
        +
        +
        +
        +

        Get the shardKeys value (if already known)

        +
        getShardKeys() : array
        +
        Inherited
        +
        +
        +

        Returns

        +
        +array- shardKeys value
        +
        +
        +
        +

        Get the sharding strategy value (if already known)

        +
        getShardingStrategy() : mixed
        +
        Inherited
        +
        +
        +

        Returns

        +
        +mixed- shardingStrategy value
        +
        +
        +
        +

        Get the smart join attribute value (if already known)

        +
        getSmartJoinAttribute() : mixed
        +
        Inherited
        +
        +
        +

        Returns

        +
        +mixed- smart join attribute value
        +
        +
        +
        +

        Get the collection status (if already known)

        +
        getStatus() : integer
        +
        Inherited
        +
        +
        +

        Returns

        +
        +integer- status
        +
        +
        +
        +

        Return the transaction's id

        +
        getTrxId() : string
        +
        +
        +
        +

        Returns

        +
        +string- transaction id
        +
        +
        +
        +

        Get the collection type (if already known)

        +
        getType() : string
        +
        Inherited
        +
        +
        +

        Returns

        +
        +string- name
        +
        +
        +
        +

        Get the waitForSync value (if already known)

        +
        getWaitForSync() : boolean
        +
        Inherited
        +
        +
        +

        Returns

        +
        +boolean- waitForSync value
        +
        +
        +
        +

        Set a collection attribute

        +
        set(string $key, mixed $value) : void
        +
        Inherited
        +
        +

        The key (attribute name) must be a string.

        +

        This will validate the value of the attribute and might throw an +exception if the value is invalid.

        +

        Parameters

        +
        +

        $key

        +string
          +
        • attribute name
          • +
        +
        +

        $value

        +mixed
          +
        • value for attribute
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Set the distribute shards like value

        +
        setDistributeShardsLike(string $value) : void
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +string
          +
        • distributeShardsLike value
          • +
        +
        +
        +
        +

        Set the collection id

        +
        setId(mixed $id) : boolean
        +
        Inherited
        +
        +

        This will throw if the id of an existing collection gets updated to some other id

        +

        Parameters

        +
        +

        $id

        +mixed
          +
        • collection id
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +

        Returns

        +
        boolean
        +
        +
        +
        +

        Set the isSystem value

        +
        setIsSystem(boolean $value) : void
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +boolean
          +
        • isSystem: false->user collection, true->system collection
          • +
        +
        +
        +
        +

        Set the isVolatile value

        +
        setIsVolatile(boolean $value) : void
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +boolean
          +
        • isVolatile value
          • +
        +
        +
        +
        +

        Set the journalSize value

        +
        setJournalSize(integer $value) : void
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +integer
          +
        • journalSize value
          • +
        +
        +
        +
        +

        Set the collection key options.

        +
        setKeyOptions(array $keyOptions) : void
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $keyOptions

        +array
          +
        • An associative array containing optional keys: type, allowUserKeys, increment, offset.
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Set the minReplicationFactor value

        +
        setMinReplicationFactor(integer $value) : void
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +integer
          +
        • minReplicationFactor value
          • +
        +
        +
        +
        +

        Set the collection name

        +
        setName(string $name) : void
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $name

        +string
          +
        • name
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Set the numberOfShards value

        +
        setNumberOfShards(integer $value) : void
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +integer
          +
        • numberOfShards value
          • +
        +
        +
        +
        +

        Set the replicationFactor value

        +
        setReplicationFactor(mixed $value) : void
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +mixed
          +
        • replicationFactor value (either a number, or "satellite")
          • +
        +
        +
        +
        +

        Set the shardKeys value

        +
        setShardKeys(array $value) : void
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +array
          +
        • shardKeys value
          • +
        +
        +
        +
        +

        Set the shardingStrategy value

        +
        setShardingStrategy(string $value) : void
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +string
          +
        • shardingStrategy value
          • +
        +
        +
        +
        +

        Set the smart join attribute value

        +
        setSmartJoinAttribute(string $value) : void
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +string
          +
        • smartJoinAttribute value
          • +
        +
        +
        +
        +

        Set the collection status.

        +
        setStatus(integer $status) : void
        +
        Inherited
        +
        +

        This is useful before a collection is create()'ed in order to set a status.

        +

        Parameters

        +
        +

        $status

        +integer
          +
        • statuses = 1 -> new born, status = 2 -> unloaded, status = 3 -> loaded, status = 4 -> being unloaded, status = 5 -> deleted
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Set the collection type.

        +
        setType(integer $type) : void
        +
        Inherited
        +
        +

        This is useful before a collection is create() 'ed in order to set a different type than the normal one. +For example this must be set to 3 in order to create an edge-collection.

        +

        Parameters

        +
        +

        $type

        +integer
          +
        • type = 2 -> normal collection, type = 3 -> edge-collection
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Set the waitForSync value

        +
        setWaitForSync(boolean $value) : void
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +boolean
          +
        • waitForSync value
          • +
        +
        +
        +
        +

        Returns the collection as JSON-encoded string

        +
        toJson() : string
        +
        Inherited
        +
        +
        +

        Returns

        +
        +string- JSON-encoded collection
        +
        +
        +
        +

        Returns the collection as a serialized string

        +
        toSerialized() : string
        +
        Inherited
        +
        +
        +

        Returns

        +
        +string- PHP serialized collection
        +
        +
        +

        + Properties

        + 
        +

        The distributeShardsLike value (might be NULL for new collections)

        +
        $_distributeShardsLike : mixed
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        The collection id (might be NULL for new collections)

        +
        $_id : mixed
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

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

        +
        $_isSystem : boolean
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

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

        +
        $_isVolatile : boolean
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

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

        +
        $_journalSize : integer
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        The collection keyOptions value

        +
        $_keyOptions : array
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        The minimum replicationFactor value for writes to be successful

        +
        $_minReplicationFactor : mixed
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        Lock mode for this collection, i.e. 'read', 'write' or 'exclusive'

        +
        $_mode : string
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        Collection name - assigned on construction

        +
        $_name : string
        +
        +

        Default

        +
        +
        +
        +
        +
        + + + +
        inherited_from\ArangoDBClient\Collection::_name
        +
        +
        + 
        +

        The collection name (might be NULL for new collections)

        +
        $_name : string
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

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

        +
        $_numberOfShards : mixed
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        The replicationFactor value (might be NULL for new collections)

        +
        $_replicationFactor : mixed
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

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

        +
        $_shardKeys : array
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        The shardingStrategy value (might be NULL for new collections)

        +
        $_shardingStrategy : mixed
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        The smartJoinAttribute value (might be NULL for new collections)

        +
        $_smartJoinAttribute : mixed
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        The collection status value

        +
        $_status : integer
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        The transaction - assigned on construction

        +
        $_trx : \ArangoDBClient\StreamingTransaction
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        The collection type (might be NULL for new collections)

        +
        $_type : integer
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

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

        +
        $_waitForSync : boolean
        +
        +

        Default

        +
        +
        +
        +
        +
        +

        + Constants

        + 
        +

        Collection 'distributeShardsLike' index

        +
        ENTRY_DISTRIBUTE_SHARDS_LIKE = 'distributeShardsLike' 
        +
        +
        +
        + 
        +

        Collection id index

        +
        ENTRY_ID = 'id' 
        +
        +
        +
        + 
        +

        Collection 'isSystem' index

        +
        ENTRY_IS_SYSTEM = 'isSystem' 
        +
        +
        +
        + 
        +

        Collection 'isVolatile' index

        +
        ENTRY_IS_VOLATILE = 'isVolatile' 
        +
        +
        +
        + 
        +

        Collection 'journalSize' index

        +
        ENTRY_JOURNAL_SIZE = 'journalSize' 
        +
        +
        +
        + 
        +

        Collection 'keyOptions' index

        +
        ENTRY_KEY_OPTIONS = 'keyOptions' 
        +
        +
        +
        + 
        +

        Collection 'minReplicationFactor' index

        +
        ENTRY_MIN_REPLICATION_FACTOR = 'minReplicationFactor' 
        +
        +
        +
        + 
        +

        Collection name index

        +
        ENTRY_NAME = 'name' 
        +
        +
        +
        + 
        +

        Collection 'numberOfShards' index

        +
        ENTRY_NUMBER_OF_SHARDS = 'numberOfShards' 
        +
        +
        +
        + 
        +

        Collection 'replicationFactor' index

        +
        ENTRY_REPLICATION_FACTOR = 'replicationFactor' 
        +
        +
        +
        + 
        +

        Collection 'shardingStrategy' index

        +
        ENTRY_SHARDING_STRATEGY = 'shardingStrategy' 
        +
        +
        +
        + 
        +

        Collection 'shardKeys' index

        +
        ENTRY_SHARD_KEYS = 'shardKeys' 
        +
        +
        +
        + 
        +

        Collection 'smartJoinAttribute' index

        +
        ENTRY_SMART_JOIN_ATTRIBUTE = 'smartJoinAttribute' 
        +
        +
        +
        + 
        +

        Collection 'status' index

        +
        ENTRY_STATUS = 'status' 
        +
        +
        +
        + 
        +

        Collection type index

        +
        ENTRY_TYPE = 'type' 
        +
        +
        +
        + 
        +

        Collection 'waitForSync' index

        +
        ENTRY_WAIT_SYNC = 'waitForSync' 
        +
        +
        +
        + 
        +

        properties option

        +
        OPTION_PROPERTIES = 'properties' 
        +
        +
        +
        + 
        +

        Collection being unloaded

        +
        STATUS_BEING_UNLOADED = 4 
        +
        +
        +
        + 
        +

        Deleted collection

        +
        STATUS_DELETED = 5 
        +
        +
        +
        + 
        +

        Loaded collection

        +
        STATUS_LOADED = 3 
        +
        +
        +
        + 
        +

        New born collection

        +
        STATUS_NEW_BORN = 1 
        +
        +
        +
        + 
        +

        Unloaded collection

        +
        STATUS_UNLOADED = 2 
        +
        +
        +
        + 
        +

        document collection type

        +
        TYPE_DOCUMENT = 2 
        +
        +
        +
        + 
        +

        edge collection type

        +
        TYPE_EDGE = 3 
        +
        +
        +
        +
        +
        +
        +
        +
        +
        + + diff --git a/docs/classes/ArangoDBClient.StreamingTransactionHandler.html b/docs/classes/ArangoDBClient.StreamingTransactionHandler.html new file mode 100644 index 00000000..deb09a96 --- /dev/null +++ b/docs/classes/ArangoDBClient.StreamingTransactionHandler.html @@ -0,0 +1,509 @@ + + + + + +ArangoDB PHP client API » \ArangoDBClient\StreamingTransactionHandler + + + + + + + + + +
        +
        +ArangoDB PHP client API
        +
        +
        Back to top  
        +
        +
        + +
        +
        +
        +
        + +
        +
        + +
        +
        + +
        +
        + +
        +

        Provides management of streaming transactions

        +
        +
        + + + + + + + + + + + + + +
        packageArangoDBClient
        since3.5
        inherited_from\ArangoDBClient\Handler
        +

        + Methods

        +
        +

        Construct a new streaming transaction handler

        +
        __construct(\ArangoDBClient\Connection $connection) 
        +
        +
        +
        + + + +
        inherited_from\ArangoDBClient\Handler::__construct()
        +

        Parameters

        +
        +

        $connection

        +\ArangoDBClient\Connection
          +
        • connection to be used
          • +
        +
        +
        +
        +

        Construct a new handler

        +
        __construct(\ArangoDBClient\Connection $connection) 
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $connection

        +\ArangoDBClient\Connection
          +
        • connection to be used
          • +
        +
        +
        +
        +

        Aborts a transaction

        +
        abort(mixed $trx) : boolean
        +
        +
        +
        +

        Parameters

        +
        +

        $trx

        +mixed
          +
        • streaming transaction object or transaction id as string
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ServerException
        +

        Returns

        +
        +boolean- true if abort succeeds, throws an exception otherwise
        +
        +
        +
        +

        Closes all pending transactions created by the handler

        +
        closePendingTransactions() 
        +
        +
        +
        +
        +

        Commits a transaction

        +
        commit(mixed $trx) : boolean
        +
        +
        +
        +

        Parameters

        +
        +

        $trx

        +mixed
          +
        • streaming transaction object or transaction id as string
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ServerException
        +

        Returns

        +
        +boolean- true if commit succeeds, throws an exception otherwise
        +
        +
        +
        +

        Creates a streaming transaction from scratch (no collections) or from an +existing transaction object (necessary when collections need to be passed +into the transaction or when an existing transaction is resumed)

        +
        create(\ArangoDBClient\StreamingTransaction $trx = null) 
        +
        +
        +
        +

        Parameters

        +
        +

        $trx

        +\ArangoDBClient\StreamingTransaction
          +
        • existing transaction
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ServerException
        +
        +
        +
        +

        Return all currently running transactions

        +
        getRunning() : array
        +
        +
        +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ServerException
        +

        Returns

        +
        +array- array of currently running transactions, each transaction is an array with attributes 'id' and 'status'
        +
        +
        +
        +

        Retrieves the status of a transaction

        +
        getStatus(mixed $trx) : array
        +
        +
        +
        +

        Parameters

        +
        +

        $trx

        +mixed
          +
        • streaming transaction object or transaction id as string
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ServerException
        +

        Returns

        +
        +array- returns an array with attributes 'id' and 'status'
        +
        +
        +
        +

        Sets the document class to use

        +
        setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $class

        +string

        Document class to use

        +

        Returns

        +
        \ArangoDBClient\DocumentClassable
        +
        +
        +
        +

        Sets the edge class to use

        +
        setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $class

        +string

        Edge class to use

        +

        Returns

        +
        \ArangoDBClient\DocumentClassable
        +
        +
        +
        +

        Steal the transaction from the handler, so that it is not responsible anymore +for auto-aborting it on shutdown

        +
        stealTransaction(string $id) 
        +
        +
        +
        +

        Parameters

        +
        +

        $id

        +string
          +
        • transaction id
          • +
        +
        +
        +
        +

        Add a transaction header to the array of headers in case this is a transactional operation

        +
        addTransactionHeader(array $headers, mixed $collection) 
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $headers

        +array
          +
        • already existing headers
          • +
        +
        +

        $collection

        +mixed
          +
        • any type of collection (can be StreamingTransactionCollection or other)
          • +
        +
        +
        +
        +

        Return the connection object

        +
        getConnection() : \ArangoDBClient\Connection
        +
        Inherited
        +
        +
        +

        Returns

        +
        +\ArangoDBClient\Connection- the connection object
        +
        +
        +
        +

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

        +
        getConnectionOption($optionName) : mixed
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $optionName

          +
        • The option to return a value for
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +

        Returns

        +
        +mixed- the option's value
        +
        +
        +
        +

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

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

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

        +

        Parameters

        +
        +

        $options

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

        $body

        +array
          +
        • The array into which the options will be included.
          • +
        +
        +

        $includeArray

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

        Returns

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

        Return a json encoded string for the array passed.

        +
        json_encode_wrapper(array $body) : string
        +
        Inherited
        +
        +

        This is a convenience function that calls json_encode_wrapper on the connection

        +

        Parameters

        +
        +

        $body

        +array
          +
        • The body to encode into json
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +

        Returns

        +
        +string- json string of the body that was passed
        +
        +
        +
        +

        Turn a value into a collection name

        +
        makeCollection(mixed $value) : string
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +mixed
          +
        • document, collection or string
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +

        Returns

        +
        +string- collection name
        +
        +
        +

        + Properties

        + 
        +

        Document class to use

        +
        $_documentClass : string
        +
        +

        Default

        +
        '\ArangoDBClient\Document'
        +
        +
        +
        +
        + 
        +

        Edge class to use

        +
        $_edgeClass : string
        +
        +

        Default

        +
        '\ArangoDBClient\Edge'
        +
        +
        +
        +
        + 
        +

        Connection object

        +
        $_connection 
        +
        +

        Default

        +
        +
        +
        +
        +
        + + + +
        param
        +
        +
        + 
        +

        $_pendingTransactions

        +
        $_pendingTransactions 
        +
        +

        Default

        +
        array()
        +
        +
        +
        +
        +
        +
        +
        +
        +
        +
        + + diff --git a/docs/classes/ArangoDBClient.TraceRequest.html b/docs/classes/ArangoDBClient.TraceRequest.html index 02368e81..dfef9fed 100644 --- a/docs/classes/ArangoDBClient.TraceRequest.html +++ b/docs/classes/ArangoDBClient.TraceRequest.html @@ -31,11 +31,11 @@ Reports @@ -252,7 +252,7 @@

        Default

        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/classes/ArangoDBClient.TraceResponse.html b/docs/classes/ArangoDBClient.TraceResponse.html index 60b12a6d..310027a1 100644 --- a/docs/classes/ArangoDBClient.TraceResponse.html +++ b/docs/classes/ArangoDBClient.TraceResponse.html @@ -31,11 +31,11 @@ Reports @@ -271,7 +271,7 @@

        Default

        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/classes/ArangoDBClient.Transaction.html b/docs/classes/ArangoDBClient.Transaction.html index 10986d50..8f6e4532 100644 --- a/docs/classes/ArangoDBClient.Transaction.html +++ b/docs/classes/ArangoDBClient.Transaction.html @@ -31,11 +31,11 @@ Reports @@ -62,45 +62,60 @@  Methods
      • » Protected - +
      •  Properties
      • » Protected - +
      • » Private @@ -122,6 +134,7 @@ @@ -440,7 +440,7 @@

        count fields

        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/classes/ArangoDBClient.UpdatePolicy.html b/docs/classes/ArangoDBClient.UpdatePolicy.html index 377e66c4..5517f0ba 100644 --- a/docs/classes/ArangoDBClient.UpdatePolicy.html +++ b/docs/classes/ArangoDBClient.UpdatePolicy.html @@ -31,11 +31,11 @@ Reports
        • @@ -137,7 +137,7 @@

        last update will win in case of conflicting versions

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.UrlHelper.html b/docs/classes/ArangoDBClient.UrlHelper.html index b2482a25..183aad0a 100644 --- a/docs/classes/ArangoDBClient.UrlHelper.html +++ b/docs/classes/ArangoDBClient.UrlHelper.html @@ -31,11 +31,11 @@ Reports @@ -178,7 +178,7 @@

        Returns

        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/classes/ArangoDBClient.Urls.html b/docs/classes/ArangoDBClient.Urls.html index 50518e3c..df53120e 100644 --- a/docs/classes/ArangoDBClient.Urls.html +++ b/docs/classes/ArangoDBClient.Urls.html @@ -31,11 +31,11 @@ Reports @@ -105,6 +105,7 @@
      • URL for update-by-example
        URL_UPDATE_BY_EXAMPLE
      • URL for file uploads
        URL_UPLOAD
      • base URL part for user management
        URL_USER
        • +
      • URL base part for all view-related REST calls
        URL_VIEW
      • URL for select-range
        URL_WITHIN
        • @@ -405,6 +406,12 @@

        base URL part for user management

        + 
        +

        URL base part for all view-related REST calls

        +
        URL_VIEW = '/_api/view' 
        +
        +
        +
         

        URL for select-range

        URL_WITHIN = '/_api/simple/within' 
        @@ -418,7 +425,7 @@

        URL for select-range

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.User.html b/docs/classes/ArangoDBClient.User.html index e2e953da..d72f4f9c 100644 --- a/docs/classes/ArangoDBClient.User.html +++ b/docs/classes/ArangoDBClient.User.html @@ -31,11 +31,11 @@ Reports @@ -136,6 +136,7 @@
      • isNew id index
        ENTRY_ISNEW
      • Document key index
        ENTRY_KEY
      • Revision id index
        ENTRY_REV
        • +
      • regular expression used for key validation
        KEY_REGEX_PART
      • keepNull option index
        OPTION_KEEPNULL
      • policy option index
        OPTION_POLICY
      • waitForSync option index
        OPTION_WAIT_FOR_SYNC
        • @@ -972,6 +973,12 @@

        Revision id index

        + 
        +

        regular expression used for key validation

        +
        KEY_REGEX_PART = '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' 
        +
        +
        +
         

        keepNull option index

        OPTION_KEEPNULL = 'keepNull' 
        @@ -997,7 +1004,7 @@

        waitForSync option index

        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/classes/ArangoDBClient.UserHandler.html b/docs/classes/ArangoDBClient.UserHandler.html index 8e8ad5e4..0cc2d318 100644 --- a/docs/classes/ArangoDBClient.UserHandler.html +++ b/docs/classes/ArangoDBClient.UserHandler.html @@ -31,11 +31,11 @@ Reports @@ -76,11 +76,13 @@
      • Revoke R/W permissions for a user, for a specific database
        revokeDatabasePermissions()
      • Revoke R/W permissions for a user, for a specific database
        revokePermissions()
      • Sets the document class to use
        setDocumentClass()
        • +
      • Sets the edge class to use
        setEdgeClass()
      • Update an existing user, identified by the username
        updateUser()
      • » Protected @@ -114,7 +114,7 @@

        Exceptions

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.Vertex.html b/docs/classes/ArangoDBClient.Vertex.html index 03a4131b..b137fb62 100644 --- a/docs/classes/ArangoDBClient.Vertex.html +++ b/docs/classes/ArangoDBClient.Vertex.html @@ -31,11 +31,11 @@ Reports
        • @@ -131,6 +131,7 @@
      • isNew id index
        ENTRY_ISNEW
      • Document key index
        ENTRY_KEY
      • Revision id index
        ENTRY_REV
        • +
      • regular expression used for key validation
        KEY_REGEX_PART
      • keepNull option index
        OPTION_KEEPNULL
      • policy option index
        OPTION_POLICY
      • waitForSync option index
        OPTION_WAIT_FOR_SYNC
        • @@ -879,6 +880,12 @@

        Revision id index

        + 
        +

        regular expression used for key validation

        +
        KEY_REGEX_PART = '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' 
        +
        +
        +
         

        keepNull option index

        OPTION_KEEPNULL = 'keepNull' 
        @@ -904,7 +911,7 @@

        waitForSync option index

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.VertexHandler.html b/docs/classes/ArangoDBClient.VertexHandler.html index 75329bca..586474c7 100644 --- a/docs/classes/ArangoDBClient.VertexHandler.html +++ b/docs/classes/ArangoDBClient.VertexHandler.html @@ -31,11 +31,11 @@ Reports @@ -67,12 +67,14 @@
      • Get a single document from a collection
        getById()
      • Gets information about a single documents from a collection
        getHead()
      • Check if a document exists
        has()
        • +
      • insert a document into a collection
        insert()
      • Remove a document from a collection, identified by the document itself
        remove()
      • Remove a document from a collection, identified by the collection id and document id
        removeById()
      • Replace an existing document in a collection, identified by the document itself
        replace()
      • Replace an existing document in a collection, identified by collection id and document id
        replaceById()
        • -
      • save a document to a collection
        save()
        • +
      • Insert a document into a collection
        save()
      • Sets the document class to use
        setDocumentClass()
        • +
      • Sets the edge class to use
        setEdgeClass()
      • Store a document to a collection
        store()
      • Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document.
        update()
      • » Protected
        • @@ -105,7 +108,10 @@
      • » Protected - +
      • » Private @@ -116,6 +122,9 @@
      • documents array index
        ENTRY_DOCUMENTS
      • collection parameter
        OPTION_COLLECTION
      • example parameter
        OPTION_EXAMPLE
        • +
      • overwrite option
        OPTION_OVERWRITE
        • +
      • option for returning the new document
        OPTION_RETURN_NEW
        • +
      • option for returning the old document
        OPTION_RETURN_OLD
        • @@ -328,6 +337,50 @@

        Returns

        boolean
        +
        +

        insert a document into a collection

        +
        insert(mixed $collection, \ArangoDBClient\Document|array $document, array $options = array()) : mixed
        +
        Inherited
        +
        +

        This will add the document to the collection and return the document's id

        +

        This will throw if the document cannot be saved

        + + + +
        since1.0
        +

        Parameters

        +
        +

        $collection

        +mixed
          +
        • collection id as string or number
          • +
        +
        +

        $document

        +\ArangoDBClient\Documentarray
          +
        • the document to be added, can be passed as a document or an array
          • +
        +
        +

        $options

        +array
          +
        • optional, array of options +

          Options are :
          +

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

          +
        +

        Exceptions

        + + + +
        \ArangoDBClient\Exception
        +

        Returns

        +
        +mixed- id of document created
        +
        +

        Remove a document from a collection, identified by the document itself

        remove(\ArangoDBClient\Document $document, array $options = array()) : boolean
        @@ -405,8 +458,8 @@

        Replace an existing document in a collection, identified by the document its 
        replace(\ArangoDBClient\Document $document, array $options = array()) : boolean
        Inherited
        -

        This will update the document on the server

        -

        This will throw if the document cannot be updated

        +

        This will replace the document on the server

        +

        This will throw if the document cannot be replaced

        If policy is set to error (locally or globally through the ConnectionOptions) and the passed document has a _rev value set, the database will check that the revision of the to-be-replaced document is the same as the one given.

        @@ -414,14 +467,14 @@

        Parameters

        $document

        \ArangoDBClient\Document
          -
        • document to be updated
          • +
        • document to be replaced

        $options

        array
        • optional, array of options

          Options are : -

        • 'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])
          • +
        • 'policy' - replace policy to be used in case of conflict ('error', 'last' or NULL [use default])
        • 'waitForSync' - can be used to force synchronisation of the document update operation to disk even in case that the waitForSync flag had been disabled for the entire collection

        @@ -481,49 +534,20 @@

        Returns

        -

        save a document to a collection

        -
        save(mixed $collection, \ArangoDBClient\Document|array $document, array $options = array()) : mixed
        +

        Insert a document into a collection

        +
        save($collection, $document, array $options = array()) 
        Inherited
        -

        This will add the document to the collection and return the document's id

        -

        This will throw if the document cannot be saved

        - - - -
        since1.0
        +

        This is an alias for insert().

        Parameters

        -
        -

        $collection

        -mixed
          -
        • collection id as string or number
          • -
        -
        -

        $document

        -\ArangoDBClient\Documentarray
          -
        • the document to be added, can be passed as a document or an array
          • -
        -
        -

        $options

        -array
          -
        • optional, array of options -

          Options are :
          -

        • 'createCollection' - create the collection if it does not yet exist.
          • -
        • 'waitForSync' - if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.
          • -

          -
        -

        Exceptions

        - - - -
        \ArangoDBClient\Exception
        -

        Returns

        -
        -mixed- id of document created
        +

        $collection

        +

        $document

        +

        $options

        Sets the document class to use

        -
        setDocumentClass(string $class) : \ArangoDBClient\Handler
        +
        setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
        Inherited
        @@ -532,7 +556,21 @@

        Parameters

        $class

        string

        Document class to use

        Returns

        -
        \ArangoDBClient\Handler
        +
        \ArangoDBClient\DocumentClassable
        +
        +

        +
        +

        Sets the edge class to use

        +
        setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $class

        +string

        Edge class to use

        +

        Returns

        +
        \ArangoDBClient\DocumentClassable
        @@ -661,25 +699,22 @@

        Returns

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

        createCollectionIfOptions() -

        -
        createCollectionIfOptions($collection, array $options) 
        +
        +

        Add a transaction header to the array of headers in case this is a transactional operation

        +
        addTransactionHeader(array $headers, mixed $collection) 
        Inherited

        Parameters

        -

        $collection

        mixed collection name or id

        -
        -

        $options

        +

        $headers

        array
          -
        • optional, array of options -

          Options are : -

        • 'createCollection' - true to create the collection if it does not exist
          • -
        • 'createCollectionType' - "document" or 2 for document collection
          • -
        • "edge" or 3 for edge collection
          • -

          +
        • already existing headers
          • +
        +
        +

        $collection

        +mixed
          +
        • any type of collection (can be StreamingTransactionCollection or other)
        @@ -784,6 +819,29 @@

        Returns

        string- json string of the body that was passed
        +
        +

        lazyCreateCollection() +

        +
        lazyCreateCollection(mixed $collection, array $options) 
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $collection

        +mixed

        collection name or id

        +
        +

        $options

        +array
          +
        • optional, array of options +

          Options are : +

        • 'createCollectionType' - "document" or 2 for document collection
          • +
        • "edge" or 3 for edge collection
          • +
        • 'waitForSync' - if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.
          • +

          +
        +
        +

        Turn a value into a collection name

        makeCollection(mixed $value) : string
        @@ -862,6 +920,16 @@

        Default

        + 
        +

        Edge class to use

        +
        $_edgeClass : string
        +
        +

        Default

        +
        '\ArangoDBClient\Edge'
        +
        +
        +
        +
         

        Connection object

        $_connection 
        @@ -898,6 +966,24 @@

        example parameter

        + 
        +

        overwrite option

        +
        OPTION_OVERWRITE = 'overwrite' 
        +
        +
        +
        + 
        +

        option for returning the new document

        +
        OPTION_RETURN_NEW = 'returnNew' 
        +
        +
        +
        + 
        +

        option for returning the old document

        +
        OPTION_RETURN_OLD = 'returnOld' 
        +
        +
        +
        @@ -905,7 +991,7 @@

        example parameter

        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/classes/ArangoDBClient.View.html b/docs/classes/ArangoDBClient.View.html new file mode 100644 index 00000000..5de0ba56 --- /dev/null +++ b/docs/classes/ArangoDBClient.View.html @@ -0,0 +1,256 @@ + + + + + +ArangoDB PHP client API » \ArangoDBClient\View + + + + + + + + + +
        +
        +ArangoDB PHP client API
        +
        +
        Back to top  
        +
        +
        + +
        +
        +
        +
        + +
        +
        + +
        +
        + +
        +
        + +
        +

        Value object representing a view

        +
        +


        + + + + + + + + + +
        packageArangoDBClient
        since3.4
        +

        + Methods

        +
        +

        Constructs an empty view

        +
        __construct(array $name, string $type) 
        +
        +
        +
        + + + +
        since3.4
        +

        Parameters

        +
        +

        $name

        +array
          +
        • name for view
          • +
        +
        +

        $type

        +string
          +
        • view type
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +
        +
        +
        +

        Return the view as an array

        +
        getAll() : array
        +
        +
        +
        +

        Returns

        +
        +array- view data as an array
        +
        +
        +
        +

        Return the view id

        +
        getId() : string
        +
        +
        +
        +

        Returns

        +
        +string- view id
        +
        +
        +
        +

        Return the view name

        +
        getName() : string
        +
        +
        +
        +

        Returns

        +
        +string- view name
        +
        +
        +
        +

        Return the view type

        +
        getType() : string
        +
        +
        +
        +

        Returns

        +
        +string- view type
        +
        +
        +
        +

        Set the view's id

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

        Parameters

        +
        +

        $id

        +string
          +
        • view id
          • +
        +
        +
        +

        + Properties

        + 
        +

        The view id (might be NULL for new views)

        +
        $_id : string
        +
        +

        Default

        +
        +
        +
        +
        +
        + 
        +

        The view name

        +
        $_name : string
        +
        +

        Default

        +
        +
        +
        +
        +
        +

        + Constants

        + 
        +

        View id index

        +
        ENTRY_ID = 'id' 
        +
        +
        +
        + 
        +

        View name index

        +
        ENTRY_NAME = 'name' 
        +
        +
        +
        + 
        +

        View type index

        +
        ENTRY_TYPE = 'type' 
        +
        +
        +
        +
        +
        +
        +
        +
        +
        + + diff --git a/docs/classes/ArangoDBClient.ViewHandler.html b/docs/classes/ArangoDBClient.ViewHandler.html new file mode 100644 index 00000000..b1ef1fac --- /dev/null +++ b/docs/classes/ArangoDBClient.ViewHandler.html @@ -0,0 +1,520 @@ + + + + + +ArangoDB PHP client API » \ArangoDBClient\ViewHandler + + + + + + + + + +
        +
        +ArangoDB PHP client API
        +
        +
        Back to top  
        +
        +
        + +
        +
        +
        +
        + +
        +
        + +
        +
        + +
        +
        + +
        +

        A handler that manages views.

        +
        +
        + + + + + + + + + + + + + +
        packageArangoDBClient
        since3.4
        inherited_from\ArangoDBClient\Handler
        +

        + Methods

        +
        +

        Construct a new handler

        +
        __construct(\ArangoDBClient\Connection $connection) 
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $connection

        +\ArangoDBClient\Connection
          +
        • connection to be used
          • +
        +
        +
        +
        +

        Create a view

        +
        create(\ArangoDBClient\View $view) : array
        +
        +
        +

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

        + + + +
        since3.4
        +

        Parameters

        +
        +

        $view

        +\ArangoDBClient\View
          +
        • The view object which holds the information of the view to be created
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\Exception
        +

        Returns

        +
        array
        +
        +
        +
        +

        Drop a view<br><br>

        +
        drop(mixed $view) : boolean
        +
        +
        +
        + + + +
        since3.4
        +

        Parameters

        +
        +

        $view

        +mixed
          +
        • view name as a string or instance of View
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\Exception
        +

        Returns

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

        Get a view

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

        This will get a view.

        + + + +
        since3.4
        +

        Parameters

        +
        +

        $view

        +String
          +
        • The name of the view
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +

        Returns

        +
        +\ArangoDBClient\Viewfalse +
        +
        +
        +
        +

        Get a view's properties<br><br>

        +
        properties(mixed $view) : array
        +
        +
        +
        + + + +
        since3.4
        +

        Parameters

        +
        +

        $view

        +mixed
          +
        • view name as a string or instance of View
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\Exception
        +

        Returns

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

        Rename a view

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

        Parameters

        +
        +

        $view

        +mixed
          +
        • view name as a string or instance of View
          • +
        +
        +

        $name

        +string
          +
        • new name for collection
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\Exception
        +

        Returns

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

        Sets the document class to use

        +
        setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $class

        +string

        Document class to use

        +

        Returns

        +
        \ArangoDBClient\DocumentClassable
        +
        +
        +
        +

        Sets the edge class to use

        +
        setEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $class

        +string

        Edge class to use

        +

        Returns

        +
        \ArangoDBClient\DocumentClassable
        +
        +
        +
        +

        Set a view's properties<br><br>

        +
        setProperties(mixed $view, array $properties) : array
        +
        +
        +
        + + + +
        since3.4
        +

        Parameters

        +
        +

        $view

        +mixed
          +
        • view name as a string or instance of View
          • +
        +
        +

        $properties

        +array
          +
        • array with view properties
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\Exception
        +

        Returns

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

        Add a transaction header to the array of headers in case this is a transactional operation

        +
        addTransactionHeader(array $headers, mixed $collection) 
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $headers

        +array
          +
        • already existing headers
          • +
        +
        +

        $collection

        +mixed
          +
        • any type of collection (can be StreamingTransactionCollection or other)
          • +
        +
        +
        +
        +

        Return the connection object

        +
        getConnection() : \ArangoDBClient\Connection
        +
        Inherited
        +
        +
        +

        Returns

        +
        +\ArangoDBClient\Connection- the connection object
        +
        +
        +
        +

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

        +
        getConnectionOption($optionName) : mixed
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $optionName

          +
        • The option to return a value for
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +

        Returns

        +
        +mixed- the option's value
        +
        +
        +
        +

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

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

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

        +

        Parameters

        +
        +

        $options

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

        $body

        +array
          +
        • The array into which the options will be included.
          • +
        +
        +

        $includeArray

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

        Returns

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

        Return a json encoded string for the array passed.

        +
        json_encode_wrapper(array $body) : string
        +
        Inherited
        +
        +

        This is a convenience function that calls json_encode_wrapper on the connection

        +

        Parameters

        +
        +

        $body

        +array
          +
        • The body to encode into json
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +

        Returns

        +
        +string- json string of the body that was passed
        +
        +
        +
        +

        Turn a value into a collection name

        +
        makeCollection(mixed $value) : string
        +
        Inherited
        +
        +
        +

        Parameters

        +
        +

        $value

        +mixed
          +
        • document, collection or string
          • +
        +

        Exceptions

        + + + +
        \ArangoDBClient\ClientException
        +

        Returns

        +
        +string- collection name
        +
        +
        +

        + Properties

        + 
        +

        Document class to use

        +
        $_documentClass : string
        +
        +

        Default

        +
        '\ArangoDBClient\Document'
        +
        +
        +
        +
        + 
        +

        Edge class to use

        +
        $_edgeClass : string
        +
        +

        Default

        +
        '\ArangoDBClient\Edge'
        +
        +
        +
        +
        + 
        +

        Connection object

        +
        $_connection 
        +
        +

        Default

        +
        +
        +
        +
        +
        + + + +
        param
        +
        +
        +

        + Constants

        + 
        +

        rename option

        +
        OPTION_RENAME = 'rename' 
        +
        +
        +
        +
        +
        +
        +
        +
        +
        + + diff --git a/docs/deprecated.html b/docs/deprecated.html index f72e33a4..a2c6dfb5 100644 --- a/docs/deprecated.html +++ b/docs/deprecated.html @@ -31,11 +31,11 @@ Reports @@ -50,6 +50,7 @@
        @@ -60,6 +61,81 @@
      • Deprecated elements
        • +

        +CollectionHandler.php13 +

        +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        TypeLineDescription
        deprecated1009use CollectionHandler::createIndex instead
        deprecated1037use CollectionHandler::createIndex instead
        deprecated1073use CollectionHandler::createIndex instead
        deprecated1528use AQL queries instead
        deprecated1583use AQL queries instead
        deprecated1649use AQL queries instead
        deprecated1880use AQL queries instead
        deprecated1947use AQL queries instead
        deprecated2006use AQL queries instead
        deprecated878use CollectionHandler::createIndex instead
        deprecated911use CollectionHandler::createIndex instead
        deprecated942use CollectionHandler::createIndex instead
        deprecated976use CollectionHandler::createIndex instead

        UserHandler.php2

        @@ -71,12 +147,12 @@ deprecated -189 +190 use UserHandler::grantDatabasePermissions instead deprecated -230 +231 use UserHandler::revokeDatabasePermissions instead
        @@ -86,7 +162,7 @@
        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/errors.html b/docs/errors.html index 8285d736..8db9fdeb 100644 --- a/docs/errors.html +++ b/docs/errors.html @@ -31,11 +31,11 @@ Reports @@ -54,18 +54,19 @@
      • Navigation
        • -
      • Document.php
        • +
      • Endpoint.php
        • +
      • CollectionHandler.php
        • +
      • StreamingTransactionHandler.php
      • Connection.php
      • QueryCacheHandler.php
        • -
      • DocumentHandler.php
        • -
      • CollectionHandler.php
        • -
      • HttpResponse.php
        • -
      • Exception.php
        • -
      • Endpoint.php
        • +
      • Document.php
      • QueryHandler.php
        • +
      • DocumentHandler.php
      • Statement.php
        • -
      • EdgeHandler.php
        • +
      • Exception.php
        • +
      • HttpResponse.php
      • GraphHandler.php
        • +
      • EdgeHandler.php
        • +
        +
        +

        +EdgeHandler.php1 +

        +
        + + + + + + + + + + +
        TypeLineDescription
        error270No summary for method lazyCreateCollection()
        +
        +
        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/graph_class.html b/docs/graph_class.html index 200759d3..dd580972 100644 --- a/docs/graph_class.html +++ b/docs/graph_class.html @@ -31,11 +31,11 @@ Reports @@ -62,7 +62,7 @@
        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/index.html b/docs/index.html index eb002262..a457564e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -31,11 +31,11 @@ Reports @@ -71,18 +71,18 @@

        Documentation

        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/markers.html b/docs/markers.html index 7cdf853f..c70c32cf 100644 --- a/docs/markers.html +++ b/docs/markers.html @@ -31,11 +31,11 @@ Reports @@ -63,7 +63,7 @@
        + generated on 2019-08-19T13:30:49+02:00.
        diff --git a/docs/namespaces/ArangoDBClient.html b/docs/namespaces/ArangoDBClient.html index 4752b23e..eed02a70 100644 --- a/docs/namespaces/ArangoDBClient.html +++ b/docs/namespaces/ArangoDBClient.html @@ -31,11 +31,11 @@ Reports @@ -59,54 +59,63 @@ ArangoDBClient
      • + Traits
        • +
      • DocumentClassable
        • +
      • Classes
        • -
      • AqlUserFunction
        • -
      • BatchPart
        • -
      • UserHandler
        • -
      • Document
        • -
      • ConnectionOptions
        • -
      • Connection
        • +
      • Edge
      • Transaction
        • -
      • ExportCursor
        • +
      • StreamingTransaction
      • UrlHelper
        • -
      • QueryCacheHandler
        • -
      • DocumentHandler
        • -
      • Edge
        • -
      • Cursor
        • -
      • Database
        • -
      • FailoverException
        • +
      • Endpoint
      • Batch
        • -
      • TraceRequest
        • +
      • ExportCursor
        • +
      • FailoverException
      • ConnectException
        • -
      • ValueValidator
        • -
      • Autoloader
        • -
      • ClientException
        • -
      • FoxxHandler
        • +
      • Collection
        • +
      • TraceRequest
        • +
      • AqlUserFunction
        • +
      • Traversal
        • +
      • View
        • +
      • DefaultValues
      • User
        • -
      • BindVars
      • CollectionHandler
        • +
      • Database
        • +
      • StreamingTransactionHandler
        • +
      • BatchPart
        • +
      • FoxxHandler
        • +
      • Connection
        • +
      • TraceResponse
        • +
      • Autoloader
        • +
      • ServerException
        • +
      • UserHandler
        • +
      • QueryCacheHandler
        • +
      • HttpHelper
        • +
      • ViewHandler
        • +
      • Cursor
        • +
      • TransactionBase
      • Graph
        • -
      • EdgeDefinition
        • +
      • Document
      • Vertex
        • -
      • Collection
        • -
      • HttpResponse
        • -
      • HttpHelper
        • -
      • UpdatePolicy
        • -
      • Exception
        • -
      • Endpoint
      • QueryHandler
        • -
      • ServerException
        • +
      • DocumentHandler
        • +
      • Statement
        • +
      • Exception
      • Handler
        • -
      • Traversal
      • VertexHandler
        • -
      • Statement
        • +
      • HttpResponse
        • +
      • BindVars
        • +
      • UpdatePolicy
      • Urls
        • -
      • TraceResponse
        • -
      • AdminHandler
        • -
      • EdgeHandler
        • +
      • EdgeDefinition
        • +
      • ClientException
      • Export
        • +
      • ValueValidator
      • GraphHandler
        • -
      • DefaultValues
        • +
      • StreamingTransactionCollection
        • +
      • AdminHandler
        • +
      • EdgeHandler
        • +
      • ConnectionOptions
        • @@ -119,6 +128,13 @@

        Classes, interfaces, and traits

        +
        +

        DocumentClassable +

        +

        Add functionality for $_documentClass

        +
        +« More » +

        AdminHandler

        @@ -364,6 +380,27 @@

        Statement
        « More »

        +
        +

        StreamingTransaction +

        +

        Streaming transaction object

        +
        +« More » +
        +
        +

        StreamingTransactionCollection +

        +

        Streaming transaction collection object

        +
        +« More » +
        +
        +

        StreamingTransactionHandler +

        +

        Provides management of streaming transactions

        +
        +« More » +

        TraceRequest

        @@ -385,6 +422,13 @@

        Transaction
        « More »

        +
        +

        TransactionBase +

        +

        Transaction base class, used by Transaction and StreamingTransaction

        +
        +« More » +

        Traversal

        @@ -448,13 +492,27 @@

        VertexHandler
        « More »

        +
        +

        View +

        +

        Value object representing a view

        +
        +« More » +
        +
        +

        ViewHandler +

        +

        A handler that manages views.

        +
        +« More » +
        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/packages/ArangoDBClient.html b/docs/packages/ArangoDBClient.html index 51067330..fc8b399c 100644 --- a/docs/packages/ArangoDBClient.html +++ b/docs/packages/ArangoDBClient.html @@ -31,11 +31,11 @@ Reports @@ -59,54 +59,63 @@ ArangoDBClient
      • + Traits
        • +
      • DocumentClassable
        • +
      • Classes
        • -
      • AqlUserFunction
        • -
      • BatchPart
        • -
      • UserHandler
        • -
      • Document
        • -
      • ConnectionOptions
        • -
      • Connection
        • +
      • Edge
      • Transaction
        • -
      • ExportCursor
        • +
      • StreamingTransaction
      • UrlHelper
        • -
      • QueryCacheHandler
        • -
      • DocumentHandler
        • -
      • Edge
        • -
      • Cursor
        • -
      • Database
        • -
      • FailoverException
        • +
      • Endpoint
      • Batch
        • -
      • TraceRequest
        • +
      • ExportCursor
        • +
      • FailoverException
      • ConnectException
        • -
      • ValueValidator
        • -
      • Autoloader
        • -
      • ClientException
        • -
      • FoxxHandler
        • +
      • Collection
        • +
      • TraceRequest
        • +
      • AqlUserFunction
        • +
      • Traversal
        • +
      • View
        • +
      • DefaultValues
      • User
        • -
      • BindVars
      • CollectionHandler
        • +
      • Database
        • +
      • StreamingTransactionHandler
        • +
      • BatchPart
        • +
      • FoxxHandler
        • +
      • Connection
        • +
      • TraceResponse
        • +
      • Autoloader
        • +
      • ServerException
        • +
      • UserHandler
        • +
      • QueryCacheHandler
        • +
      • HttpHelper
        • +
      • ViewHandler
        • +
      • Cursor
        • +
      • TransactionBase
      • Graph
        • -
      • EdgeDefinition
        • +
      • Document
      • Vertex
        • -
      • Collection
        • -
      • HttpResponse
        • -
      • HttpHelper
        • -
      • UpdatePolicy
        • -
      • Exception
        • -
      • Endpoint
      • QueryHandler
        • -
      • ServerException
        • +
      • DocumentHandler
        • +
      • Statement
        • +
      • Exception
      • Handler
        • -
      • Traversal
      • VertexHandler
        • -
      • Statement
        • +
      • HttpResponse
        • +
      • BindVars
        • +
      • UpdatePolicy
      • Urls
        • -
      • TraceResponse
        • -
      • AdminHandler
        • -
      • EdgeHandler
        • +
      • EdgeDefinition
        • +
      • ClientException
      • Export
        • +
      • ValueValidator
      • GraphHandler
        • -
      • DefaultValues
        • +
      • StreamingTransactionCollection
        • +
      • AdminHandler
        • +
      • EdgeHandler
        • +
      • ConnectionOptions
        • @@ -116,6 +125,13 @@

        Classes, interfaces, and traits

        +
        +

        DocumentClassable +

        +

        Add functionality for $_documentClass

        +
        +« More » +

        AdminHandler

        @@ -361,6 +377,27 @@

        Statement
        « More »

        +
        +

        StreamingTransaction +

        +

        Streaming transaction object

        +
        +« More » +
        +
        +

        StreamingTransactionCollection +

        +

        Streaming transaction collection object

        +
        +« More » +
        +
        +

        StreamingTransactionHandler +

        +

        Provides management of streaming transactions

        +
        +« More » +

        TraceRequest

        @@ -382,6 +419,13 @@

        Transaction
        « More »

        +
        +

        TransactionBase +

        +

        Transaction base class, used by Transaction and StreamingTransaction

        +
        +« More » +

        Traversal

        @@ -445,13 +489,27 @@

        VertexHandler
        « More »

        +
        +

        View +

        +

        Value object representing a view

        +
        +« More » +
        +
        +

        ViewHandler +

        +

        A handler that manages views.

        +
        +« More » +
        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/packages/Default.html b/docs/packages/Default.html index 9c95bbee..966013a2 100644 --- a/docs/packages/Default.html +++ b/docs/packages/Default.html @@ -31,11 +31,11 @@ Reports @@ -65,7 +65,7 @@
        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/packages/global.html b/docs/packages/global.html index a7d90f62..7bbe32ff 100644 --- a/docs/packages/global.html +++ b/docs/packages/global.html @@ -31,11 +31,11 @@ Reports @@ -65,7 +65,7 @@
        + generated on 2019-08-19T13:30:48+02:00.
        diff --git a/docs/structure.xml b/docs/structure.xml index 7c09aaff..c80a6b91 100644 --- a/docs/structure.xml +++ b/docs/structure.xml @@ -1,344 +1,538 @@ - + - ArangoDB PHP client: AqlUserFunction + ArangoDB PHP client: single document - - - + + + - - - AqlUserFunction - \ArangoDBClient\AqlUserFunction - - Provides management of user-functions - AqlUserFunction object<br> -An AqlUserFunction is an object that is used to manage AQL User Functions.<br> -It registers, un-registers and lists user functions on the server<br> -<br> -The object encapsulates:<br> -<br> -<ul> -<li> the name of the function -<li> the actual javascript function -</ul> -<br> -The object requires the connection object and can be initialized -with or without initial configuration.<br> -<br> -Any configuration can be set and retrieved by the object's methods like this:<br> -<br> -<pre> -$this->setName('myFunctions:myFunction');<br> -$this->setCode('function (){your code};'); -</pre> - -<br> -or like this:<br> -<br> -<pre> -$this->name('myFunctions:myFunction');<br> -$this->code('function (){your code};'); -</pre> - - + + \ArangoDBClient\Document + Edge + \ArangoDBClient\Edge + + Value object representing a single collection-based edge document + <br> + + + - - ENTRY_NAME - \ArangoDBClient\AqlUserFunction::ENTRY_NAME - 'name' - - Collections index + + ENTRY_FROM + \ArangoDBClient\Edge::ENTRY_FROM + '_from' + + Document _from index - - ENTRY_CODE - \ArangoDBClient\AqlUserFunction::ENTRY_CODE - 'code' - - Action index + + ENTRY_TO + \ArangoDBClient\Edge::ENTRY_TO + '_to' + + Revision _to index - - $_connection - \ArangoDBClient\AqlUserFunction::_connection + + ENTRY_ID + \ArangoDBClient\Document::ENTRY_ID + '_id' + + Document id index + + + + + ENTRY_KEY + \ArangoDBClient\Document::ENTRY_KEY + '_key' + + Document key index + + + + + ENTRY_REV + \ArangoDBClient\Document::ENTRY_REV + '_rev' + + Revision id index + + + + + ENTRY_ISNEW + \ArangoDBClient\Document::ENTRY_ISNEW + '_isNew' + + isNew id index + + + + + ENTRY_HIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES + '_hiddenAttributes' + + hidden attribute index + + + + + ENTRY_IGNOREHIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES + '_ignoreHiddenAttributes' + + hidden attribute index + + + + + OPTION_WAIT_FOR_SYNC + \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC + 'waitForSync' + + waitForSync option index + + + + + OPTION_POLICY + \ArangoDBClient\Document::OPTION_POLICY + 'policy' + + policy option index + + + + + OPTION_KEEPNULL + \ArangoDBClient\Document::OPTION_KEEPNULL + 'keepNull' + + keepNull option index + + + + + KEY_REGEX_PART + \ArangoDBClient\Document::KEY_REGEX_PART + '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' + + regular expression used for key validation + + + + + $_from + \ArangoDBClient\Edge::_from - - The connection object + + The edge's from (might be NULL for new documents) - - \ArangoDBClient\Connection + + mixed - - $attributes - \ArangoDBClient\AqlUserFunction::attributes - array() - - The transaction's attributes. + + $_to + \ArangoDBClient\Edge::_to + + + The edge's to (might be NULL for new documents) - - array + + mixed - - $_action - \ArangoDBClient\AqlUserFunction::_action - '' - - The transaction's action. + + $_id + \ArangoDBClient\Document::_id + + + The document id (might be NULL for new documents) - + string - - __construct - \ArangoDBClient\AqlUserFunction::__construct() - - Initialise the AqlUserFunction object - The $attributesArray array can be used to specify the name and code for the user function in form of an array. - -Example: -array( - 'name' => 'myFunctions:myFunction', - 'code' => 'function (){}' -) - - \ArangoDBClient\Connection + + $_key + \ArangoDBClient\Document::_key + + + The document key (might be NULL for new documents) + + + string + + + + + $_rev + \ArangoDBClient\Document::_rev + + + The document revision (might be NULL for new documents) + + + mixed - + + + + $_values + \ArangoDBClient\Document::_values + array() + + The document attributes (names/values) + + array - - \ArangoDBClient\ClientException + + + + $_changed + \ArangoDBClient\Document::_changed + false + + Flag to indicate whether document was changed locally + + + boolean - - $connection - - \ArangoDBClient\Connection - - - $attributesArray - null - array - - - - register - \ArangoDBClient\AqlUserFunction::register() - - Registers the user function - If no parameters ($name,$code) are passed, it will use the properties of the object. - -If $name and/or $code are passed, it will override the object's properties with the passed ones - - null + + + $_isNew + \ArangoDBClient\Document::_isNew + true + + Flag to indicate whether document is a new document (never been saved to the server) + + + boolean - - null + + + + $_doValidate + \ArangoDBClient\Document::_doValidate + false + + Flag to indicate whether validation of document values should be performed +This can be turned on, but has a performance penalty + + + boolean - - \ArangoDBClient\Exception + + + + $_hiddenAttributes + \ArangoDBClient\Document::_hiddenAttributes + array() + + An array, that defines which attributes should be treated as hidden. + + + array - - mixed + + + + $_ignoreHiddenAttributes + \ArangoDBClient\Document::_ignoreHiddenAttributes + false + + Flag to indicate whether hidden attributes should be ignored or included in returned data-sets + + + boolean - - $name - null - null - - - $code - null - null - - - - unregister - \ArangoDBClient\AqlUserFunction::unregister() - - Un-register the user function - If no parameter ($name) is passed, it will use the property of the object. + + + set + \ArangoDBClient\Edge::set() + + Set a document attribute + The key (attribute name) must be a string. -If $name is passed, it will override the object's property with the passed one - - string - - - boolean +This will validate the value of the attribute and might throw an +exception if the value is invalid. + + \ArangoDBClient\ClientException - - \ArangoDBClient\Exception + + string - + mixed + + void + + - $name - null + $key + string - $namespace - false - boolean + $value + + mixed - - getRegisteredUserFunctions - \ArangoDBClient\AqlUserFunction::getRegisteredUserFunctions() - - Get registered user functions - The method can optionally be passed a $namespace parameter to narrow the results down to a specific namespace. - - null - - - \ArangoDBClient\Exception - - + + setFrom + \ArangoDBClient\Edge::setFrom() + + Set the 'from' vertex document-handler + + mixed + + \ArangoDBClient\Edge + - $namespace - null - null + $from + + mixed - - getConnection - \ArangoDBClient\AqlUserFunction::getConnection() - - Return the connection object + + getFrom + \ArangoDBClient\Edge::getFrom() + + Get the 'from' vertex document-handler (if already known) - - \ArangoDBClient\Connection + + mixed - - setName - \ArangoDBClient\AqlUserFunction::setName() - - Set name of the user function. It must have at least one namespace, but also can have sub-namespaces. - correct: -'myNamespace:myFunction' -'myRootNamespace:mySubNamespace:myFunction' - -wrong: -'myFunction' - - string + + setTo + \ArangoDBClient\Edge::setTo() + + Set the 'to' vertex document-handler + + + mixed - - \ArangoDBClient\ClientException + + \ArangoDBClient\Edge - $value + $to - string + mixed - - getName - \ArangoDBClient\AqlUserFunction::getName() - - Get name value + + getTo + \ArangoDBClient\Edge::getTo() + + Get the 'to' vertex document-handler (if already known) - - string + + mixed - - setCode - \ArangoDBClient\AqlUserFunction::setCode() - - Set user function code + + getAllForInsertUpdate + \ArangoDBClient\Edge::getAllForInsertUpdate() + + Get all document attributes for insertion/update - - string - - - \ArangoDBClient\ClientException + + mixed + - - $value - - string - - - getCode - \ArangoDBClient\AqlUserFunction::getCode() - - Get user function code + + __construct + \ArangoDBClient\Document::__construct() + + Constructs an empty document - - string + + array + + $options + null + array + + \ArangoDBClient\Document - - set - \ArangoDBClient\AqlUserFunction::set() - - Set an attribute + + createFromArray + \ArangoDBClient\Document::createFromArray() + + Factory method to construct a new document using the values passed to populate it - - - - \ArangoDBClient\AqlUserFunction - - + \ArangoDBClient\ClientException - + + array + + + array + + + \ArangoDBClient\Document + \ArangoDBClient\Edge + \ArangoDBClient\Graph + - $key + $values - + array - $value - - + $options + array() + array + \ArangoDBClient\Document - - __set - \ArangoDBClient\AqlUserFunction::__set() - - Set an attribute, magic method - This is a magic method that allows the object to be used without -declaring all attributes first. - + + __clone + \ArangoDBClient\Document::__clone() + + Clone a document + Returns the clone + + + void + + + \ArangoDBClient\Document + + + __toString + \ArangoDBClient\Document::__toString() + + Get a string representation of the document. + It will not output hidden attributes. + +Returns the document as JSON-encoded string + + + string + + + \ArangoDBClient\Document + + + toJson + \ArangoDBClient\Document::toJson() + + Returns the document as JSON-encoded string + + + array + + + string + + + + $options + array() + array + + \ArangoDBClient\Document + + + toSerialized + \ArangoDBClient\Document::toSerialized() + + Returns the document as a serialized string + + + array + + + string + + + + $options + array() + array + + \ArangoDBClient\Document + + + filterHiddenAttributes + \ArangoDBClient\Document::filterHiddenAttributes() + + Returns the attributes with the hidden ones removed + + + array + + + array + + + array + + + + $attributes + + array + + + $_hiddenAttributes + array() + array + + \ArangoDBClient\Document + + + set + \ArangoDBClient\Document::set() + + Set a document attribute + The key (attribute name) must be a string. +This will validate the value of the attribute and might throw an +exception if the value is invalid. + \ArangoDBClient\ClientException - - + string - + mixed + + void + $key @@ -350,37 +544,53 @@ declaring all attributes first. mixed + \ArangoDBClient\Document - - get - \ArangoDBClient\AqlUserFunction::get() - - Get an attribute - - + + __set + \ArangoDBClient\Document::__set() + + Set a document attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. +This function is mapped to set() internally. + + \ArangoDBClient\ClientException + + + string - + mixed + + void + $key string + + $value + + mixed + + \ArangoDBClient\Document - - __isset - \ArangoDBClient\AqlUserFunction::__isset() - - Is triggered by calling isset() or empty() on inaccessible properties. + + get + \ArangoDBClient\Document::get() + + Get a document attribute - + string - - boolean + + mixed @@ -388,18 +598,19 @@ declaring all attributes first. string + \ArangoDBClient\Document - + __get - \ArangoDBClient\AqlUserFunction::__get() - - Get an attribute, magic method + \ArangoDBClient\Document::__get() + + Get a document attribute, magic method This function is mapped to get() internally. - - + + string - + mixed @@ -408,1524 +619,1759 @@ declaring all attributes first. string + \ArangoDBClient\Document - - __toString - \ArangoDBClient\AqlUserFunction::__toString() - - Returns the action string + + __isset + \ArangoDBClient\Document::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. - - + string + + boolean + + + $key + + string + + \ArangoDBClient\Document - - buildAttributesFromArray - \ArangoDBClient\AqlUserFunction::buildAttributesFromArray() - - Build the object's attributes from a given array - - - - \ArangoDBClient\ClientException - + + __unset + \ArangoDBClient\Document::__unset() + + Magic method to unset an attribute. + Caution!!! This works only on the first array level. +The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. + + - $options + $key + \ArangoDBClient\Document - - $name - - - - The name of the user function - - - string + + getAll + \ArangoDBClient\Document::getAll() + + Get all document attributes + + + mixed - - - string + + array - - - $code - - - - The code of the user function - - - string - - - - string + + $options + array() + mixed + + \ArangoDBClient\Document + + + getAllForInsertUpdate + \ArangoDBClient\Document::getAllForInsertUpdate() + + Get all document attributes for insertion/update + + + mixed - - - - - - _action - - - string + \ArangoDBClient\Document + + + getAllAsObject + \ArangoDBClient\Document::getAllAsObject() + + Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class + + + mixed - - - string + + mixed - - - eJzFWltz27YSfvevQGc0Iykj2b28ybEb1XUSd1I3x44fOo5HA1GQhJgiWYCUo3by38/uAuAVpOQ2p8cPESUudpe737fYBfPyx2SdHB2dvHhxxF6wqeLRKv75J/b+7XsWhFJE6YRN/wjvtFCvsyhIZRyBHIq+4lm6jhWDv9ew6pH9yndC0Z0gTnZKrtYpu8ivvv/2ux9GLFWSr0Sk2ZvN/O0IbofxKhIj9kaoDY92sPrk6CjiG6ETHojcnQvy5DR3872Kt3IhNINFoG8DN1m8ZBl4OV5aN7X1s+Y9i+efRJC+nKtzuhs1BKRm3ImxdM1T/AVUL1gaW4Ns+p93DBcxt0ofO41XKVNiJXUqlB6xLBrn30DtgoVwTeoUyz1lYDVdCwY/boVyitznB7hjvRFRwBOdhTwVelKXe5mF5jOU56QO44hhwetlkbxCgAdpxkP2iW+5DpRM0qrYiVPYdESJPzKpIAGoJoijSJSDSw8aQBDngslIppKH8k+xQB1PMl0zQA1+xlnqbqOOpVxliqOa4/qjTaNdVcJp18IYUwKQJbaQo/mOfDKO9AEhAgwtNMT9UcAd6YlbogRd9PD2+Bx0XkPkBv3NLs/upLjuD0/dymLBRbyABS56bDD8axdnCnxeiC+nsMLE0xoqG4dQHO5Z9Cy3guf69CpRcSJUumMaohmtWI8QNKbEl8FUQa9/JVqxK+ny4JUzXikyUAYekXCsVgvoppZRgLcY++74B6odQci1bhSsv45QhmoH/r2wbtVQa286mVdbrqBAOSH78wl9JkpugYOsNyu0QHXyWEnBa20eCcDIU3jIeQbsPfZZ40rxXc1QnIJ6wHWvWMvO2P3DQebowmvKRLvNlk0CGOr3m4agaofCVi4ZLcTnihqIiE7Z5fWHm99n19NfL1EJgsejaGoLbqeOi99+Jh0II9RRV3JlC4wWhDB/ua+FAENVCugU426i7wqLq/c6EYFc7op6SqUNEb0E6jYgDc+CNzaId1BEKuvxv/zMN0koJu47CQ3cN2ajxc7OWRvVRyVhCgsJl5n+pe9EhlXrOQgSrvimhG+kbH5Nf+N6cYdw2MjUtJjI0V8jquNGgOx+YOr4gqe87lq6VvGTZh+rjP9oPi4/ByJpEjKbhzIorMxmBCGVBenA/4wj63XD4TMWZWFowmYKBz2XqaklvoNgr8x+JymXbCD1zGS1rn04LOks6Z1nMlxMc9nXKt5M/QoKQ1+OzL8NRtzkDYen5FZCfbVkUcwoiYIWDKjkj6h8DyFCAm5qSPiIyRT27DBEdaTW1m0J5cjWdsO0OtrBRM8R5wQoY3YGn+YYeh8FXV11/y7Zod6BbNNK6JqE9sMaM2jMem+gCy2gy+HF7A8i/wESa1o524IsuQxzKuR6oBPJVMQ28jMWEJWJxronrpnOgkBovczC404cu97R5MVic2SD2ILUykZh8VX85iqogyopbqCykL835egBdeFVGX9VRQYzHYqoVD0Y3iz8inrQUybAXFG4XqLc+DyJdTqoWLhToZ5M7m7ezaAnn93dXt7MXt9dX3y4+u165GPaCps1p3AwHJ9/0nE0g8YaXJo9KZ4kGO3C7WGuZHha+GmznLtLen/RqPG0jZZ3xSjwXGLmaYJJZA8hdwfS0aOpk4A7H/387LOdnJeA8zgOBeyMvXzIO4yIVR6iFziCCOgSkIaNMuBlYUG6fPzgLpNbHoKQ3dIrv8FCeFLDWoEDixud9u1BWdTG3mLAPQP3Qy3qHEY+Uak6O7O0axDLaixQTTPL0M+qTIEqpMpbEUIyJxPab+D7oIs+7J6sPJSBn5cM8r/hVcMQ8ilavMfca7SHEqC4v1JxllDfgtl5aPF7TzVYiBDYQTr/KTnfiGJsB8hU53NP92jGSuoWY4IlD8MdtkeWHLyc5YLH0EJF0BkAng3OYJZPNVvET9RdcdtuAoryxY3uvb7DfTUSHbiX/cssgtTd5Hkpd/Z6UOGRdyv8u7gv4zHn4jeOi/8Q+rkKgn+h8aHR2x3CAYhPgwA97KpRvpUB7sEkgBXWo/x938Cx/9BoUh2hqmI+b8uSrVy7MULeo6MWCJZ6+MZYUllYH2XLOCrv+zWkOL8bAW59iFtAceuZyDGeAm4yINaabwHmKYNND74hBfJ8j9gcuRPqmMoISepsPs4F8kMCeFqlwJ98ZITB8NpJlQfD0v2bOE7LMrfZvGuJW/mk4mhVttMi6N/ye0T2/8E8587kjIGW4QyhrEW4nEyK04cRGxjfhta57i2AMup9CIsQ+6Clzqa1bJkNuRNoK4/HhYMexFVnad8c86/lg448n5UPPMl5Zj72P+/z80KOPy8v6Hm7o7d0CF0c7vlT0nsUu/pPXUgjV+o5e2aOBmh0xPxZwvr/jdQzEzoSbVR+0zZE4qluedC/ikCrXBSPzUBBv6WRq0+h92iNRkFyzdO84YqDIz5iG76CZzddWaNdg1kHX+pUhMybHejaMKzFwFM65HLtjdOzEEHICWWwqnSUy5ZS6cag1Z2xXIpc6uYwRIrhaVwRaM9cZXo0G04QNp94RlmHZduB2T64aAhHsGYGJzWYBFzju5hqIWOTikwJB7VqftqQmyvBH0+7TdC5cJeJcoE6yMRCLDl0Nl06qxHaqzU/osOPWmnbXzHKABjnzUbrokq37hBQXjBi13fv3iHvCygBL6I4xVqxr2yaxHtqiO0h/RRv7SX94t7qYZdgE962N15pfLW8WtHwNsdT/DDE2BnfhjiSiE2S7vASz6A5zTByHpYPMltGrb+XBnfQYb5qMz6BGzTvwyYICIBvNvbDzuDPZjbEXzMB6E9XtMnPtnDX8bu//hbn//jSHiYjeruyouTICIY7GqAbGTiwPP6f2TGbtfGj2VaQ1J7RSJeG4+qbuu7AVHshOyhlMDpEqVdb29Ok8a3pCfaMSbw6ItWe5SectatnieVNU8Ub2JJXciuiyovPeo9kjlcaJ3xfoYltf+libXaQzUrc1ze9Jt/qe177ytaj9Q6buAt22TSbYPvK5l4Ftukt+gy6O64HtfepkwndHLH+R/d/eVwK5h9rstgM/hflbKUS - - - - ArangoDB PHP client: batchpart - - - - - - - - BatchPart - \ArangoDBClient\BatchPart - - Provides batch part functionality - <br> - - - - - $_cursorOptions - \ArangoDBClient\BatchPart::_cursorOptions - array() - - An array of BatchPartCursor options + + $options + array() + mixed + + \ArangoDBClient\Document + + + setHiddenAttributes + \ArangoDBClient\Document::setHiddenAttributes() + + Set the hidden attributes +$cursor - + array + + void + - - - $_id - \ArangoDBClient\BatchPart::_id - - - An array of BatchPartCursor options - - - array - - - - - $_type - \ArangoDBClient\BatchPart::_type - - - An array of BatchPartCursor options - - - array - - - - - $_request - \ArangoDBClient\BatchPart::_request - array() - - An array of BatchPartCursor options + + $attributes + + array + + \ArangoDBClient\Document + + + getHiddenAttributes + \ArangoDBClient\Document::getHiddenAttributes() + + Get the hidden attributes - + array - - - $_response - \ArangoDBClient\BatchPart::_response - array() - - An array of BatchPartCursor options - - - \ArangoDBClient\HttpResponse - - - - - $_batch - \ArangoDBClient\BatchPart::_batch - - - The batch that this instance is part of - - - \ArangoDBClient\Batch - - - - - $_documentClass - \ArangoDBClient\BatchPart::_documentClass - '\ArangoDBClient\Document' - + \ArangoDBClient\Document + + + isIgnoreHiddenAttributes + \ArangoDBClient\Document::isIgnoreHiddenAttributes() + - - string - - - - - __construct - \ArangoDBClient\BatchPart::__construct() - - Constructor - - - \ArangoDBClient\Batch - - - mixed - - - mixed - - - mixed - - - mixed - - - mixed + + boolean - - $batch - - \ArangoDBClient\Batch - - - $id - - mixed - - - $type - - mixed - - - $request - - mixed - - - $response - - mixed - - - $options - - mixed - + \ArangoDBClient\Document - - setBatch - \ArangoDBClient\BatchPart::setBatch() - - Sets the id for the current batch part. + + setIgnoreHiddenAttributes + \ArangoDBClient\Document::setIgnoreHiddenAttributes() + + - - \ArangoDBClient\Batch - - - \ArangoDBClient\BatchPart + + boolean - $batch + $ignoreHiddenAttributes - \ArangoDBClient\Batch + boolean + \ArangoDBClient\Document - - setId - \ArangoDBClient\BatchPart::setId() - - Sets the id for the current batch part. + + setChanged + \ArangoDBClient\Document::setChanged() + + Set the changed flag - - mixed + + boolean - - \ArangoDBClient\BatchPart + + boolean - $id + $value - mixed + boolean + \ArangoDBClient\Document - - getId - \ArangoDBClient\BatchPart::getId() - - Gets the id for the current batch part. + + getChanged + \ArangoDBClient\Document::getChanged() + + Get the changed flag - - mixed + + boolean + \ArangoDBClient\Document - - setType - \ArangoDBClient\BatchPart::setType() - - Sets the type for the current batch part. + + setIsNew + \ArangoDBClient\Document::setIsNew() + + Set the isNew flag - - mixed + + boolean - - \ArangoDBClient\BatchPart + + void - $type + $isNew - mixed + boolean + \ArangoDBClient\Document - - getType - \ArangoDBClient\BatchPart::getType() - - Gets the type for the current batch part. + + getIsNew + \ArangoDBClient\Document::getIsNew() + + Get the isNew flag - - mixed + + boolean + \ArangoDBClient\Document - - setRequest - \ArangoDBClient\BatchPart::setRequest() - - Sets the request for the current batch part. - - - mixed + + setInternalId + \ArangoDBClient\Document::setInternalId() + + Set the internal document id + This will throw if the id of an existing document gets updated to some other id + + \ArangoDBClient\ClientException - - \ArangoDBClient\BatchPart + + string + + + void - $request + $id - mixed + string + \ArangoDBClient\Document - - getRequest - \ArangoDBClient\BatchPart::getRequest() - - Gets the request for the current batch part. - - - array + + setInternalKey + \ArangoDBClient\Document::setInternalKey() + + Set the internal document key + This will throw if the key of an existing document gets updated to some other key + + \ArangoDBClient\ClientException - - - - setResponse - \ArangoDBClient\BatchPart::setResponse() - - Sets the response for the current batch part. - - - mixed + + string - - \ArangoDBClient\BatchPart + + void - $response + $key - mixed + string + \ArangoDBClient\Document - - getResponse - \ArangoDBClient\BatchPart::getResponse() - - Gets the response for the current batch part. - - - \ArangoDBClient\HttpResponse + + getInternalId + \ArangoDBClient\Document::getInternalId() + + Get the internal document id (if already known) + Document ids are generated on the server only. Document ids consist of collection id and +document id, in the format collectionId/documentId + + string + \ArangoDBClient\Document - - getHttpCode - \ArangoDBClient\BatchPart::getHttpCode() - - Gets the HttpCode for the current batch part. + + getInternalKey + \ArangoDBClient\Document::getInternalKey() + + Get the internal document key (if already known) - - integer + + string + \ArangoDBClient\Document - - getProcessedResponse - \ArangoDBClient\BatchPart::getProcessedResponse() - - Get the batch part identified by the array key (0. - ..n) or its id (if it was set with nextBatchPartId($id) ) - - \ArangoDBClient\ClientException + + getHandle + \ArangoDBClient\Document::getHandle() + + Convenience function to get the document handle (if already known) - is an alias to getInternalId() + Document handles are generated on the server only. Document handles consist of collection id and +document id, in the format collectionId/documentId + + string + + + \ArangoDBClient\Document + + + getId + \ArangoDBClient\Document::getId() + + Get the document id (or document handle) if already known. + It is a string and consists of the collection's name and the document key (_key attribute) separated by /. +Example: (collectionname/documentId) + +The document handle is stored in a document's _id attribute. + + mixed - + + \ArangoDBClient\Document + + + getKey + \ArangoDBClient\Document::getKey() + + Get the document key (if already known). + Alias function for getInternalKey() + mixed + \ArangoDBClient\Document - - getCursorOptions - \ArangoDBClient\BatchPart::getCursorOptions() - - Return an array of cursor options + + getCollectionId + \ArangoDBClient\Document::getCollectionId() + + Get the collection id (if already known) + Collection ids are generated on the server only. Collection ids are numeric but might be +bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used + + mixed + + + \ArangoDBClient\Document + + + setRevision + \ArangoDBClient\Document::setRevision() + + Set the document revision + Revision ids are generated on the server only. + +Document ids are strings, even if they look "numeric" +To reliably store a document id elsewhere, a PHP string must be used + + mixed + + + void + + + + $rev + + mixed + + \ArangoDBClient\Document + + + getRevision + \ArangoDBClient\Document::getRevision() + + Get the document revision (if already known) - - array + + mixed + \ArangoDBClient\Document - - setDocumentClass - \ArangoDBClient\BatchPart::setDocumentClass() - - Sets the document class to use + + jsonSerialize + \ArangoDBClient\Document::jsonSerialize() + + Get all document attributes +Alias function for getAll() - it's necessary for implementing JsonSerializable interface - - string + + mixed - - \ArangoDBClient\BatchPart + + array - $class - - string + $options + array() + mixed + \ArangoDBClient\Document - eJzdWm1z0zgQ/p5foZvJTBwmpMfXlnBAGqA3A3TafOAuZDKKrSSijp2T5JYc9L/f6jV+d5NwwJAPgOXV7rP77Eormad/bFabVuvk0aMWeoReMBwt4/OX6PLNJfJDSiJxiuZY+KsNZgIkpNDzDfZv8JI46aESVK9wIlYxQ+gVvLpBb/GWMDXOaeQThNCT/hOt5aTVivCacNCVV3Tm4Fyy+JYGhGsISGJAiyTyBY0jHFKxNYieztmzPDhUBs/CsEAARcsPMefopbRwKZ38AmNSQmGQPwhLhDBjeIvixU5wmDAOrsYbiYYbUTvj+S1mZk57NrdTrNSJ+nvD6C0WBAR8peq91oQGaDI9+/4gaPADjIrthvwAs4z8kxAuvnGo3wixuYKUhtfaiP5nJQYjWQFivCIm78UKC/iDckQjLrBMYfi3qoZ4UQZEYbZxqDCv3pWYHQImwRJfxCyvGizitVWuocFPOJzx/BPxRS+FV2GckzCOlhyJOKdpTT+TALVpgPRPegwPEPSdTqmhj8ZvEy4VoSSiwBzCUYDuaChHNlC9oEXEahIn7JYwiJN68uNIQOk/BqUrggPCygHIJHQA1IOBYNIE7KvgSxdQQLmg0TKhfKVkArpYEAZWrLTWAAhiBhblFEZEwiJAwxjEBx55EgreLwdjtSgw9gEYAZtVE0we6QnmoW6GSWFkchmHPZvVKKQ3MBdHVNB/iWHSx1Ex0AbZiTO4Ak5CwvrZpDnR+bVJ5iH13dqNZjPfppmnM6kn86Cnuei5KPR27vUc7q5S+aVlsga1LV6opAUOOSwo7pVzdaArerYmbEk8Oy4NArWPny2JqW+zCHvd7lnLqaEL5FHwXriJk84siP1kDbwP5f7RmXa7KUjKttYMs87TknUqdsDvd8bJZ8GwL1KYRx/GV7OLV7PRh4vr8XVq1s6kKlIT2lKBi8CDgJe+GgMFniKi9PWVpsazHFUIadY8x19RLLvtTXT8T09H78ZXf82uX7y7GF/8PZoCc45greK+uGhdE8FVWkKlL2CRVsWfMFWWqXWkeUHLS5jS3XUHNq3Lsjof93yeGrc1oIGxmEozY0zJ/T+uuhX3WD9N+lR4CNAG0sq+vr0+zDejWzlXC3ypgOdRp6Ep8M2xV0v8odGXk4+Nf6pGKzhQEAfa2sE87OvnPkwoFxq40OCb2LC75KGEmPnHclJYGCuY2TWfVvJgfg7w3BhQu2ETRdajBpacF81EmWbhcKYyLfURVBW2p0qyXJfuZI+ga3//jYX02aKZNuNdI2/Wnybg0vowDg4BTqN6NgCv1d6AN+OZetxNrHMhd5qAzQWQ0wWFhJpv1Ut92LshW+T93u/3oy707oiC77APedD8UYHuMJeJA6cOsUIR9GQu18xWiLr5AIgVi+840tcPo88+UY1O6VqJ2hulqSlSlyz2iWzDKyluZ5tKtQNotjPjqRRup1O8JNK7vo2D8xBEL70657teH4OizoIyLjqnmTfK1icOjqR/qbJSdv8EgbRN+5Mt+G+mB5dKJh3CWMygaUZfv6LsEBoMzEkgj87hcOeCNJCqo0ARTVoH9PGUvyN30m7+/JGRd3FO28zScnrqMwLn81csXr+QSWmdtVKdaeocVLRzjwjYr3K6DEAF4PvCyByA3ZyVcA3xcugewviDKT+WpH0IOoKcWkIqo9YYsh9UGO4yZmDmFoKgz2cX59OmNDdHgLzAfqlFgiX5xdJqBC5901yqjdHPkkfa6++fPPwXy55JSeigKyNY7cwu1G/0dZyN+Oj89eh6iqCJaQdY4ErarMXJtDpRpYL6XWgvkvw4DInqcGqZejBBqRQaOtUV9bZPlT0A589Sa2m/v2PF6fu8XHT0KxyGpePzbVkwCzV2YIkVKqzGVPaCuHA5iwbPyjvp+oYsHd6I3CEN3stcBWqv4ijSlHndXmkaHbY3MLKOb+t30EMqa1KaTMZaoKOl09gOTXvlU+gygtUrM8UOTQszSpK4xHP5ywwEZIGTUBSDoI5ompjsKc3rDOMkDFAUC5gtCFvTKHV+l0uguhzrd5rJuC9eFzSevK/MLU3qQ6Rf+/0xfa2DHu9mZcWzHwHTJ8tcVdVfHGQu7p0PORfUl0j9GQrZLyBIf2wXMUoK30VjAfkvj8KFE2znY/ZT/kerrnNWfdcU1Jh0EPXlkgHZ1pJ1WPe/acp9+1E6q+6aCid3Xx/Vy1iwUb83/4FhhkOKuedwwYYnh3sQPPAOL0nEbRTnH52UzN7/AAi5Sy0= + eJy1V2FvGjkQ/c6vmEhIkAhK2o+k9NJrSJq211QpjVQlUWR2B/DF2CvbS0DX/Pcbe70bsrCBq45VpMB6/Oa9mfF4ePtHMklqtc7BQQ0O4L1mcqxO/oRvH79BJDhK2wXD5VggxCpKp/SC7JzpccKiezZGgGLXB7/BL7LUTpSmNfjEJHy3iFMmpV+KVLLQfDyx8KH49Obw9ZsWWM0JUBo4mw4/tmhZqLHEFpyhpt0L2t2p1SSboiHfWHJ7VIi4YiJFUMO/MbKgMdFoaJ1EAMu1REoIWuVKtofMYAwYj1cUvh3qd1uJJdDILQG8fnXoWUaCGQN9B4pzizI2cJKD/1Nzlp6rew5gMEHvv2FgpNUUmlMfkyHC1x9fvsCI4ijxoWBn9sPGfP/xjGmY8jnG4U3H/0+0sqSRxNXvHC4FqNqxVbtwa9Wq0zwO4EkBlzHOCwD/IVLSWOh/HVz+vDu9vPgLetDwxo1VtEuccUNpBPJVwipDDS48kFUOpozzHS1VR64VmKVaHKYWS5pdxO5xAc3CAFw97sM0NT50VGG0IMevVjZyAw9cCJgxwWNGGy1hzbJSHfkvT5hMxpBlw060eqDvOQ7OI0xc3QIfLSEQOJceuez42CMYyMq1n28vWyVMs2ngDnUnEaANz1WWjH3qAeoZg3Zg4sqmKnrHGm2qJcwUL9VMOhQ8glEq/ZkEg7bpSLQCelZ62cFxD2lv1i2FtP3uLlZXIaL7SxY+vZ11wU7oZOYlGx7fMAKK0t1uvqsZvB8V1o+15xyI4/XhLfR6rrIaZQK5iV83KEbdblaK5ydlU/cERST+XFrUkonz+InCinkWzKNn7x9r2xH43P+5HYPPuNgRhcv+1csU8qO9I/+us7xM4JRazo6cDy5edj1Q/9nxGgrO/V5+TqIJ3VsYr6vRPW78iQuW3rG5dsRv9+HXL1i3AHskKXBcI4XOHkFCcAojwcZVcnNm1J2tTnELXQTuOqShw7p0smtl3Gd0c7IZ/OP6G8BhNfxNAzPUFufFjdAmjrFAvb5vZq2w7i+0dnaJZ/srGqAfDNrZ0JHNKZvaYVaLDrncC3O13msvI7FUNMGjtyq0l6SfbSUdmlQrTGhk8QLupXqQKxNBcJaFo10VvPUix0FkWd+ygCCzSkeRQrrjfyuBNEO03Sj0PyfPnWarqhJH/nrO9e8m7QWxu08ZSduQMCesWgGjiWh16jJ+jODSkCxy1EkTdx1voE73uoo4s3xGA5TWbOHmqgr8TtYbNql7L8Sp0ueexw/PYUVtnd4yKJ4ezRfa/WrqVmx/am/LQ4w/vK6jylSIcj/1Lq7DCOw72cpZyAK8DpmqaxMuFdCtp15O2VLalhPrthU5pT//Y+eOZiZmmu5wdLv+TQsaN/kvupvwq2l44wwaFIV/AaDf7i0= - + - ArangoDB PHP client: user document handler + ArangoDB PHP client: transaction - + - - \ArangoDBClient\Handler - UserHandler - \ArangoDBClient\UserHandler - - A handler that manages users - . -A user-document handler that fetches vertices from the server and -persists them on the server. It does so by issuing the -appropriate HTTP requests to the server. - - - + + \ArangoDBClient\TransactionBase + Transaction + \ArangoDBClient\Transaction + + Transaction object + A transaction is an object that is used to prepare and send a transaction +to the server. + +The object encapsulates:<br /> +<ul> +<li> the collections definitions for locking +<li> the actual javascript function +<li> additional options like waitForSync, lockTimeout and params +</ul> + +The transaction object requires the connection object and can be initialized +with or without initial transaction configuration. +Any configuration can be set and retrieved by the object's methods like this:<br /> + +<pre> +$this->setAction('function (){your code};'); +$this->setCollections(array('read' => 'my_read_collection, 'write' => array('col_1', 'col2'))); +</pre> +<br /> +or like this: +<pre> +$this->action('function (){your code};'); +$this->collections(array('read' => 'my_read_collection, 'write' => array('col_1', 'col2'))); +</pre> +<br /> +There are also helper functions to set collections directly, based on their locking: +<pre> +$this->setReadCollections($array or $string if single collection) +$this->setWriteCollections($array or $string if single collection) +$this->setExclusiveCollections($array or $string if single collection) +</pre> +<br /> + + + + + ENTRY_ACTION + \ArangoDBClient\Transaction::ENTRY_ACTION + 'action' + + Action index + + + + + ENTRY_PARAMS + \ArangoDBClient\Transaction::ENTRY_PARAMS + 'params' + + Params index + + + + + ENTRY_COLLECTIONS + \ArangoDBClient\TransactionBase::ENTRY_COLLECTIONS + 'collections' + + Collections index + + + + + ENTRY_WAIT_FOR_SYNC + \ArangoDBClient\TransactionBase::ENTRY_WAIT_FOR_SYNC + 'waitForSync' + + WaitForSync index + + + + + ENTRY_LOCK_TIMEOUT + \ArangoDBClient\TransactionBase::ENTRY_LOCK_TIMEOUT + 'lockTimeout' + + Lock timeout index + + + + + ENTRY_READ + \ArangoDBClient\TransactionBase::ENTRY_READ + 'read' + + Read index + + + + + ENTRY_WRITE + \ArangoDBClient\TransactionBase::ENTRY_WRITE + 'write' + + WRITE index + + + + + ENTRY_EXCLUSIVE + \ArangoDBClient\TransactionBase::ENTRY_EXCLUSIVE + 'exclusive' + + EXCLUSIVE index + + + + + $_action + \ArangoDBClient\Transaction::_action + + + + + + + $_connection - \ArangoDBClient\Handler::_connection + \ArangoDBClient\TransactionBase::_connection - Connection object + The connection object - + \ArangoDBClient\Connection - - $_documentClass - \ArangoDBClient\Handler::_documentClass - '\ArangoDBClient\Document' - - + + $attributes + \ArangoDBClient\TransactionBase::attributes + array() + + The transaction's attributes. - - string + + array - - addUser - \ArangoDBClient\UserHandler::addUser() - - save a user to the user-collection - This will save the user to the users collection. It will additionally grant the user permissions -for the current database + + __construct + \ArangoDBClient\Transaction::__construct() + + Initialise the transaction object + The $transaction array can be used to specify the collections, action and further +options for the transaction in form of an array. -This will throw if the user cannot be saved - - \ArangoDBClient\Exception - - - string - - - mixed - - - mixed +Example: +array( + 'collections' => array( + 'write' => array( + 'my_collection' + ) + ), + 'action' => 'function (){}', + 'waitForSync' => true +) + + \ArangoDBClient\Connection - + array - - boolean + + \ArangoDBClient\ClientException - + - $username + $connection - string - - - $passwd - null - mixed - - - $active - null - mixed + \ArangoDBClient\Connection - $extra + $transactionArray null array - - replaceUser - \ArangoDBClient\UserHandler::replaceUser() - - Replace an existing user, identified by its username - This will replace the user-document on the server - -This will throw if the document cannot be replaced - + + execute + \ArangoDBClient\Transaction::execute() + + Execute the transaction + This will post the query to the server and return the results as +a Cursor. The cursor can then be used to iterate the results. + \ArangoDBClient\Exception - - string - - + mixed - - mixed - - - array - - - boolean - - - $username - - string - - - $passwd - null - mixed - - - $active - null - mixed - - - $extra - null - array - - - updateUser - \ArangoDBClient\UserHandler::updateUser() - - Update an existing user, identified by the username - This will update the user-document on the server - -This will throw if the document cannot be updated - - \ArangoDBClient\Exception - - + + setAction + \ArangoDBClient\Transaction::setAction() + + set action value + + string - - mixed - - - mixed - - - array - - - boolean + + \ArangoDBClient\ClientException - $username + $value string - - $passwd - null - mixed - - - $active - null - mixed - - - $extra - null - array - - - get - \ArangoDBClient\UserHandler::get() - - Get a single user-document, identified by the username - This will throw if the document cannot be fetched from the server - - \ArangoDBClient\Exception - - + + getAction + \ArangoDBClient\Transaction::getAction() + + get action value + + string - - \ArangoDBClient\User - - - $username - - string - - removeUser - \ArangoDBClient\UserHandler::removeUser() + setParams + \ArangoDBClient\Transaction::setParams() - Remove a user, identified by the username + Set params value - - \ArangoDBClient\Exception - - - string + + array - - boolean + + \ArangoDBClient\ClientException - $username + $value - string + array + + getParams + \ArangoDBClient\Transaction::getParams() + + Get params value + + + array + + + - grantPermissions - \ArangoDBClient\UserHandler::grantPermissions() + set + \ArangoDBClient\Transaction::set() - Grant R/W permissions to a user, for a specific database + Sets an attribute - - \ArangoDBClient\Exception - - - string - - - string - - - boolean + + + + \ArangoDBClient\ClientException - + - $username + $key - string + - $databaseName + $value - string + - - grantDatabasePermissions - \ArangoDBClient\UserHandler::grantDatabasePermissions() - - Grant R/W permissions to a user, for a specific database - - - string + + __set + \ArangoDBClient\Transaction::__set() + + Set an attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. + + \ArangoDBClient\ClientException - + + string - - string + + mixed - - boolean + + void + - $username + $key string - $databaseName + $value - string - - - $permissions - 'rw' - string + mixed - - revokePermissions - \ArangoDBClient\UserHandler::revokePermissions() - - Revoke R/W permissions for a user, for a specific database - - - \ArangoDBClient\Exception - - - string - - + + __get + \ArangoDBClient\Transaction::__get() + + Get an attribute, magic method + This function is mapped to get() internally. + + string - - boolean + + mixed - + - $username - - string - - - $databaseName + $key string - - revokeDatabasePermissions - \ArangoDBClient\UserHandler::revokeDatabasePermissions() - - Revoke R/W permissions for a user, for a specific database + + __isset + \ArangoDBClient\Transaction::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. - - \ArangoDBClient\Exception - - - string - - + string - + boolean + - $username - - string - - - $databaseName + $key string - - grantCollectionPermissions - \ArangoDBClient\UserHandler::grantCollectionPermissions() - - Grant R/W permissions to a user, for a specific collection + + __toString + \ArangoDBClient\Transaction::__toString() + + Returns the action string - + + string - - string - - - string - - - string - - - boolean + + + + buildTransactionAttributesFromArray + \ArangoDBClient\Transaction::buildTransactionAttributesFromArray() + + Build the object's attributes from a given array + + + + \ArangoDBClient\ClientException + - $username - - string - - - $databaseName - - string - - - $collectionName + $options - string - - - $permissions - 'rw' - string + - - revokeCollectionPermissions - \ArangoDBClient\UserHandler::revokeCollectionPermissions() - - Revoke R/W permissions for a user, for a specific database + + __construct + \ArangoDBClient\TransactionBase::__construct() + + Initialise the transaction object - - \ArangoDBClient\Exception - - - string - - - string - - - string + + \ArangoDBClient\Connection - - boolean + + \ArangoDBClient\ClientException - $username - - string - - - $databaseName - - string - - - $collectionName + $connection - string + \ArangoDBClient\Connection + \ArangoDBClient\TransactionBase - - getDatabases - \ArangoDBClient\UserHandler::getDatabases() - - Gets the list of databases a user has access to + + getConnection + \ArangoDBClient\TransactionBase::getConnection() + + Return the connection object - - \ArangoDBClient\Exception - - - string + + \ArangoDBClient\Connection - + + \ArangoDBClient\TransactionBase + + + setCollections + \ArangoDBClient\TransactionBase::setCollections() + + Set the collections array. + The array should have 2 sub-arrays, namely 'read' and 'write' which should hold the respective collections +for the transaction + array - $username + $value - string + array + \ArangoDBClient\TransactionBase - - getDatabasePermissionLevel - \ArangoDBClient\UserHandler::getDatabasePermissionLevel() - - Gets the list of collections a user has access to - - - string + + getCollections + \ArangoDBClient\TransactionBase::getCollections() + + Get collections array + This holds the read and write collections of the transaction + + array - - string + + \ArangoDBClient\TransactionBase + + + setWaitForSync + \ArangoDBClient\TransactionBase::setWaitForSync() + + set waitForSync value + + + boolean - - string + + \ArangoDBClient\ClientException - $username - - string - - - $databaseName + $value - string + boolean + \ArangoDBClient\TransactionBase - - getCollectionPermissionLevel - \ArangoDBClient\UserHandler::getCollectionPermissionLevel() - - Gets the list of collections a user has access to + + getWaitForSync + \ArangoDBClient\TransactionBase::getWaitForSync() + + get waitForSync value - - string - - - string - - - string - - - string + + boolean - - $username - - string - - - $databaseName - - string - - - $collectionName - - string - + \ArangoDBClient\TransactionBase - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler + + setLockTimeout + \ArangoDBClient\TransactionBase::setLockTimeout() + + Set lockTimeout value - - \ArangoDBClient\Connection + + integer + + + \ArangoDBClient\ClientException - $connection + $value - \ArangoDBClient\Connection + integer - \ArangoDBClient\Handler + \ArangoDBClient\TransactionBase - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object + + getLockTimeout + \ArangoDBClient\TransactionBase::getLockTimeout() + + Get lockTimeout value - - \ArangoDBClient\Connection + + integer - \ArangoDBClient\Handler + \ArangoDBClient\TransactionBase - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection + + setReadCollections + \ArangoDBClient\TransactionBase::setReadCollections() + + Convenience function to directly set read-collections without having to access +them from the collections attribute. - - - mixed - - - \ArangoDBClient\ClientException + + array - $optionName + $value - + array - \ArangoDBClient\Handler + \ArangoDBClient\TransactionBase - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - + + getReadCollections + \ArangoDBClient\TransactionBase::getReadCollections() + + Convenience function to directly get read-collections without having to access +them from the collections attribute. + + array - - string - - - \ArangoDBClient\ClientException + + \ArangoDBClient\TransactionBase + + + setWriteCollections + \ArangoDBClient\TransactionBase::setWriteCollections() + + Convenience function to directly set write-collections without having to access +them from the collections attribute. + + + array - $body + $value array - \ArangoDBClient\Handler + \ArangoDBClient\TransactionBase - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - + + getWriteCollections + \ArangoDBClient\TransactionBase::getWriteCollections() + + Convenience function to directly get write-collections without having to access +them from the collections attribute. + + array - + + \ArangoDBClient\TransactionBase + + + setExclusiveCollections + \ArangoDBClient\TransactionBase::setExclusiveCollections() + + Convenience function to directly set exclusive-collections without having to access +them from the collections attribute. + + array - + + + $value + + array + + \ArangoDBClient\TransactionBase + + + getExclusiveCollections + \ArangoDBClient\TransactionBase::getExclusiveCollections() + + Convenience function to directly get exclusive-collections without having to access +them from the collections attribute. + + array - - array + + \ArangoDBClient\TransactionBase + + + set + \ArangoDBClient\TransactionBase::set() + + Sets an attribute + + + + + \ArangoDBClient\ClientException - $options + $key - array + - $body + $value - array + + \ArangoDBClient\TransactionBase + + + __set + \ArangoDBClient\TransactionBase::__set() + + Set an attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. + + \ArangoDBClient\ClientException + + + + string + + + mixed + + + void + + - $includeArray - array() - array + $key + + string - \ArangoDBClient\Handler + + $value + + mixed + + \ArangoDBClient\TransactionBase - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name + + get + \ArangoDBClient\TransactionBase::get() + + Get an attribute - - \ArangoDBClient\ClientException + + string - + mixed - + + + $key + + string + + \ArangoDBClient\TransactionBase + + + __get + \ArangoDBClient\TransactionBase::__get() + + Get an attribute, magic method + This function is mapped to get() internally. + + string + + mixed + - $value + $key - mixed + string - \ArangoDBClient\Handler + \ArangoDBClient\TransactionBase - - setDocumentClass - \ArangoDBClient\Handler::setDocumentClass() - - Sets the document class to use + + __isset + \ArangoDBClient\TransactionBase::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. - + string - - \ArangoDBClient\Handler + + boolean - $class + $key string - \ArangoDBClient\Handler + \ArangoDBClient\TransactionBase + + + buildTransactionAttributesFromArray + \ArangoDBClient\TransactionBase::buildTransactionAttributesFromArray() + + Build the object's attributes from a given array + + + + \ArangoDBClient\ClientException + + + + $options + + + + \ArangoDBClient\TransactionBase + + $collection + + + - The collections array that includes both read and write collection definitions + + + array + + + + array + + + + + $readCollection + + + - The read-collections array or string (if only one) + + + mixed + + + + mixed + + + + + $writeCollection + + + - The write-collections array or string (if only one) + + + mixed + + + + mixed + + + + + $action + + + - The action to pass to the server + + + string + + + + string + + + + + $waitForSync + + + - WaitForSync on the transaction + + + boolean + + + + boolean + + + + + $lockTimeout + + + - LockTimeout on the transaction + + + integer + + + + integer + + + - eJztWm1v2zYQ/u5fcQMC2A6cBNtHd+7a9S0duiLIGuxDUqS0dLa10qJGUnGMIv99R1LvsvyWuHXXCAVqiXfHe3n4HMXo19+iSdRqnRwetuAQnksWjsXL3+Hs9Aw8HmCo+xArlOALL57SLUxY6HOUJG0UnkXM+8zGCJDpvrBqdpDFeiIkjcFrGvwMf7K51YRnKgg9owTw8/Ev9OSk1QrZFBWZw4qlJ7l36eSgJ0zDlIU0s7L+KTN+7ITM/VHVX6cyQu1NSOUGpQ48+jGSYkpDCKRDD4GEjZGILAZKKzM0BREWRI7hraZskK4SMJxDoFQchGMjYTRZFEkRyYBphNMPH85A4r8xWlOiaGWt/NWz5HGmFFyQkdMkLrzVGPoKkvvWl1bLKNiUmesQFLtBYK6MiRM2RZ7gHD0diDCRTBU+TAIFs4Bzp5oqFJUV5No2I1ac+X5gnjDO5zCmeHSuTCmdUq5oVKXzjIS0414spSmVzzQbMoWN7uiJFDMIRrlVj4Wh0DBE66pf0XxmFRS8uvUwWhAoZV+yKSgtTQUPjEWDQjiiORHsT1GYjClKoxM+dl7RP0Ih+S3k/LhidRrcog9wEFHFZvQjseqSYZ4J6ZdNvh1BKPIxMq4i9IJRgH7PeoHTSM9Td21Ghtag3zQ3owLdoJ2bhSAiVxwYcTZ2CyKdgBI8QZpC5tHS9E49cUyXvUlr4uOIxVxbcMgYq54wKdmcPCGYSgY1T9zwLNAT+jkMSEbOwckaNAAbijgH0XG1fhJ1LEMYCsGRzB5ZF3oGIQ4dIuZ+FRzpsrJLyj45sf9H8ZAHHozi0KLagNmss04Gi15WywGEMee9LL/ZvfPc3Xat1S9uDrqsnZcpLaUXyeLMLuhO98li2aOnNhgjm/nSKJp5mPjaKJi5ngTRKJhUbpBEV5CzFapeg6r+GPVzzk10uaaBjx15IcLQsUinS84LpTsXkqt+/+L83fXFX6/Oe6nwP0qE1xh6wsfrmSSaNaUxHnSLljXBJ0+5uU5OyrSkUNcICYJwIRGpkqXUa8NrZ7lyCSANgdGDl4nNTrdQ5zsiMOpI0LnKKIrS3C2EcJfHloDdQNxZuKtR/TlG3HRQWgt4Sw3M8ITxjpaET4HZxWublnZt03jdyLYyMZY1jKynlhriemyd6eaMndj/eqTdI5ITbZUEY8BLro6F7d6i6NEju+8buxvDfMbmKmH4GsAk2pAI91IKuZTYkyrvC7nvM2PnE0he0yNF4upT5MSk/f4wDrhP9zX+vsxy/LFosakFxLpjZtuQ9xdxY5UcLyLf7MpXcWMKx6XcGDtbu6JGZ36PmDFx6JEY/8/E6Iq8L7zYTHcUWMdMBj8NMtbsVrZ9a5PsXYNZN+kKs80+Npm1yVphNU1olb4Le0FLyDvhX7MfXYOBF3eMjTn5De3GiQloYfMKk25Fy6t41Z3/+NVjnwfj2exngeAaFq9Bv3lhrXWQ5T4uXrmU/3zJ1tdg2rzvBRiJKqLXHYv25tccC53Su54ltEGub8X+UEajKOa4UZHkZfs6UO9x1obBUxgxrvBjHVUmff2+J5EY6zVl6rlhVLcx6GXGuo24O8epyE7FNoDaw0KjV+rHtjMFKum4PnJcsAXY2Z7Y5KNM/VUc0Zu0XWkRVdJA0pwBTokvgmHAA2rQ6XGe4D5EgszPwWaDwkhbGNiNAT2zdS6W9f6EVjNgmCr0z+x0xk5Cam7+NajQVaAG6LVozZ59np/8XTploMKmgDO5YunOwms6+dwWbeZaSkZVzXT+9w6r6VYxfbwGnW0PyMySj4Qsz2wzjevFQ+5+3x66pEcoZ6WTG6WR+UvBvfTEphh6FfFJbMWDnwU+NJvbMT72AAZVC8VwyELxNhH5JGefbHhE3f7RTAb0GtVJdtPdHg2LwrAI+XwJ4FZXfZNy9cruD6AtZ+1aM03a2WVpA9e2k9mGdVD7Qwdd92a6HrRTV9sVt7/xW/U53ojPWMOyA/Aj2W1DdtKmdFu2c9r3p7tGL7bgu0eQPMQWbeN6bMpd7VCE2P4RWGvTBtz0t/J1cHcf5MF2bTh3t4LffGDTZr4X7fxF5v6aDb2ciO+0w9fieGz539Gq+jp94Z4rY59bxb7B/w26D8OAB0oXIaTSr6wmBgWeh8q0lJ2eIDVgzP19oYhu+3VddkSTe5ydPi3yufGwMd2FqF2cOhah8BVPINPdr5G+bJMsdbD2x/VRkGN0PRzseKdaLHMDSkpmV9Y655V3eIN8/V3ngwBh2fbxh8HFQ/W8BdhYu9fZ76SavhzdDFmLetZybK3uW7sA2/IG9E3RR//sJ8HXjAdMdUrHCHaAwrqiYrAxhuoq+cR4eFWQa9Ns/wHHNBQx + eJy9WVtv2zYUfvev4AADkgonWbc3p83qZm3XoeuKJMUwtIVBS7TNhpZUkkriDf3vOzwkJepiO9ktQGKLPDrX71zIPPmhXJej0cmjRyPyiMwkzVfFj8/Ju5/ekVRwlusp0bCoaKp5kQONIXtW0vSarhgh9RvnSIybtNLrQsIeeQmb1+QXumUSd9Ki3Eq+WmtyXn/77tvH309ABgd+uSKvNoufJrAtilXOJuQVkxuab+Htk9EopxumQDTrSD2t9b9qVCXF4jNLtdN4FlpBuCLUExC9ptqsVIplRBeklKykkgFFRhSDP7TjAUOk1ww25Q2Tx07CFaw4jixPaakqQTVT0ycLSU7ODMWTSthPwc+QQVoIwZCrIhlb8pzb70vwnijSa56vWvSgQUUF+UxvqEolLzVZVnmtFZLRLEMmQFaUlpvg14zcUq5fFvJym6cT5H3FN6yoNFoJ5tKNQh4nVkdvkO75k0j2peKSKWdBnrPWtuGXgnMXjKA9VPA/WGb43XK9JmCZ+TSS3XZLBvBb8lUlqXk6xsDl2/aq566YFSYZYIfdQOwWW9TJKhIpsmEgKHMO0GsexAJthUBjPMZm7+gMGM5QizjybiVx8ue2qCRokLGvp1Fy2qY/bwIYUynpNo4ko1lEnp6RaLOdm4d5E+UJiW4l1wz3HT3szh9HsANfvouSxIp4cuKVa+BjQFFbMmQAfYj26f+pOkDJJJT5FaogayZKJmvwKpNQJpytfACMpVpsJ2RBTWKCORBcXifGoAeAyQXoHYZljMoa540VACVfEb4kCj5FmH9Jm8lvxtR/zOXFXSoqxW/+LqcBT9riKwtwn97aOBAybt4j+HOEuRt601LaSpeDVhnk76KAfDRhxjTC6AbvhAWpLXXD7yAeZCxbnvZSzepRXzTY68yNwd4iF7CUs2SY823b/Y4zrv5d1o5iTAM3Na5yq6b4U6Xa9b3NZ1EUghgVm3rq+PwWrFiwdttGw4Xn2rw0Dgux5fImWBnk0mq/A80XoJSavvz4+HtsmqkwFoV9kd1p6GqtteeQYqM/R0YFbKTmB0qva5Z5xu7c2gl+Qj1Wmrx4e3Xx+3x2fvX617fkKYksqwiacYfPO2wvB/i8m13Mfrk0fGw3GuDz7IZC1sydGS6iQfhq9xbLruOOW3KBUAOGAGueW1/Ya9e8FOvyqgcLJPT0Ro9xSGXB6ZqVny1UyVK+3Ha7/8SbYDJxWUnYlp6xb+NmKOhqwnOzvDEGUyfxuKPXizu6KQWb+mdbu/0TweLt1QiKe0NA+pU/3CTYLRomUWszCZ6SSSDVgQW7TdivvkYhVZBlSKplxfx20ja0BgnCBwbIejAZB0OKT/rO7AKRcUHqsHEVFpM1cPwMl486sXDTjp1SMqppVzW9lsWtIh/bafvRfkC3YKVN8hCq1ULwtG6VZD7HpJFVquNhGydO6b6+T0leCWH9ZpMdJUBbhil/GnIO2CUuNcwPlNeYq7kFQY9/kgRcrcewEy4qLrKg2Mw0ZO6igtn4pSw2sx3MTmtWX0f2by9FX9yxFNj0i2QnMWG2v+VCkLJQGom/VExu21Xej5KVtEUXBtxKaGgxqk4ccl5JVchj21zxO6Y3kLdyHHIFJlUWsukmpUdCHXOCC1Ca/TO4OgTXknIRgNMpavulSQocIqo0ZUotK1GP2NSbdEMFELkK0lrDlmnOBwpHMJ77k8YhJDLr/biLJ5gLVAlIYvbxqYfByozLHlVxcnRmwhG3APNeCjWdvr94M7+6mL29tK1lMoSpHrPPqsjncO6CSXd+K2kJjSD2Y3GNt6RmFcCr1tcnSb2AYn5WRsBpJwfAVXH7xQ+RjXX0qZcHzt+76EOkjzrvmNie7sI/noBsMDCWw5XQTz6DJP9CRWqOTVZEDw/1PBwrJpbTaTg3TEhs9UucgslOa1cHrHUec+beA8CrWvGuyj5gNdYGNN+t6CUoameYfWFxRfo/jIodu+JQ0D1jY2cxiA2+ezg0rw5Y7PxpNfGXDfsj45R/WGSs3nsjgxc/dUUYDs34mm27S/vi9MC4xIb/ZEdETHn5BnqshTGS9uqJ7RU5u+1KjqPXOXDlGcmKtNrAVmMqAU5RMlhrenXygxH7yZRC1HEv0kN3TsiGrsBae/Ey1IfNxVuLyJ5JqRDGkc3tTTCR+Wbm+WQMjjQ2x6Gn9w2FSZlLpXe13OFg1VSo2/5CCr4hZoZsXGvuJTvE/ihrm+yRa7Zmht8JPt+WC57thdB8fghEClyWrolFTwc8KRz1SL+ckWmLKoBFr76f9igXcOi/Pt0vxp3v9olxOf8QMRlbUmiifa7NVNtz1kHGOwfOVw/Gex00+L4xUwlOiKZuJeYSgMkcQNw7s90XhUeIPDz9HQCVhaOHYfjChLx9/+aNqTsNnkHZvNCmVh0A4sr59nCZRqqdheS1Mv8AWK2YtNe4KXgFr8Zw0ErM4Mo2pd6ar+akRXHS5QvB/KGfs/6Q/U8cZu55GMTaPio7ZIMaSyoA2LEZveDJeSk54CY3Lw44Kpgmh4vwrmGyGQydSzv7qOdOf194q5rLE+umewGxPWm5w3QlJZbhAW673KKLS9vl9sOnvqLZYcxzc75s3/yHzQDOmNBzVvyGuQlkR9N39yz/wSx2rwOwE7/rdP4gHr0jOwLM7X7oF/8+yvq1f9/bg0A8INn2g32SfTvY93a/aIMGeOU5hzmIqjhw2XSKGxMSffT/bfRRXXwM6MyU9Bd9s7Ux - + - ArangoDB PHP client: single document + ArangoDB PHP client: streaming transaction - - + - - - \JsonSerializable - Document - \ArangoDBClient\Document - - Value object representing a single collection-based document - <br> - - + + \ArangoDBClient\TransactionBase + StreamingTransaction + \ArangoDBClient\StreamingTransaction + + Streaming transaction object + + + + - + ENTRY_ID - \ArangoDBClient\Document::ENTRY_ID - '_id' - - Document id index - - - - - ENTRY_KEY - \ArangoDBClient\Document::ENTRY_KEY - '_key' - - Document key index + \ArangoDBClient\StreamingTransaction::ENTRY_ID + 'id' + + class constant for id values - - ENTRY_REV - \ArangoDBClient\Document::ENTRY_REV - '_rev' - - Revision id index + + ENTRY_COLLECTIONS + \ArangoDBClient\TransactionBase::ENTRY_COLLECTIONS + 'collections' + + Collections index - - ENTRY_ISNEW - \ArangoDBClient\Document::ENTRY_ISNEW - '_isNew' - - isNew id index + + ENTRY_WAIT_FOR_SYNC + \ArangoDBClient\TransactionBase::ENTRY_WAIT_FOR_SYNC + 'waitForSync' + + WaitForSync index - - ENTRY_HIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES - '_hiddenAttributes' - - hidden attribute index + + ENTRY_LOCK_TIMEOUT + \ArangoDBClient\TransactionBase::ENTRY_LOCK_TIMEOUT + 'lockTimeout' + + Lock timeout index - - ENTRY_IGNOREHIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES - '_ignoreHiddenAttributes' - - hidden attribute index - - - - - OPTION_WAIT_FOR_SYNC - \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC - 'waitForSync' - - waitForSync option index + + ENTRY_READ + \ArangoDBClient\TransactionBase::ENTRY_READ + 'read' + + Read index - - OPTION_POLICY - \ArangoDBClient\Document::OPTION_POLICY - 'policy' - - policy option index + + ENTRY_WRITE + \ArangoDBClient\TransactionBase::ENTRY_WRITE + 'write' + + WRITE index - - OPTION_KEEPNULL - \ArangoDBClient\Document::OPTION_KEEPNULL - 'keepNull' - - keepNull option index + + ENTRY_EXCLUSIVE + \ArangoDBClient\TransactionBase::ENTRY_EXCLUSIVE + 'exclusive' + + EXCLUSIVE index - + $_id - \ArangoDBClient\Document::_id - - - The document id (might be NULL for new documents) - - - string - - - - - $_key - \ArangoDBClient\Document::_key + \ArangoDBClient\StreamingTransaction::_id - - The document key (might be NULL for new documents) + + The transaction id - assigned by the server - + string - - $_rev - \ArangoDBClient\Document::_rev + + $_collections + \ArangoDBClient\StreamingTransaction::_collections - - The document revision (might be NULL for new documents) - - - mixed - - - - - $_values - \ArangoDBClient\Document::_values - array() - - The document attributes (names/values) + + An array of collections used by this transaction - + array - - $_changed - \ArangoDBClient\Document::_changed - false - - Flag to indicate whether document was changed locally - - - boolean - - - - - $_isNew - \ArangoDBClient\Document::_isNew - true - - Flag to indicate whether document is a new document (never been saved to the server) - - - boolean - - - - - $_doValidate - \ArangoDBClient\Document::_doValidate - false - - Flag to indicate whether validation of document values should be performed -This can be turned on, but has a performance penalty + + $_connection + \ArangoDBClient\TransactionBase::_connection + + + The connection object - - boolean + + \ArangoDBClient\Connection - - $_hiddenAttributes - \ArangoDBClient\Document::_hiddenAttributes + + $attributes + \ArangoDBClient\TransactionBase::attributes array() - - An array, that defines which attributes should be treated as hidden. + + The transaction's attributes. - + array - - $_ignoreHiddenAttributes - \ArangoDBClient\Document::_ignoreHiddenAttributes - false - - Flag to indicate whether hidden attributes should be ignored or included in returned data-sets - - - boolean - - - - + __construct - \ArangoDBClient\Document::__construct() - - Constructs an empty document + \ArangoDBClient\StreamingTransaction::__construct() + + Constructs a streaming transaction object - + + \ArangoDBClient\Connection + + array + - $options + $connection + + \ArangoDBClient\Connection + + + $transactionArray null array - - createFromArray - \ArangoDBClient\Document::createFromArray() - - Factory method to construct a new document using the values passed to populate it + + getCollection + \ArangoDBClient\StreamingTransaction::getCollection() + + Get a participating collection of the transaction by name +Will throw an exception if the collection is not part of the transaction - + \ArangoDBClient\ClientException - - array - - - array + + string - - \ArangoDBClient\Document - \ArangoDBClient\Edge - \ArangoDBClient\Graph + + \ArangoDBClient\StreamingTransactionCollection - $values + $name - array - - - $options - array() - array + string - - __clone - \ArangoDBClient\Document::__clone() - - Clone a document - Returns the clone - - - void + + getId + \ArangoDBClient\StreamingTransaction::getId() + + Get the transaction's id + + + string - - __toString - \ArangoDBClient\Document::__toString() - - Get a string representation of the document. - It will not output hidden attributes. - -Returns the document as JSON-encoded string - - - string + + setId + \ArangoDBClient\StreamingTransaction::setId() + + Set the transaction's id - this is used internally and should not be called by end users + + + mixed + + $id + + mixed + - - toJson - \ArangoDBClient\Document::toJson() - - Returns the document as JSON-encoded string - - + + query + \ArangoDBClient\StreamingTransaction::query() + + Executes an AQL query inside the transaction + This is a shortcut for creating a new Statement and executing it. + + \ArangoDBClient\ClientException + + array - - string + + \ArangoDBClient\Cursor - $options - array() + $data + array - - toSerialized - \ArangoDBClient\Document::toSerialized() - - Returns the document as a serialized string + + buildTransactionAttributesFromArray + \ArangoDBClient\StreamingTransaction::buildTransactionAttributesFromArray() + + Build the object's attributes from a given array - - array - - - string + + + \ArangoDBClient\ClientException + $options - array() - array + + - - filterHiddenAttributes - \ArangoDBClient\Document::filterHiddenAttributes() - - Returns the attributes with the hidden ones removed + + __construct + \ArangoDBClient\TransactionBase::__construct() + + Initialise the transaction object - - array - - - array + + \ArangoDBClient\Connection - - array + + \ArangoDBClient\ClientException - $attributes + $connection - array + \ArangoDBClient\Connection - - $_hiddenAttributes - array() + \ArangoDBClient\TransactionBase + + + getConnection + \ArangoDBClient\TransactionBase::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection + + + \ArangoDBClient\TransactionBase + + + setCollections + \ArangoDBClient\TransactionBase::setCollections() + + Set the collections array. + The array should have 2 sub-arrays, namely 'read' and 'write' which should hold the respective collections +for the transaction + + array + + + + $value + array + \ArangoDBClient\TransactionBase - - set - \ArangoDBClient\Document::set() - - Set a document attribute - The key (attribute name) must be a string. -This will validate the value of the attribute and might throw an -exception if the value is invalid. - + + getCollections + \ArangoDBClient\TransactionBase::getCollections() + + Get collections array + This holds the read and write collections of the transaction + + array + + + \ArangoDBClient\TransactionBase + + + setWaitForSync + \ArangoDBClient\TransactionBase::setWaitForSync() + + set waitForSync value + + + boolean + + \ArangoDBClient\ClientException - - string + + + $value + + boolean + + \ArangoDBClient\TransactionBase + + + getWaitForSync + \ArangoDBClient\TransactionBase::getWaitForSync() + + get waitForSync value + + + boolean - - mixed + + \ArangoDBClient\TransactionBase + + + setLockTimeout + \ArangoDBClient\TransactionBase::setLockTimeout() + + Set lockTimeout value + + + integer - - void + + \ArangoDBClient\ClientException + + + + $value + + integer + + \ArangoDBClient\TransactionBase + + + getLockTimeout + \ArangoDBClient\TransactionBase::getLockTimeout() + + Get lockTimeout value + + + integer + + + \ArangoDBClient\TransactionBase + + + setReadCollections + \ArangoDBClient\TransactionBase::setReadCollections() + + Convenience function to directly set read-collections without having to access +them from the collections attribute. + + + array + + + + $value + + array + + \ArangoDBClient\TransactionBase + + + getReadCollections + \ArangoDBClient\TransactionBase::getReadCollections() + + Convenience function to directly get read-collections without having to access +them from the collections attribute. + + + array + + + \ArangoDBClient\TransactionBase + + + setWriteCollections + \ArangoDBClient\TransactionBase::setWriteCollections() + + Convenience function to directly set write-collections without having to access +them from the collections attribute. + + + array + + + + $value + + array + + \ArangoDBClient\TransactionBase + + + getWriteCollections + \ArangoDBClient\TransactionBase::getWriteCollections() + + Convenience function to directly get write-collections without having to access +them from the collections attribute. + + + array + + + \ArangoDBClient\TransactionBase + + + setExclusiveCollections + \ArangoDBClient\TransactionBase::setExclusiveCollections() + + Convenience function to directly set exclusive-collections without having to access +them from the collections attribute. + + + array + + + + $value + + array + + \ArangoDBClient\TransactionBase + + + getExclusiveCollections + \ArangoDBClient\TransactionBase::getExclusiveCollections() + + Convenience function to directly get exclusive-collections without having to access +them from the collections attribute. + + + array + + + \ArangoDBClient\TransactionBase + + + set + \ArangoDBClient\TransactionBase::set() + + Sets an attribute + + + + + \ArangoDBClient\ClientException $key - string + $value - mixed + + \ArangoDBClient\TransactionBase - + __set - \ArangoDBClient\Document::__set() - - Set a document attribute, magic method + \ArangoDBClient\TransactionBase::__set() + + Set an attribute, magic method This is a magic method that allows the object to be used without -declaring all document attributes first. -This function is mapped to set() internally. - +declaring all document attributes first. + \ArangoDBClient\ClientException - - + + string - + mixed - + void @@ -1939,17 +2385,18 @@ This function is mapped to set() internally. mixed + \ArangoDBClient\TransactionBase - + get - \ArangoDBClient\Document::get() - - Get a document attribute + \ArangoDBClient\TransactionBase::get() + + Get an attribute - + string - + mixed @@ -1958,18 +2405,19 @@ This function is mapped to set() internally. string + \ArangoDBClient\TransactionBase - + __get - \ArangoDBClient\Document::__get() - - Get a document attribute, magic method + \ArangoDBClient\TransactionBase::__get() + + Get an attribute, magic method This function is mapped to get() internally. - - + + string - + mixed @@ -1978,17 +2426,18 @@ This function is mapped to set() internally. string + \ArangoDBClient\TransactionBase - + __isset - \ArangoDBClient\Document::__isset() - + \ArangoDBClient\TransactionBase::__isset() + Is triggered by calling isset() or empty() on inaccessible properties. - + string - + boolean @@ -1997,2182 +2446,2354 @@ This function is mapped to set() internally. string + \ArangoDBClient\TransactionBase - - __unset - \ArangoDBClient\Document::__unset() - - Magic method to unset an attribute. - Caution!!! This works only on the first array level. -The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. - - + + buildTransactionAttributesFromArray + \ArangoDBClient\TransactionBase::buildTransactionAttributesFromArray() + + Build the object's attributes from a given array + + + + \ArangoDBClient\ClientException + - $key + $options + \ArangoDBClient\TransactionBase - - getAll - \ArangoDBClient\Document::getAll() - - Get all document attributes + + eJzVWNtuGzcQfddXTAABkgw5bhv0Ra7TyLLqKDBysdSmhW0I1IqS2K64G5JrW2jy753h3rjUrpI2yEOFAJaW5OGZw8OZ2fz0c7yJW62To6MWHMFQMbmOLs7h7cu3EISCSzMAbRRnWyHXYHBYs8CISOJsWvAiZsFfbM0BirUju8wOssRsIoVj8IpJmBrOt0xKOxRE8U6J9cbAqPj2w3ffP+vjJgIBpYbL7eJlH4fDaC15Hy65wtU7XH3Sakm25Rr35t62p0Uo0zrWEC3+5IHxyddQ10IGFNWzpz/aHYOQaV2CzhxM/mi4XGpwnp0zzVt/tyhyS4c+R5BiBJHUhkkDK5RGLOGehQnX2ZwT+9dOgfHr2fUf88kFnEFHLDsYmoc32/BKcAh2DLiFQL2WsNiBwQmaq3uusiX5yhf3TNG5kjzHHkaFSazEPTMc2nOx3CcwlMCUYjuIVsg5DLnF0JDofH+hq6bZZ5ECHDvrs0NyYXgNik/QIbDPdESKqoRQWb2hC2tUKcZMsS0tlxm5dlB+B+JtPQPlU29pGl/b2Wlon9BR2S8Pwmwa1DsQdrIIRQCrRKZM5vMgj7BbT7bfyOQMZBKGPYubetbuwBTd/oGL7MD1Mo3pI1bQFXpu8bt7+L2eg0qfNtni+PkiEeHSuTNDg35cJIbrX1S0HTaAnRZQn0oCJydocwNJTKyNCETMDB2vo2rL2921Cypwc1cC473kLNhAN5vKCmI3moerwSC9mKM3V1fj0Wzy5vX0rjIw/n109et08tv4Di8jtClVNUjgkrixE+/oNPhDbaIZFZNTZv0Uuw+1m9cr9bWxvb+ezA7ERU54IjQeRrc5xD1DfFtFLGVHjVSRb6DN9Xh48f+ShhgfUCbTx8+ll3jVWONNo1rgZS5KZrR5DvBehCHOUdEDMCqfAY/T2pOudLCwfMjI2L1qcP1cbSE1pFV8nMPWZ/Ss+FlRMBXbP5G/v79UcZMo+Rm962rZwdy95sY9LWseLxn/F/OkApM/PEG6HYcsyav4WmjDFZYdIV2BO5Ukkn/LVGgmctoqF9SZxzvGji67Dl/qL+pR9vWcLLu+hB5ramcyf3sMpw0MiQT1MyKr0EKiZJKF4Q5dvAS9iZJwafVcoIfweVrFsTWk+UrX+3ArHnFeO4Wv9nKYSWSyXXAFUd6sHYxb27gRyg8dW0KuDJXoFMXOgY8fMZQ57sCVCOwjv6aXWsGTs6xL8PLTAZNNS0GSeEk9GqmKWHjN7LVHz3k9WKe+aGX9RYVqhQfJdwbdNLoe/XRwYK/029nt0gGFT30rjB95QPmf+A7fXcGHhKsdHrwWS/6ZZDTLrMLIGMogjO33A8wcNmqWZW7UZUv9I1mI2+1oVJinX5Pcsk4PRWdoq5Q1/eiTp5CU4h8SoVJ/FhSqrV6v4UKOEqUxjhw1sD8tbjphDzQNiheA9d61aF2Ht+9h+/Cm45qFyp890vKw27oQ9KwqcG5mm2zzJrbb62e7lRB5niiQjp8XITSljHNqZa0h0nSP+aJsHmCF7Sye91rc8+x9qf7U2lHstKp7J39bfUu9rXdC/lYUGeSBh1Eo/EXtdsag6V3gX2HsvSDY6pWNVhqnycV+45MdV5bTmlb55QmPBv/Z9+w5CwXTXYftYGAH+tC5zf+PIdd0cVtX0ykd/QNGwTZW + + + + ArangoDB PHP client: URL helper methods + + + + + + + + UrlHelper + \ArangoDBClient\UrlHelper + + Some helper methods to construct and process URLs + + + + + + getDocumentIdFromLocation + \ArangoDBClient\UrlHelper::getDocumentIdFromLocation() + + Get the document id from a location header - - mixed + + string - - array + + string - $options - array() - mixed + $location + + string - - getAllForInsertUpdate - \ArangoDBClient\Document::getAllForInsertUpdate() - - Get all document attributes for insertion/update - - - mixed - - - - - getAllAsObject - \ArangoDBClient\Document::getAllAsObject() - - Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class - - - mixed - - - mixed + + buildUrl + \ArangoDBClient\UrlHelper::buildUrl() + + Construct a URL from a base URL and additional parts, separated with '/' each + This function accepts variable arguments. + + string + + + array + + + string - $options + $baseUrl + + string + + + $parts array() - mixed + array - - setHiddenAttributes - \ArangoDBClient\Document::setHiddenAttributes() - - Set the hidden attributes -$cursor - - + + appendParamsUrl + \ArangoDBClient\UrlHelper::appendParamsUrl() + + Append parameters to a URL + Parameter values will be URL-encoded + + string + + array - - void + + string - $attributes + $baseUrl - array + string - - - getHiddenAttributes - \ArangoDBClient\Document::getHiddenAttributes() - - Get the hidden attributes - - - array - - - - - isIgnoreHiddenAttributes - \ArangoDBClient\Document::isIgnoreHiddenAttributes() - - - - - boolean - - - - - setIgnoreHiddenAttributes - \ArangoDBClient\Document::setIgnoreHiddenAttributes() - - - - - boolean - - - $ignoreHiddenAttributes + $params - boolean + array - - setChanged - \ArangoDBClient\Document::setChanged() - - Set the changed flag + + getBoolString + \ArangoDBClient\UrlHelper::getBoolString() + + Get a string from a boolean value - - boolean + + mixed - - boolean + + string $value - boolean + mixed - - getChanged - \ArangoDBClient\Document::getChanged() - - Get the changed flag + + eJydVm1v2zgM/p5fwRXFOSncutePadNu67D1DsOhuPY+XYdAlplYmCx5krwtOOy/j5JfYnteu2sKNLHJh3pIPqR9cVXm5WyWHB3N4AheGaa2+s1ruL25BS4FKreEf/5+DznKEg0U6HKdWXL13i9Lxj+yLQJ0wOuACUZWka8hG/zJFNw5xIIpFUxclzsjtrmD6+7X2envZzE4IyigsvCuSG9iMku9VRjDOzSE3hE6mc0UK9DS2Tg69rzL404XOOIMTgPXyjpTcQdMZVAazdFan98PGU3kY4XiPtXTk7NAg6UUi1EsLpmPYuRNOHD238wnHZj4zxGRd+ByhEzzqqBwIDLYGF0AA6k5c0IrIssywtaIFkh0DCuAzhFqC4ed8zHc3N/fgqEqUEb4VBSDrjKqDXM84EEnWGzoDNBJ+C6rVApOUIrPYVMpHs7ZonvTBPkje0vY9w2DeUdyEfB1LfxHbGD+Qth1zaLnt+g5hcIlwJmKHNGkNu1c7kmzVFfE1/kwXbbCgtIO8DMqKmUdeBCqSVxVUp53hm+zAadTWK1WHlxqu2cVQ5SsszSJpugFy0WWeh1eJmtWiqQtaXLBtZQYqnSZXHzE3eUA/VIK6+YxtH+He/e/KBrdENkCVoBfS6kznEdJFO8bv+hlASip8xPcnkvn+VSGBe31mAKMy0f3KGZlZIbcR/U+k6Ga3o1YwQk1JqL/hKthDaQ3btf7KQ+7qxm1lFG9/LWffZZlwsdk0k+AszFY9MPmaBa+CJeHU5DxfDRL9zmJrhsDxjmWzsJnRmsrlQjMbEPd7cnjk+y50MKgWWxZjRyZMWxH1QrkyHAcmNdXtMhYWaLKnppzWktYEK2sd8CjY51WQmbEa94SjBsiDY8V/PthPNeH1EsytIjzfQc32vgKwrxBM1vHGUvCi6adP2/3sxct4AWN5YaRyMf+PeE28cYiDXfPB6CesjrWJ6tGTHSBqpbjCDohyMrInynvVWgLhBaiQ1P3qlf91vG29SDpyAotaU5KSIMSjmsqP3T3+QpihfUKoqdwfVNvehSfEpF/cP1vIdX6DFnaoZ4aPmMVDbTi+Xqx0LqC1SX8dhiKNCUb2jWp1hS/9phSSm0iiViUm+WSnlyvCXHXbKgaN5bKI91v60576MpLJ3euXIe5WX+q0OzaBBY/04h/GWgfVt1qIkZI7QlspvteiK9U/iaZuiuT3uP2HdAmxANfrAaL/ov2XNCmN8ZwEMbsADRFNV+ExV9p8WQhR11ti1affAWRPy+CJUThxKitEVUpvEStmRTMzrtXqeUy3KaF8NC+GD40b2bpQ+cVUa2/Ax4tFgg= + + + + ArangoDB PHP client: endpoint + + + + + + + + Endpoint + \ArangoDBClient\Endpoint + + Endpoint specification + An endpoint contains the server location the client connects to +the following endpoint types are currently supported (more to be added later): +<ul> +<li> tcp://host:port for tcp connections +<li> unix://socket for UNIX sockets (provided the server supports this) +<li> ssl://host:port for SSL connections (provided the server supports this) +</ul> + +Note: SSL support is added in ArangoDB server 1.1<br> + +<br> + + + + + TYPE_TCP + \ArangoDBClient\Endpoint::TYPE_TCP + 'tcp' + + TCP endpoint type - - boolean + + + + TYPE_SSL + \ArangoDBClient\Endpoint::TYPE_SSL + 'ssl' + + SSL endpoint type + + + + + TYPE_UNIX + \ArangoDBClient\Endpoint::TYPE_UNIX + 'unix' + + UNIX socket endpoint type + + + + + REGEXP_TCP + \ArangoDBClient\Endpoint::REGEXP_TCP + '/^(tcp|http):\/\/(.+?):(\d+)\/?$/' + + Regexp for TCP endpoints + + + + + REGEXP_SSL + \ArangoDBClient\Endpoint::REGEXP_SSL + '/^(ssl|https):\/\/(.+?):(\d+)\/?$/' + + Regexp for SSL endpoints + + + + + REGEXP_UNIX + \ArangoDBClient\Endpoint::REGEXP_UNIX + '/^unix:\/\/(.+)$/' + + Regexp for UNIX socket endpoints + + + + + ENTRY_ENDPOINT + \ArangoDBClient\Endpoint::ENTRY_ENDPOINT + 'endpoint' + + Endpoint index + + + + + ENTRY_DATABASES + \ArangoDBClient\Endpoint::ENTRY_DATABASES + 'databases' + + Databases index + + + + + $_value + \ArangoDBClient\Endpoint::_value + + + Current endpoint value + + + string - - - setIsNew - \ArangoDBClient\Document::setIsNew() - - Set the isNew flag + + + __construct + \ArangoDBClient\Endpoint::__construct() + + Create a new endpoint - - boolean + + string - - void + + \ArangoDBClient\ClientException - $isNew + $value - boolean + string - - getIsNew - \ArangoDBClient\Document::getIsNew() - - Get the isNew flag + + __toString + \ArangoDBClient\Endpoint::__toString() + + Return a string representation of the endpoint - - boolean + + + string - - setInternalId - \ArangoDBClient\Document::setInternalId() - - Set the internal document id - This will throw if the id of an existing document gets updated to some other id - - \ArangoDBClient\ClientException - - + + getType + \ArangoDBClient\Endpoint::getType() + + Return the type of an endpoint + + string - - void + + string - $id + $value string - - setInternalKey - \ArangoDBClient\Document::setInternalKey() - - Set the internal document key - This will throw if the key of an existing document gets updated to some other key - - \ArangoDBClient\ClientException - - + + normalize + \ArangoDBClient\Endpoint::normalize() + + Return normalize an endpoint string - will convert http: into tcp:, and https: into ssl: + + string - - void + + string - $key + $value string - - getInternalId - \ArangoDBClient\Document::getInternalId() - - Get the internal document id (if already known) - Document ids are generated on the server only. Document ids consist of collection id and -document id, in the format collectionId/documentId - - string - - - - - getInternalKey - \ArangoDBClient\Document::getInternalKey() - - Get the internal document key (if already known) + + getHost + \ArangoDBClient\Endpoint::getHost() + + Return the host name of an endpoint - + string - - - - getHandle - \ArangoDBClient\Document::getHandle() - - Convenience function to get the document handle (if already known) - is an alias to getInternalId() - Document handles are generated on the server only. Document handles consist of collection id and -document id, in the format collectionId/documentId - + string + + $value + + string + - - getId - \ArangoDBClient\Document::getId() - - Get the document id (or document handle) if already known. - It is a string and consists of the collection's name and the document key (_key attribute) separated by /. -Example: (collectionname/documentId) - -The document handle is stored in a document's _id attribute. - - mixed + + isValid + \ArangoDBClient\Endpoint::isValid() + + check whether an endpoint specification is valid + + + string - - - - getKey - \ArangoDBClient\Document::getKey() - - Get the document key (if already known). - Alias function for getInternalKey() - - mixed + + boolean + + $value + + + - - getCollectionId - \ArangoDBClient\Document::getCollectionId() - - Get the collection id (if already known) - Collection ids are generated on the server only. Collection ids are numeric but might be -bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used - - mixed + + listEndpoints + \ArangoDBClient\Endpoint::listEndpoints() + + List endpoints + This will list the endpoints that are configured on the server + + \ArangoDBClient\Connection - - - - setRevision - \ArangoDBClient\Document::setRevision() - - Set the document revision - Revision ids are generated on the server only. - -Document ids are strings, even if they look "numeric" -To reliably store a document id elsewhere, a PHP string must be used - - mixed + + + array - - void + + \ArangoDBClient\Exception - $rev + $connection - mixed + \ArangoDBClient\Connection - - getRevision - \ArangoDBClient\Document::getRevision() - - Get the document revision (if already known) - - - mixed - - - - - jsonSerialize - \ArangoDBClient\Document::jsonSerialize() - - Get all document attributes -Alias function for getAll() - it's necessary for implementing JsonSerializable interface + + normalizeHostname + \ArangoDBClient\Endpoint::normalizeHostname() + + Replaces "localhost" in hostname with "[::1]" in order to make these values the same +for later comparisons - - mixed + + string - - array + + string - $options - array() - mixed + $hostname + + string - No summary for method isIgnoreHiddenAttributes() - No summary for method setIgnoreHiddenAttributes() + Name of argument $value does not match with the DocBlock's name $mixed in isValid() + Parameter $mixed could not be found in isValid() - eJztHGtz2zbyu38F3PFVUk6y0kzvZs6O0ri246hp7YztppezcxqIgiXWFKkhKDtq4/9+uwBIggRAUrZzvetEXyyLwGJfWOwLfP7dYrbY2Og/ebJBnpC9mIbT6OB78vb1W+IFPguTHcL9cBowMom85Rx+gHE49OWCetd0ygjJZu2LCeIhXSazKIZn5AcakrOEsTkNw9KjVzDvmvxEVywWT7xosYr96Swh+9m3Z0+/edYlSezDUiEnR/Px6y48DqJpyLrkiMUAdwWz+xsbIZ0zDlixEkK7GXnvaLBkJBr/yryExGwRMw7PgTxCUyq9KAjgqR+FvTHlbFIm+/k4ftGIAwDPw0eEPN1+JhD0Aso5OVDwiD9fBAy/cXL5A4/CMwZEBv5vdBywjd83cKZAGz9PyPkslwDxJ6Q9F+wZM3L8848/kivgaMhusyG8oyam81/e0Jhw4CMQ29MhqQF98XcRRwlQD2RvjfwJMK4Ki2u2+i+gAavU4BGzG5+DwO6HzNz/yNyrA+ya1WkC1IyXCeOkLTSwf4NaZl+MxjFdOReTE8mAXHwwF30V0ClJIuKHE9+jCSO3M5bMWJxjcks58WagiAAsiDwaBCsbDuMoCpwopPMH5IoGnN0HDZ/DbtL5DnxhNzBizFhIOL0B8AAAJhHOYnhg5VQllj4/BvgDMAvLdVAE/voTinubRFc5eortfBYtgwlqz4LFoDvzTC1A4ECUB4YMHibLOAQkorBLQOpkRpFcNYPill+wkAbJ+qyfRO8kfszN/b1QqhBYxBlNyIRd+SGgfjvzvZmuiTktScwowgc0Z/5kwsLt9fVSTtzLwa+poXK+HT9/GkYx8jOGeV6wnMB3P4Q9rfgM/KA9zhK+vpIIyK9N3B28PdCsK5DAPhYge1HIE3J4fH76fjQ8ACgtMJCtCihoHavBvDl8L+DASAug09Sq1aJzevhOwAFbZYEj90o9TWfHh79IsnCCBVBZijUAXw8PDg6P987PT4ff/3x+eCZglzXp4csMj45PTg+ti9kVwLLkLfWTV1F8tgo9Ei2EfXAtevL2fHhyPPplb3g+enVyOjp7f7yPi2kgLAssosD3Vg1hvz35cbgvNENOs8C7ZmxxvAyChhDfHB6+FSciwEynWqDu45x46YFDAqaOzRfJSvN+irtvQWM6l2aDbEksOMk/PYUZDbqAnJ+AY5MPw3O5BJfUfZ4vXpyo6TRmZEe6YQ3nBv4Li+oBkmcsQVIlGXAkmIYKcfWUCc38iO31VnboIayP5xdaTDCHt+bi2+SAXdFlAPKAMcJqPe8DxDV4VhSbspHLMagVuVqGws0lo5GXCr5dEuiAhKAq8nyWHil+/CvS9vlIjG2nYzsdbQR++n2hpujo4VEfgkO9BDWNuSfsPZz7wrohg8fgR9/SeMJ7XjRfwAE99gM/PUELi8JBkK140TJE+sHAAj9bCRzfvRcwtyyDali7BUh3dehwFlzt7NiN3/0Rq4b6ABTthrMO0aFVl9db4SFI4ylViyMeYJXz18SgNVKeI6vWsKILZ53uWll+uzN9KuolUbwic/CkIuE3Z5u17GUvebrXlEO7gHBT+tqLaLEMECvfMOTJLI5uOZGB6+FHjwmkK829Ag/2KzXt6hebYbefFLbzoeJ4yIBJtzBzsj4dTqbs01FMFzObieMJ2BLN0klD/iqO5nvSdkm8u2Xs0L0tG72tjM8DwXYJOzd/uWABf0bBHU/Bo+u9hd7g4IXiXVmFMthCfds4uJsO3dVUxERGTNiXMVsbT5PObj5KMSsbvOvQsf0gChlok4PppwIMF5rl4dCyUOZ06nsOSd1E5dDePH0QZtvgt9pS4LiqY2jXeCaY6ngGzrDxDI6kSQQnUaLCZEFSFvJeYfgC4QpzsOkInYU0d5Elj7JwMtGSAuUYawjBuQ/uGi4dLZMFxo3GaV/B9jzZwMkPZyfHPRZ6EUZKEpt1BJLlXgpwSqJ3iSqJzsR0Q1qpqknmJxHms9odl8I9gLRaa5L5culDESgL7mNkn5lEXHvKkj34PSWw2q8qe6A1o6XnJyPaYZiwGLAr+HzqmUDEVwMe7Pz9EQ7n837Zz3wMZVM61MAyq7V+heEjuURb6aGUr+airquQFDNUIin7RSH/XAqJ9Q1Ntg1V8iybsYZiZss8SC21mPTWT2biN8WvCFOAMZtHN1nG0q6eGoyeDlDP/tlnGtGzg79yuBO4na9XfgDaZsYUOZCuEw+7r2YZZZm6OZAOAvnO9nSH5OIycNPdLAwYvGgZguNWBtIhL8jTsreX+4fGmugpln48pnPDX0xXVWFKzqcL22x7yIKfZdhs/q4xuxgy6WFM9lUAJwXodbGs4U7kc11bRGRwLMWYkn5ixUaUq/K0YigYO19yUTBKHbvtfIbPpZVOg7c8tErdvRwYDSdEFp9EPAX/p3BYGlKhxHIIANwPBWQjH79ORKbsmQgviL7vBHmlwaLSRVRgAYPlXwy3XGxr7MUbYUtpR6K2mkGyJWVkYbY8IgsDRR1XQYninZ10VrsqaBI4AI4XTz+QwQATxK0yAukQ8byQNzioSTmo83I4yVEwhktmljMAzRB4c/i+GQZv2OozoXB6+K4ahbRi8ZnWF7mbRpmfNZe3IIJIbKYKqwJEm7JsKhOsRsqA/wLR/9Ahnz4R2wNx7tgTAfiBTYCGU49KXRRr1VpZCa2lC4CjqeKwa7QtZgTPBXRTZNc1wV0i4lCVujIMMlpA9LD1QdI3pkGABhDRU60a4PyBjV6ip4zOD4TQKZwJ8wIqbCDMshblr/yYJ0Wznpkt+D6ni4V0wFGQnczzDVb3NMzW4Pt/y1qPRnX2Ot9StmyUKzdSewxb+NATtOOJWkeWZEgvP4I1TRPVLf9KrxpykW0BCipZMVUU2msczr1d3rjF/EdhrPUsUuPz9FRzltZvK7t6T+vUu6Hi/sECG41cIivKIBuV8bfM4CHHtrLplGE5arwi2DCDVEqxd7AjQdRA8SuWWKnnMc79ccCwzWDB4sQ3s3YPYhi2MzCaNj9wGRwDGiLwJW08FrClSXKpU8Mmpb2PptvFE8bUZdVVYVfmnwpGPlLBAdVi/cxC79MlUrC5ual88Ci+5iCBYIViwENBWHQVEQbshgWadUfZsCsWo0yN5fJDwZeQsLkEu/y6qH3yCIDfIy5SEiI0xNNyEiGmy4XwMDt5+C3j9x2tpo4pfsGHdTYXcr1GlipQs8hSPbHJsdKw2A9LO4JyHzdLbuH5ZMlkdYn6PVXx/DTbKuek0tXtny9ZL9ea7qxXlpVJpeUQv+pcrDswMXnVIP0FvqbYwKJQEt/AritU9zNViYIJKUuICM1j8N927pMYg+RnoJseOdDV+aX2ye/1Veo7DZyZG1Lr2sBZABWjivrOCZPQvJisWWDC8FT4rE0XNkwE8lh6G7GPPk9424hOWsZ+65oRjKKn8KCDmbisam5A+YA5ufKvpSjvnhibJuJeKJtgmuD86EJzqX8T0dlt1v0EaIclWWJ9Zgjz/pTUb/H70NSgvaU5dbZk9nqEPTZJVmIMNB0tCeBLZSsMSqGQZk1BvfXNCZtGZTFaXdJSw+FrJVolm2rZ9AOZEnHn3hG9+s6MbIVi3pB8/TV5KvI44OgvIq6C5NYIU4rwbNMPUyMvo2ed6K7EzJWUF4y0pl70T4MEvOSMYwcN1KlptqKgGDPxuUozOKprUQ135lV40yLzlTdvWBe/kA3RH0hhaFXkIabdw9sVFtUHBzrGndCXDn5NLEs5jzwfDO8Ne0R36lUUDwUeP6sgo+RKpVK50LIJRVXOdlq9ThcSrKKLXWQq81+wj9ymnV6Ed6XMPGMVdBQl7giVxhqokpsj8Ynz5EAMcldMSwc0wEP/r3oX3RU3idZOtOlA8FFUcw3d7IrIM/Xf025slQ71i91GMsUDwQvEqVlr3C8x/hwTcensS1z3p4zrHmCUhOAyvTpLJvvicmJJs1yYTSIms3UzikuG1fkLqTN7/ERob5PQcQtCRuBTvs/KLRO7hQ2squ9yUkcYGaPqnmZc2S255Irctv24SveuhFdV9tCaMIwkCtnyljGPYvves3ZkZKKra7NoUo81Dm1jSUfSvzqcRZnUl+WPaphjz1A0ZYdTzcw+jRKJxRxxXeBup62Ura3EyeeOhvk1EKtMUFjQkwqWGmSHB1inPa4+fzu0JprkIAP0qY24dtxRU/X+MwulNlbkdTTV+msbrgm2jj9pz7W9fFYqB+Vl2pTUyoLqUQPKNFTTc8fXrrRqV4G7qnwQ4VXMW5+zStKmOWnNiKoTj7x+WCccOaonxolTCO00FmAwCMbECFD2AFuo+gLEKs5Gc3WnONNG/L9ORG7qdAGtQ55TLJKGGqFUIp2JJHWHzOv36dC8+0n2Mym/wJ8IexwWEJcgAEOuaiSymh7Nlc6Z0O/V4uRPxIWTWtTX0gutbcefVDUtwepZuyCGM8WfcXLJ35B8QzmXqGy3zuTlZ/SfJMNqeNsquikF/DYXMZuO5jTxZu1W/98XtPfbXu9fT3v/GPU+/P5N9+/f3l32tR93tl9e9tqdv3YHu1ubTy5bf8FBz/727d1Wv9UVZKxBx1A2sBFx8z0p3NsBalqOqys552CvSeHibqs3JIbo87pZjdpiYHcPvTXh37s3z6a5FvD3UF3R7+Uo8toCW11709+3LLmYtfW3gskOVajW3xpVRZQfSVcxpq9WVnnRKNfWLOqvOBksloq0seMhiBmdrMh1GN2G5VdfaO8gkHHwlIUsFrqpit/ylRmiHr5dHI4XA4HxKIT8JTa4Kg2zF1loyHTTIrhiST5nOOmn44Yu65o10tvo7JLii1h0zyQLHTG7o8JH4/UvltMvt9R1R6DTkrhFI1qD62TTgHSR7F2Lds0K1NKOW72G+ArF3I/CGxbCtvCYfqUBFyjeewG/bhIwCz+QZPFqANhJlKu5hmAsyiwhrqXQ6ZQ/tVK/FkTWyLTE4zrlLpgb3cpJjnZIWayWu4qiL1MxA9OQSgg87XvPudrisrkJRxVWFztK2M0seu+AqPFkTGS7VT/r2jn8SPFVWDuYyEkBI1RNYGXVOrcoLGAt+lrF+2PyzjlAEZ0No9GoLPw0mfYwkW/XbuZHMGA1ditj7J7Yp/k9G1AHqzlpwIzPY9nqLVoZ39qYuWAkam36vj68iYGyTAiBBTEQhm+DSjmUwh+L/kJsaw7xytloeHw++mnvn9vkPAJCQTzjYKW6sWkJd+zuuMXryF14JK6ryQ2Zvzppyc37XiX5FUB+Bgu2r9lXQ5IvAzAa7S3dBnfAjWIfFwFe0mwJPy5T+i55ZrsCpM+uCxGMN8KVuKO9UqmBrOtcMykP3iUMzlUVaqxIEEXX5CulE19l9soibt1Su4SdXk+yibpQxMHr7r38TXgPiorzexwAz5Uukffrc5dYvCivodnKX9jX1OdK9Vkj8DNoc0Z4jYWuobW6udJhlbG8ITwsPLBChq3GNJZNctmLIlEjym+KlL7KFfUcvfZfinz/50W+x2ze/FVTHrbGFebKKtzdBmwDUWYeicCgnVrKnR3xa5e0LhP1/tZL9aLU8WU6CCPv/wCKbfl+ + eJy9WG1v2zYQ/u5fcTM8RE4dK8mXAWqTNEuNpkWRBYk7tIhTg5Zpm4hMCiSdly397ztSpCzJsut0w4wglsnjcy987njUm5N0ljYa4e5uA3bhVBI+Fe9+h8vzS4gTRrmOgPJxKhjXKGBk3qYkviNTCpCLn1lJO0kWeiYkzsFHwuFaUzonnNupWKRPkk1nGs7yp8P9g8MOaMkQkCt4Px+dd3A6EVNOO/CeSlz9hKvDRoOTOVWom1bUvs6t7zlDQaU0ZhMWE80Ed2af8twRiAXXhKE+PaOgqLynEhKRiduxzHUjx2msUU4YCDMzEUkiHhifLtH0U0oVEInLFlLiuuQJ1CJNhdR0DMFc4IwWMKJAxmMcSYimsh0ZxDeL5Nh+J+wYdJxGYTgTSkdmLaqSZsxbgbapXHbB2SMKKxHf0Uzy88WHL5D9VhCkUtwzo6zgobPJeM1UO4dSKllRe339qah2a7ww88c8XwhNIwvk5IApFwDGl0RzWAfdgzcj6dcWHjezTTEemymA/e6hpUmcEKVyJjT+bphJyw/z2YWzbIuWu3dPkgV1s17o7T1B95CVfOqGQvudSnaPmwetoV2FzKug988uy7woLceIKg39r5e9oRE8gh3c3p1VFBO0rVCMIKLgDtagFAixHZpdgHCGWzV4V3RKH1NLj6Kbqgbuqve+9+XSOxl+C9DP55nWaTsahIMw6L46aUfBYPyqPQhPWuFmZcVobFDmYoHKMBxWmfoZbXVR26DVxyz8ZjPS6WvXasnLE+Nj+liD2bvoX30d9i7eXf7x4aJvYL0FNWjviCYjorDybIZ7d9o//f30undt8MZ+kQFcSQ1JDbkJcPpQKPrlzEiJJHOXG9CyaQB7S35VKm95rZ5J8aAgy9/eY0zTVSmXaItRwmKYLLgtQDAcWpfkItZBprRt5bL0Nh82geAXRZNJFDH1J0nY2Au2C1LmY62wPlYMCRTmN9eToMn4vUFY4xbs/Kp2mh3w+K9z+O+N/LFliuLecVYoMPQtVzEKYiUC6oXkGHoXWElTSRUalykUE1t31+3JnExZXB2UGaQD3HsR8rpN0OLaogTV6DtlJad/4KtRa6qRMYHw/4Rv9bW8Goj1tdA5rExsCn5Pqe6j6AbiYUinwznR8SzIKLgsgEuaVGjozbLy/kyopdImDVj1XqABpV+swVS4F6gw4rU6nChfJIlnhvm//LdKES6w/UvYX7RIkOVGPrAkMaUO+wcNpuBHWAqx0TJ9VAeXjO2gcqOmzXkpuYodwFo+5VaO16zcSK589Rp6OW12dzB3E+x/gxtohtbfEKtQ9qjwGW47gFPGfTNuHLZjDniLfDRNIJg++39Pylzzlgl5jvL/LiHx2wpQtY7VpZg3w2/LkLsQe4Cbw9v6Q2DLzP05U1Rmi93mLWypyb8qE3B9fAcPM4pckOWcK+0oNvL2fNxMizl7xJTYTAsIYlRjbkZ+mbCKiZTkyZAwG1XtNfwZCZGgCmwMqAn2D+ztwIQkCslt/HtgaiuyVbqJGrIxNczMXNdxtHwTcOMfb4tb5J/KvQyi2ih4UHh+xmK34Dnt4ejoCPbXEMY6WssDbHIpiWfgYIAoaNG0CuNN8I6hRFVkvbayWzYC9qQ/cgdFfqAi6uvGil4njN4Zsv6s2u9V5huS5MyvUv8TU6v9vp/sY1eTnTaJESs2TObyS3R2+Rd8wqYLiaR3bxGyu219lpzlt2toLW/ahsszWrh6uxcHC0VXsi1h/M6dcGE4FrHqEntBHo+6sZiH5/3+ZeivHCq0l4TuTM+Tag5ludbCrjDFHpue2p976DQFP5bJdKuN/KB8Ix9UW/qNeWVCmZsX1Iejmm25kaahXortHSOjgs8yUVH0+epTfoMqkst3qB7BrvmosOtvr7QjpcPR1lwFTfN+KDHHVNO8vzAP9qB8YHoGzZsoOri1E0KOsXbirs3JHTWbicbaRHMvm5ZHnL1u2ndBuN9zZAVT9g1PHVt8Tc3V7i0teEF/4te8qDE5d4uCXHsxJcMQ3LlUCpENi42KKTCOmDAWVG3sbJruXUF+hT9xd/gc+vng8LdBd9/+HbSzI3AwOMAUsNrMUbgMU3lrMe3t26EhukVU4MkXRXa0AzsD/x7SE3s08EI7CPUPvDch/w== - + - ArangoDB PHP client: connection options + ArangoDB PHP client: batch - - + + - + - \ArrayAccess - ConnectionOptions - \ArangoDBClient\ConnectionOptions - - Simple container class for connection options. - This class also provides the default values for the connection -options and will perform a simple validation of them.<br> -It provides array access to its members.<br> -<br> - - + Batch + \ArangoDBClient\Batch + + Provides batching functionality + + + - - OPTION_ENDPOINT - \ArangoDBClient\ConnectionOptions::OPTION_ENDPOINT - 'endpoint' - - Endpoint string index constant - - - - - OPTION_HOST - \ArangoDBClient\ConnectionOptions::OPTION_HOST - 'host' - - Host name string index constant (deprecated, use endpoint instead) + + $_batchResponse + \ArangoDBClient\Batch::_batchResponse + + + Batch Response Object + + \ArangoDBClient\HttpResponse + - - - OPTION_PORT - \ArangoDBClient\ConnectionOptions::OPTION_PORT - 'port' - - Port number index constant (deprecated, use endpoint instead) + + + $_processed + \ArangoDBClient\Batch::_processed + false + + Flag that signals if this batch was processed or not. Processed => true ,or not processed => false + + boolean + - - - OPTION_TIMEOUT - \ArangoDBClient\ConnectionOptions::OPTION_TIMEOUT - 'timeout' - - Timeout value index constant + + + $_batchParts + \ArangoDBClient\Batch::_batchParts + array() + + The array of BatchPart objects + + array + - - - OPTION_FAILOVER_TRIES - \ArangoDBClient\ConnectionOptions::OPTION_FAILOVER_TRIES - 'failoverTries' - - Number of servers tried in case of failover -if set to 0, then an unlimited amount of servers will be tried + + + $_nextBatchPartId + \ArangoDBClient\Batch::_nextBatchPartId + + + The next batch part id + + integer + string + - - - OPTION_FAILOVER_TIMEOUT - \ArangoDBClient\ConnectionOptions::OPTION_FAILOVER_TIMEOUT - 'failoverTimeout' - - Max amount of time (in seconds) that is spent waiting on failover + + + $_batchPartCursorOptions + \ArangoDBClient\Batch::_batchPartCursorOptions + array() + + An array of BatchPartCursor options + + array + - - - OPTION_TRACE - \ArangoDBClient\ConnectionOptions::OPTION_TRACE - 'trace' - - Trace function index constant + + + $_connection + \ArangoDBClient\Batch::_connection + + + The connection object + + \ArangoDBClient\Connection + - - - OPTION_VERIFY_CERT - \ArangoDBClient\ConnectionOptions::OPTION_VERIFY_CERT - 'verifyCert' - - "verify certificates" index constant + + + $_sanitize + \ArangoDBClient\Batch::_sanitize + false + + The sanitize default value + + boolean + - - - OPTION_VERIFY_CERT_NAME - \ArangoDBClient\ConnectionOptions::OPTION_VERIFY_CERT_NAME - 'verifyCertName' - - "verify certificate host name" index constant + + + $_nextId + \ArangoDBClient\Batch::_nextId + 0 + + The Batch NextId + + integer + string + - - - OPTION_ALLOW_SELF_SIGNED - \ArangoDBClient\ConnectionOptions::OPTION_ALLOW_SELF_SIGNED - 'allowSelfSigned' - - "allow self-signed" index constant + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + string + - - - OPTION_CIPHERS - \ArangoDBClient\ConnectionOptions::OPTION_CIPHERS - 'ciphers' - - ciphers allowed to be used in SSL + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + string + - - - OPTION_ENHANCED_TRACE - \ArangoDBClient\ConnectionOptions::OPTION_ENHANCED_TRACE - 'enhancedTrace' - - Enhanced trace - + + + __construct + \ArangoDBClient\Batch::__construct() + + Constructor for Batch instance. Batch instance by default starts capturing request after initiated. + To disable this, pass startCapture=>false inside the options array parameter + + \ArangoDBClient\Connection + + + array + - - - OPTION_CREATE - \ArangoDBClient\ConnectionOptions::OPTION_CREATE - 'createCollection' - - "Create collections if they don't exist" index constant + + $connection + + \ArangoDBClient\Connection + + + $options + array() + array + + + + setConnection + \ArangoDBClient\Batch::setConnection() + + Sets the connection for he current batch. (mostly internal function) + + \ArangoDBClient\Connection + + + \ArangoDBClient\Batch + - - - OPTION_REVISION - \ArangoDBClient\ConnectionOptions::OPTION_REVISION - 'rev' - - Update revision constant - + + $connection + + \ArangoDBClient\Connection + + + + startCapture + \ArangoDBClient\Batch::startCapture() + + Start capturing requests. To stop capturing, use stopCapture() + see ArangoDBClient\Batch::stopCapture() + + \ArangoDBClient\Batch + - - - OPTION_UPDATE_POLICY - \ArangoDBClient\ConnectionOptions::OPTION_UPDATE_POLICY - 'policy' - - Update policy index constant - + + + stopCapture + \ArangoDBClient\Batch::stopCapture() + + Stop capturing requests. If the batch has not been processed yet, more requests can be appended by calling startCapture() again. + see Batch::startCapture() + + \ArangoDBClient\ClientException + + + \ArangoDBClient\Batch + - - - OPTION_UPDATE_KEEPNULL - \ArangoDBClient\ConnectionOptions::OPTION_UPDATE_KEEPNULL - 'keepNull' - - Update keepNull constant + + + isActive + \ArangoDBClient\Batch::isActive() + + Returns true, if this batch is active in its associated connection. + + boolean + - - - OPTION_REPLACE_POLICY - \ArangoDBClient\ConnectionOptions::OPTION_REPLACE_POLICY - 'policy' - - Replace policy index constant + + + isCapturing + \ArangoDBClient\Batch::isCapturing() + + Returns true, if this batch is capturing requests. + + boolean + - - - OPTION_DELETE_POLICY - \ArangoDBClient\ConnectionOptions::OPTION_DELETE_POLICY - 'policy' - - Delete policy index constant + + + activate + \ArangoDBClient\Batch::activate() + + Activates the batch. This sets the batch active in its associated connection and also starts capturing. + + \ArangoDBClient\Batch + - - - OPTION_WAIT_SYNC - \ArangoDBClient\ConnectionOptions::OPTION_WAIT_SYNC - 'waitForSync' - - Wait for sync index constant + + + setActive + \ArangoDBClient\Batch::setActive() + + Sets the batch active in its associated connection. + + \ArangoDBClient\Batch + - - - OPTION_LIMIT - \ArangoDBClient\ConnectionOptions::OPTION_LIMIT - 'limit' - - Limit index constant + + + setCapture + \ArangoDBClient\Batch::setCapture() + + Sets the batch's associated connection into capture mode. + + boolean + + + \ArangoDBClient\Batch + - - - OPTION_SKIP - \ArangoDBClient\ConnectionOptions::OPTION_SKIP - 'skip' - - Skip index constant + + $state + + boolean + + + + getActive + \ArangoDBClient\Batch::getActive() + + Gets active batch in given connection. + + \ArangoDBClient\Connection + + + \ArangoDBClient\Batch + + - - - OPTION_BATCHSIZE - \ArangoDBClient\ConnectionOptions::OPTION_BATCHSIZE - 'batchSize' - - Batch size index constant + + $connection + + \ArangoDBClient\Connection + + + + getConnectionCaptureMode + \ArangoDBClient\Batch::getConnectionCaptureMode() + + Returns true, if given connection is in batch-capture mode. + + \ArangoDBClient\Connection + + + boolean + - - - OPTION_JOURNAL_SIZE - \ArangoDBClient\ConnectionOptions::OPTION_JOURNAL_SIZE - 'journalSize' - - Wait for sync index constant + + $connection + + \ArangoDBClient\Connection + + + + setBatchRequest + \ArangoDBClient\Batch::setBatchRequest() + + Sets connection into Batch-Request mode. This is necessary to distinguish between normal and the batch request. + + boolean + + + \ArangoDBClient\Batch + + - - - OPTION_IS_SYSTEM - \ArangoDBClient\ConnectionOptions::OPTION_IS_SYSTEM - 'isSystem' - - Wait for sync index constant + + $state + + boolean + + + + nextBatchPartId + \ArangoDBClient\Batch::nextBatchPartId() + + Sets the id of the next batch-part. The id can later be used to retrieve the batch-part. + + mixed + + + \ArangoDBClient\Batch + - - - OPTION_IS_VOLATILE - \ArangoDBClient\ConnectionOptions::OPTION_IS_VOLATILE - 'isVolatile' - - Wait for sync index constant + + $batchPartId + + mixed + + + + nextBatchPartCursorOptions + \ArangoDBClient\Batch::nextBatchPartCursorOptions() + + Set client side cursor options (for example: sanitize) for the next batch part. + + mixed + + + \ArangoDBClient\Batch + - - - OPTION_AUTH_USER - \ArangoDBClient\ConnectionOptions::OPTION_AUTH_USER - 'AuthUser' - - Authentication user name + + $batchPartCursorOptions + + mixed + + + + append + \ArangoDBClient\Batch::append() + + Append the request to the batch-part + + mixed + + + mixed + + + \ArangoDBClient\HttpResponse + + + \ArangoDBClient\ClientException + - - - OPTION_AUTH_PASSWD - \ArangoDBClient\ConnectionOptions::OPTION_AUTH_PASSWD - 'AuthPasswd' - - Authentication password + + $method + + mixed + + + $request + + mixed + + + + splitWithContentIdKey + \ArangoDBClient\Batch::splitWithContentIdKey() + + Split batch request and use ContentId as array key + + mixed + + + mixed + + + array + + + \ArangoDBClient\ClientException + - - - OPTION_AUTH_TYPE - \ArangoDBClient\ConnectionOptions::OPTION_AUTH_TYPE - 'AuthType' - - Authentication type + + $pattern + + mixed + + + $string + + mixed + + + + process + \ArangoDBClient\Batch::process() + + Processes this batch. This sends the captured requests to the server as one batch. + + \ArangoDBClient\HttpResponse + \ArangoDBClient\Batch + + + \ArangoDBClient\ClientException + + + \ArangoDBClient\Exception + - - - OPTION_CONNECTION - \ArangoDBClient\ConnectionOptions::OPTION_CONNECTION - 'Connection' - - Connection + + + countParts + \ArangoDBClient\Batch::countParts() + + Get the total count of the batch parts + + integer + - - - OPTION_RECONNECT - \ArangoDBClient\ConnectionOptions::OPTION_RECONNECT - 'Reconnect' - - Reconnect flag - + + + getPart + \ArangoDBClient\Batch::getPart() + + Get the batch part identified by the array key (0. + ..n) or its id (if it was set with nextBatchPartId($id) ) + + mixed + + + mixed + + + \ArangoDBClient\ClientException + - - - OPTION_BATCH - \ArangoDBClient\ConnectionOptions::OPTION_BATCH - 'Batch' - - Batch flag - + + $partId + + mixed + + + + getPartResponse + \ArangoDBClient\Batch::getPartResponse() + + Get the batch part identified by the array key (0. + ..n) or its id (if it was set with nextBatchPartId($id) ) + + mixed + + + mixed + + + \ArangoDBClient\ClientException + - - - OPTION_BATCHPART - \ArangoDBClient\ConnectionOptions::OPTION_BATCHPART - 'BatchPart' - - Batchpart flag + + $partId + + mixed + + + + getProcessedPartResponse + \ArangoDBClient\Batch::getProcessedPartResponse() + + Get the batch part identified by the array key (0. + ..n) or its id (if it was set with nextBatchPartId($id) ) + + mixed + + + mixed + + + \ArangoDBClient\ClientException + + + + $partId + + mixed + + + + getBatchParts + \ArangoDBClient\Batch::getBatchParts() + + Returns the array of batch-parts + + array + - - - OPTION_DATABASE - \ArangoDBClient\ConnectionOptions::OPTION_DATABASE - 'database' - - Database flag + + + getCursorOptions + \ArangoDBClient\Batch::getCursorOptions() + + Return an array of cursor options + + array + - - - OPTION_CHECK_UTF8_CONFORM - \ArangoDBClient\ConnectionOptions::OPTION_CHECK_UTF8_CONFORM - 'CheckUtf8Conform' - - UTF-8 CHeck Flag + + + getConnection + \ArangoDBClient\Batch::getConnection() + + Return this batch's connection + + + \ArangoDBClient\Connection + + + + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + eJztW+tz2zYS/+6/AvU4JynVw+lMZ26UyK3jOI2nTeKx3Wt7SUYDkZDEhiJ1BOXHtfnfb3fxIECCspzmPt1p2olEAovd3y72BfjZd+vlem9v9PjxHnvMjgueLfIXz9n5q3MWpYnIyjGb8TJawlsc8P2aRx/5QtiRJzSIXvFNucwLxl7Cq4/sNb8TBT2XSRYJxtiT4RNFZbS3l/GVkECrTuipZeW8yK+TWEi1fJIt2HyTRWWSZzxNyrs6PyzEkVnZrD3ai1IuJXtOEv2xh29oOfw8ZmerdV6U7GAa59FmBUROaHRtXRo7on83UrAX7lg+SwWIUKNLy7ELEDjPYMbb2e8iKvVLM+b7a16wV2W5tsMOpiS5+e0tvN7M0iSqD4GV60u/TPmClUteMpksQALJkjn8TjSs7IZLti7ySEgpYgbay/JyiNjrJ5MjVhYbwfrqlTMW3syBngjJMcvzVPAM+LPjffaL5JqXwn3PJopcQIarpWC8KPgdy+cKy3MOasoJRhlaX43W6OBg2bJ8NQDWf/ehZfFM3JYarzWunMShRZOsFAtR/CnLAq31YIrTLLtnbQjURgVYOM4C4p9sCgk6yddomV8IBEXzrSK5DZAozzJBe0JrIbT+STXoYFrNaGGiGtDcP7ik5FlSJv8WLBZzvklLds3TTavxAUEzoWU9S6+yu8Cqaue+ARWd7a7zrao+Q0s/DOAKcAGVTVSCVufwv1o6gYccnNiw9pvN7iwS8AQNOOLrckNsFOJfGyFLxuelQB5BUGAgHlrJchYn5KvIFfTBqsHNEZkTIiImRwQKLgc+GEYJY2narGAfgAcv0cP7qNALT/eOsZAjcryP8sY3SZqyVQ5satE1/+CrwL6KGGQocz0DOFkNXfKWEQZUVzyLOVC5G9b4UUzT58AIAh93Z5nHFfaR0Qg8H7JLAaCLNL+hEXr0uCb+s/XRW4uTYGP7PE2OOtbmOmzArtCrgliFWOXXgk2TmAHzbFqIa8ZLMKfZpoTgNy/yFYyRqGcTlSQ8ACVl4DTpdQXokL1QNiGRNKlw+GwEa3t8uIpGVi7xt9GINaJktRIx2k16pw1p5lggWhTB4i6IkSKwHs271HLD+CQDwTibJ7cggcJf4k5EXJd5GuPqaHGVx5VD2o1J3JGoqtpLYBrsJAM+Z8LsSGktoPn5ZSkyBZrSIlpOTGzFfYf2SkRLUJhcKQPFWA/rXK7Tl8j4MfGNYAgeG6ayvFjxlJInkmsbF2cZ2Dxs0ohLIfuKH1pIaxtsH7KXQnAMjmtRzJE27nxYi8/yTcm+fYSgP/n2UR/YX4uMgANxFPsEKZoU7Ahe08pofeS7KJVOmESHTafW9rvhrdw34SV3okWPiKm0iraaa2kwAu3jqfPWuGD8WDdsX1uzUa8PnVfOFsZXxMp0JYqF6Jp3fXaAkA6OFsKPa91er6IEDrngIGQ16/TXq4vp2cvp6a9nl1eXzlBNzg0cVoLGqIr3iSOIjjH4gSys2xh7xA57Dnzuql6ikokb9t4zxAYth/FPe3XuJEBiNdl1tNpzOByNGIyzQSby8g1whwYGMFt4V4Bfgg1IgQJ3YppHsBHyTAwbALanG+rBeHz65urit+nl8Zuzq7N/nmKm2cWg3mvo4EMdUd/gJsrkWjB1x3Y9vDRq9Qh9KdDN+ekP+SxhEDBeuIs7O70jZ1RA1m13Vu8h4bI+Vnl9Xbyoh+Ht267f+gbVeDoCTVwOHHj14jTjaStCFEkaiQi67xzyi3xdveuTQ8VnVgU1eaWoF4fvSfTxeNusEErbwfLMIAwQuAjK4bq9hyPiCu0AcuaGsSVUYVhdzQREpqokuhNlH4IEmLLNiDDUQZTja/T3MATSQNhoKdL2BWF8wZNsGMDUgtiQ20GxXBb5jWQK99PbSKwdi3yIKTZUVYELHiZaiuhjrSRN1CYjzAW5kOGQApmFEdBbQKgVfZx5IzqFIPSq98PK6ziONpHHRBPA+dvfmH14YqZBZGjxFMICRUHKtYKwJWhrMF8JTXLbNUC7nROeIe/+5oBEoFx6ed1zAw0OVtCAlJ1eq+FdEE+SHGC/ibBGF5MMsCrIwvOIagTHt9VtxygdXfFWnVc413eTWlXJMnECtB7fdEeh/eYRmUzu2YD34BDYmp8vtmNJNcldC1EpiRVRW9brPG4BoEWwY+2TZOVHMEsGmaSJU0rKHVRN2wssO2/Ukm1oKPiJ362gVJ4z7FmlVX4z1XK2HYXxB/veB+PwV6V1pLk30jqyE3ml/L8oZKdNwZCJ5FqrAkJKLBqiqkzEdu7AEMpGe+XhcBgFKno7oqInaVjUzIfi8gPiolVuCle2gF/ZNn1/Rjp2PwyOg9uSirkYLHzLeLDwDadXFxxdX6IrxcEOZvEgRO71lO3+rx0fI7cLUyLPMkLIpdHuMWmr1PcEzR9c6I4ZQaC8KMZagYkYL+6wzo4TWYJD3CRyCRlYeYOpmq730XtWfkYHkr+ywQI2pZuI7t56rnr/tNrDNlhoZrPSdXvzqnT/TNeUVA0S20kfYOvGtHUorU05NZkEFgaxao2VRSKuRYWtmhQGdkXtpANbXTYbtjsnrbWWfNcl2oZwbY6t+21X/6HQ6eM3Rg1Yv/pmXSw7xS1frVMxtq3xHlWjZfPAYkfEvHr8y4Dnd15almqDtLVR0ELnoSAfUxFFgJmOOTYxPWPbitxKlMs8ZtjNhUn6l7Z0Q7H7w+lVn52/vbyCfL0XpmPGKjqWF2yWU0cQ/GVV8bkstijJPUasD9GF3ftaZR0u9FpyOmKlq8XvW/7relwXYjFdUQTrPBpN+ToZyQRNdtT97vyZ+nr0/uZx70/1Ep/GSQF+ip4+Sm47FXH6tvDyIyztvkrAQYEPw3fvOmp250OzkPPfgw11OvWOjzK9uzX17Grjv5rgDPZd48XYPFHidBodKW0VWKh0wBQ6qvSkVSaNdZr1p2KnAxbQYUP1O1hh4lrZBmzFVkRNn1SnjnMSOeXdxoaT/Vp/cTymo5oGrsQkLvNmsxIFGIm/ODq+xnDv/ddf+yM+MYHnTveuEuWbrAww3quR8+Gc+Q7aIemAGuLAm+l8WrF+WtNjW5BAnYVbtSIHZdJWfiXStcC26NufHOs60OcEYB2vrq7OR0+GT9g3h99AXYh7WMRkL0DkaWPGEKZgfxY385iNpvFsNJV3shQrtQ/NOdPocHS4nQqkFSUMHKBZjtEvgJ8gsqPfZZ49ZdGSF7A9J5tyPvj7dlKi5Isx2z/cv3dFnciM2UmaS2GGb531x74oirzYH1P7pr8/TeL98T6It9/fV1/hCx697Y8P+/tLLl/nhdgfP+mzfUVlf/zuj08f4Kc9g1NPPjWW99ZXFzl0x971yl3NnZt1WRPT462hKDPve0bYV76g5h8V8T5751lfJ3KjZIdhQ317jO378/37MB13vvemmvbB9dPNXfrOFeWDF9FDCFY5q4LDDg4VRoW9DKN3VCO3Aist/VydMnjsR58og4atyc1J90dh7vyEg/eal9jkD79U9wJawrQ+QVP/DNixOYmuso9GFvYFordE8X9JyqWV9Udx1zVi9A3Pzd6dOUJX90Lsc3G7TvOYigT9NUCsGg8pquCAfLeaCFAfAMpkVnSrIxC9t20lNafmcSOryYlrSBBIXwkei6Lb0fIPzuJOvaFroynG/YpUMPoRLu+qQWTOxNKukU1TAAha54YihO2H4vRWazdXuaTXTtZ9wizWB1qqfo6rcwadZUpRXENRBhrKM9Nk3CHp/FN1iAambT03hxp0Qu2efOD9M7mJ8N18kzJdv3j34NQNI2xX4FE5HX+zOU9SYHjIjt3ZehH2+wZLeaiypblxwvVNgRtRiOqAZchOubnThUcwSYn3C24yZu0NcrfNYknuQcLXNMb6lA4t8Lac6iTChAYm9xyftGzj3TawZr/RYvROOnY41HBPZsK5sOnCeu0C3Yq1o/B6gf7uZ9WVm5Zes986ctmtZ/M6q3PSOcpnG6fi289T3nfsPUUmVuvyThtup+VQPMpXM7z88QIkUc4BJRkMMLa7+dfrs9en0+dvf37z4vjit9o7ys22UcQ0xHicq0a6dDvgZAoD4hQNsr64n/zBBlcX0A5w7D/QYzg3I7Xh4Kdyt4420OHaeaGqoPJ93rCm6yLlDychiZuZfwtl5aLtT7KRs7hpt41FHQ8+ZohXV0cbn7iP4+Xp+fHF8dXbiyZ/rR7aW7VV6wHTakwOcEjyms3V22ZWinhgmQqR+402MMSBpCJJaYysyVEL/ZsibQI1YT8XqSGtWgXnRAsed+F/OR7/fPHT9Pnx1cmrvlkn0H30bjY7hZbbylzn2L8ENvoKg7o/CdJSSQDIf0LtYrLGbw4bPsY/sqtftA5pYZbHdxaE9qWfwzDvtMubB/ax6tKj/q7qDBYRjs8NZ3wPd3B9xaoL8lb38qPO6VpdjZPXBT6hVK8iVUv3HAxDlPwMsK6Bz+NFY+GzYVAww6DU0VB8cNkItgeAM1Xf6Bk9Cr7OgluIh0PbridllHSVeclT1VgJXLJsyfr0dUsMAJvMdEvDeQuN0HG/lrpoYvc0dbbw7l3OBxNP5om6HFPavx3ACqN7OBwOsx6mmZi5JTHrgpuAapDSUFGqexeN9n8CmX/LzS1bBFI/p8EKZJhAES8nY2qZ6fYVsgIscH0sh38L05ZV13v0D0o0W0/fKjNrHmi4XdVA4a4mNTusW1Iyc7jmIBPnQl1lEbeJLNsys5AL9tn4nzeMdfCk6wu0CbSV+K63aS2Niy2eaencRpP4/zb+r2rLVLVfSG2W3g76s/cN3L/U2tLG8htgrX+h1BTSrR23iuTQvIdrvNRveY62/lWVx/aA1f90xGe+fmDfvIe+owC1M87twlRNno5716FFkpP6gB3ua9zHt3t7WPMK/9Hx0ZSnCZddfQGVHkGS+x5SXr4QmTQbYKbu+WJQ+A9cdS4W + + + + ArangoDB PHP client: result set cursor for exports + + + + + + + + ExportCursor + \ArangoDBClient\ExportCursor + + Provides access to the results of a collection export + The cursor might not contain all results in the beginning.<br> + +If the result set is too big to be transferred in one go, the +cursor might issue additional HTTP requests to fetch the +remaining results from the server. + + + + + ENTRY_ID + \ArangoDBClient\ExportCursor::ENTRY_ID + 'id' + + result entry for cursor id - - OPTION_MEMCACHED_SERVERS - \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_SERVERS - 'memcachedServers' - - Entry for memcached servers array + + ENTRY_HASMORE + \ArangoDBClient\ExportCursor::ENTRY_HASMORE + 'hasMore' + + result entry for "hasMore" flag - - OPTION_MEMCACHED_OPTIONS - \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_OPTIONS - 'memcachedOptions' - - Entry for memcached options array + + ENTRY_RESULT + \ArangoDBClient\ExportCursor::ENTRY_RESULT + 'result' + + result entry for result documents - - OPTION_MEMCACHED_ENDPOINTS_KEY - \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_ENDPOINTS_KEY - 'memcachedEndpointsKey' - - Entry for memcached endpoints key + + ENTRY_FLAT + \ArangoDBClient\ExportCursor::ENTRY_FLAT + '_flat' + + "flat" option entry (will treat the results as a simple array, not documents) - - OPTION_MEMCACHED_PERSISTENT_ID - \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_PERSISTENT_ID - 'memcachedPersistentId' - - Entry for memcached persistend id + + ENTRY_COUNT + \ArangoDBClient\ExportCursor::ENTRY_COUNT + 'count' + + result entry for document count - - OPTION_MEMCACHED_TTL - \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_TTL - 'memcachedTtl' - - Entry for memcached cache ttl + + ENTRY_TYPE + \ArangoDBClient\ExportCursor::ENTRY_TYPE + 'type' + + "type" option entry (is used when converting the result into documents or edges objects) - - OPTION_NOTIFY_CALLBACK - \ArangoDBClient\ConnectionOptions::OPTION_NOTIFY_CALLBACK - 'notifyCallback' - - Entry for notification callback + + ENTRY_BASEURL + \ArangoDBClient\ExportCursor::ENTRY_BASEURL + 'baseurl' + + "baseurl" option entry. - - $_values - \ArangoDBClient\ConnectionOptions::_values - array() - - The current options + + $_connection + \ArangoDBClient\ExportCursor::_connection + + + The connection object - - array + + \ArangoDBClient\Connection - - $_currentEndpointIndex - \ArangoDBClient\ConnectionOptions::_currentEndpointIndex - 0 - - The index into the endpoints array that we will connect to (or are currently -connected to). This index will be increased in case the currently connected -server tells us there is a different leader. We will then simply connect -to the new leader, adjusting this index. If we don't know the new leader -we will try the next server from the list of endpoints until we find the leader -or have tried to often + + $_options + \ArangoDBClient\ExportCursor::_options + + + Cursor options - - integer + + array - - $_cache - \ArangoDBClient\ConnectionOptions::_cache - null - - Optional Memcached instance for endpoints caching + + $_result + \ArangoDBClient\ExportCursor::_result + + + The current result set - - \ArangoDBClient\Memcached + + array - - __construct - \ArangoDBClient\ConnectionOptions::__construct() - - Set defaults, use options provided by client and validate them + + $_hasMore + \ArangoDBClient\ExportCursor::_hasMore + + + "has more" indicator - if true, the server has more results - - array - - - \ArangoDBClient\ClientException + + boolean - - $options - - array - - - - getAll - \ArangoDBClient\ConnectionOptions::getAll() - - Get all options + + + $_id + \ArangoDBClient\ExportCursor::_id + + + cursor id - might be NULL if cursor does not have an id - - array + + mixed - - - offsetSet - \ArangoDBClient\ConnectionOptions::offsetSet() - - Set and validate a specific option, necessary for ArrayAccess + + + $_fetches + \ArangoDBClient\ExportCursor::_fetches + 1 + + number of HTTP calls that were made to build the cursor result - - \ArangoDBClient\Exception - - + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + string - - mixed + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string - - void + + + + __construct + \ArangoDBClient\ExportCursor::__construct() + + Initialize the cursor with the first results and some metadata + + + \ArangoDBClient\Connection + + + array + + + array + + + \ArangoDBClient\ClientException - $offset + $connection - string + \ArangoDBClient\Connection - $value + $data - mixed + array - - - offsetExists - \ArangoDBClient\ConnectionOptions::offsetExists() - - Check whether an option exists, necessary for ArrayAccess - - - string - - - boolean - - - $offset + $options - string + array - - offsetUnset - \ArangoDBClient\ConnectionOptions::offsetUnset() - - Remove an option and validate, necessary for ArrayAccess - - + + delete + \ArangoDBClient\ExportCursor::delete() + + Explicitly delete the cursor + This might issue an HTTP DELETE request to inform the server about +the deletion. + \ArangoDBClient\Exception - - string - - - void + + boolean - - $offset - - string - - - offsetGet - \ArangoDBClient\ConnectionOptions::offsetGet() - - Get a specific option, necessary for ArrayAccess + + getCount + \ArangoDBClient\ExportCursor::getCount() + + Get the total number of results in the export - - \ArangoDBClient\ClientException - - - string - - - mixed + + integer - - $offset - - string - - - getCurrentEndpoint - \ArangoDBClient\ConnectionOptions::getCurrentEndpoint() - - Get the current endpoint to use - - - string + + getNextBatch + \ArangoDBClient\ExportCursor::getNextBatch() + + Get next results as an array + This might issue additional HTTP requests to fetch any outstanding +results from the server + + \ArangoDBClient\Exception - - - - haveMultipleEndpoints - \ArangoDBClient\ConnectionOptions::haveMultipleEndpoints() - - Whether or not we have multiple endpoints to connect to - - - boolean + + mixed - - addEndpoint - \ArangoDBClient\ConnectionOptions::addEndpoint() - - Add a new endpoint to the list of endpoints -if the endpoint is already in the list, it will not be added again -as a side-effect, this method will modify _currentEndpointIndex + + setData + \ArangoDBClient\ExportCursor::setData() + + Create an array of results from the input array - - string + + array - + void + + \ArangoDBClient\ClientException + - $endpoint + $data - string + array - - nextEndpoint - \ArangoDBClient\ConnectionOptions::nextEndpoint() - - Return the next endpoint from the list of endpoints -As a side-effect this function switches to a new endpoint + + fetchOutstanding + \ArangoDBClient\ExportCursor::fetchOutstanding() + + Fetch outstanding results from the server - - string + + \ArangoDBClient\Exception - - - - getDefaults - \ArangoDBClient\ConnectionOptions::getDefaults() - - Get the default values for the options - - - array + + void - - getSupportedAuthTypes - \ArangoDBClient\ConnectionOptions::getSupportedAuthTypes() - - Return the supported authorization types + + url + \ArangoDBClient\ExportCursor::url() + + Return the base URL for the cursor - - array + + string - - getSupportedConnectionTypes - \ArangoDBClient\ConnectionOptions::getSupportedConnectionTypes() - - Return the supported connection types + + getFetches + \ArangoDBClient\ExportCursor::getFetches() + + Return the number of HTTP calls that were made to build the cursor result - - array + + integer - - validate - \ArangoDBClient\ConnectionOptions::validate() - - Validate the options + + getId + \ArangoDBClient\ExportCursor::getId() + + Return the cursor id, if any - - \ArangoDBClient\ClientException - - - void + + string - - loadOptionsFromCache - \ArangoDBClient\ConnectionOptions::loadOptionsFromCache() - - load and merge connection options from optional Memcached cache into -ihe current settings + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use - - void + + string - - - - storeOptionsInCache - \ArangoDBClient\ConnectionOptions::storeOptionsInCache() - - store the updated options in the optional Memcached cache - - - void + + \ArangoDBClient\DocumentClassable + + $class + + string + + \ArangoDBClient\DocumentClassable - - getEndpointsCache - \ArangoDBClient\ConnectionOptions::getEndpointsCache() - - Initialize and return a memcached cache instance, -if option "memcachedServers" is set + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use - - \ArangoDBClient\Memcached + + string + + + \ArangoDBClient\DocumentClassable + + $class + + string + + \ArangoDBClient\DocumentClassable - eJzFXOtTGzkS/85foaW4s9kYyO6Hqy0ScuuYIXhjjAsbcjmScgmPjGeZV82MIexu/vfr1mtemoeBrfOH4HjUv261Wq1WqzVv/x2uwq2tgx9/3CI/kn5E/dvg+D2ZnE7IwnWYnxySReD7bJE4gU+CEP/E0BRb/xrSxR29ZYRowgGn4Q/pOlkFETwjv1GfTBPGPOr7/NEiCB8j53aVkIH+9vPrn37ukSRyANCPyQfv5rQHj93g1mc98oFFQP0I1AdbWz71WAy8WYHtG92PqeOFLkPJE+r4LIK+0DgmS5Cn3Jt92Z3ZyollQ+rGAQmj4N6xWUySFSM2W9K1m5B76q6ZQMKfUzREkICE+jZ5cFyXhCyClh6hJBYSAbljU8F9iQje/tub6B0SD5OUI40i+kjoYsFAmCQgThITj3k3LIp1e/m3eSBix1/gI0Je7//MNSg6OdCyn0u5uYwe0MXkSx9F6HMJtv7cQmquW/ygqqDr6yiCpqlN8Eeqxa/3NBLdkL8c8L9h5NzThJGduVTkEbn+CuNmwHd8m32Df6H7qGnm22HgoGhCOcmKJuSBCT3LYUBVdQPkq8VzFX/VhtnQandfjLbgwSFukOMiYjSGFo5PFvBFDLECShEUZMyiezCuhLluTNbcUIAz4FJiO8sl4/pxGbVZtE8+SVmhkS/MQSMqPNlVnz1Iqh6h9u/rOHH8W3iiBN4nwyV23Q78TkLu/OChQKbwlHqS6FG2+JYooZdR4PEfXSdO0BhTBa/9xHGReAnsRJscLGh4Re8ZTlauTaBOmG8yAMdPKoZfatWSTId8II7I67ItCOOkLjlj3oIuVnx44oSiUeM0TOXGp6ApkyCatkocfAj8/bXrlkVQUpIYugxDIcwGBg/FyPeQ/0jOJ7Ph+XhujY8n58PxDIA7SsxOGf40ABJ0amZ80rVZGLEFSGr3wMzSucAVAUOzWy3C6fmUs18BDwPrSRAB6zV6lpfkOjm/4FxDgDdwnTkeC9bSmbbW5mx4Zp1fctxEAAA0tirCj0V/wKaFrcfSUtWshgdL6rjBfWrSDrbl/uN1T8xQWLPWvut4DnoM6gVrP8kiKp/BkatlPukPR+dX1sV8djG0pii64jwDwriiA2f0W4YldpZ0QfiYAbYd7wrfB94gDtHBPFCHOwhYUwrdqhUo1aYWSWu1NGARrrbLtS8WztYjdtEfWHy8kN6Auw1cnSX4QRYlztJBY4u3W8NDN4Ynn+cDSxibwBqwqMouDNzISs29J7Gdj/tnVp73GLBMPaWuC346Zu5yL3YgprHbM+yPRuef5lNrdDKfDj+MrWPkyPGmADflaAaWCydcoanylsJRg8Gu5fo2nY6qOQ6Gk1PrgturRDHgW/4KnTAA4+jWecHT/nhgHafmwCTlrMosBrAOJxhdua6IUGKcoTAvH+Wix77BqtVeg4MLqz/jrBcceaCBDdwvQxuZR+zeidHam+EvrKvhFL4gAyCrxgwD11k8thb7cnIMYoM3HQ0Hn4U/Rfpq/DvGwvFaBETtsD9a1mR8ORohuqI24F+w0EUXsGEHLqzJCMa8TQ+Omcs219CxNbLaaegTeEkeL8SP/qI1/qf+cDaffh4PEBsd7UkQTQHAwGCEa0Vr4NHwbMi9Fl9iDHDTOydsjTb9OJwgWAxEBqz3NFmsIOb8o/1i+74/G5xOh//lk+YG6adA/mJ6/e388mLcH80Vh9+DdQQx3ovyGE5h5KYz6wwZOPH0EaIW7yXRr85H/dlwZAn8q8CFjZ1rkr+/xpAiwRUHHQq44IivOTUu/3J2Or+cWheIjeSXQNOMHMK+7iGIagISDjzpT6efjhX0BIlMC0gBPHkMmySefZ5YCnYGzQ2gg8yOuQprcD4eW4OZ9KgphdExqb3f0qW31ZAXlgRFRE1UOVfqwfjkQCDeuAokpFGTVBxo0hfxCyeaUGPEfEwTeoOxaz0euPT++/6Uj4EtSUyrxexk7xcyOGWLO3JSCzg4tQYf59D+FxyUk/MLPpkGK6C8TJa/wNBgfkPGW+pTDhRwA4ozzNNbOBVHl1MEOf5n1tmgD0IcQ/hzcSVDEo0yFSAV4Z6Jrc7QtGUrfsizlemSDdime9Q71oqt2jlOYYH+nGOu9qLxR/a4gQQh6AlCJhCEODXuIZVgAsoegvccz+bD45wEEwWVDO0NJBBb7CRx23CfzUY5nrPEbWTlBzKq50EbRL03dHFXzWx8PuNhPETX7/uDj8iOIzwOJKlpUYY9oswExmJTrAxKpu5scvMoE6c8CyjzfTyT5EkUBfYrOAjqyXTWjgLagxUI9nPUrUqsJasoeOAJumym74v4Y31bsLDkXMP1DURF6f5tPueaiNaLpJtnL/b0f+rpvINZp713abaON597LLplXdzMHB7esuRYqqS720uRUp+gv0AM33Vi2Gh387jXAqmQNfm6S/75z5QYPz848ZxL0BJgN9OVcncqqDAn2bLl17ST37eKSnMDqlzFSRR4AzTkbkYtspkyEfXoe8nqPoDVgU1WGUTEEgiepB3tZVsSirloUxq2YBAwhn3X7RZHXyLndVElJc6NnMlTzE8scEpKeXoE1lwWx1RO2GyK2WzkRXMuTB2ZLtsJlkvM3uyJJFqwlPwKrT3nG8xPsiOyTtBafEFJAiMT2f37oOAxi9oT7Kdo1uJrTzKpn03XsjUanGj/BNvgSzF5WDHMPeNgi66IDXK8gcbNGjUqtKigmyBwQZ3gTxhO8YIES+qin0T5HpyYtdCkxSmVMiuM0uhHlEYr1XXBvOCeZfSUtdj/k30+0d4u/Ti1uKKS1n6zdjayM+6Dnj+hzavUi6hNTG81q3Xrnjp1Af4Z63RijBcw6dtC1R+qFY1L2g9iUYTQbs5yptsrzPjSeiSkwoObgmK6naHPB0XJ2yH7SiG7xkXH6Kv1kNcNa+aQK83xJwGGNxWqlgO0VzoYAar0KK5pxRnkj4C6u6SgW9iXsijpbrrmv2nQiZnuWrUynUxp/eG/RR1+ks5XhKB4bsZPxzyIiBw8802Df5N6GpypRgsiDCLRcfksN0wtFY4oZ1IkvYf4+3S+wNOLtmHeO/JTlYH2bRv8Ds6QbJ+N55aKRGSKM8dVmAKPGLUxrahJe8RJhGvAQbuBNcHG8J3eUkcHDhg+kRjC+j22XIKOe+IQ1oPxDuQJvxfYeKRgtJp676bl28uLC90DUZ66NgCpnlCaRWmUudeCMRayZBv+9Rf5QQEcHjrxFTqhTIP2HiwOATtZdrcd6cl0D9UqInZqnX/Ene0eybDI+jf1LVXXEUnl84PIA+w/WEbCzOKmH9tmKjx4xbUlR/1yU2FnCZMAWfMQKP0dlkoGmwHSDhGtcAfWFnL0ToWVhTHA0cz19aihtwKlCMNFrnGCGKaCHG/KRKqf6LTKj2+gt3f5n78bRjhnnArySCqvKOvBQdErKEcpVnUGjpShnjff/l3zeFzhvjECVKhnI6e3p5yeUEMxJIsTkF5uH4d+bvP4vaTi7Kcc8nLPoes/tMaqK0C08y34P+H+tK+JH5wExOLrWn40muKGkjC1Pg1b/o1Rgh5rzG+0os44iR1RPHG+tDIg0g40btar1JnQq1dv8rOgztzeHRmYVyU8qsttTBaY8bUZ7TRFSHnRy3qBVb5CvBpbL4imIrr89KyOayvK9lpmUvhfmBgKxVQJmbVbWU4UJ7Cy5WPdNENm3s1e59RitDpS+MBycE2+9qoJeemP4QOEWOZUQ8nLd8yUsiNXXJ+Hh8fWSf9yNOMUNYCFMpgWgHmKVtCyoGUDaEFRA17AbCF3M2Zliv0d6VCe07Vv9sJVuBfCTqDTCkgdUmjh6g2j8pihKIGe+u3EwKR9Tkf/ev26hlAWZWygXEFRA5kvmGgDmaOoQS5UMrRAzlPUQOdrGNpA5yhqhZZ1KWUNN3iAtO6h7dhoihrUtKhgU3ly9QKt5MlS1ACnRQIlkXjgWU+qKwDayZShqJsX6el3S9yUos6X8eqr8qdZ+YUCrk10lC3Ra9eXDEU7XFGDtwkup6gBL9fbNYGXKOqGV9bWGcahangFRZ3Eulxk07HN1oM8gZIXfLTth6aodVmqTqOE2mRroiqj/GlLyuswNibVJRdl0s48FjVHddZQLrBo0GKZoga+eMid7ZgKT7s7Hubwb3GTnW4tK1PGmf1kvA6xwhvTZvyyj/NHWinULriGHeSqFUxjhD1VIKr2qDrW7rynsbPobNbDTOz/5O5VYLTvW1oK1dDDgRvErNMjnY+MhXt917ln1f29yhQpNFQdmM9vculJ6Hz+xIViwXjuMEPW/eN+bO2br2To7qdHU4YcZnMxAW6CRCFBNt/ZSLDBQQ2vII9Xwdq1eRpZZjk65g1sO6lxO5VK7TQklUTrDURGY8qKjAOUsFsWVQh9cEAW1BeXQBx+1qEzBHgXCBRwgJBPGZriEVnbSo6a3nlrLOkPVJ75kdwEMAv5MOFpr76I85wByplV+4IWQxpzHd5G1GapFnk2zS9kxuSnff1KJ1mEhwcH/NiwqR/QpnPY1JIbWbbgBT/GY2aDokwZ/ZzGn1vYA4r06B36a3FMxvPB1H2gj7FIC6syGEOec2PdPqE2qNTpZ2ctX/oQoeUhKWB8rTqCEbiNY73p0aBhrB/whlb5aBST1f5t5si1h424P5C2sJaXOiNdNpytKTCronRPthysfi0dfuS9p66JKs3qHRamWWfToXg+I2w8mwv/zlO5cNfsJ3cwgslZAkiPUQkXqJjH5m1zx1K4D5hfjof/MU1lHDEs/VD+8DXP3GJrYgcexbtwweKObTCDhfvKZ7wJg9C+Vr7pdNRePGicifBeQLQcZ5QzjNjt3MMy8e72wWH3i/1qd+dAjBL8wx+YPOOtElVe9OQHP+kUgQ7gagmiL3F62OyeuUHILzniNLPXXqhv1aagmVjWZgl13M073OUnzkLu659yS0vjAWHzqqt3m2qd9qWrzcnZJGuK0ivR6fpX096jxx1CjmZX/2+DaAaW2IrtkShDeFYYkyaOnqWkDEwbLZV2MS+kqzJr6exKD/CzndVsxprF5kT4PyNhS02UaHfzHTQOm7jHN+GX2A4P9d6njmUug50NtZ6Alc9ZPxMsl6XOlGQWt59YJ80jc15VbjhkEw4rKL8HQFwpwFdEKCwnU8sGxo/3oqt26uVSmuLW01zAXTx/3lHvDkgXcX3mqY8y88uhpDgS7xsoGriQrzaMyh9ZczjOuHY8Ko59vhYXa9Z0mNwUIacI+d3CSwT6m8jxhEg9r+/vW+m/RavlZ9Y8llzzqZHeLZJFZlX2+mRzNJ6Sl6zxCcUMmnbTWoaKg/63R+WgvWzU2fiYv8IEX1ISGPQqz+6lWjM6JC0nX07c5889IZewr5bFEVkTw1Cxu+PwgI/A37cGvb8hr17tOMY6L4f8cHRUW9dhnDJC6HxtEwjt1Nh+JtRP3DRca+VhZrNR1rCkh2oKR6o8VE/J3+Oy6CEtpzKH4u4U3nTGFUUlZUvX0NQbZHpErxy6NHy7eL9wm79rg1VVNaXze690wTF9VQ3gY4Tt3K4j9BURNz/8FWLv+nlvsGlTPac2iVoDlz64/UjIe5dmTyw1IN6aY7YjzZS/dEoVyHe00jryhsim+PmVSV0nrfd55V7VLlAS1ChZi8r98mVXLLTbzydedVJKtsmG86aO6hcVAecvWondNhUmu+XOMi9MHruZAEJY/Ajk7O6a117ZltpqdqR6qjOBEutNbFDWt1REA2rdbTv2Cq1cqVoYf3WT0cR1YxtQUtbZgGxTtIGyNrMjAWqUQUHXcPdS0BrDOL108i+G65opz8JFigzB9y1AF1MbOkzjriFbxh/3SOeLerufurt686XUGvv+P2ga8g0= + eJytWVtPGzkUfs+v8CJUQhtg24d9gNItDeFSUUAQpK0KipwZJ/F2xs7aHkJ2xX/fczyeGc8tAamjFsLY5/6di52Pf85n805n7+3bDnlLjhQVU3n8hVyfXZMg4kyYfaKYTiJDNDMkSJSWikzgP3uaS2U0UCHh5zkNftIpIyTn0bfkdpEmZgYk8HylgtwaxmIqhF0K5Hyp+HRmSD//9OH39x96xCgODIUmp/H4rAfLkZwK1iOnTAH1Eqj3Oh1BY6ZBNquIPchNulbykYdMExoETGtiJDEz5ozSRE4IJYGMIhYYLoUzy1k1hI3O5NhqJiT4QApDuSA0inIu8CcyHbMpF4KL6e7HsfrkmJxPPIHWixy1kGTMp6jNmIGpVOgJU4qFyEoKRqayh2TIoKQB1zphhIYhR3VpRM6Gw2tg/k/CtLHWTZgJZhmtAk9z1ChXdaJkbBXSTD0ytfuiAGouAlwi5MPuH9bzQUTBmQPrrb5VsPNfBzdYt+MDlse4SjZHoQySGHj1LdEkEUGqPDdLt3fP/k40I8f+XjqOGISywteGRQrhQibHf8Mnt5jt+fxIFWAm21QSM1f8kRoGihVc6lJSq4ic47JuYk+VossWzo6sRfkEQi2Mh4nXsk8p69w3ZlSTWCq2AUAKeUANmLBDOGBQJaznBZ5kOzNkNKkwljJq0QDIvwF1XQUHVx6C3BSzgPDLu4sL1MIthhISEpNpRh8BzQJ2N4mP+RMLW+TzsC5aJPEYLIOctlkRQIpCSsyoIQsGhsY0ZDbjEh6F1hVOndQDLYJsPoG6h+R9XaKLIARTLW1ZzK0vcQOcaUMGl8Ob76PzY2C1xcOtF3DbcF7eIJOITltZnh3dfru6GSBfR/AS5u5Flpy6lf3N4PbuYojcU5IG5hugn9lwyeJkdBccSqRRDPzvl1zAHSWax/OIpRjvWSjkemy3KnJycWTVGKG0l5iY8QQuiTCtfPtXd5eWsd3WZJ5ZzlnVPCjjULBCspgxgewgqQxWWq/acwFwyw0j2DbDKWApLVkrLB1+v7bhRLlN+oypZomKyirttrL7cnQ7uLu5QI6OsoHpuYCeAkX5X+bnxoIb203IhCttiiCKkGgZQ1IxQ0NqaDV/51TR2KvAZNMr2Tt+/U57ILqyQmzBYV+RTRSRfsRylmqaIxjXAFWKmUQJiMh46RW6FUxdkU6ZBivrvZkpudDkvtwc79Nfg6eAzettJhlHPMjbHRmNbEhUEphus196Tjtrbf6H0ygFS9pkrfZmxvXOJ6+HQXg3/Y5W2em5EHfin7U9UFZJsUckUeRwgg/UbwA9dKuuJf6hWTTZ38+q2sP2tqddhaeTVyUp5D83inGm/9gqjxBbrbKAqjRArGLRKHxvj1ADo+c4geIfJ9p2LwCTYvkWoIZMb/WEK8agYt27rjqDO7rYWrcbvJKRe37PqDO4HuaYqEtwKQF7fjzUVtE7IK/btchqkp6W+sw34JdqkYCJD0DNTbQkIYuY8WtFJWeGILM8tYq0Lx8PLgbDQTa0Yv5zAdXaH0sJHcskK9j2vZUGNu+2ZGY1B8nntBzYGQbSG+cfOwd5MoKfQi4iLMlhSUamWo9MaAQzqUQALLhmK/M79Ue3mqcI5yITqrjFTlJ+40ezyGZI35S9W4IS3t0mu2Rrbwt+evw93GSPcwR64KC0+AwjEh4WurnzyCaravjclCaOpXVPK1ZOWdr4jTRQrIvhrHJqyo5c5bA6CdBBMXjNHFaGY8pMH9t5LSCOs1cVSylgh4GH3KgGmwR7MqVpRpRm9Xb8rz21wbmWAO61gfYKo0R5rqmd3V6bCXacBm9m+ha9vWQRHvAt7F22ZCOthkjNKJTE6kxed/wl8PuC0FqZDa5WHR5isSJv3lTLZBWJUJthmAzTU4v1he8H9zge1p9XhSu7zeW+QZ3frDq1/pIV1vQ5rBTcgyYdcgNtLS7tyDBYpS53olbPk5YMrIC1j7M3K+Lt5V4OJS7miWnEb2lgSgcwHL0CGRf3CS1Z+yh5WIXlq0Ynd/rKMZV1Lk+Z2jxUuWYoQlR67zXFEVb+6ub8XfPgU27FpcKBpxPAjYfjFbuaJ6UcMJXp7JkwTMg1RDWU+ehu0gVPGQ82//r5Ddj+Pr4dDY5PB1Ut8YE+zSi2jM1s6t6E6DbtrKsISX7oe31/P7AAPQEsHmFgu8irV3Xf9kGN93PpTaN3fpGyJez8MoU75U8NvfPE9gOvF/yqJuClZkuu1UtnJdOwMkkBZ92EFhJIWiPnYD/z0smfYKDQrBtfemRry3Pfu3fZkruF8adiG9PDQurOJ+g8X7UU3e2G4flVo3eFOKs+q+blUrH4bX0nW7D08is1zF1HSbwUMaXLYjxoB1DBE6HdOAXHKRhb209a6amthrAKwG7cUIjX1hRChtcDeGXSOs5nAIITbDGatEDIhreh868vou6mon7AK09tK2nb2imS2st3O+pPaN6/CvZ3KoIsByajwV/XVzfDts7qee+XXDo2jL3rZqyTNCPWjLdF4qw1JL+67GGs7FcsLwZAXb3zcJ1meIPrlIJ/9guFEY041V3/awWoubgCheE++0YomyTG9/5GrBv/A0pyseQ= - + - ArangoDB PHP client: connection + ArangoDB PHP client: failover exception - + - - - Connection - \ArangoDBClient\Connection - - Provides access to the ArangoDB server - As all access is done using HTTP, we do not need to establish a -persistent connection and keep its state.<br> -Instead, connections are established on the fly for each request -and are destroyed afterwards.<br> - - + + \ArangoDBClient\Exception + FailoverException + \ArangoDBClient\FailoverException + + Failover-Exception + This exception type will be thrown internally when a failover happens + + + - - $_options - \ArangoDBClient\Connection::_options + + $_leader + \ArangoDBClient\FailoverException::_leader - - Connection options + + New leader endpoint - - array + + string - - $_httpHeader - \ArangoDBClient\Connection::_httpHeader - '' - - Pre-assembled HTTP headers string for connection -This is pre-calculated when connection options are set/changed, to avoid -calculation of the same HTTP header values in each request done via the -connection + + $enableLogging + \ArangoDBClient\Exception::enableLogging + false + + - - string - - - $_baseUrl - \ArangoDBClient\Connection::_baseUrl - '' - - Pre-assembled base URL for the current database -This is pre-calculated when connection options are set/changed, to avoid -calculation of the same base URL in each request done via the -connection + + __toString + \ArangoDBClient\FailoverException::__toString() + + Return a string representation of the exception - + string - - - $_handle - \ArangoDBClient\Connection::_handle - - - Connection handle, used in case of keep-alive + + + setLeader + \ArangoDBClient\FailoverException::setLeader() + + Set the new leader endpoint - - resource + + string + + + void - - - $_useKeepAlive - \ArangoDBClient\Connection::_useKeepAlive - - - Flag if keep-alive connections are used + + $leader + + + + + + getLeader + \ArangoDBClient\FailoverException::getLeader() + + Return the new leader endpoint - - boolean + + string - - - $_batches - \ArangoDBClient\Connection::_batches - array() - - Batches Array + + + __construct + \ArangoDBClient\Exception::__construct() + + Exception constructor. - - array + + string + + + integer + + + \Exception - - - $_activeBatch - \ArangoDBClient\Connection::_activeBatch - - - $_activeBatch object + + $message + '' + string + + + $code + 0 + integer + + + $previous + null + \Exception + + \ArangoDBClient\Exception + + + enableLogging + \ArangoDBClient\Exception::enableLogging() + + Turn on exception logging - - \ArangoDBClient\Batch - - - - $_captureBatch - \ArangoDBClient\Connection::_captureBatch - false - - $_captureBatch boolean + \ArangoDBClient\Exception + + + disableLogging + \ArangoDBClient\Exception::disableLogging() + + Turn off exception logging - - boolean - - - - $_batchRequest - \ArangoDBClient\Connection::_batchRequest + \ArangoDBClient\Exception + + + eJyVk99v2jAQx9/zV9wDEhRBWduXie5XR7dWVTVVyx6RoiMciTVztmwDRRX/ex0nDZCm05oXR7773n2+d/KnrzrXUTTq9yPow5VBztT1d3i4fYBUCmI3hgUKqdZkgB5T0k4o9qlF9jeN6V/MCKAWToImBHHlcmV8DO6QIXZES2QOoVTprRFZ7mBS/51/OPs42APcLGe3Ax+WKmMawA0Zr9569SiKGJdkfW9qtL2sffyskIc/Gsh/cmH3PsBtNcFGSAkzApcbtWEQ7MgwSrmFTU4MuB9AjloT26b9FvNWcFrM5eL0IjCnEq2tsWoqj+KI5xb2nE9RMbLgo/j68Is2IAnnxQJ4rpUoWoTQS4YHMbgE64zgrLochVMbsUZH0EnKCpfhttnhN7mVKYyWFcCQNmS9FQyMauFHQ4fbP+5uSnklHrZXOcZazaRIYbHiNHRIEqfioOqdhIRyCMVXFU+Syf1VHCcJnEJ3DF1/dJzf5fBLRu4+eOudlO52rR5jcsEFv2+a3s5/qirQtRLzf3q1NW+nrNh0XPmqNgafoXO4u130xvbeh1m7e1vSjn8w7vZNHeO/QHvs8AQSlAJt79VDGI9DeADdqSfzj4rttHpWs+mr7K5f9TMcvmlo + + + + ArangoDB PHP client: connect exception + + + + + + + \ArangoDBClient\Exception + ConnectException + \ArangoDBClient\ConnectException + + Connect-Exception + This exception type will be thrown by the client when there is an error +during connecting to the server.<br> +<br> + + + + + + $enableLogging + \ArangoDBClient\Exception::enableLogging false - - $_batchRequest boolean + + - - boolean - - - $_database - \ArangoDBClient\Connection::_database - '' - - $_database string + + __toString + \ArangoDBClient\ConnectException::__toString() + + Return a string representation of the exception - + string - - + + __construct - \ArangoDBClient\Connection::__construct() - - Set up the connection object, validate the options provided + \ArangoDBClient\Exception::__construct() + + Exception constructor. - - \ArangoDBClient\Exception + + string - - array + + integer + + + \Exception - $options - - array + $message + '' + string + + + $code + 0 + integer + + + $previous + null + \Exception + \ArangoDBClient\Exception - - __destruct - \ArangoDBClient\Connection::__destruct() - - Close existing connection handle if a keep-alive connection was used + + enableLogging + \ArangoDBClient\Exception::enableLogging() + + Turn on exception logging - - void - + \ArangoDBClient\Exception - - setOption - \ArangoDBClient\Connection::setOption() - - Set an option set for the connection + + disableLogging + \ArangoDBClient\Exception::disableLogging() + + Turn off exception logging - - \ArangoDBClient\ClientException - - - string - - - string - - - $name - - string - - - $value - - string - + \ArangoDBClient\Exception - - getOptions - \ArangoDBClient\Connection::getOptions() - - Get the options set for the connection + + eJyFkk1rAjEQhu/7K+ZQ8AO/6lHFam1RSgul9igs2Tjuhq6TZZKtleJ/bxJXLVJoLpNl5nln3smO7oqsiKJusxlBE6YsKNUP9/C6eAWZKyQ7AKmJUFrAL4mFVZpcpS+eFEJ+iBQBztwsICEpSptpdjl4EgRLi7gVRCEldbFnlWYWZudbv3fbb4Fl5QTJwHybLFouneuUsAVzZEfvHd2NIhJbNK43XrUdnm3MjhO3H68mfs+UudgAuy8QdirPIUGwGesdQbJ3N6y8wy5D8t+M4EjnA5k1e6l1yYrS02781epAGuRP5M4o4bGvq+L/+zKKpE8B9Dr9YFTmwpiTl7MVN79FWhu4mPuOPBa8+9OEN7QlEwgwNkzJWDAa10kEBb0Jk/56z4Cd6Akf8Qpu/61SVXdDLMokVxI2JcnQIY6tXgaq3ggFxxH9qcTjePY8XS7jGDpQG0DNhRvrnqc9TtG+oDFuUfXGMGCH6BAdtxGLXAlTv97JYBCyLaitTn/QqlpxsrourjnVH36V7/s= + + + + ArangoDB PHP client: single collection + + + + + + + + Collection + \ArangoDBClient\Collection + + Value object representing a collection + <br> + + + + + ENTRY_ID + \ArangoDBClient\Collection::ENTRY_ID + 'id' + + Collection id index - - \ArangoDBClient\ConnectionOptions - - - - getOption - \ArangoDBClient\Connection::getOption() - - Get an option set for the connection + + + ENTRY_NAME + \ArangoDBClient\Collection::ENTRY_NAME + 'name' + + Collection name index - - \ArangoDBClient\ClientException - - - string - - - mixed - - - $name - - string - - - - get - \ArangoDBClient\Connection::get() - - Issue an HTTP GET request + + + ENTRY_TYPE + \ArangoDBClient\Collection::ENTRY_TYPE + 'type' + + Collection type index - - \ArangoDBClient\Exception - - - string - - - array - - - \ArangoDBClient\HttpResponse - - - $url - - string - - - $customHeaders - array() - array - - - - post - \ArangoDBClient\Connection::post() - - Issue an HTTP POST request with the data provided + + + ENTRY_WAIT_SYNC + \ArangoDBClient\Collection::ENTRY_WAIT_SYNC + 'waitForSync' + + Collection 'waitForSync' index - - \ArangoDBClient\Exception - - - string - - - string - - - array - - - \ArangoDBClient\HttpResponse - - - $url - - string - - - $data - - string - - - $customHeaders - array() - array - - - - put - \ArangoDBClient\Connection::put() - - Issue an HTTP PUT request with the data provided + + + ENTRY_JOURNAL_SIZE + \ArangoDBClient\Collection::ENTRY_JOURNAL_SIZE + 'journalSize' + + Collection 'journalSize' index - - \ArangoDBClient\Exception - - - string - - - string - - - array - - - \ArangoDBClient\HttpResponse - - - $url - - string - - - $data - - string - - - $customHeaders - array() - array - - - - head - \ArangoDBClient\Connection::head() - - Issue an HTTP Head request with the data provided + + + ENTRY_STATUS + \ArangoDBClient\Collection::ENTRY_STATUS + 'status' + + Collection 'status' index - - \ArangoDBClient\Exception - - - string - - - array - - - \ArangoDBClient\HttpResponse - - - $url - - string - - - $customHeaders - array() - array - - - - patch - \ArangoDBClient\Connection::patch() - - Issue an HTTP PATCH request with the data provided + + + ENTRY_KEY_OPTIONS + \ArangoDBClient\Collection::ENTRY_KEY_OPTIONS + 'keyOptions' + + Collection 'keyOptions' index - - \ArangoDBClient\Exception - - - string - - - string - - - array - - - \ArangoDBClient\HttpResponse - - - $url - - string - - - $data - - string - - - $customHeaders - array() - array - - - - delete - \ArangoDBClient\Connection::delete() - - Issue an HTTP DELETE request with the data provided + + + ENTRY_IS_SYSTEM + \ArangoDBClient\Collection::ENTRY_IS_SYSTEM + 'isSystem' + + Collection 'isSystem' index - - \ArangoDBClient\Exception - - - string - - - array - - - string - - - \ArangoDBClient\HttpResponse - - - $url - - string - - - $customHeaders - array() - array - - - $data - '' - string - - - - handleFailover - \ArangoDBClient\Connection::handleFailover() - - Execute the specified callback, and try again if it fails because -the target server is not available. In this case, try again with failing -over to an alternative server (the new leader) until the maximum number -of failover attempts have been made + + + ENTRY_IS_VOLATILE + \ArangoDBClient\Collection::ENTRY_IS_VOLATILE + 'isVolatile' + + Collection 'isVolatile' index - - \ArangoDBClient\Exception - - - mixed - - - \ArangoDBClient\HttpResponse - - - $cb - - mixed - - - - updateHttpHeader - \ArangoDBClient\Connection::updateHttpHeader() - - Recalculate the static HTTP header string used for all HTTP requests in this connection + + + ENTRY_DISTRIBUTE_SHARDS_LIKE + \ArangoDBClient\Collection::ENTRY_DISTRIBUTE_SHARDS_LIKE + 'distributeShardsLike' + + Collection 'distributeShardsLike' index - - - getHandle - \ArangoDBClient\Connection::getHandle() - - Get a connection handle - If keep-alive connections are used, the handle will be stored and re-used - - \ArangoDBClient\ClientException - - - \ArangoDBClient\ConnectException - - - resource - + + + ENTRY_NUMBER_OF_SHARDS + \ArangoDBClient\Collection::ENTRY_NUMBER_OF_SHARDS + 'numberOfShards' + + Collection 'numberOfShards' index + - - - closeHandle - \ArangoDBClient\Connection::closeHandle() - - Close an existing connection handle + + + ENTRY_REPLICATION_FACTOR + \ArangoDBClient\Collection::ENTRY_REPLICATION_FACTOR + 'replicationFactor' + + Collection 'replicationFactor' index - - void - - - - executeRequest - \ArangoDBClient\Connection::executeRequest() - - Execute an HTTP request and return the results - This function will throw if no connection to the server can be established or if -there is a problem during data exchange with the server. - -will restore it. - - \ArangoDBClient\Exception - - - string - - - string - - - string - - - array - - - \ArangoDBClient\HttpResponse - + + + ENTRY_MIN_REPLICATION_FACTOR + \ArangoDBClient\Collection::ENTRY_MIN_REPLICATION_FACTOR + 'minReplicationFactor' + + Collection 'minReplicationFactor' index + - - $method - - string - - - $url - - string - - - $data - - string - - - $customHeaders - array() - array - - - - parseResponse - \ArangoDBClient\Connection::parseResponse() - - Parse the response return the body values as an assoc array + + + ENTRY_SHARDING_STRATEGY + \ArangoDBClient\Collection::ENTRY_SHARDING_STRATEGY + 'shardingStrategy' + + Collection 'shardingStrategy' index - - \ArangoDBClient\Exception - - - \ArangoDBClient\HttpResponse - - - \ArangoDBClient\HttpResponse - - - $response - - \ArangoDBClient\HttpResponse - - - - stopCaptureBatch - \ArangoDBClient\Connection::stopCaptureBatch() - - Stop capturing commands + + + ENTRY_SHARD_KEYS + \ArangoDBClient\Collection::ENTRY_SHARD_KEYS + 'shardKeys' + + Collection 'shardKeys' index - - \ArangoDBClient\Batch - - - - setActiveBatch - \ArangoDBClient\Connection::setActiveBatch() - - Sets the active Batch for this connection + + + ENTRY_SMART_JOIN_ATTRIBUTE + \ArangoDBClient\Collection::ENTRY_SMART_JOIN_ATTRIBUTE + 'smartJoinAttribute' + + Collection 'smartJoinAttribute' index - - \ArangoDBClient\Batch - - - \ArangoDBClient\Batch - - - $batch - - \ArangoDBClient\Batch - - - - getActiveBatch - \ArangoDBClient\Connection::getActiveBatch() - - returns the active batch + + + OPTION_PROPERTIES + \ArangoDBClient\Collection::OPTION_PROPERTIES + 'properties' + + properties option - - \ArangoDBClient\Batch + + + + TYPE_DOCUMENT + \ArangoDBClient\Collection::TYPE_DOCUMENT + 2 + + document collection type + + + + + TYPE_EDGE + \ArangoDBClient\Collection::TYPE_EDGE + 3 + + edge collection type + + + + + STATUS_NEW_BORN + \ArangoDBClient\Collection::STATUS_NEW_BORN + 1 + + New born collection + + + + + STATUS_UNLOADED + \ArangoDBClient\Collection::STATUS_UNLOADED + 2 + + Unloaded collection + + + + + STATUS_LOADED + \ArangoDBClient\Collection::STATUS_LOADED + 3 + + Loaded collection + + + + + STATUS_BEING_UNLOADED + \ArangoDBClient\Collection::STATUS_BEING_UNLOADED + 4 + + Collection being unloaded + + + + + STATUS_DELETED + \ArangoDBClient\Collection::STATUS_DELETED + 5 + + Deleted collection + + + + + $_id + \ArangoDBClient\Collection::_id + + + The collection id (might be NULL for new collections) + + + mixed - - - setCaptureBatch - \ArangoDBClient\Connection::setCaptureBatch() - - Sets the batch capture state (true, if capturing) + + + $_name + \ArangoDBClient\Collection::_name + + + The collection name (might be NULL for new collections) - + + string + + + + + $_type + \ArangoDBClient\Collection::_type + + + The collection type (might be NULL for new collections) + + + integer + + + + + $_waitForSync + \ArangoDBClient\Collection::_waitForSync + + + The collection waitForSync value (might be NULL for new collections) + + boolean - - $state - - boolean - - - - setBatchRequest - \ArangoDBClient\Connection::setBatchRequest() - - Sets connection into Batch-request mode. This is needed for some operations to act differently when in this mode. + + + $_journalSize + \ArangoDBClient\Collection::_journalSize + + + The collection journalSize value (might be NULL for new collections) - + + integer + + + + + $_isSystem + \ArangoDBClient\Collection::_isSystem + + + The collection isSystem value (might be NULL for new collections) + + boolean - - $state - - boolean - - - - isInBatchCaptureMode - \ArangoDBClient\Connection::isInBatchCaptureMode() - - Returns true if this connection is in Batch-Capture mode + + + $_isVolatile + \ArangoDBClient\Collection::_isVolatile + + + The collection isVolatile value (might be NULL for new collections) - + boolean - - - getBatches - \ArangoDBClient\Connection::getBatches() - - returns the active batch + + + $_distributeShardsLike + \ArangoDBClient\Collection::_distributeShardsLike + + + The distributeShardsLike value (might be NULL for new collections) + + mixed + - - - doBatch - \ArangoDBClient\Connection::doBatch() - - This is a helper function to executeRequest that captures requests if we're in batch mode + + + $_numberOfShards + \ArangoDBClient\Collection::_numberOfShards + + + The collection numberOfShards value (might be NULL for new collections) - + mixed - - string + + + + $_replicationFactor + \ArangoDBClient\Collection::_replicationFactor + + + The replicationFactor value (might be NULL for new collections) + + + mixed - + + + + $_minReplicationFactor + \ArangoDBClient\Collection::_minReplicationFactor + + + The minimum replicationFactor value for writes to be successful + + mixed - - \ArangoDBClient\ClientException + + + + $_shardingStrategy + \ArangoDBClient\Collection::_shardingStrategy + + + The shardingStrategy value (might be NULL for new collections) + + + mixed - - $method - - mixed - - - $request - - string - - - - detect_utf - \ArangoDBClient\Connection::detect_utf() - - This function checks that the encoding of a string is utf. - It only checks for printable characters. - + + + $_shardKeys + \ArangoDBClient\Collection::_shardKeys + + + The collection shardKeys value (might be NULL for new collections) + + array - - boolean + + + + $_smartJoinAttribute + \ArangoDBClient\Collection::_smartJoinAttribute + + + The smartJoinAttribute value (might be NULL for new collections) + + + mixed + + + + + $_status + \ArangoDBClient\Collection::_status + + + The collection status value + + + integer + + + + + $_keyOptions + \ArangoDBClient\Collection::_keyOptions + + + The collection keyOptions value + + + array + + + + + __construct + \ArangoDBClient\Collection::__construct() + + Constructs an empty collection + + + string + + + \ArangoDBClient\ClientException - $string - - array + $name + null + string - - check_encoding - \ArangoDBClient\Connection::check_encoding() - - This function checks that the encoding of the keys and -values of the array are utf-8, recursively. - It will raise an exception if it encounters wrong encoded strings. - + + createFromArray + \ArangoDBClient\Collection::createFromArray() + + Factory method to construct a new collection + + + \ArangoDBClient\ClientException + + array - - \ArangoDBClient\ClientException + + \ArangoDBClient\Collection - $data + $values array - - json_encode_wrapper - \ArangoDBClient\Connection::json_encode_wrapper() - - This is a json_encode() wrapper that also checks if the data is utf-8 conform. - internally it calls the check_encoding() method. If that method does not throw -an Exception, this method will happily return the json_encoded data. - - mixed + + getDefaultType + \ArangoDBClient\Collection::getDefaultType() + + Get the default collection type + + + string - - mixed + + + + __clone + \ArangoDBClient\Collection::__clone() + + Clone a collection + Returns the clone + + + void - + + + + __toString + \ArangoDBClient\Collection::__toString() + + Get a string representation of the collection + Returns the collection as JSON-encoded string + + string - + + + + toJson + \ArangoDBClient\Collection::toJson() + + Returns the collection as JSON-encoded string + + + string + + + + + toSerialized + \ArangoDBClient\Collection::toSerialized() + + Returns the collection as a serialized string + + + string + + + + + getAll + \ArangoDBClient\Collection::getAll() + + Get all collection attributes + + + array + + + + + set + \ArangoDBClient\Collection::set() + + Set a collection attribute + The key (attribute name) must be a string. + +This will validate the value of the attribute and might throw an +exception if the value is invalid. + \ArangoDBClient\ClientException + + string + + + mixed + + + void + - $data + $key - mixed + string - $options - 0 + $value + mixed - - setDatabase - \ArangoDBClient\Connection::setDatabase() - - Set the database to use with this connection - Sets the database to use with this connection, for example: 'my_database'<br> -Further calls to the database will be addressed to the given database. - - string + + setId + \ArangoDBClient\Collection::setId() + + Set the collection id + This will throw if the id of an existing collection gets updated to some other id + + \ArangoDBClient\ClientException + + + mixed + + + boolean - $database + $id - string + mixed - - getDatabase - \ArangoDBClient\Connection::getDatabase() - - Get the database to use with this connection, for example: 'my_database' - - - string + + getId + \ArangoDBClient\Collection::getId() + + Get the collection id (if already known) + Collection ids are generated on the server only. + +Collection ids are numeric but might be bigger than PHP_INT_MAX. +To reliably store a collection id elsewhere, a PHP string should be used + + mixed - - test - \ArangoDBClient\Connection::test() - - Test if a connection can be made using the specified connection options, -i.e. endpoint (host/port), username, password + + setName + \ArangoDBClient\Collection::setName() + + Set the collection name - - boolean + + \ArangoDBClient\ClientException + + + string + + + void + + $name + + string + - - getCurrentEndpoint - \ArangoDBClient\Connection::getCurrentEndpoint() - - Returns the current endpoint we are currently connected to -(or, if no connection has been established yet, the next endpoint -that we will connect to) + + getName + \ArangoDBClient\Collection::getName() + + Get the collection name (if already known) - + string - - notify - \ArangoDBClient\Connection::notify() - - Calls the notification callback function to inform to make the -client application aware of some failure so it can do something -appropriate (e.g. logging) - - + + setType + \ArangoDBClient\Collection::setType() + + Set the collection type. + This is useful before a collection is create() 'ed in order to set a different type than the normal one. +For example this must be set to 3 in order to create an edge-collection. + + \ArangoDBClient\ClientException + + + integer + + void - $message + $type - + integer - - - Argument $message is missing from the Docblock of notify - - eJztPWtzG7eu3/MrmHN9Kjkjy25uT6fXqXOr2ErsNrE9frS3k2Y0qxVlbbPa1d2HHZ3T/PcDgI/lcsmV5Dz6mKPJTCwtCYAgAAIgyP32fxezxYMHu48ePWCP2CALkpv06Bk7Pz5nYRzxpNhnYZokPCyiNIEm2Oq7RRC+DW44Y7rDIbWlh0FZzNIMnrHvg4RdFpzPgyShR2G6WGbRzaxgh/qvx3tfPu6xIosAYJKzF/PxcQ8ex+lNwnvsBc+g9xJ67z54kARzngNubqF9ouk/z9LbaMJzFoQhz3NWpKyYVc1ZzrNbnslhDKBZHKumUc4macJZmUfJDTu+ujrvsTsOv7EkLVjC+QSh8bwIxnGUz1iAIBY8y6O8ABoMLrEgmbC3nC9YVOQMOhS8/+04e4odThJoHUx6RnOgIuMVYMADIJDqabxkU+AkD8IZy/j/l9AGYSB47ALjLLJ0CR2CacGzuyCb5ArR6mmCYYb4iLG9/mPibxgHwIfDarb/9QAfE2vx88h4xtIF0S6fqAbf3QYZ0JYFS/nLLv2/yKJb4ALbGsluMGMW6POM7wB6Ph/HMCBkP5sBo4C/wMEMpwRZYYqi6Hc1i2juFtA/DOKwjAHRhN3NeGJOicRLfMt5sRvOgCEc5gHmNLhNo4mCp2BQpynNQw5iZ1LEboMY5oJFSW1qhPjcRgF20uBsgmucEiPzsGpWFItjgfCAdTpP6HE728ZBztn1xUviFZIellmGwjkJQLrg4efmmiboE/MK8VxnsWRUi9jCACYx2JUyh+ECUSESCBSjuu4EcXTLXbgznqdlFnLfTBHQJt7ncXDDIhN4Q+2RDhfGcZrGHmzQ5QcAOEB4TZzPgiKcgXAODCVcWzvHsvMBe/2mCXprFADlt5xQsHT8KwzEhYGeezAYEFwIwmBRlJnEgDzggVMY6o9sJDUoB2waxLmDU3K4F1Ii742tBqUFm9LBuiSvL+O6v1vIL3nByoXQekODaZZ6aLKiCcLB50qtF2K1bAhgMcvSu5wN34V84VLHRZAFcyFIbEsB2wF1ioooiB0GpA5ADqyE5S5k0zIRTUcj6AcMKMOiWwe9Te3FYoSfrQKs185TtZaIHw9gib4zNP1MPOxqIE8a/U1Fgv5dC+7rBrD9/bPzq5Oz09Hh2enp8BD/fMMODmA+EM4OAeo0EYHlPJJztwGOo8HV4NngcvhmW861AbFc4Fwe6wWiK5G+b5q+OAWJ4e/AScE1NLQtIZqnwG2g2F2QO+1TxkG7EmbYf9+MkoeCE2pPIWDtOqfhiy9gWRope6vbCGK3tw0Q+PluGuL47GbVDLz3sAWVJVDiiUtbtWJ6FyGpFcKFWqEb0mXZQo+VgWrQ/7DMpGYfuzG5FdBY/G+3dvMYSBeC0yVcPQnFyW8iAsXVL3TD06Pzs5PTK/bbbzVGr9P3+OzyXv3Ozy7u1e/H4cXJ859Hh8P7dT88OT8eXlzep+vg5cuzn0aXw5fPR5cnL06HRxqCLaAkM8Iy1cWm23lVwnKBoQVKnxTEDusrMejDF3LrTY0Ejy3MOLpq/U5Nyn228TUNB4yUBGuYkt1dli94iAab1Ea52DmHCAl+rJnuDUTo6uTV8Oz6yuYEooOBoooV0ZynpRr0PlvQOk0+YwGjm6Pog3I6jFYNIhK0ga3Aj4A/AkJGkgirl9afJ7W+7ytWMw7L+9rMqBYKDz8MyzsFb7Euip51CkZRQHx8B3ZfUisWoQpWTTg2o1gtOx5664FEndDaOmezsSmj6y9iL6TgqAV/PXstl6nGUFvt6Y2yp3ljzZLwLA1ro/mzrTCeBcZmxTx6x9uX7Jv6cmKzACPNrECtE+hlK9NDcXNJ2iHNLJtbJ3kONg/4RWH2i+FVle9wsmhN5pQQEu4QOIhBne4r2wrBDqdzIYKNdIYcDQrpBc8XMBK+in9dxNpT3nENOsVV7WIlzNDzIIpTMMNdBbi7jZ4Yk7DrUG1N3cokpWj1BVT+jodlwWWQ0hU6Fy94tr//anh1fHY0Ah71mIDe6TQwGPPbJBnYmXPFna7Gbuq+V7Pr836OHoTKENxFhVgU0OR8YKhiygMIBOFpSoRqRQh3IOqbLDHRsUi1GH5S2UE8aoKRhE8sQwLFJxAl5K6SJTeWzyVO159Hmq7/iMJU/jVk6fqPIUqI7pPLkk+UPomAYCr7z7lUHQ8HR3+AtWpwdXj8WcwLIVppYBYyZTpZfg7pIWybGRj2B7UwyN4/hI05Gr4cXg0/g5WRiDYzNB6xm/CYF9yUu3vLlAC1yibJSaIk+Ee3TxL4RxEsweXfSbKGgjyRVMEszzTiE9yli8dB+LZHW8hFtmTBTRAlmBuIID4FTuVszMOgrDYKKV8TZBDXyL1zzEFh1iq4hebBOOZ9doLb1ZiagsC/Z4AlCUao1Z4Gw6mg3cOEBXHBsyTA/SAFu4voMFsWE4NgppIiiomIefAumpdzlpTzMe7gS3BTQkBQg6Lg80WRs1kAEMecQ8ALUFZpDAgxB0IRgMoVVM9S/FWJUP1nncV1faqmoLiTMsS92aWI/uUcaLl3ayyF6iAuYyDP2Y2KEcQsb6x4ckup8gXqmgJYt5mlWls5SAFub82jMEsxedYtslqCBxNMD62wH5Xwlr8q4yJaxHyYTBZplBR5t5Gc290VohrNoR0J0j77FROkuE2sijaMz90sgnaCBEeeD2Ww+St+lIqF466V48PPe0CNy2i3OeVbTkRq4BZXYNIkw54eNFIh/tzb88HJy7Mfhxcqh/rGh1KxTCZSM9xax235Ow5KhyUt4zTD5PKdt7ckCjQ5mi67HcFiodkEDTVb5p8llo6DX5rflObe4u4W752/Av1hCuqdlFwZHaSflBfJWHI9MDNr7IRV5jHni+7jPRD/L/f29lxT+8D9zchLAkVgBogKVe6DghQVlSVLTUHcgqUQmonNcv0j0H6hOVh/1iK1W3zBGqKy8xTs7qEo4VDKY4st4MvmQRz9kyhRrfb39c/HEHFi8q0LKOwFR6TQc0xamWS/NoC+cSbSLfFJUjZPM6WpebU4KB6qnCd4DkXqkiRjo8SywR8KvSl9tR/cpgJEYR5kb0nwuOQpC3B1JCQ47w6e4M813sGM4GQ3h+s3Q9oENdYitwUiNSrjCemMZEQfVd9eiAM2iaZTTuVAaimfYj4ij4CVDbjmDu0mluviZHj5hj1le+yLL5y6CtQmuO2CzNqGhvdG4jOOlmwKJS1SEKIgWTaYQGVcSrV9Ns5v35rSpUTHFJsy0Ua1KTZezdPS48QB9DLhBiT8XaHRNeG7LQt28tkUSdZGdsXq7pQnaWqaeuK0MarXn31tBfOlRM1eWrXv+pdcYzd1poDaG4wsNFs+hh0DoFoT8xlZShq+LGVEt1zPAvjq4KmXmUNJN1iem7L/QWs0fv5jjI3PJsb4r2B1QoyV/2N01jM6Lv23/HnEmfEwnc/BMMDPItcgTEyje5ms8I7bnE3AHWMZAKwaKWUYuLaAxXLBc8bzMFhAIJ6lcwo9HtThNPM6F1xXa8uCmaCIwlpxukzQUYEzlhwgdnouE4ukYyJfYxcieNIDzUINOzmgamjMinUzJTY8e2kWMWqDvHHEg5pZ2U9oewV87GqA2+zhgWlgr34+H46uT0/+rxFuNSnuH7Achp4U024H7fE++3v+97zTYzV8x7RJq/H17GG6K15MM7Su6RhcXx2PcACY8tys1/Xl8KJp3UAag8mEieM50T8DvQ1k5Va2ai1+pGq0A6rk//qrEU/CdMK7voBwIwqxxm2/w/ofCux8cHn509GbGhh7FW2f8AYFnYHJAxQFKQ0fSquY0CaUJs+bjSxRs8er/vxAuTNqm30iZFYRO+SnXbcqzFrD7kXcBqqn4FcV9Ae0feAxCsZhkt3RZLw7ypd5weedRk3det2xqLPMYqk5Ni1rFCtTKVmzdNtK+56sPGfSoyVD1n1TLDPGFSTN8ARZgvvbO65y79aqNJ1tVmWY4Cj5KNWgfqkfR/vFTnW0L0dohQnsRlXl9TrPDevMQe4N3iKvFBcDXZELCy38obbBlEzIdgcWfss6ocs04+FbHEG93DcvcJ7o9EYjc/dwytNpd6ul3lW4YgqcDxZ+VEJKkWc+e98klk4VmJOrxitGSc/VJDlyjvY+QYvGXwylzjtdZ6AF4KE3R/1VuaUsq+4JPwf+yTxeW9rRrs++FLHlDGcYhzOxj9bI+e77E4713DK45IYQgWcGP0jxqDKa6BzTppMeU+U2aVkyDZ+Qvop/tqU32b/2qQuPSFk6dNAUF2PELokSrLHtmzij4q74dts68wgKq1kL+a1hNGoSKRuZgzNZcy8TscZhlHp40GBmUsaxbOzf0FXFAqpKQNhtYoaIa/IyLuzyDjrtqVlBll8IPowahNDgtjwvLfMqGHmOraPJmG1RcAvaLgHYVJ8A4jtnk5KiD9qih2iHkixVKYOA27fII4KAclyJWFTYjzescZhz8KQmiss7dXaJh56eVHDDrJ4rCm+M5vRdlvhhjLVuLQ50xVyIeIaRM8ShiEDGcxzYCpZp85IdWwWskgXJKKtAYe1aMFkK7nD2HgrnytgSg1VykC+TsDodaaodKBlh7drVPaSA5LzWHrw2zd/g8ufTQyoJc4U8Jub6RoxhqExw6pjkK+KN4pE5lpI8O9vX69OD+ukaYZmrE8/AX6clrp8fPZA8wqE01k3VpX7A9UAMrmWfrgqv0+kUOHoJTPUvuc+wJOp8cHHVY9Yevwab6eOuJvfGZRRPtHzVUfcccUGPuYWwUSXzsYclOGxvvDl8+t97sO8/hgyQgJ2L8g3Ze5I+ExV8miQ5SAezESmuTaTYFTBfJlOt+7rhBnvx7WGV95i13XRzsXBK+u858R8yFFu61XkbATcLQv68JJO4vhd+dTE4HL55YtkvBcoRLmG9EqMGGa1AXjFejXt4ejw4PRweSSJccgfOCUzFTBaN1aeLyujwh1c8z4MbqqSjudPT0TDymlkzvQA2IYpHGqvLSCn+dDHAuMJvWmwk5NeP37jFY3tt61Rh6eQQ4nS8uvzeKRAwV+mCC+8xT8O3nKoHCr4vYqc53dGjvUUrBAIHEUOtuo/oCFjkZBuRux2VyKZoYtDWOE8fgqtLPhb6vDe0iSCrMrEwzmUoffKpxp3ES/QwShj5MieJhX5qtyBybKXTDtBVhIco/YVwksO1jsIvt+QI6EvyKRbc6cOnlWhqofwc48JhXAVvQQwa49IbXzjs9kHiZkSJyiLkaARzNBK/6YjySXM0osXrDqKcjHA/yhfpg7R1dI0LetoyTFGbTHjxjNhL6jv3gXAzWadZ1I5UMJlEKMtBrDfMitRA4lwO71vmaA6mGgbVb6it7ISMmbPXlrzN56XaYrlHuZiGBSbJD8cuDnGCECeKNRjw1s2v5CzUCPZyQ3HEd1WFt5M727SitevYsb9PtWMnLhhp1DJ0//aCahbUzq2o8bsLokIdqK8C306ubdbfeuyrvW/aqNWY6WC1YKHB4DU2bRWAdTdv3zf50JIfW3/Yvxjj7rjG7fByH7ryVB67MMdCYSE9rvPVxkdlaJzWyGGzVdE/MsAMtLvSoFsuRK8KOC3YmxvxVgeqgvIRnSgadOVNeMXLcGYkN7xNa3wU6790m7Z79gNg7yFukDSePEsnS/i1HYlewbzNtp1PnEXgHldLIKrcrYyHHC9b6Kn1fY2y49pXFSqp4TrTEy0q+NMsTRe5zHLL4qaEi6z1Apw6lYRpphPP0YVVGUMh5UYWkQ6rykvugpzOauSwpteuDtswO2dqj6FaO3UaAFleLhZxVJ2XMIv/P+S8mnmWxk1Mo6phJkUSV0iPrDbcWNXlW/Z4b4/99psB5ekBmL49h2eLBTkQyTO6J6Jx1GGLZsMmQSiFw52i1g+d+5sSnekCYYZ3GqFjzQs6/hMl9RmpkpgmSar1Afs1T5PRhIutTWysI2kXaunlNyrpzRFU6UCJxUwEyp9ed3iWpdlpOe+0V3G5OlCy5Muv/ucf2+ahRAe12AaGKOqD8lm0wKLBOOaY0gaFS5ObVJ9scnzW8B2+s+iTIWoHgkLjETK3Y1camZ91F/x7senrNdj0NY6Q/IG4WQ9gNTfbVQWe4AaTHFaHv/x8jbXfWlMJ4Rcpt7V+p4x34Oqgmd8zlWSLYMGoWFxBZZ1SR82nxu2nkGDYvjkELNo1Xw+E92HrStccxMY15BrP/cj788YEH0mvPTHAykn/iAHAhhZZD7Qt9F3ynApbsdhbdnf7WjajxZZ8xWY/l9dkssXgI9GpGmd7AbKfvb4EN34amVK1HOdVwYGwa1icKkrek6UsIP3H3n9XazNaUrGiTrBA+LZeilH3R9CYQ2df2T1PeAb+EpIQhZyVSVWRkNX8q7bpaepBxwEQ3GUkxHcEzMfWZhFKkmqvZZqWCZU3katMFraqtX3QROIUptpickEOPQUjiofu+jK3D++4cbJIwX+gPRthyeZzmDrfrq7Y1dlhF/RV1K+Iq3PZuHn7rudqSMB4aGwSect2W67LNUcoW9du8JVjbQyWFzWaBWiRFXAVHlvBgmgudpCACRraDcBKJAMwLiHgrRw0edbOLF4MqoF1BW4fw8xrkNWW2GYMs/iVeab544ztpj62FffabTS/Yi6kAImr7sX51h6Vsilx33bPs7xXWWSOOQUOVIGC5NDuggArkMxBBeXelm4UFSydTldNbE0JBK41VUE0bmeDWa+XAGHUd0cXnADVfX3dOibgZVl+nuKFfQueBaJIE+9ECIvKv4yX4jZ2VaxPgNZiY64mp1b6RwxOJS/1NsMc+qE5AkaiXop0LaCeYGQD7m6teX8Vo58ZW7QrGG3t5q5gtDaDKCG0DRXlVqFkJNViR842McyjP83L1a2xRPlJQtAksFcU7LfrjSk63oGsUHSv/spb3VfRIO9v96JXchiwGe1BuW6TUJNSzIJCqWBuHB7BvEEHC7USQzHdgikusahKsnaAAC5rsNRrApSidOkGQrw7rt/ve+yFqrxSfQQ89Q1Lr/AAX+4sfyM3y0e+UUZHxWxxEPJZGmPYIy9QV7DEWzOME0VyBoQ6U1vBOUDJ3y3ga/3qj6r6rSIF/bg6ORG+IIGr6xgIAfiAMMnJDd3d4pFrwW+SlQWWe2CNaSl2/2o4KjfEmDt/dbaz8NtTZOYvLLENgVmVYpQ+sjWrXOre4CN5gb70GURzVRJaw1jbja4ti3YxSa1shr5A8I1p1Ulr2YzhG/4Xvj1GYJWSaeaLPIUyTe+gXr4pBZmETJQ1Q4iDc4m3JisVgQ5lMdWidlKITWHZF9cfOo5BDn44A+UCOc1ya32xtE+WBkoM+mYq3C1FsC22FhcnZborAq+vnu98o1Z0IaIuMyiPuBnXRBWgVSMYXlfS4joGsMj4zWhOE9vZ3S0xRy8b2yGQynv7ygPlc6Nw0WdY15oi/P6WL3NDjVWqXT4VfKZDG8UUOZSBXc5yENR4ac6oKJsNIlU7rYIxcZsT4iwTnFV2l6WAW5w/mcgJsOfammQxs6umuPVkSOskEriR4ktXlLw4pvGhkXugqhjn5DnnDYSc3jgjemK8sAV8ZwdP1RXfFigLnWizKoVON1Phvv94CVYwjsZZkC1NPwKMLow9juURGyxT0BXOFnLVa0TprrzbmY9HUtgVozqtFQVEFCUM5mNFi7OxTOqoO5yBLZTRaeKjZz3WIVXtyNR+vUbVBR8/LdtWZ2iKCKQWSqERMV5qPumznyqBJVuR4HMpuPviknyked20lmPIUgI8g6ann2PYao/NP3DxMoDa0F0X1PsH35rjpc0nebEYuU/KaAph8u1ueOQn5/F0f9+0z/TkLyUuzTEaN/D/CaWj9otXVsSobaO94k0Jq4MQ2jyU5yK3YZlC7yoTyyZwMjV8dr0UCccGmATRH1j4eeVNJ3SbYBzThV3oassguE70tgw/+nhekjDJcET72zRHCiosrHqO5D67bE+rL26zR4DR2Ds3xiTKFT0LrbzgTx0iMdda0dvdXr0CwXwdgqq2qbMTWeDxyQwXThYmStfDgPBBUYEVwBpgR3KWu6oIWg3igO21Hedc42jw8fDwhxFo0Dd4Svj52cWrN96yeLc8k4fxxBJgRQheLenzQsxSIXMS7DH+xr6/xEtBzi4Oh6OzZ98PD6+aL+q4F+gNc9OORJaWQDogDVJI13aIg1ttKVudClynb0+8z/JdgNc8gsGaL/U56I54caUA+rzMaLtDqnFaR6COLgeTCYwslzd76PywaudRPPP4lqC3SXyrNNdec6KPcdvh7dpyq9/zhWGmAvekAUhTuManBsiGtPlrVz50Zlut0KrMl2b1itRXnXOV7jZWH0wV0UvP6nXsKFB4Xax8/6t1cW7jjXY6IRT1eb+6Yao7S/Nid5FmeDUI8CoTL+VaBHl+l2a+vA3GyFgKpbOb9dxtGYacT/LVoXKVzcMEbOMO1+ZVh1UmpHudxSCT1xcvR4OjVyf0dq1LfG2RaZ/Wv5mwGTTXIFh7b5sDsFaf9QHY4lOF/Z57Il1ZaOPFqnrm7ziF7FUKXc4gWScFoZtmveah2xldLAmWyzxouxTH17nrdr9HwnNRN9JVpeSNvGl9wd9xk66AEf1Nqr2q2Sg1twXO/S6gtjL1NSpFzIPj2suja6+iMJDa7LgrOSJ3Ef+aB2/J6Cso4jXXLMC6QwkhuENegFNEaV1VnwceKbmWmOWkJ5SQ1a7iYpGliyyiLTDev+mzOL25cW1+ed+faCdT5WVeW3NR2LB9r/Xl9OyKXpM3ePny2eDwhzcVOMVysPz06udREEdBbpwvAxcJf4dI+Bf1fm7lBo5/qZphmem/AdBMboQ= - - - - ArangoDB PHP client: transaction - - - - - - - - Transaction - \ArangoDBClient\Transaction - - Transaction object - A transaction is an object that is used to prepare and send a transaction -to the server. - -The object encapsulates:<br /> -<ul> -<li> the collections definitions for locking -<li> the actual javascript function -<li> additional options like waitForSync, lockTimeout and params -</ul> - -The transaction object requires the connection object and can be initialized -with or without initial transaction configuration. -Any configuration can be set and retrieved by the object's methods like this:<br /> - -<pre> -$this->setAction('function (){your code};'); -$this->setCollections(array('read' => 'my_read_collection, 'write' => array('col_1', 'col2'))); -</pre> -<br /> -or like this: -<pre> -$this->action('function (){your code};'); -$this->collections(array('read' => 'my_read_collection, 'write' => array('col_1', 'col2'))); -</pre> -<br /> -There are also helper functions to set collections directly, based on their locking: -<pre> -$this->setWriteCollections($array or $string if single collection) -$this->setReadCollections($array or $string if single collection) -</pre> -<br /> - - - - - ENTRY_COLLECTIONS - \ArangoDBClient\Transaction::ENTRY_COLLECTIONS - 'collections' - - Collections index - - - - - ENTRY_ACTION - \ArangoDBClient\Transaction::ENTRY_ACTION - 'action' - - Action index - - - - - ENTRY_WAIT_FOR_SYNC - \ArangoDBClient\Transaction::ENTRY_WAIT_FOR_SYNC - 'waitForSync' - - WaitForSync index - - - - - ENTRY_LOCK_TIMEOUT - \ArangoDBClient\Transaction::ENTRY_LOCK_TIMEOUT - 'lockTimeout' - - Lock timeout index - - - - - ENTRY_PARAMS - \ArangoDBClient\Transaction::ENTRY_PARAMS - 'params' - - Params index - - - - - ENTRY_READ - \ArangoDBClient\Transaction::ENTRY_READ - 'read' - - Read index - - - - - ENTRY_WRITE - \ArangoDBClient\Transaction::ENTRY_WRITE - 'write' - - WRITE index - - - - - $_connection - \ArangoDBClient\Transaction::_connection - - - The connection object - - - \ArangoDBClient\Connection - - - - - $attributes - \ArangoDBClient\Transaction::attributes - array() - - The transaction's attributes. + + getType + \ArangoDBClient\Collection::getType() + + Get the collection type (if already known) - - array + + string - - - $_action - \ArangoDBClient\Transaction::_action - - - - - - - - - __construct - \ArangoDBClient\Transaction::__construct() - - Initialise the transaction object - The $transaction array can be used to specify the collections, action and further -options for the transaction in form of an array. - -Example: -array( - 'collections' => array( - 'write' => array( - 'my_collection' - ) - ), - 'action' => 'function (){}', - 'waitForSync' => true -) - - \ArangoDBClient\Connection + + + setStatus + \ArangoDBClient\Collection::setStatus() + + Set the collection status. + This is useful before a collection is create()'ed in order to set a status. + + \ArangoDBClient\ClientException - - array + + integer - - \ArangoDBClient\ClientException + + void - $connection + $status - \ArangoDBClient\Connection - - - $transactionArray - null - array + integer - - execute - \ArangoDBClient\Transaction::execute() - - Execute the transaction - This will post the query to the server and return the results as -a Cursor. The cursor can then be used to iterate the results. - - \ArangoDBClient\Exception - - - mixed - - - - - getConnection - \ArangoDBClient\Transaction::getConnection() - - Return the connection object + + getStatus + \ArangoDBClient\Collection::getStatus() + + Get the collection status (if already known) - - \ArangoDBClient\Connection + + integer - - setCollections - \ArangoDBClient\Transaction::setCollections() - - Set the collections array. - The array should have 2 sub-arrays, namely 'read' and 'write' which should hold the respective collections -for the transaction - - array + + setKeyOptions + \ArangoDBClient\Collection::setKeyOptions() + + Set the collection key options. + + + \ArangoDBClient\ClientException - - - $value - - array - - - - getCollections - \ArangoDBClient\Transaction::getCollections() - - Get collections array - This holds the read and write collections of the transaction - + array - - - - setAction - \ArangoDBClient\Transaction::setAction() - - set action value - - - string - - - \ArangoDBClient\ClientException + + void - $value + $keyOptions - string + array - - getAction - \ArangoDBClient\Transaction::getAction() - - get action value + + getKeyOptions + \ArangoDBClient\Collection::getKeyOptions() + + Get the collection key options (if already known) - - string + + array - + setWaitForSync - \ArangoDBClient\Transaction::setWaitForSync() - - set waitForSync value + \ArangoDBClient\Collection::setWaitForSync() + + Set the waitForSync value - + boolean - - \ArangoDBClient\ClientException + + void @@ -4181,28 +4802,28 @@ for the transaction boolean - + getWaitForSync - \ArangoDBClient\Transaction::getWaitForSync() - - get waitForSync value + \ArangoDBClient\Collection::getWaitForSync() + + Get the waitForSync value (if already known) - + boolean - - setLockTimeout - \ArangoDBClient\Transaction::setLockTimeout() - - Set lockTimeout value + + setJournalSize + \ArangoDBClient\Collection::setJournalSize() + + Set the journalSize value - + integer - - \ArangoDBClient\ClientException + + void @@ -4211,1984 +4832,1686 @@ for the transaction integer - - getLockTimeout - \ArangoDBClient\Transaction::getLockTimeout() - - Get lockTimeout value + + getJournalSize + \ArangoDBClient\Collection::getJournalSize() + + Get the journalSize value (if already known) - + integer - - setParams - \ArangoDBClient\Transaction::setParams() - - Set params value + + setIsSystem + \ArangoDBClient\Collection::setIsSystem() + + Set the isSystem value - - array + + boolean - - \ArangoDBClient\ClientException + + void $value - array + boolean - - getParams - \ArangoDBClient\Transaction::getParams() - - Get params value + + getIsSystem + \ArangoDBClient\Collection::getIsSystem() + + Get the isSystem value (if already known) - - array + + boolean - - setWriteCollections - \ArangoDBClient\Transaction::setWriteCollections() - - Convenience function to directly set write-collections without having to access -them from the collections attribute. + + setIsVolatile + \ArangoDBClient\Collection::setIsVolatile() + + Set the isVolatile value - - array + + boolean + + + void $value - array + boolean - - getWriteCollections - \ArangoDBClient\Transaction::getWriteCollections() - - Convenience function to directly get write-collections without having to access -them from the collections attribute. + + getIsVolatile + \ArangoDBClient\Collection::getIsVolatile() + + Get the isVolatile value (if already known) - - array + + boolean - - setReadCollections - \ArangoDBClient\Transaction::setReadCollections() - - Convenience function to directly set read-collections without having to access -them from the collections attribute. + + setDistributeShardsLike + \ArangoDBClient\Collection::setDistributeShardsLike() + + Set the distribute shards like value - - array + + string + + + void $value - array + string - - getReadCollections - \ArangoDBClient\Transaction::getReadCollections() - - Convenience function to directly get read-collections without having to access -them from the collections attribute. + + getDistributeShardsLike + \ArangoDBClient\Collection::getDistributeShardsLike() + + Get the distributeShardsLike (if already known) - - array + + mixed - - set - \ArangoDBClient\Transaction::set() - - Sets an attribute + + setNumberOfShards + \ArangoDBClient\Collection::setNumberOfShards() + + Set the numberOfShards value - - - - \ArangoDBClient\ClientException + + integer + + + void - - $key - - - $value - + integer - - __set - \ArangoDBClient\Transaction::__set() - - Set an attribute, magic method - This is a magic method that allows the object to be used without -declaring all document attributes first. - - \ArangoDBClient\ClientException - - - - string + + getNumberOfShards + \ArangoDBClient\Collection::getNumberOfShards() + + Get the numberOfShards value (if already known) + + + mixed - + + + + setReplicationFactor + \ArangoDBClient\Collection::setReplicationFactor() + + Set the replicationFactor value + + mixed - + void - - $key - - string - $value mixed - - get - \ArangoDBClient\Transaction::get() - - Get an attribute + + getReplicationFactor + \ArangoDBClient\Collection::getReplicationFactor() + + Get the replicationFactor value (if already known) - - string - - + mixed - - $key - - string - - - __get - \ArangoDBClient\Transaction::__get() - - Get an attribute, magic method - This function is mapped to get() internally. - - - string + + setMinReplicationFactor + \ArangoDBClient\Collection::setMinReplicationFactor() + + Set the minReplicationFactor value + + + integer - - mixed + + void - $key + $value - string + integer - - __isset - \ArangoDBClient\Transaction::__isset() - - Is triggered by calling isset() or empty() on inaccessible properties. + + getMinReplicationFactor + \ArangoDBClient\Collection::getMinReplicationFactor() + + Get the minReplicationFactor value (if already known) - + + mixed + + + + + setShardingStrategy + \ArangoDBClient\Collection::setShardingStrategy() + + Set the shardingStrategy value + + string - - boolean + + void - $key + $value string - - __toString - \ArangoDBClient\Transaction::__toString() - - Returns the action string + + getShardingStrategy + \ArangoDBClient\Collection::getShardingStrategy() + + Get the sharding strategy value (if already known) - - - string + + mixed - - buildTransactionAttributesFromArray - \ArangoDBClient\Transaction::buildTransactionAttributesFromArray() - - Build the object's attributes from a given array + + setShardKeys + \ArangoDBClient\Collection::setShardKeys() + + Set the shardKeys value - - - \ArangoDBClient\ClientException + + array + + + void - $options + $value - + array - - $collection - - - - The collections array that includes both read and write collection definitions - - - array - - - + + getShardKeys + \ArangoDBClient\Collection::getShardKeys() + + Get the shardKeys value (if already known) + + array - - - $readCollection - - - - The read-collections array or string (if only one) - - - mixed - - - - mixed - - - - - $writeCollection - - - - The write-collections array or string (if only one) - - - mixed - - - - mixed - - - - - $action - - - - The action to pass to the server - - - string - - - + + + setSmartJoinAttribute + \ArangoDBClient\Collection::setSmartJoinAttribute() + + Set the smart join attribute value + + string - - - - $waitForSync - - - - WaitForSync on the transaction - - - boolean - - - - boolean + + void - - - $lockTimeout - - - - LockTimeout on the transaction - - - integer - - - - integer + + $value + + string + + + + getSmartJoinAttribute + \ArangoDBClient\Collection::getSmartJoinAttribute() + + Get the smart join attribute value (if already known) + + + mixed - + - eJzNG9tu2zj2PV/BBQzYLpxk23lLmux4Mmkns2lSJCmKQVsItEzbamTJQ0pJvIP++57Di0RKlGS7me4aaGyJR+d+JdXX/1otVnt7hy9e7JEXZMxpMk9//YW8/+09CeOIJdkRyeCmoGEWpQnAINjPKxre0zkjpHjiTALLRZpni5TDGnkDi/fkHV0zLlfCdLXm0XyRkbPi16t/vvxpBDQiwJcI8nY5+W0Ey3E6T9iIvGV8SZM1PH24t5fQJRNAmlWoHhf835WsknTylYWZ5nhsS0EiQagBINmCZngnF2xKspSsOFtRzgBiSgSDP7SiAQTKFgwW+QPjB5rCHdzRGFkS0pXIY5oxcfR6wsnhKUK8zmP1HUenEkGYxjGTWAWZslmUROr3DLQXp+F9lMwdeOAgpzH5Sh+oCHm0ysgsTwquJBidTiUSAEtXClsc3TPySKPsTcpv10k4krjvoiVL80xKCeLSpZA4DhWPRqCspk/C2Z95xJnQEiQJc5YRXwjKnTAi5aFx9B82RXyPUbYgIBl+I2W97NAAfLNonnOKVwfScMnavWuwC6aIcQa+wx7AdpO15Ekx0hdkyYDQVCsgW0SWLaSsYGhpjx6u7Z8CwrHkYtA3aiWD4V/rNOfAwZR9O+4Pj134s9KAA8o5XQ/6nNFpn5yckv5yHeBFUFp5RPqPPMqYXNfwsBq87MMK/HjVHw4VideHhrnSfdApCkl8AtBtuA9/JOvgShhQ+C8WKVmweMV44bwCAwrN6cQD+FiYxesRmVAMTBAHjBsVgeHVACD5iFzadulJblF7PQGeksxJNCMCvmM7AIculhuQfkckHvlVyuQpCJ2tlfYI6ZXPEfnZlxFn60BBqvyUhHE+haibpBBFaBzp/NIm1jN2GnGpLqMn0CLpcUcyQxXv7tdJg7xa3AHImyYx3ErY0I/50dW8xizv7opaQ/SopaZSVfoupmwqhJuVXTyTNI0JslhmQY3no3VHuVg12ZdYoiTDh3p2+lRYLq07XixO0fSUTHClEKvpy4OfZKkLY5TIqmZ7f+0hKVnm8PNCO0sl/epFA/PzA+VQSw2Qvn0ov1c8eoACRXpBiQUKqYeKJQpkVZqBUSY5lLYDHzVp3QqhNAP04CO98llyQj59qZOzYg7UPWVPDiZgVGTk/Oru5o/g7Pry8vzs7uL66hZw9S0H69fRjnXZb8U4ltgQmZa1jsf2lnZkH8cXd8Gb65vg9o+rM8RpuZ4HMToQybQHtWO+vD77d3B38e78+sMdIra80YP4vSztHSjfj2/G76QaVSfgwYMJsQPLzfn4V8Qhy4hHdzcXd+ddWpMwJ6bW1JFIF+sFOvJ1erByQRGr6awahQdNTqmx1Yld6P5FsCouf7QhHz0bSmU63a+Y9lKsWBjN1tUGcGREwLQ+yzksc4PYdHLYF1Y5iRK8vUSBqaZYjcvzJ7pcxezIXKvyba6IGzxlfS8BSL3424tENgwlkr6zOLSuhiOLqo4y2XDYLcu3vg1lxw2CZjxnZnnoClo4ifRiK+9hrS1+q89+tX0Fy2gjVdDoco0f27hjeXu/Ygvd8KpGdUozWmUtW/D0UZDPbg34rL7On0K2qifqfBJHYdEtkSCQIcPzMBv4ZRxppuv8npAkj2OlN1VRlFyy77EKAQD27LJgIKFUDyIRKB+ooR8OLaQW4kkexVOrmI2LMvCGp8txA7KS6rc99bcWoedPLAQ09YJbiUuY7h6jOCarVGQS+M+c8bXbMZhhIueqgMOIk8cZ1DtRxA05y7lI+YGqvfK3jG4Ad0IcQoVTzZZGU6uV2hEKkxN5g7DiGlRt+9aMRrHlm5pR1XthTMiGNA9DJsQsj4shixqRHmgMQDqBOPdk+4UTopBNeJSYWbPLEZnS/qDmTiDzClyUqcsTj3/tn6IpBo6zfOCxODr6cHMZ3N2Mr25VOR75/GmOk5dBNRjun34VaRLA1A1zTvDI6QpqwMAMRYWvDQtUlmsVvJr4KG5IMr8LJFD1f1DTwH3wU1/Zuf+lFgNa103wtpfvVZ5Bux43+f5N6aqdbaDGZ2WLWv5zHqzWyMLkFc1XDG9ErZm7UYhbltV2Qrw1TNZ4aSIBfh1PyYI+MPIKXH6yL+9DAcXtIRgj9ByL4WzK1uMiChfFkyn80aG5QqIPDn1D0VNs/XVG51oZTK3x4tsw0M9VNYl+JteDe7YO2FMkMqEH9JF5pCHZ+qZX+cAn9fyXWmJtJqjUtwHF+tStSSoMdZoeX3hb2QGwJwknlaMBhbZgwxwsPA1gQ1BsbL65a7525wfggWDx7OioNq4MG6NBbmkpYjY7FX8zQ7EX5Bn6i3IfzO+bpdUdCXW+JgPF39A4TaO08w5ptUK1uBvUo3nB+Ha2UZy3m8XeOWixjdxo+DstY02g25nHGUjBSsjpZjbqFF1rV8puAXfZyhZlO4M5sjQzj8XF3qtpsRtu7fydZrM2iLYzmz3tg9WAz26jvd1Ebq1hFNyC7bKZLcd2NrMFaTeZ2oNos5YnZT+zvdS2SWuJbjCY2ksZ6Wq6mbHaJHaqlDmoaTeSZn47+yi+m/mEtu+BJaDEkJXEYNYx+/QqS9Y2e80cAu0aZnF4gMoZxaCFGr0kM5gC622gadxro9P2bVdDe2I0VLVpOTN8aqjhX5wFuW31BYcHiXZ3Hc5/mA53cKuaEtsdbDclfp//1Y4x/j/cz9+PP5f34b7rcznfD1HgDr5X1eDzup7UYFtNkq8LFFj9DtGDwal6q61CbVmRBoh/1DIu/iMSgeqVJWhtWFP7Swl7rFIe9C8SwBpNyTQN8yUslaISwNR3hrcWb0WyGzjirTy4L2mMyJLOQVp1XF/Rlhz48HUNB0ididI4RkWWZ/7WJq5xXINnysKYqkEijj2CCjKLuMiatun8xiqgJG9+tzDTGuiG4LZzqVrcrqgAm6NUtTG3rzfocCei0fnMVl4aTVtdKAi6nEiAysIFUd5TcZ6QCtwn9cYSOXJALd+obHg4rZD9mUDauT+uE+xXjpRFv5VWU5XfgqB7Ot5BryGtb06uPoS20nOn8t3IuOeSrdqsT5q7kXQOLNsoeoak3Sjq88w2WrpH3obMlM1oHmdtWN346sTauhXWXXHs1LIv04k8BezIFCrHmNxiPzAiVx8uL7GYlEkKUm+SZliAukq0yhvb5pSNQrw2udRb0eeN8RrBWv+xgW2d6qwPDfw1s/HMwA/edmSAx3uts+Z2lbcwMPxe4rmKPN9Caw9x64DxBMppbbN+03r4P3baIGhy2/qoLKEaFXsh8AXW+Zxx9RpiCFqRL4lJqw/x2I0tV9kaf+Kei+qho0nMzBsLked1mu9RGG7GMbC1uhTqiBDYmNEYYmCAwxJcaS0NO9SkndejqJ1duzza8vux5LPj7EtYB5VaTRs5oruxrE/Ccs5lQ+jB1qSWLL1V/XbHOZh5v6RBmF/wdNx9c9VuS3G2omQewfDmPRIxs4Z+SaShgf2e/bCNju81+RYH0RCNI1nL8ZLTZXXi6UrCPgSq/WrjwXRfbU/vQtnpyNoYcBqyDTDtwozdq7Xx4rRq3Yh2YUU1cW1MmB6u7el6swUcyLcrAxh5qRhYfn10JBdGpP/Z/HcEEzaTzxYcDsT/BWjOaJI= + eJy1XG1z2zYS/u5fgXQ8tZyRkyZpvzi1r4qtJEpsySPJyeWajoaSIJkJRWpIKo7u2v9+uwBIggRAgJbi6Vx8JrD77CsWC5C//2t9tz44ePr48QF5TDqxFy6jy1fk5u0NmQU+DdNTkvjhMqBkFgUBnaV+FMJIHPzH2pt99ZaUkHzeBZvCHnqb9C6K4Rl554VklFK68sKQPZpF623sL+9ScpH/9vyXZ8/bJI19IBgm5M1q+rYNj4NoGdI2eUNjmL2F2U8PDkJvRRPgTStsX+ZifPCCDSXR9AvgJTFdxzSB5yAG8VQxfp/G504SgR5m+IiQX548Z1BmgZckiDKj+L8DfMxQ4M9jMr6TFUf8OWmtmLxTSvq3V1dkAToK6b00KDkWkzMaf3zzYrLyv9M5OSkTEyOesn/Xsf/NSyk5nPhzUEU9ENThQ6EkYCVQ5UmVngENPrLiSbfrB+Pxw7QMBokZwOAjK5h7z09fR/FoG87IN+ZKD0Q2jaIAoCn0DOCkcVaMX6JNHHrByP8v3Q0j155CzgBRGmeF6CejbZLS1V50WCZmcnwxyAHahyjwUj/YUXk5uDI5I7xs2Ev2RAdy7mN4TTcpHd158Ty58r/uiDHLHGbKBri6CfbEsllNaTxY8Cn7Qa6jaUo2paFmNcOiEPgzD3m/9mYpANoLUgNZA1hltBnvyg/91WZlxI1A72M/pQlJI4SfbGYzmiSLTVCH10LWgBtmDd2hJ2gKWDBGaQzTl9v9aFpP1QC4OtjqxWzCe7rd0YG9OPa2GdiCXB1KHFWjy5UXp+8iP+ykIjT3pE0DXRNSZbhdo6mXbsrya5YhzSiFNxti5feVbgdrJriZZ2Yew9gq52KYyv2iVOP54Zx+L1GZwayUdPvj4adJ75KckSN/flRLhlVo9YT6nesuksKh9cRYeVVPbPzphhHDofXEjqQ65chC9WOnN56MPvUvkLQ8r56DVGbYOLwb3A77navJqPcfhl+eWs+Ee5KN/mjcGd+OkLIYX0+0cBIb4ffdT5PBzbg36DPq0sR6DlmRY6PfG4HiR+PuNfO2bJKNdlahOFD/MLjqjHtXXU4/n6jPXjIXXWFh43fZG42HvVe34+5k9LYzvBxNrnrvGWsttXoxy1WCjXX/9vpVdzgZvBacWciVKdhlVlZYG9dh9+aqd9FB/5i87lyMB0Pkq5Kxs9Yt1zbu172+AYGWmh1EdQm2hh2qutd/A/E37Iy7bz6xCKwSceSLi6oTQwzKUc6JTXNgoayGVl7XneEYMhcouTMWbs24qpRUR17H0ZrGqQ+lXrTmfQyFDc8rk5vh4KY7HPe6TKZioobqPJptVhQW4bp9NCeOK8XkcnBxew3SAOHnKjU6XyrbexOl7uUbFP6FSqUPFcw0isNSz0YhwhP0pN/9OHk1GPaB1DOV1G0YRN4cah0XUrf9q0Hnsnupl+3KnVBORiOc5EFTiv2UjYBoJveqiwEhoftVJXtJA5o6wrvsXnXHjNBvOnwwMt7M0oR4IaGrdbpViebl1NqLvVXWGTpktcsJL2GwFE3vaM3c9C6O7hPyudxy+8z/6X6fUdXL15spZCCy2IRcg5PJLIPb4tzPYNcYBLzo5V05/PEXRDx/dCZGSE/x5zC985OT84SmfRjGBx+/zIf8c8D/t6otnge3ZEXTu2iOe7AcEPEqpbhBfr28FQ3zkvWQlakJdh5CP/W9gIg/oLLNjGKaQm0k9ys1OsUqR1btLKaQa1/H0aqDvFslBFX9Hkoxf8bETmiwaB0L98IfgEi92R3YQWD2EnIIxQ85OxdUFZMURJlhWji8nQ2WbZP/KiSVZr40GO4NTZl7zunC2wSm9FdVYd4CVfueei0uaXrJOYyBaquqt4wsKOv0tJRfTbgvgiiklXZ2CeqQkUx47OHgqigrb+nPDPJ9i6rNZTXgkKYiiAifCWyC1B8ecS+VwSwgXQfLzVTrYLmtaR2ctxhdYEgtP/tgbevNqI1yt6uestq4qRmsK92Mg5UGSx3losHhoA1Ns6E8WB+lXhZ1+YEOE4NEi/r1pRQIRXRD2nk3GvRPaDiLcD3nxJsESZ4ESnQMC68aQGk0YgRMyUCoK43eJVHYOjapZifx9iFJBlAvxRd4NuEUW0IiyIWdIGgdP0Ak8AEaw3oH8ewqEp5kSpOchRrlc8zZWoxwFoy5cRCUhMpiIDEIkjWp+L/g7DYCeoEybNV8DZGEy94Z+bO05vKVKO9XFT+4Suc5vm2cw1pTmjmY6s2zim5ReZaU882Ty42gc90aYJ5cNEsqMoo1oXZm3ggpz8wWCPNc1nPTaAkrD/Ms0ZFSZvH+lHme3HCS5xWdp3zqX0XWLtXOmKNZ6Vy3sin1G/exP2Us+nbOX6SesrbW0+IqL6IuiKpdHhmL7lSJo3DTkrJKuwBS2y8yJMPZURNUunLABZi+NySDMx8QNcFXrUBcsCltIxmWegxkgeQnE5Z2W0qdc+wMhrWUFBTFMU8jjSiVkxMMTbepBEhzmlMgU8oSzsG0xI1YpaZbnyrrG57X4LavlQ9gm6ljstok7CArq/eeKBP9hNz7Adv0+nM8m8FCgZ+DiWKwoOmFc8LPxtg2G/5/RodmO23UdUEBiPsho1xl3GijnrVCUESCy3dJyspgfgwndrQwuDjTNWnPeaOm7JcrBQD62SPwc46XDVV8m2sOd/MV0VtHPa4qrcHZBvpIv0FnjRi26wf3Lhcb5o5Mb95SNv2FZzbjgwWKrfezL155WWNm+LGocPbHV66IzKzfFfXR/ljn9VSNNUVptVemWSlWxzary/bHGOs4M0fW8dkbL179mbmNWBW4P35S1Whm+j4vIV0ZZ7/ZAehLRTOWS03huMe8USkTa3JIqWjcv17UEsyMRanG9g9HXxWaIV1rasT9o1LqwZrAqVSHPwgMqwctKLA6/AHsNXVgDRClKmyK6OlTsgm/htG9VBO0eeUG5Z2/DKNYnHbpy8i0enfaWAjyAkWUcVCNYJckhAIPMgEWYRKRJU0Tsllj1chOaZJoBUUjTItV+o3qPV7CHfqmO9rVwg1vjtoKN6x3/Ln2DKtos2cHWeTnn0nlzzjZvZQb3UWbYE7CKBUKsmrTUNuV+5cI5oy0eH15jJhsRzGV+/I+trxi6s23hDlT9SJb6epVQryYgpVDGjMTYysP783R+BuYOAqDbbWq10yH7T6NwRbgsCS/Vzf1l0uKR5mgi5u3N5Nefzy57vz7Se6NEQge+N402ELxD65d3gaBJDRI6D14GgSBx9uSfI+QcMUDj01CTf6ivf/fJuVrf6Aq6fk8ogkz5xYUe+d9w82Q8tKA2ibsGRuehUXrdn+p+qbBPjZS0pnyDnsh6VC3IqOXgJOkLWkrxEbJR5dy5JUOkeXYyx/w+bvGHyPXNAJLWOTg4+9iOIcff0vEFoDOh6KylzFDWPysDq3G03C7qW0WwH8QWYsNrjsLNTITccbdOiZHFC9vkiieY6hH6DEweO4vFhC2YcrvUbIUwGwTxSsvgKySsyWwhwM7eat1gOOAdNbNQEpA8EWJPOfLbDtf0pMC1E6tB7xKe8iQnnDAZ+Q5OTnP4BZc2tnjF/i4AmGHIOMbHqStX7sY0zO8uicuHR2pZQgHZjwQZ07BMmqVJorhQg+vHZlLf6kRr43y/AEXc9coZ+SaRnkh+KMzrao4YM0AlP0BTR5GCteoyj0TA74io4JHCn+QRpZUKRTZIDfxN8Z+SG6qu6Iho26Qm/jZzG7ZSZ+c9JSbJwxx9T67gw+lwxl5xtKGuIXXzm7ni3SS3VeT/s7yiPLXX/Gv5Ttu0tPf8Omc31rbIedkbQ9O17y4M1cUg0xru8Cmi3vpUUZl19gXJB8S/Y/8UBxQlLOd7iSwfL6LPzwhVK5PtuuHZZcPLcOcBpWvM1oGi7uKpUF/4QvD2esa8HNc/NY8uQkzuKe3ikvkDtEgh4mpzllMfknGlsREQFjSWD1kTSLDxgK/drxbzhHXCKVXb05IB+94JNHM91IfdytsyCwKU88PMSY4XyhhYFZyylaANl6HiO5vIbyxadIGFUG6xJqiDRG1gMSgoGyQVOS2ZoHUnFzEYaE0VE4x6nk7Oo38VpGz40hWcPce9XUnmw9J8lv8yC5F5kuml6Er/sHerM0PxKyTGhhVc9SiNyjL/VhTChh//w2r8QSBZfM01YyMNJtpM6zmfXNXm7q9Ya5aVlaCxbSlt9LrbWt6i1xXb2Smtc5pYFrNUZYxVkWTp8aUMjJXU2pey2+W3C0v4quWlGW2WLL08n69JbWv29eGaDbjlCw82JadnMNKGpc3m7BWn5wnnO5eNprVI8Q9xnGuAFfLV7920DCC675voOnRZYLbOnX5BxFs5tZ+wMBi8Po5jexYPZPdqyVznO62rH4eorE16z4IobNnrgCrRcvfkODHLSa7Fpfo+DvoCQmqX32o2Dhrt2ZWtn414iH2rjuirYhvuULvZk/tZGebNv2AhmperbwWQ5vvP5rDuOZDGXVLsMu0Jj127cF3k4i2r80VyK6OoP86SVNHsH+PRNPvLivF1vnWXDiVIt1k//rPeFRcQJxYZk5g/CIK9dnxqCfEhn1VTH5KvJQGgZ/Sn0zKcvEU4wWAHZwF/yqes35wjvRI40aq0K6eZFRXU2dy+vSK6k+q6iwuZbgwXL9+aN8Yck0r7pMbuEzdtZH9phjD21Ju7mGWvbmHWPVodBKtsix+Yr67Xe8qtR/ksRQZbnObdIMNd3kMxYXC39XM2USUqPRxo6Y2dvmckabHVxXT1u3TXoB3sKvy7aKKQeWXgo3fO3qwIeXrUE1iXLTjjBFewGxkb/m7UE17b7VfgjIYmInvYtnipQKLSfFqF/kS+fJl7SbhWv+1qAfZ2XjbzBSyKgZnIxrFf0Dc2lRpNq0qsc3Ghvc0/jkAWdmnSCde4HtJq7jSdHrK/t4mR5+zT6tmn1mYfr4onXD8H33Kbwc= - + - ArangoDB PHP client: result set cursor for exports + ArangoDB PHP client: connection + - + - ExportCursor - \ArangoDBClient\ExportCursor - - Provides access to the results of a collection export - The cursor might not contain all results in the beginning.<br> - -If the result set is too big to be transferred in one go, the -cursor might issue additional HTTP requests to fetch the -remaining results from the server. - - - - - ENTRY_ID - \ArangoDBClient\ExportCursor::ENTRY_ID - 'id' - - result entry for cursor id - - - - - ENTRY_HASMORE - \ArangoDBClient\ExportCursor::ENTRY_HASMORE - 'hasMore' - - result entry for "hasMore" flag - - - - - ENTRY_RESULT - \ArangoDBClient\ExportCursor::ENTRY_RESULT - 'result' - - result entry for result documents - - - - - ENTRY_FLAT - \ArangoDBClient\ExportCursor::ENTRY_FLAT - '_flat' - - "flat" option entry (will treat the results as a simple array, not documents) - - - - - ENTRY_COUNT - \ArangoDBClient\ExportCursor::ENTRY_COUNT - 'count' - - result entry for document count - - - - - ENTRY_TYPE - \ArangoDBClient\ExportCursor::ENTRY_TYPE - 'type' - - "type" option entry (is used when converting the result into documents or edges objects) - - - - - ENTRY_BASEURL - \ArangoDBClient\ExportCursor::ENTRY_BASEURL - 'baseurl' - - "baseurl" option entry. - - - - - $_connection - \ArangoDBClient\ExportCursor::_connection - - - The connection object - - - \ArangoDBClient\Connection - - - - - $_options - \ArangoDBClient\ExportCursor::_options - - - Cursor options + TraceRequest + \ArangoDBClient\TraceRequest + + Class TraceRequest + + + + + + + $_headers + \ArangoDBClient\TraceRequest::_headers + array() + + Stores each header as an array (key => value) element - + array - - $_result - \ArangoDBClient\ExportCursor::_result + + $_method + \ArangoDBClient\TraceRequest::_method - - The current result set + + Stores the http method - - array + + string - - $_hasMore - \ArangoDBClient\ExportCursor::_hasMore + + $_requestUrl + \ArangoDBClient\TraceRequest::_requestUrl - - "has more" indicator - if true, the server has more results + + Stores the request url - - boolean + + string - - $_id - \ArangoDBClient\ExportCursor::_id + + $_body + \ArangoDBClient\TraceRequest::_body - - cursor id - might be NULL if cursor does not have an id + + Store the string of the body - - mixed + + string - - $_fetches - \ArangoDBClient\ExportCursor::_fetches - 1 - - number of HTTP calls that were made to build the cursor result - - - - - $_documentClass - \ArangoDBClient\ExportCursor::_documentClass - '\ArangoDBClient\Document' - - + + $_type + \ArangoDBClient\TraceRequest::_type + 'request' + + The http message type - + string - + __construct - \ArangoDBClient\ExportCursor::__construct() - - Initialize the cursor with the first results and some metadata + \ArangoDBClient\TraceRequest::__construct() + + Set up the request trace - - \ArangoDBClient\Connection - - + array - - array + + string - - \ArangoDBClient\ClientException + + string + + + string - $connection + $headers - \ArangoDBClient\Connection + array - $data + $method - array + string - $options + $requestUrl - array + string + + + $body + + string - - delete - \ArangoDBClient\ExportCursor::delete() - - Explicitly delete the cursor - This might issue an HTTP DELETE request to inform the server about -the deletion. - - \ArangoDBClient\Exception - - - boolean + + getHeaders + \ArangoDBClient\TraceRequest::getHeaders() + + Get an array of the request headers + + + array - - getCount - \ArangoDBClient\ExportCursor::getCount() - - Get the total number of results in the export + + getMethod + \ArangoDBClient\TraceRequest::getMethod() + + Get the request method - - integer + + string - - getNextBatch - \ArangoDBClient\ExportCursor::getNextBatch() - - Get next results as an array - This might issue additional HTTP requests to fetch any outstanding -results from the server - - \ArangoDBClient\Exception - - - mixed + + getRequestUrl + \ArangoDBClient\TraceRequest::getRequestUrl() + + Get the request url + + + string - - setData - \ArangoDBClient\ExportCursor::setData() - - Create an array of results from the input array + + getBody + \ArangoDBClient\TraceRequest::getBody() + + Get the body of the request - - array - - - void - - - \ArangoDBClient\ClientException - - - - $data - - array - - - - fetchOutstanding - \ArangoDBClient\ExportCursor::fetchOutstanding() - - Fetch outstanding results from the server - - - \ArangoDBClient\Exception - - - void - - - - - url - \ArangoDBClient\ExportCursor::url() - - Return the base URL for the cursor - - - string - - - - - getFetches - \ArangoDBClient\ExportCursor::getFetches() - - Return the number of HTTP calls that were made to build the cursor result - - - integer - - - - - getId - \ArangoDBClient\ExportCursor::getId() - - Return the cursor id, if any - - - string + + string - - setDocumentClass - \ArangoDBClient\ExportCursor::setDocumentClass() - - Sets the document class to use + + getType + \ArangoDBClient\TraceRequest::getType() + + Get the http message type - + string - - \ArangoDBClient\ExportCursor - - - $class - - string - - eJytWW1PGzkQ/p5f4UNRE9oA1364D1B6pRBeKgoIgnRVQZGz6yS+buyc7SVwJ/77zdjejfctAamRWsKu58UzzzwzNh//nE/nrdbO27ct8pYcKCom8ugLuTq9IlHCmTC7RDGdJoZoZkiUKi0VGcM/9jiXymiQQsHPcxr9pBNGSK7j0IrblzQ1UxCBz1cqyI1hbEaFsK8iOX9SfDI15DD/9uH39x96xCgOCoUmJ7PRaQ9eJ3IiWI+cMAXSTyC902oJOmMabLOS2b18S1dKPvCYaUKjiGlNjCRmyvymNJFjQkkkk4RFhkvht+V3NYCFfssz65mQEAMpDOWC0CTJtcCvqHTEJlwILibbH0fqk1dyNg4M2ihy9EKSEZ+gNyMGW6VCj5lSLEZVUjAykT0UQwUFD7jWKSM0jjm6SxNyOhhcgfJ/UqaN3d2YmWiaySqINEePclfHSs6sQ5qpB6a2X5RAzUWErwj5sP2HjXyUUAhm30br0DrY+q+FC2zY8ePDJ4XwoZWjv+Gbf5mt+fxAFeQ2W+Qf79ifc8UfqGGkPVxqgcSWrDjrRM7xta5TT5WiTw2avVhVrc+9ghAEuXuteidZ1b4xpZrMpGIbkPCYR9TAFrYIB6yolPWCBJFsZZbBOhdGUiYNHoD4N5CuuuBhxWOw67AFSLy4PT9HL/zLWELhIOin9AFQJ2B1nfkZf2Rxg30eV02LdDaCnUHtWfRGUEoA3Sk1ZMFgozMaM1sZKU9iGwrvjotAgyGLe3B3n7yvWvQZhGSqJ0tf+e4L2gBn2pD+xeD6+/DsCFR1eNx5gbYNH+UNMk7opFHl6cHNt8vrPur1Ai9R7h/EMkpn8FQ3qr/u39yeD1C7E6lRvgH+mQ1fLN5Gd8GByoxiEP+QGgF3lGg+myfMYbxnoZD7sdnoyPH5gXVjiNZessVMJ2hJhWnUe3h5e2EV22V12zNPc1beHtBtqoFZF1MmUB0UlUFGDFiZC4BbvjGC7S2eAJYcZa3Y6eD7lU0n2q3zZ0Q1S1VSdGm7Ud2Xg5v+7fU5avSSNUrPBHA/Tfi/LKyNBTeW9cmYK22WSRQx0XIGRcUMjamh5fqdU0VnAQOTdkDZWyF/u16FoSwJW3DYR6SNJtxXpDPnaY5gfAeoUsykSkBGRk8B0a1Q6knaKY1W8r2ZKrnQ5K7YxO7cj/5jxObVNpOOEh6RcSrcPodDmxKVRqZbH5ee987uNv/Fe+TA4pqh9d5Mud76FPQwSG877GillUEIcSX+WlkDtEqWa0SaJB4n+AH+BtBDt+pa4R+aJePd3YzV7jc3A+9KOr29ssjS/nOtGb/1H51hVkSHOB90Gm2B1FG4cpWKWuM7O4QaGBFHKZD/LNW2ewGYFMuXgDRUemMkPBmDi9XoenaGcHSxtW7WRCUTD+KeSWdw3c8xUbXgSwLW/LivvMXogL1u1yKrzrqj+iw2EJcyScBkBqDmJnkiMUuYCbmiVDMDsFmcLoXry0f98/6gnw2XWP9cAFuH4yOhI5lmhG2fW2uw5+2GyizXIPns6MDOMFDeOP/YOSiwEf0UcpEgJccFG5lrPTKmiWZEIgAWXLOV9e3i0S3XKcJ5WQll3GInKT4Js7msZihfp96/AgrvbpJt0tnpwP+B/gA32ccHAiOwV3j5DCMSDvXdPHikzcoePteViVdpw9OIlRPmGr+RBsh6OZyVTjfZ0aiYVm8BOigmr17DynRMmDnEdl5JiNccsGKhBOwwcJ9vqmZPgj2awjQjCrN6M/7Xnq7g/EkA99pAe4VRojjXVM5Yr60EO05DNDN/l729sCM8iFvY+2rJRloNmZpSoMTyTF4N/AXo+4LQWlkNnqv295GsyJs3ZZosIxG4GYbJ2J1abCzCOPiP12HjebkMZbee7mvc+c26U+kvGbG6z36JcPfqfMg3aLm4sCLDYFm62IkaI08aKrAE1kOcvdky30Ht5VDiYp6aWvwWBiY3gOHoFcnZ8tzfULUPksdlWL5qdPKnrxxTWecKnKnMQ8UGH6So8Lx+nil22AIf4KED4BDAc8Wq+gEox0Fp6HomDOtsjVAFPCFo63zBw8O9LavD/AJqdxefDvtHJ/2yl/iB9ssodoJ2Nky3IWl1K6suQu3ukz400d3dyALuGLB1gInqopJeOW6bexWlz4UntWH5JV6WMPLLHG4Vv9X0wmPL7wG3/ypSD0qtoXaqVFiqHGQaKeDsmtKlBeI4bw77Z0EthRMJEMe6caRHOp0gfO/eZa/8rUo45dqc7i+tbn2CTvJVS9HdrBmGXzVKl4QzNlk1/xZY4rf1nWnB3GWW25i/XpJ4yWEKl7R4cI6AkVOh/XgExyMYQ5tPTu4UVkFYCWDXfsjD62I44hM87uMVSON4ngEITqTLUaMBQja9NZ18PXv6m4fqga04ha2UbWqPKGovve3oPqZ5P1qqv1UJVDkoGfb/urq8HjR1yiB6v+QSsWaMXTczHbuKWDOuLgtn7Ubyq8ge5sr+aePFAKi6dxav8wxvZOudspe5zgw5yq/kbJeGSKblc5WSBigGaqja0jvlKSJTV3OfdcOMx8YKk6VhxzvZditX+ZqHr/C3ilVBrN5NWLVN9zqVaSZy40td9LPAQ+jtqiFNONXd0DXodfgGCPku+wtYFsvRXbgQ+fp/CMr46Q== + eJylVk1vm0AQvfMr5mDJHyJ1k97skqZxVVuVKkWpe6ora40nBgUWurtYsqr+987uAsaATa1y8cfMm/fmzbDw/kMapM54NHJgBB8F47vk0yM8LZ7Aj0LkagJ+wjn6Kkw4peish5T5r2yHACVgZnJNkGUqSATF4Avj8E0hxozzWugz4fxQwizIqIAJ+kl6EOEuUDArv929vb1zQYmQ2LiEebxZuBSOkh1HF+YoqPSB0GPH4SxGScKwpmnqFM3NIiYlLAXlPOOvDKUq+rmo62KzMuS+DgHcvnlnhPhNlt+OTjAq9DUiUxKBEpD5AQTItiiASSC3mBDsAINXPIB3D3sWZTgEjDA2fAZc1HjYM2Hz83/G5jMV4Z4phN7aFpbgwY+fZEK7BBUgBEqlECNZsG3jkGS/tqKVxMIulhfWBchEdHX5HPtdRGcoDIMtAcmL+bVJtoeriTSoSbE8uiOl3gF1SPHq2hpEU+jnzfRbWkGyJz1xS+kFqlOlTLA4XxLoFQOm68ZgbYBsMJrzcA2ce9Wzg4MjuCA+WYQ66jiPGuo43DpEOwtQITpOy8isjCs3LttEoQ8vGTdnDqzXdAARKPPVoOjZLRpwq5pcyzY0ZexNp6+eCkJ5c7+u+OWV7k0baRVnvIKmmVVxwqtqaGZWDPCsQJvzp7EGc1qD8hDIt7kw+HSapdcCVSZ42zlQc3GHamFLDOr+5DVqNl0SeXZf6rra7oumsK+mRJeu6iS6ZbWcNldpei4n2qWrPvvz2swmnM71vzQ+Ur0udV37pv7liLtK1ZIKdKnSJIUq0mWemWsWhUwOqk/OycREXOivineAVf4Q3qyqif3h1PkLRzV67g== - + - ArangoDB PHP client: URL helper methods + ArangoDB PHP client: AqlUserFunction - - - + + + - + - UrlHelper - \ArangoDBClient\UrlHelper - - Some helper methods to construct and process URLs - - - + AqlUserFunction + \ArangoDBClient\AqlUserFunction + + Provides management of user-functions + AqlUserFunction object<br> +An AqlUserFunction is an object that is used to manage AQL User Functions.<br> +It registers, un-registers and lists user functions on the server<br> +<br> +The object encapsulates:<br> +<br> +<ul> +<li> the name of the function +<li> the actual javascript function +</ul> +<br> +The object requires the connection object and can be initialized +with or without initial configuration.<br> +<br> +Any configuration can be set and retrieved by the object's methods like this:<br> +<br> +<pre> +$this->setName('myFunctions:myFunction');<br> +$this->setCode('function (){your code};'); +</pre> + +<br> +or like this:<br> +<br> +<pre> +$this->name('myFunctions:myFunction');<br> +$this->code('function (){your code};'); +</pre> + + - - getDocumentIdFromLocation - \ArangoDBClient\UrlHelper::getDocumentIdFromLocation() - - Get the document id from a location header + + ENTRY_NAME + \ArangoDBClient\AqlUserFunction::ENTRY_NAME + 'name' + + Collections index - - string + + + + ENTRY_CODE + \ArangoDBClient\AqlUserFunction::ENTRY_CODE + 'code' + + Action index + + + + + $_connection + \ArangoDBClient\AqlUserFunction::_connection + + + The connection object + + + \ArangoDBClient\Connection - - string + + + + $attributes + \ArangoDBClient\AqlUserFunction::attributes + array() + + The function's attributes. + + + array - - $location - - string - - - - buildUrl - \ArangoDBClient\UrlHelper::buildUrl() - - Construct a URL from a base URL and additional parts, separated with '/' each - This function accepts variable arguments. - - string + + + __construct + \ArangoDBClient\AqlUserFunction::__construct() + + Initialise the AqlUserFunction object + The $attributesArray array can be used to specify the name and code for the user function in form of an array. + +Example: +array( + 'name' => 'myFunctions:myFunction', + 'code' => 'function (){}' +) + + \ArangoDBClient\Connection - + array - - string + + \ArangoDBClient\ClientException - $baseUrl + $connection - string + \ArangoDBClient\Connection - $parts - array() + $attributesArray + null array - - appendParamsUrl - \ArangoDBClient\UrlHelper::appendParamsUrl() - - Append parameters to a URL - Parameter values will be URL-encoded - - string + + register + \ArangoDBClient\AqlUserFunction::register() + + Registers the user function + If no parameters ($name,$code) are passed, it will use the properties of the object. + +If $name and/or $code are passed, it will override the object's properties with the passed ones + + null - - array + + null - - string + + \ArangoDBClient\Exception + + + mixed - $baseUrl - - string + $name + null + null - $params - - array + $code + null + null - - getBoolString - \ArangoDBClient\UrlHelper::getBoolString() - - Get a string from a boolean value - - - mixed - - + + unregister + \ArangoDBClient\AqlUserFunction::unregister() + + Un-register the user function + If no parameter ($name) is passed, it will use the property of the object. + +If $name is passed, it will override the object's property with the passed one + string + + boolean + + + \ArangoDBClient\Exception + + + mixed + - $value - - mixed + $name + null + string + + + $namespace + false + boolean - - eJydVm1v2zgM/p5fwRXFOSncutePadNu67D1DsOhuPY+XYdAlplYmCx5krwtOOy/j5JfYnteu2sKNLHJh3pIPqR9cVXm5WyWHB3N4AheGaa2+s1ruL25BS4FKreEf/5+DznKEg0U6HKdWXL13i9Lxj+yLQJ0wOuACUZWka8hG/zJFNw5xIIpFUxclzsjtrmD6+7X2envZzE4IyigsvCuSG9iMku9VRjDOzSE3hE6mc0UK9DS2Tg69rzL404XOOIMTgPXyjpTcQdMZVAazdFan98PGU3kY4XiPtXTk7NAg6UUi1EsLpmPYuRNOHD238wnHZj4zxGRd+ByhEzzqqBwIDLYGF0AA6k5c0IrIssywtaIFkh0DCuAzhFqC4ed8zHc3N/fgqEqUEb4VBSDrjKqDXM84EEnWGzoDNBJ+C6rVApOUIrPYVMpHs7ZonvTBPkje0vY9w2DeUdyEfB1LfxHbGD+Qth1zaLnt+g5hcIlwJmKHNGkNu1c7kmzVFfE1/kwXbbCgtIO8DMqKmUdeBCqSVxVUp53hm+zAadTWK1WHlxqu2cVQ5SsszSJpugFy0WWeh1eJmtWiqQtaXLBtZQYqnSZXHzE3eUA/VIK6+YxtH+He/e/KBrdENkCVoBfS6kznEdJFO8bv+hlASip8xPcnkvn+VSGBe31mAKMy0f3KGZlZIbcR/U+k6Ga3o1YwQk1JqL/hKthDaQ3btf7KQ+7qxm1lFG9/LWffZZlwsdk0k+AszFY9MPmaBa+CJeHU5DxfDRL9zmJrhsDxjmWzsJnRmsrlQjMbEPd7cnjk+y50MKgWWxZjRyZMWxH1QrkyHAcmNdXtMhYWaLKnppzWktYEK2sd8CjY51WQmbEa94SjBsiDY8V/PthPNeH1EsytIjzfQc32vgKwrxBM1vHGUvCi6adP2/3sxct4AWN5YaRyMf+PeE28cYiDXfPB6CesjrWJ6tGTHSBqpbjCDohyMrInynvVWgLhBaiQ1P3qlf91vG29SDpyAotaU5KSIMSjmsqP3T3+QpihfUKoqdwfVNvehSfEpF/cP1vIdX6DFnaoZ4aPmMVDbTi+Xqx0LqC1SX8dhiKNCUb2jWp1hS/9phSSm0iiViUm+WSnlyvCXHXbKgaN5bKI91v60576MpLJ3euXIe5WX+q0OzaBBY/04h/GWgfVt1qIkZI7QlspvteiK9U/iaZuiuT3uP2HdAmxANfrAaL/ov2XNCmN8ZwEMbsADRFNV+ExV9p8WQhR11ti1affAWRPy+CJUThxKitEVUpvEStmRTMzrtXqeUy3KaF8NC+GD40b2bpQ+cVUa2/Ax4tFgg= - - - - ArangoDB PHP client: AQL query result cache handling - - - - - - - \ArangoDBClient\Handler - QueryCacheHandler - \ArangoDBClient\QueryCacheHandler - - A base class for REST-based handlers - - - - - - $_connection - \ArangoDBClient\Handler::_connection - - - Connection object - - - \ArangoDBClient\Connection - - - - - $_documentClass - \ArangoDBClient\Handler::_documentClass - '\ArangoDBClient\Document' - - - - - string - - - - - enable - \ArangoDBClient\QueryCacheHandler::enable() - - Globally turns on the AQL query result cache - - - \ArangoDBClient\Exception - - - - - disable - \ArangoDBClient\QueryCacheHandler::disable() - - Globally turns off the AQL query result cache - - - \ArangoDBClient\Exception + + getRegisteredUserFunctions + \ArangoDBClient\AqlUserFunction::getRegisteredUserFunctions() + + Get registered user functions + The method can optionally be passed a $namespace parameter to narrow the results down to a specific namespace. + + null - - - - enableDemandMode - \ArangoDBClient\QueryCacheHandler::enableDemandMode() - - Globally sets the AQL query result cache to demand mode - - + \ArangoDBClient\Exception + + mixed + + + $namespace + null + null + - - clear - \ArangoDBClient\QueryCacheHandler::clear() - - Clears the AQL query result cache for the current database + + getConnection + \ArangoDBClient\AqlUserFunction::getConnection() + + Return the connection object - - \ArangoDBClient\Exception + + \ArangoDBClient\Connection - - setProperties - \ArangoDBClient\QueryCacheHandler::setProperties() - - Adjusts the global AQL query result cache properties - - - \ArangoDBClient\Exception - - - array + + setName + \ArangoDBClient\AqlUserFunction::setName() + + Set name of the user function. It must have at least one namespace, but also can have sub-namespaces. + correct: +'myNamespace:myFunction' +'myRootNamespace:mySubNamespace:myFunction' + +wrong: +'myFunction' + + string - - array + + \ArangoDBClient\ClientException - $properties + $value - array + string - - getProperties - \ArangoDBClient\QueryCacheHandler::getProperties() - - Returns the AQL query result cache properties + + getName + \ArangoDBClient\AqlUserFunction::getName() + + Get name value - - \ArangoDBClient\Exception - - - array + + string - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler + + setCode + \ArangoDBClient\AqlUserFunction::setCode() + + Set user function code - - \ArangoDBClient\Connection + + string + + + \ArangoDBClient\ClientException - $connection + $value - \ArangoDBClient\Connection + string - \ArangoDBClient\Handler - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object + + getCode + \ArangoDBClient\AqlUserFunction::getCode() + + Get user function code - - \ArangoDBClient\Connection + + string - \ArangoDBClient\Handler - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection + + set + \ArangoDBClient\AqlUserFunction::set() + + Set an attribute - - - mixed + + + + \ArangoDBClient\AqlUserFunction - + \ArangoDBClient\ClientException + - $optionName + $key - \ArangoDBClient\Handler - - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - - array - - - string - - - \ArangoDBClient\ClientException - - - $body + $value - array + - \ArangoDBClient\Handler - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - - array - - - array + + __set + \ArangoDBClient\AqlUserFunction::__set() + + Set an attribute, magic method + This is a magic method that allows the object to be used without +declaring all attributes first. + + \ArangoDBClient\ClientException - - array + + + string - - array + + mixed - $options + $key - array + string - $body + $value - array - - - $includeArray - array() - array + mixed - \ArangoDBClient\Handler - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name + + get + \ArangoDBClient\AqlUserFunction::get() + + Get an attribute - - \ArangoDBClient\ClientException + + string - + mixed - - string - - $value + $key - mixed + string - \ArangoDBClient\Handler - - setDocumentClass - \ArangoDBClient\Handler::setDocumentClass() - - Sets the document class to use - - - string - - - \ArangoDBClient\Handler + + __isset + \ArangoDBClient\AqlUserFunction::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. + + + string + + + boolean - $class + $key string - \ArangoDBClient\Handler + + __get + \ArangoDBClient\AqlUserFunction::__get() + + Get an attribute, magic method + This function is mapped to get() internally. + + + string + + + mixed + + + + $key + + string + + + + buildAttributesFromArray + \ArangoDBClient\AqlUserFunction::buildAttributesFromArray() + + Build the object's attributes from a given array + + + + \ArangoDBClient\ClientException + + + + $options + + + + + + $name + + + - The name of the user function + + + string + + + + string + + + + + $code + + + - The code of the user function + + + string + + + + string + + + - - No summary for class \ArangoDBClient\QueryCacheHandler - - eJzVVt9P2zAQfs9fcaqQWqoWtkl7CYPRFUQ1Mal04mGCqXKSSxrm2JntrFSI/31nN/1BS0sQ8IClNEnv7ru7z3cXf/maj3LP2282PWhCRzGRyJNv0O/1IeQpCuND5+Ic/haoJqBQF9xAyMIRwoiJiKciITtrepyz8A9LEGCO0nUATsgKM5KKZPCdCfhpEDMmhBOFMp+oNBkZ6M6fPn34+LkFRqUEKDScZUGvRWIuE4EtOENF1hOy3vc8wTLU5BtX3B54XsiZ1nBhQ+/akHs2YlSAtwZFpKF89+48z0bmOLCrCWdcBozzCZhCkX8pwFDGjxNR2sxMj81IybGG09sQc5NKUQr23T0vAp6GEBcitDJAwQKOjV0nvJuq0topFIdDuFS8hzxH5ftBkfKI3ht0ad+/HJwPLy5PB7+G3U63d9qCq3quJGmaFHX99+7BAsqMUt0+StB0pRDo3DZ220d5YRrWTWumcaOlGKIIZYTDsWI5gTWu6hm91uHwCOpSEG4JfO89SVkcvxVnUarfD2lxXI01jUZvIQyMhMj2TAQW/BVq7sSh/SCwd0HkNPkHXK5Q2eXI1FYOY5pAVhwWStGEgIgZFjD9MjZD6/Y1KKxCW4QcDTrmNvLQiW4KXRZT4sprEx+LPavIwFyeM8UyAKYUm8DOAsfJ2871Vn97M6Tty7hN41yO6TuzZE54AgKEQmPkV4NqQ8ZuBy4a7dvnNCsyEEUW0AdBxmWgumpczGxKcpxyDiPJo2pQlNFqHT6dCXWFX87ZDVFQYUqbV9yqBkrKbgKlZmXS7EFfap3SwIB/jBfEPVMVA61JUWvRbxzTjRzUprC1vdVqUmhzmVbT1l6jEPvzImisVd9aEwYymvRtqWrqxSXFA+9ho7r1jG5d7lSiPZdCo/XwkmG3FKydcXMHJTlzPw7/u7bImybAABe18eqtX3mzkgeb9eiAfGPe6Y/ZqHwOnfflyXHIeMp0Y+386PtO3IL69eyEel2ePYPrNe064f4Hk6JLzQ== + eJzFWt1z2zYSf/dfgc5oRlJGsq/XNzl2o7pO4pvUzTnxQ8fxaCASkhBTJAuQcnSd/O+3uwD4CVJ2m+v5IaKE/cLu/ha7YF7+mG7So6OTFy+O2As2VzxeJz//xN6/fc+CSIo4m7H579GtFup1HgeZTGKgQ9JXPM82iWLw9xq4HtgvfC8UrQRJuldyvcnYRfH0z398/8OEZUrytYg1e7Ndvp3AcpSsYzFhb4Ta8ngP3CdHRzHfCp3yQBTmXJAlp4WZ71Wyk6HQDJhA3hYWWbJiOVg5XVkztbWzYT1Llp9FkL1cqnNajVsEUjPuyFi24Rn+AqJDliVWIZv/+x1DJua49LGTeJUxJdZSZ0LpCcvjafENxIYsgmcSp1hhKQOt2UYw+HEnlBPkPj/CirVGxAFPdR7xTOhZk+5lHpnPSJ6TOPQjugWfV2XwSgIeZDmP2Ge+4zpQMs3qZCdOYNsQJX7PpYIAoJggiWNRdS5tNAAnLgWTscwkj+R/RIgyHmW2YZA1+JnkmVtGGSu5zhVHMcfNrc3jfZ3CSdfCKFMCMkvsIEbLPdlkDBlChghQFGrw+4OAFenxW6oEPQxweXoOMq/Bc6Phdl9Ed1Y+D8enjrNkuEhCYHDeY6PxH/skV2BzKL6eAofxp1VUVQ6ueLpl8bPMCp5r06tUJalQ2Z5p8Ga8ZgPKoCkFvppMtez1c6IWy0mPHZyGmQcPCCrWwDstahkHuMTY98c/UH0IIq51qyj9cYQ0VB/w74VV3chMu+hoXu24giLkiOzPJ/SZKrkDnLHBopQCFcijxe0Hso1nsP9lDvA89qniSvF9Q0uSgWxI3EHJy87Y3X1bF1TLSNiKIeNQfKlJAit1xi6vP978trie/3IJQoYYtGFb0NwWul4ZF7/+TDIwfCijKeTKAlsLiqy/zDacgN6q7HOO7jBOcYB2dVanIpCrfVnHqKRgJq0AMq1Ugr3gwhbzDASRyGYELr/wbRqJmftORCP3jVlvsbNz1gWxSYWY3ELEVYR9HTqScV17kQYpV3xbyTmESvFMf9NmUQV3WM80pBjP0V/Lq9OWg2wdNvUz5BlvmpZtVPKo2ac6Cj+Zj8svgUjbIMmXkQxKLYsFpZDKg2zk3+PEWt0y+IzFeRQZtxkw075MLatgEAgHVUQ6SrliI6kXJqpN6eNxRWZF7jKXUTgvaF+rZDv3CygVfT0y/7YQcVMc9J5SV3P11YrFCaMgCmIYUamdUNkcg4cELGoI+ITJDM7KKEJxJNZWWglVwtZUg7RmtoOKgQPOCUDGVGSf5AR6DgXdVP3crOihM5t0Eyd0K0L70xojaNR6F9CEjqQr0ovZH0TxAwTWtFD26F9xGRVQKORAB5CrmG3lFywgKhctvkeumc6DQGi9yqPj3jx2PZuJi83NiXViR6bW6rfNr/I3V0FdqpLgVlaW9HemHN2jLHyq5l9dkMmZHkFUqu4NbkK/oAH0cikgV5SmVyA3PU8TnY1qGm5VpGez25t3C+iFF7cfLm8Wr2+vLz5e/Xo98SFtjU2SEzgaT88/6yReQEMLJi0eFU9T9HZp9rgQMj4t7bRRLswluf/SKPG0C5a3ZQv+XGAWYYIJ4AAg90+Eo0dSLwD3Pvj50Wd7Ly8Al0kSCTgZB8Vw9TQg1nGIVmDrL6BLQBi2yoAXhSXoirafu0jueARE9kiv/QaMsFODWoGDghtZDp1BedyF3nKwPAPzIy2aGEY8Uak6O7OwawHLSiyzmmaFsR9VuQJRCJW3IoJgzmZ03sD3UR982B1pua8mflEyyP6WVS1FiKc4fI+x16gPKUDwcK2SPKW+BaNz32H3gWoQigjQQTL/KjjfiHJchpSpz8We7tGMc9QtJpSWPIr22B5ZcPBqlEscQwsVQ2cA+WzyDGZomMLD5JG6K27bTciigrnVvzdPuG8GoieeZX8ziiB0N0Vcqp29HtVw5D0K/2zeV/OxwOJ3Dot/MfULEZT+pcT7Vm/3FAyAf1oAGGBXjfSdCHAbk5CswI/0d0OTjsP7VpPqAFUn81l7csKWMEU/chVqGB22KbQ8SxnJbN9CJwrrhOONIfLe6nRkaaXNb00uNcbmwFtNtWpr0EgmZ3crBp2b+ACJ3nldcYwXdNscsLfhO0BCxuBchG+IkiIlJmyJ8Ip0QpWGKHW+nBYExXgPu1UK7CmmSpgdrx1VdXasrN8kSVal+ZAv+1gc56NK4nVVTwehvysYUD34H4x87rrMKOiY3zDbtYhWs1l5QTFhI2Pb2BrXf0pQRL2bsBliN1ppfjormzmzexNt7bG4NNCTcfVx2zfq/G3xoNvIZ8UDL3ueGY/D+31+XMjw58UFLe829APdD5fXcv6QDB7EvvlTX6aRKc2YPTNGI1Q6Yf4o4RHxndQL4zoibR0OprOIxWNT82h4FYNUGZbbZiBg2NHrNQfVO9RG0yKZ5unvkOPJHp+wLV/D3k3j1uroYBzC9y01IvPSBRo7dGs5E1XuwVwH5OSEIog4ZRlwVS5h2Uoq3ZrF+iNWUJFJ/RgGTzG8sCsd7Rm9TBtn3QnE5hOvMZtp2XWndihdNLgj2DCTJ400CbjG1yT1QsZmNZpKHjSq+WmLbqkEfzjtV0FXx30qqgXqSSpCseLQ/PTJrHvooNTiFg8/GqXtcMWoJsC0aDY6mWoNvcuAKsOEXd++e4e4L1MJcBEnGdaKQ2XTBN5TQ2yb6Yd4Z7vpJ/dWD8uCfXrX2Xil8a3vek3z3RIv+qMIfWdsG+PUIrZptsdHvKbmNObIZVS96+yYxv5cGNxdiPmqzYQFZtCVAByCkAHwzfp+3Ov8xcK6+FsGAO3p8zbZ2eXuZv4err/lKwJ8nw7DE72AWVNwZAzzH83YrQg8sTz+n9GxWHTho91WEFXnwfYTjrD1K7rqQaOSLRxja7kTce01X7OvMLcWrYuzb9D4db/LsDp7EtRS3DUPinaONs+Jbs7OG+senXhy9Ok0B0c3Z7u+g256YbyAjojrUeM15WxGixM2/OT+a4oLwfJTgxYbqP8CsBdRSQ== - + - ArangoDB PHP client: document handler + ArangoDB PHP client: Traversal - - - + + - - \ArangoDBClient\Handler - DocumentHandler - \ArangoDBClient\DocumentHandler - - A handler that manages documents - A document handler that fetches documents from the server and -persists them on the server. It does so by issuing the -appropriate HTTP requests to the server.<br> + + + Traversal + \ArangoDBClient\Traversal + + Provides graph traversal + A Traversal object is used to execute a graph traversal on the server side.<br> +<br> +The object requires the connection object, the startVertex, the edgeCollection and the optional parameters.<br> <br> - - - + + + - - ENTRY_DOCUMENTS - \ArangoDBClient\DocumentHandler::ENTRY_DOCUMENTS - 'documents' - - documents array index + + OPTION_FIELDS + \ArangoDBClient\Traversal::OPTION_FIELDS + 'fields' + + count fields - - OPTION_COLLECTION - \ArangoDBClient\DocumentHandler::OPTION_COLLECTION - 'collection' - - collection parameter + + ENTRY_STARTVERTEX + \ArangoDBClient\Traversal::ENTRY_STARTVERTEX + 'startVertex' + + Collections index - - OPTION_EXAMPLE - \ArangoDBClient\DocumentHandler::OPTION_EXAMPLE - 'example' - - example parameter + + ENTRY_EDGECOLLECTION + \ArangoDBClient\Traversal::ENTRY_EDGECOLLECTION + 'edgeCollection' + + Action index - + $_connection - \ArangoDBClient\Handler::_connection + \ArangoDBClient\Traversal::_connection - - Connection object + + The connection object - + \ArangoDBClient\Connection - - $_documentClass - \ArangoDBClient\Handler::_documentClass - '\ArangoDBClient\Document' - - + + $attributes + \ArangoDBClient\Traversal::attributes + array() + + The traversal's attributes. - - string + + array - - get - \ArangoDBClient\DocumentHandler::get() - - Get a single document from a collection - Alias method for getById() - - \ArangoDBClient\Exception + + $_action + \ArangoDBClient\Traversal::_action + + + + + + + + + __construct + \ArangoDBClient\Traversal::__construct() + + Initialise the Traversal object + + + \ArangoDBClient\Connection - + string - - mixed + + string - + array - - \ArangoDBClient\Document + + \ArangoDBClient\ClientException - $collection + $connection + + \ArangoDBClient\Connection + + + $startVertex string - $documentId + $edgeCollection - mixed + string $options - array() + null array - - has - \ArangoDBClient\DocumentHandler::has() - - Check if a document exists - This will call self::get() internally and checks if there -was an exception thrown which represents an 404 request. - + + getResult + \ArangoDBClient\Traversal::getResult() + + Execute and get the traversal result + + + array + + \ArangoDBClient\Exception - - string + + \ArangoDBClient\ClientException - - mixed + + + + getConnection + \ArangoDBClient\Traversal::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection - - boolean + + + + setStartVertex + \ArangoDBClient\Traversal::setStartVertex() + + Set name of the user function. It must have at least one namespace, but also can have sub-namespaces. + correct: +'myNamespace:myFunction' +'myRootNamespace:mySubNamespace:myFunction' + +wrong: +'myFunction' + + string + + + \ArangoDBClient\ClientException - $collection + $value string - - $documentId - - mixed - - - getById - \ArangoDBClient\DocumentHandler::getById() - - Get a single document from a collection - This will throw if the document cannot be fetched from the server. - - \ArangoDBClient\Exception - - + + getStartVertex + \ArangoDBClient\Traversal::getStartVertex() + + Get name value + + string - - mixed - - - array - - - \ArangoDBClient\Document - - - $collection - - string - - - $documentId - - mixed - - - $options - array() - array - - - getHead - \ArangoDBClient\DocumentHandler::getHead() - - Gets information about a single documents from a collection - This will throw if the document cannot be fetched from the server - - \ArangoDBClient\Exception - - - string - - - mixed - - - boolean - - + + setEdgeCollection + \ArangoDBClient\Traversal::setEdgeCollection() + + Set user function code + + string - - array + + \ArangoDBClient\ClientException - $collection - - string - - - $documentId + $value - mixed - - - $revision - null string - - $ifMatch - null - boolean - - - createFromArrayWithContext - \ArangoDBClient\DocumentHandler::createFromArrayWithContext() - - Intermediate function to call the createFromArray function from the right context + + getEdgeCollection + \ArangoDBClient\Traversal::getEdgeCollection() + + Get user function code - - - - \ArangoDBClient\Document + + string - + + + + set + \ArangoDBClient\Traversal::set() + + Set an attribute + + + + \ArangoDBClient\ClientException - $data + $key - $options + $value - - store - \ArangoDBClient\DocumentHandler::store() - - Store a document to a collection - This is an alias/shortcut to save() and replace(). Instead of having to determine which of the 3 functions to use, -simply pass the document to store() and it will figure out which one to call. - -This will throw if the document cannot be saved or replaced. - - \ArangoDBClient\Exception + + __set + \ArangoDBClient\Traversal::__set() + + Set an attribute, magic method + This is a magic method that allows the object to be used without +declaring all attributes first. + + \ArangoDBClient\ClientException - - \ArangoDBClient\Document + + string - + mixed - - array - - - mixed + + + void - - $document + $key - \ArangoDBClient\Document + string - $collection - null + $value + mixed - - $options - array() - array - - - save - \ArangoDBClient\DocumentHandler::save() - - save a document to a collection - This will add the document to the collection and return the document's id - -This will throw if the document cannot be saved - - \ArangoDBClient\Exception - - - mixed - - - \ArangoDBClient\Document - array - - - array + + get + \ArangoDBClient\Traversal::get() + + Get an attribute + + + + string - + mixed - - $collection + $key - mixed + string + + + __get + \ArangoDBClient\Traversal::__get() + + Get an attribute, magic method + This function is mapped to get() internally. + + + string + + + mixed + + - $document + $key - \ArangoDBClient\Document|array - - - $options - array() - array + string - - update - \ArangoDBClient\DocumentHandler::update() - - Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document. - Attention - The behavior of this method has changed since version 1.1 - -This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the document to-be-replaced is the same as the one given. - - \ArangoDBClient\Exception - - - \ArangoDBClient\Document - - - array + + __isset + \ArangoDBClient\Traversal::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. + + + string - + boolean - $document + $key - \ArangoDBClient\Document - - - $options - array() - array + string - - updateById - \ArangoDBClient\DocumentHandler::updateById() - - Update an existing document in a collection, identified by collection id and document id -Attention - The behavior of this method has changed since version 1.1 - This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the document to-be-updated is the same as the one given. - - \ArangoDBClient\Exception - - - string - - - mixed - - - \ArangoDBClient\Document - - - array - - - boolean + + __toString + \ArangoDBClient\Traversal::__toString() + + Returns the action string + + + + string - - $collection - - string - - - $documentId - - mixed - - - $document - - \ArangoDBClient\Document - - - $options - array() - array - - - replace - \ArangoDBClient\DocumentHandler::replace() - - Replace an existing document in a collection, identified by the document itself - This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given. - - \ArangoDBClient\Exception - - - \ArangoDBClient\Document - - - array - - - boolean - + + eJzVWG1v2zYQ/u5fwQEGLAeKvW775HRZvdRNPHhpYLvFhqYQKImW1cikSlJJvGH/fUfqnZLsGuswTB8sSzrey3MPj0e+/Cnexr3e+Oysh87QlGMasNc/o7ubO+RFIaFygtYcPxIucAQSSugVTuSWcQTXG5B/QL/iPeH6i8fiPQ+DrURXxb/vvn3xvY0kD3FAqEDXO/fGhs8RCyix0TXhO0z3MHrc61G8IyLGHikcudI+XBQO3nH2GPpEoIDjeAta665NS2cRcz8RT6JQoEQQH0mGyDPxEkkQNkcjRpHcEiQIhxdIgIXRS5dfKpXZXf1dg0imlZPPScjBDzXMY5TCyxC0pJ/tVJvEXL4nXJLn9AXxAwKBR5kspr5+zWL1CF7EmAMAElxqs/4qCgFrfW2ljMVkPPaZJ0ZYQ+W7I4/txjfr9d24wGAcUp88j7ZyV+QO0H2ARICSOsT6owipR7SFF6MfdEq8CAtRYcCfPfVVJ0NdKSaN+LOPucyrR8wh47lQ9nqs7zEPHzHkpO+UWiDdLVaKbA0EwhL45EIuxajNFuYc7w0zTIJy4EG/HIt+RB8+No15LKESbUIS+aKmBDwUEr29W8/f3jpv5rPF6xWoGKSSg6aiMtcC6Uy0aJvdrpe/O6v1dLl+P1uuZ78pjRXmtKidplAf1jh7fT27ertYzK6Ut0ppnX0tejV0fQen6gWgRAONfPYGMIzBpz1iG83bIiGjLqgzXU1TcxrKEEehIFqTOWnNnOqJUWEQ6lcop65zcx7CbHeJnviGkiwsdfUrMKdKQJ6jTUJzgFMn/8D60ccSH1BmTO7TlWnSpvO7n5YEYeIgt5w9CXRfn7r36W327JG4Ob8SNwq90g/H0SzhiSetdkDtGjC2GZmdOZr7CNSiSRQNtbW0POgQ5DYU55eVWQ2C/eocNyQFkavSrFX1YdgmPKt5ZRleDjPOqSvcICsUjnbbyt0eDivOVjTXqoMe4uwID4jV+G4XEFT8+6uX/jYYP8vXHij6AZH1CQTLiUiiBu05kQmnOd4gE4MxMq0Ut05KmGT4KtwBv5faUWvYM9PtMn9/p3iscGtgddEr01EEUgpWWHJ+GTMhrVpq3vFITCbvlgtnvZxClVxNF3Zb7sC/ktLW8Pzyk2DUIdRjPnGeYMmH8mVVPB0WSqp0yVAv3NR6fxFK40VXdpfpmNZmoCOrlcnXqF61gWZVraajGq6RkTyMBsKdQayAlqoDy+t7rYCN0FyiXQLryxZICwswigiGJ0YJKto2G0G2EY4EQx6mqaRI3PNCoFiuIVrOwZ9J/jzY7W9zqclu/yYzO6h8XzImqzKrxD00JB/5xBkNqnY6BNtre/8RRwn5FwqxWe+0nY4qCrKWINFmMmm0CzayUk+HmavdJL3O89saUsaXLGwld6wWVN0/zL6g2//S3RY21pdQNY3/s1yZy80p6ar3Yidm7DgGp2fOCOa05NWj6XZeJRCKQLEItKeu/0D25qtDaTwxbZbSb6P2dKnG4BvoDFLktGijLdBmESVPpmVrMKegNfTLCBEoGNSaAZMZ5Yr4QVn7qJZA7doXo2ijHQ4gSNgnbplvgLQGI2rDi2tCEANWVTlS+MlyD1v2yOgpBMEkX3GQT2Dfp9kEoyqbLdgUcSEbW66DqemYqhA9Ui13CV6FuLnwLnwG5zKIQDi9bxjvZpUOvGOGPLLQP0gYxzlGGQFIeVuUcsWgioeFOkJoLXNoUhOtUKJ9HbhoiLuc4IeLwwaNTd8hm+317IvM+mSDoQk8pL2O4VGtRdesbkb9O1RCWpPd5Nl50dZ0asoYkhIuJ1p1gI1u3y0WqmSUjIWZRplUZeZYwU350lJ+QqHRaq8OjWJUL8ymeGvhyYaoLVrXSmuifLzElLtaAbLQVuvjNRXnEDa6knAKdWPfqBP/j3Q5TlfCmuuiluqs3XOhjj2DgHDw0t3DfI0iFWWa9CGCOkZ2sdyrv+qEAHvQIYvQjUh+1hK2HHD9E8BcxqBtp1kkyj2FG/QX0LMT6EuACfCUoTQ8AlPG3a/JbOXPIRprP4/swtI1rnaKdcoikQGb7ckS2KVQ2aqtCxbJVmk/cWRHhmu7MQhHn7U60FJgYRUnYpOJfm2jwX1+hJ53su59IaW6jr8BeLzhcA== + + + + ArangoDB PHP client: View class + + + + + + + + + View + \ArangoDBClient\View + + Value object representing a view + <br> + + + + + ENTRY_ID + \ArangoDBClient\View::ENTRY_ID + 'id' + + View id index + - - $document - - \ArangoDBClient\Document - - - $options - array() - array - - - - replaceById - \ArangoDBClient\DocumentHandler::replaceById() - - Replace an existing document in a collection, identified by collection id and document id - This will update the document on the server - -This will throw if the document cannot be Replaced - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given. - - \ArangoDBClient\Exception - - - mixed - - - mixed + + + ENTRY_NAME + \ArangoDBClient\View::ENTRY_NAME + 'name' + + View name index + + + + + ENTRY_TYPE + \ArangoDBClient\View::ENTRY_TYPE + 'type' + + View type index + + + + + $_id + \ArangoDBClient\View::_id + + + The view id (might be NULL for new views) + + + string - - \ArangoDBClient\Document + + + + $_name + \ArangoDBClient\View::_name + + + The view name + + + string - + + + + __construct + \ArangoDBClient\View::__construct() + + Constructs an empty view + + array - - boolean + + string + + + + \ArangoDBClient\ClientException - $collection - - mixed - - - $documentId + $name - mixed + array - $document + $type - \ArangoDBClient\Document - - - $options - array() - array + string - - remove - \ArangoDBClient\DocumentHandler::remove() - - Remove a document from a collection, identified by the document itself + + getId + \ArangoDBClient\View::getId() + + Return the view id - - \ArangoDBClient\Exception - - - \ArangoDBClient\Document - - - array - - - boolean + + string - - $document - - \ArangoDBClient\Document - - - $options - array() - array - - - removeById - \ArangoDBClient\DocumentHandler::removeById() - - Remove a document from a collection, identified by the collection id and document id + + setId + \ArangoDBClient\View::setId() + + Set the view's id - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed - - - array + + string - - boolean + + void - $collection - - mixed - - - $documentId + $id - mixed - - - $revision - null - mixed - - - $options - array() - array + - - getDocumentId - \ArangoDBClient\DocumentHandler::getDocumentId() - - Helper function to get a document id from a document or a document id value + + getName + \ArangoDBClient\View::getName() + + Return the view name - - \ArangoDBClient\ClientException - - - mixed - - - mixed + + string - - $document - - mixed - - - getRevision - \ArangoDBClient\DocumentHandler::getRevision() - - Helper function to get a document id from a document or a document id value + + getType + \ArangoDBClient\View::getType() + + Return the view type - - \ArangoDBClient\ClientException - - - mixed - - - mixed + + string - - $document - - mixed - - - createCollectionIfOptions - \ArangoDBClient\DocumentHandler::createCollectionIfOptions() - - - - - - array - - - - $collection - - - - - $options - - array - - - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler - - - \ArangoDBClient\Connection - - - - $connection - - \ArangoDBClient\Connection - - \ArangoDBClient\Handler - - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object - - - \ArangoDBClient\Connection - - - \ArangoDBClient\Handler - - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection + + getAll + \ArangoDBClient\View::getAll() + + Return the view as an array - - - mixed - - - \ArangoDBClient\ClientException - - - - $optionName - - - - \ArangoDBClient\Handler - - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - + array - - string - - - \ArangoDBClient\ClientException - - - - $body - - array - - \ArangoDBClient\Handler - - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - - array - - - array - - - array - - - array - - - - $options - - array - - - $body - - array - - - $includeArray - array() - array - - \ArangoDBClient\Handler - - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name - - - \ArangoDBClient\ClientException - - - mixed - - - string - - - - $value - - mixed - - \ArangoDBClient\Handler - - - setDocumentClass - \ArangoDBClient\Handler::setDocumentClass() - - Sets the document class to use - - - string - - - \ArangoDBClient\Handler - - - $class - - string - - \ArangoDBClient\Handler - - Name of argument $revision does not match with the DocBlock's name $ifMatch in getHead() - The type hint of the argument is incorrect for the type definition of the @param tag with argument $revision in getHead() - Name of argument $ifMatch does not match with the DocBlock's name $revision in getHead() - The type hint of the argument is incorrect for the type definition of the @param tag with argument $ifMatch in getHead() - No summary for method createCollectionIfOptions() - - eJztHWtT20jyO79iNkWtTcpAkt1PJOTCAhu8RwJFyOVShKJkaYy1yJJXDx51m/9+3fPSzOhhyTaEZO0PYEszPdMz/e7W6NW/JqPJysrm06cr5CnZiZ3wMtr7jRwfHBM38GmYbhEvcrMxfCMjJ/QCGkNDbPtm4rhXziUlRHXbZT3YTSdLR1EM98gfTkg+pJSOnTC0bv0O/a7IO+eOASVv3GhyF/uXo5Tsqm8vnj1/0SNp7MNQYULejgcHPbgdRJch7ZG3NAa4d9B7c2UldMY0gVlRa0IvV3IEJRIkHTkpgb4ANlEoJgK3nQLSvP2Qpu5Ib0+GcTSGe5QkNL6GZtAaAUxonPgJ3IdbYxKFWpMN0k8BAEBJIjK4I36SZH54iS2wpzOZxNEE0E0pOTg9PSYx/SujDFSkQ3k1iF+L2Wpf6zcl8UMXbxHybOMFWzM3cJKE7Al0DgSu9DaloZcQ8XvlfyvYhy0hfp5q+Dtx7AAOoUdvxc1N9t+NwiQl++9PTz5f7B3tfnwHXz+QbdJRXTuwLRZYNwoC6qY+rNfEiWE3UySMAtSj49P+0fuL3aPDw/1d/Ipw874lgOmtM54EtAnU/f/uvDs+3EeQohfCswG+pSlxCKznJUBVtMKIwdHQEM1lr53AdxICExhFHhkCD1zS9Le7vtddsxq+SUdxdJOQ/VuXTkoAvWGIkATYAihnVVs3sq6vou8RGNCRDWHEMBsPFPoSzti/pR4hqxKRvodwFFq+B3/9oV/oxzefrEZsjgm7uU74LyfoifvRUFxKZPeaz6vJ6yMBzYkp2WrSJfBfdy6AtIPMo/0QdhcGTzowkzTOKLKNuMfYxxcNiJPCogyylCYbZI8OnSzgPDaEzvTVJgBtPvZlGMX0wPdgoXYUWH0GySi6ISPWYIEDx/TaT5DicaQR1dhS3mkFzh++c0C+IbRBFAUUBLc/JJf+NUxaAkRMssADyQktGUFFaeNBNievbUKOaZrFoZJAFiJC4Hq2mDXYd5INAt8lwyzkRA9M1dVYoqfTtaRJRbLb5Oyccx8XcvgRc1pNR36y/lryaDVICWztJQPxtSgudkfUvcLFdHLU6C0qCGs9TmFIcuMHAXEd+JPQYLi1hQitKcIN7lDJEBdBJggTliWmEsAN8nsIwIXgIEyShORm5MN+xXQS04QL7pD8+uxXqV02pgkg8mmEpBsCO+N4hMZxxJQiXGSAItfNYhudajm1IDFVJ6VsGhM0XUs7Iyep3GibTNL4TvvFdnyT7x1bPPKBkWq+grBVAAc6uYyDgHHIgCKxxT69pp4BKae96ukINWdRLUqcl+rGV6AjZNSuPZlVulYyecqELr2d4HiwE3xrQTaZS8hFldEbkOuuUjbj3cijQK/b29vY2x5GmyqD8tK4+3XFntOfGehm6IBLatzji7yqI7tSxX+zqeucGflYnNfy/i5YtHwTK8TUVK5aqvWaLv9YtX7veti2HU51qvYTwZ9AOzCsn/IxaLKJxC6+q3lsPD7lP0VbNzAAUJgBb00iUAZ6185mZ438BHKN7akt2d4EoND1gUlPF9cwEgjWAIUjwLFFuQTyVX1b9ZzUMddwW9MLctG6H+Mg2dr6eHKo/KweaWyrsIHEpTOg+OQ9vemck20pmytsIjem4J/+Dvuyg6v5yU9HuxFw4C3gj9NuYhOVy+SuYmTuJtmeEZPJwoPymXtNbqL4ahTFCTVdKhAJBGerPHi0mrA99dDlV8EMkyTbSegsDtTmrGskup6AcCWwJ6AcsCEac1LDL8W82WUp5n90MS83rUL8czqbRfbHUQqsgq008a8EI3JnnShsoAh03lTCd+xc0V11XRf4ukluyAaCshsE9QENJjTe2hpkfuDBbzHHs6pJnutiekQdD0z4gHIXH+eb30WVxRC6uKJ3F9y37CoS0+Qx+flnUmyoyERraes3ZuIrXSFBnzNDHzmlzNK3Jn3W6Q/XVT/SedIhG5r+UbM4h8tw0/INCAUWazjI+yiks49kuxRsFPCcJ9CZGmoY1F4oCGFN+Guc7Mw56ZTB1lECY30O0nSieU2/FL0m7oCE9IbwcK7ST92Osp7Ad2VOpQuq7ZJ6G521gmuEH6nJjRn8kSACdbo6AdkL+hUEAzKDM4iyEvWd3L9PZcKbTW+3j0RsWICEzp0ei7A7Skm/KvgHb66TdgrAhqmwUp3InNJ+iqR25FcXjD7HD0X6An5ivDylhBO/0NzyLsgbMhKULkeoNOIPAEJdyE2hug07FCDDyQXlF+pjeji/toazHDEfqt62BSPVWWc2PJql92PpslV6CEvXUGezWrqLCgA2jgAW+hkMIi3dHIC8fY88O5dRpEhqmhnE6Hua/dOah74vayhHDz12xAdNH4WivFhq5UgGn9WiUUPfjxlTC77edjH2oMqM0cmnYMdY002IBdO0bHibbkm/s45UBgy1KouoJAYhAFRKX+ZFjqnHcuiKJ8BHYzkVpqjM+EXeSBkbvPjA5UGNctG4qnGiumb6ylWRLlsIfzGT9V8sI28au7cIx9gsfSHZa5dVAiiaMK+XbILZYGvLmkPzONCHFLxvPTEGGzXNgPRZ/srBdPomCNs4dTPWL3Gu0YhG/RfTSeC48GsD6CFJgWQwlDFyrpk5EhEPywDGfkhFaizihugvalWZV58ltCdHTnywbu7IBNfJEMs4MCIhRgbjihm4Q/8yA8zQUBZDhFRSoa0OmpvFiKKHSkUg6M2YZFBugxKwYoPXC8jBqI7nUVAZMA38hUtAhcpWDdHIEXqrQv2aoS5SGu2aYgGImJUVtSJzB67Yx45e8bqahn0x2MJ5INeGGHTh14R5nCPLbHBWBYT7ekdFPrhxnCUf9Mbx09+j+MNd6OJ4CDqhbN/QKe/hyMgqARDMOLoGcycCpetwNBnF+cAeTpgCaSN5ARign9DHDUY28ZMrskn6Q25h+ny+yYS6aGh5AryJXScB7mKRMQYOwCLbwZay4ZCaJhMQcF5LZKsTCJzA1pGEYNdzpmFLnxujvPzp+cazWueDs3KRPXqW/cNNpobZBAWFabc+htm7LMBStD30QSpsFPzURAR2LLZizt9fmR/zLU2EwMW+clpGsAA/ViIWtTPup9IPTNKWG2qlSQYGJF+ERC4Cz6SUp7LFoKVRDGupWsRLdkLOaihmyuQrro6HgeZIrJFG2PURFb4yUvFUr0eJEsTlbKkDGTOBXC6Ia0vUcGXIawO0lsCkvlcJt5EWmk3xKG0giKLeJ5yiDySb/i34UNNli9djSvmImWsqaBHqZz4F9I1U0D9MCT2gGqoTsC1TF/hp5rCr3q39glXGI1pLkbYTBN0Pj9n9rqkRBAbg9BcUnElTHIfXXOsW2yZ+gDJNuwRtmW4paVzkEWhcE9LnKHTz6wKnrS1ZiXyyv3O6v2aMdK5+GXEQPX+ez6A/FCCtHedrWgikGNEToGMaenx1MYhSDGtimGCTBQ6mAEel6icXjnDgxE4XEkG8MmE7J0i93qwkuFFoz1Z1Jwhgd8E3o3H6cQJNaLdcvTZJvEyiRGVeeJM/kyi8oKEbefTiJsZFirlPuqaTObbi5FKREFFNNzdFRBbYB9QSenbskQBYsxvaiTE1TQYssjSGIXvKC0RJdRkBX8esbpKXbkZXVD4UIOo4BzSIbjb00XadDLHb0t1XTU3193qyXo+LHxlmZ5OAvQVNNvgTVsjEgJK+J33d37DlMbYU+lDVIuJzCeimIky0VzHIjCojNWb4ieE9cBLfZWWp+TwAHB+cYG1qD9cmijEjgKuBto3rsmAt6wY+dj5xwmbOdb+hv33PINPVgZq8vXUKrW6BcqWlpjpX2pYN2EACQxo6K8RD+KMP/97/fF5O1EHkOjKSakz/UNzgoTOdJ3BeP6mObVKEPi83HfpAfWpglaSRz67IaVSYuasAxZA8WrK972HkR069m09SF12m+S/i31irVbeC/T0j7GvAOBFx0HoIJ/v/OS/kXwEXjABbfplXJJmaZX0LS4rx/xAMGt9Ty2dnLKuWs4k3JGmsME3lSTBezB0JLkl5Cbjt5Pih4VT08oQJY3heXyMzdhfIg0Au0q4FRr2I6TXPNaHpjMyq3Ec5/E6aIkhmy6OwUVZXJGw3kdDCXLXIUxNuD13jE1PQ7/nG80qvJOPIGXLBeLZqZn+GQ7Y9GjA4JxFYZfiQlrRneeF7Fwkc1wTzcEE0YN9xkOxyxMYoGAsyvaeSc8L50B40QzeErTHQU4YopT0+X9BaIGWpeDAAFYYExlQQi1fLlEA0tP2e9QFdl8FCmUlMnDGVIhbDkiyBtbhIIt98k0b4XCv3EeiKPYlQTL+VxPzmc7faV6kxH4eTAro3Yv6CNrhnmSUsagA0BRsFs3GjcAi3U9LtMJLp9EgHpBLYqEAy7z8eHpIzVHzCRzlfa+iGsJlcUTp5D4Ywc+646s6Eq4R+VJzBsOpRThbrZll5JRHyGjbWHo0LILZUWBB+zAmQBcDR3jYL3VhRXBenoMO5QQ9MsAgLWbXBx/IeLZSGUezqPiHXXjadiz1RfqXyGymmZuXGKH7RhiTDwLkE9gMhSKEpdHIGAeUP6LEsOgi0WHctm6JW7Sli6hjrKIIb5y4RLnJBTqFNyR/mQfqpdRY58qVByyauopZOLysxRhWtrKDKmmA+B158rYW+jIxzm5DYHJrMiiKFXtGMXKqqx6qqBH73oalkHYoVHGkfdswzWnrRtVmL0iJ6aeXg1m3NydOHotiKL4UmenGXcoFdoJApqbP5I5czFH2Tx6RS1Wx+ILWqcPoxVStD76HV65TnimZUvqYSZYzftjLxnrTq1ArF1lLXKAJbn6WCcCm5l5K7ZDZLyf29S+4p5bBzS/Ri0RwXtdOKZGd1qX6s7FtFfmxqYuzTTv/04sPn97trJWm4nGkJS9exXS02M1J7NVk9/hjfCb1OOnXgpOCS4GbC6+Px3s7p/sXx0WF/93Nd3i/fIFktWyxU9sG5SrtiB88aDnqOD3KZu9kSAKsu4ubAMVuTra39k5Ojk3z+dnmSXjBuRqRVIN6q+EH0WOU1i7XL7qVl1WL2+jZqzyEXmqsiYn+4Phb10fMUSBfSqjMVpU9NzgpxU5LXtQusiilOXV7V5TinJVnXVFV3UpIK3ZZTKTwXxlotIP9SOKikxEw94fHqmfMYedsUz9BZhmnmD9NYiQT90bIHyShYlVyNTeV/eK7gxzQjH9D5l/Wc3zS4LiaxuOj6PAK2SXj9IUWtwGUpa01+aFmO+9gjK7PKf957GSpZoD4QhMlZ+PEoBYbjgyuGBwkLZ63PebovZXDvUeEZny1fyq96vljKr+9Dfj3EyVBynIUeDvVIorrZ9IOfljHde4vpPsZg7cn+8eHObpNorVrE+YO15qCzRGstCI3CtfoIZuy15OSr+w/DznXcVouHRswALFnE8SJlgKYFc1Xn6bHcrPHTKt9FsHYcmY+vFk4Bax+jXWCokD1zuAwVPkiosPB857c3qx7UJURKe+hQoZGXU71yfm8SXsR510cXtfPPGjiUM0mENoHFVuEty3Sb1Tk0PcPWrqEAoh1CRoxzyGoKY5ERedFKuRizjkOZ11+cxVt8PMLsxxZn30CgTXv/SeEgudYBLljdhM5xIuMiJNKCI1uLiWstKKo1X0xLAjEk12IE14IDXUvB9b0JrocPEXFZ0/50zHs+L3wZ7VlItGdv/3C/UWmeWsP5gz3GmLPEekwA7SvzlnV2TUMzFQEZrqLMM0+TtnEQPhnjxNFL9pITXdsKsyMvgYitBqx8oMLyKD8XtN5XsbT90Ul9JsoWwPJQIw1GWwnsXxsHsVZ5tPXesPxlHfKrpSnxACmXgiKU0Ivn1pRCtM5UsCiWHbqBx4H4+EqJHMIa+ftvwPmCm05ld4ZB5BS7QPOxeRG5vdNpc/DELi99cYKUGtRz44PZmlkUN+XQunwmS7qem65LYi42VVtmhX0uSSt6blWPXfoKCN6s6jARsfBiNMMT4cunXcKXL+Om+00CFN/oNUNlh+PJd/w0OiSPVUe0ev+OPeTp3YTisE/kfj3BRXvBjOu8tK21aY1jVd58gu8BYOP8wsbBn7OMkVvvU06inn6wWcVx1EzYFt5Ok4MTL6S2Dl7T3gRd8/oaTvTlR/Hwkr1t0kV3Yy1PXLUY+dzi5J840DazcO3RUEag/Levd8vNGPuQo+JrfkqpsWbN8gxeii3ZOe3qUimwc9MIzEJmQU/pU/r+u2ldjW6l72J10pSOJ2kld5uoFlZfHtNXQbr6oXfiJatTXq+qyZUxiLwRnvnKdgbPIA1gLO/OWoevK0Af7B3tF+ywc5VZUOTIbvZI5wvYFc4lDRN5lPzgi9UW7YD/A3Mz5GM= + eJyNlUmP2jAUgO/5Fe+AxCIo3Q4VDHQog2bRFKEZijQqFXISQ9wGJ7INM6jqf6+XJJCN4Esgb/ve5lx9Db3QsrqtlgUtGDFEN8HNN5jdzcDxCaaiBwuCX+UfxLlUUVrXIXL+oA0GSAzGWlcL0U54AZMyeEAUngXGW0SpFjlBeGBk4wkYJ78+vv/wpX0MfLu179pS7Acbittwi5m0PsSBOaGOCgvw6d1n+aZrWRRtMZdAOMPST5JaIH+HIbB/Y0cAwyHDXMoJ3QCCvcwtcn5ls+FFCeYhdHF0nay/lhLoyOq0YO5hHQWIC42tTtnGMP3x+AhrWSYqJUrMm5FBbHe9Rwy4YIqzE3uIhF39DFkgZErYhdqKuDLfssiqRNXeT7Ty/pWwr99moyyi3Ah18VvK3gkoFzCZzp9eVvc3MIA6cet5zEUcvMLFdPR9opwo1foZFnEIq1zNX2balVItcTVW6mznCA5yivE2FIdoWNJ1DBFDW0CMoQPUdBbmdExKqsUnZrF+VPmaZo309zF8NkRm3tJC4bHglcMyPadL85i8OTgUJKDpvu5snziw3lFHyWC1cuJkGzqFtgEzE2kGWp2a8AjvDPUsyOrVjjNxKtUpDYwHI/2Xa/kTFjtGQRxXI5sWMxrn5z+TxwaLe7fRhAx25CrmU5tiqIra/oxFglXnBWCp/mW5svj7oAKZa+QacXPUR1xVzPPQ2XIW7XthQfMrny/pVOpUFvU4CpcRFo15IeGJYinhXOpUEp6O4yWESO+93usSULPzEaeLBCqwKWUe+X4p8s/khToc++teL7lF4zMYxqlFY98utdIXZ4GV6Wy5nb4lC+xMvY92v+K6ykXXX8IV8gniDXUb93r6TRvqS9lX+UmlPL6q7KVSqDf71n+69j+0 - + - ArangoDB PHP client: single document + ArangoDB PHP client: default values - - \ArangoDBClient\Document - Edge - \ArangoDBClient\Edge + + + DefaultValues + \ArangoDBClient\DefaultValues - Value object representing a single collection-based edge document + Contains default values used by the client <br> - - + - - ENTRY_FROM - \ArangoDBClient\Edge::ENTRY_FROM - '_from' - - Document _from index - - - - - ENTRY_TO - \ArangoDBClient\Edge::ENTRY_TO - '_to' - - Revision _to index + + DEFAULT_PORT + \ArangoDBClient\DefaultValues::DEFAULT_PORT + 8529 + + Default port number (used if no port specified) - - ENTRY_ID - \ArangoDBClient\Document::ENTRY_ID - '_id' - - Document id index + + DEFAULT_TIMEOUT + \ArangoDBClient\DefaultValues::DEFAULT_TIMEOUT + 30 + + Default timeout value (used if no timeout value specified) - - ENTRY_KEY - \ArangoDBClient\Document::ENTRY_KEY - '_key' - - Document key index + + DEFAULT_FAILOVER_TRIES + \ArangoDBClient\DefaultValues::DEFAULT_FAILOVER_TRIES + 3 + + Default number of failover servers to try (used in case there is an automatic failover) +if set to 0, then an unlimited amount of servers will be tried - - ENTRY_REV - \ArangoDBClient\Document::ENTRY_REV - '_rev' - - Revision id index + + DEFAULT_FAILOVER_TIMEOUT + \ArangoDBClient\DefaultValues::DEFAULT_FAILOVER_TIMEOUT + 30 + + Default max amount of time (in seconds) that is spent waiting on failover - - ENTRY_ISNEW - \ArangoDBClient\Document::ENTRY_ISNEW - '_isNew' - - isNew id index + + DEFAULT_AUTH_TYPE + \ArangoDBClient\DefaultValues::DEFAULT_AUTH_TYPE + 'Basic' + + Default Authorization type (use HTTP basic authentication) - - ENTRY_HIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES - '_hiddenAttributes' - - hidden attribute index + + DEFAULT_WAIT_SYNC + \ArangoDBClient\DefaultValues::DEFAULT_WAIT_SYNC + false + + Default value for waitForSync (fsync all data to disk on document updates/insertions/deletions) - - ENTRY_IGNOREHIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES - '_ignoreHiddenAttributes' - - hidden attribute index + + DEFAULT_JOURNAL_SIZE + \ArangoDBClient\DefaultValues::DEFAULT_JOURNAL_SIZE + 33554432 + + Default value for collection journal size - - OPTION_WAIT_FOR_SYNC + + DEFAULT_IS_VOLATILE + \ArangoDBClient\DefaultValues::DEFAULT_IS_VOLATILE + false + + Default value for isVolatile + + + + + DEFAULT_CREATE + \ArangoDBClient\DefaultValues::DEFAULT_CREATE + false + + Default value for createCollection (create the collection on the fly when the first document is added to an unknown collection) + + + + + DEFAULT_CONNECTION + \ArangoDBClient\DefaultValues::DEFAULT_CONNECTION + 'Keep-Alive' + + Default value for HTTP Connection header + + + + + DEFAULT_VERIFY_CERT + \ArangoDBClient\DefaultValues::DEFAULT_VERIFY_CERT + false + + Default value for SSL certificate verification + + + + + DEFAULT_VERIFY_CERT_NAME + \ArangoDBClient\DefaultValues::DEFAULT_VERIFY_CERT_NAME + false + + Default value for SSL certificate host name verification + + + + + DEFAULT_ALLOW_SELF_SIGNED + \ArangoDBClient\DefaultValues::DEFAULT_ALLOW_SELF_SIGNED + true + + Default value for accepting self-signed SSL certificates + + + + + DEFAULT_CIPHERS + \ArangoDBClient\DefaultValues::DEFAULT_CIPHERS + null + + Default value for ciphers to be used in SSL + + + + + DEFAULT_UPDATE_POLICY + \ArangoDBClient\DefaultValues::DEFAULT_UPDATE_POLICY + \ArangoDBClient\UpdatePolicy::ERROR + + Default update policy + + + + + DEFAULT_REPLACE_POLICY + \ArangoDBClient\DefaultValues::DEFAULT_REPLACE_POLICY + \ArangoDBClient\UpdatePolicy::ERROR + + Default replace policy + + + + + DEFAULT_DELETE_POLICY + \ArangoDBClient\DefaultValues::DEFAULT_DELETE_POLICY + \ArangoDBClient\UpdatePolicy::ERROR + + Default delete policy + + + + + DEFAULT_CHECK_UTF8_CONFORM + \ArangoDBClient\DefaultValues::DEFAULT_CHECK_UTF8_CONFORM + false + + Default value for checking if data is UTF-8 conform + + + + + eJydVltP4zgUfu+vOG8UBFO2DBJbZi+ZNKWZCU2VpoxYIUVu4rReHDuKHdjOav/7HLsX6EjNFvqSNOfyfedqf/qjXJStVufkpAUn4FREzGX/M4yHY0g5o0L3IKM5qbmGJ8JrqlDNaP5ZkvSRzCnA1si1+lZIar2QFcrgCxEw0ZQWRAgrSmW5rNh8ocHdvnXPf+megq4YOhQKborZ8BTFXM4FPYUbWqH1Eq07rZYgBVWITX+Cvd7G4EqhCUM3u7yhVjSD2RL0gq5DW4fyaVb9flBUionUiADOP3QtHTJTuiKpRodEKeivEO9Wifq3ZVQtK/M72YihlJUGURczWkHb0mI5CLn6rkqaspzR7Hht1rHPVAqloe8NnGkQJ+MwiuE3uLrs/oqB74HRrKCyXse/A7QrOQgx9m+9cGpAL86vrXwf7DowmUNOGJdP+K5ohQ8FGqGr5YaKgJQoaupRUWAKsFOwb2RBNEu3thtOhrmi2rg4PzU2wujXgrOCafRGClkLbVA3YM+Mc5hR01Y0a4hs4PhBeOdFSRz53sQE2BxfQf55hWZSCW2MRVF0m6lj5Ea0CQfTiirPhGkm5iDFNqSDuBycbseOGvuOWUMMvSxXpYZhHI9hRhTm0kwjcmGp1WmqsjONh0l8P/YQ+OizMT7a31+r7slxzk2QA1lNliKFdq7Mg2DyM6KJKVjG1KNJQCbTujBJqUsUUdXBKaWV4aQ6GeXUvjXR++b4cTK5H7lILydc0UPIpZJzmtrs/C3rShAOin2nDTBfwmk0coJk4v9lEnFxcXn58eNF9xAwpu4kxzTzJv/+JLkLAyf2A+9NgVQUs+a+hNNefVlttJfPpg3wS86X8GzmxP5hFRLYFsBMW5bh2GB17Bg9CvksXjlpqoIbeU78Jua2F3EvizXDBSVZ4xy44WjkubEfjkwjfqW0PHM4e6IHdeNkEkBq+io3HU8BR271itANmDh2/uA+cT27WtexNU3efsSFRL/mpHoHdjJybt+UXJKmtLQ7RlGenymGh2b2MyXVNPRBEH5LJl4wwI6/GXl9RNdVfVhPsnKx3uy4ajd7HcGbiuuPh15kNq2oOd+PstoSeCpyli4b/E3HfexHPBMD371Hr1NrN7ZmvZ4XRWG0H6SiJTe3if9Fibxx4LjvhbHr7QCUvhd4747lVVkWNH00LYGnpt3COPDTeHB2ZeBQoWgqz9BzvyaofWXGcBBGty/d+F+rZW86CeGMqPbOfafXs6JTOHrY3OQe1peo2cOO5tHxdesHwdIT5g== + + + + ArangoDB PHP client: single user document + + + + + + + \ArangoDBClient\Document + User + \ArangoDBClient\User + + Value object representing a single User document + <br> + + + + + + ENTRY_ID + \ArangoDBClient\Document::ENTRY_ID + '_id' + + Document id index + + + + + ENTRY_KEY + \ArangoDBClient\Document::ENTRY_KEY + '_key' + + Document key index + + + + + ENTRY_REV + \ArangoDBClient\Document::ENTRY_REV + '_rev' + + Revision id index + + + + + ENTRY_ISNEW + \ArangoDBClient\Document::ENTRY_ISNEW + '_isNew' + + isNew id index + + + + + ENTRY_HIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES + '_hiddenAttributes' + + hidden attribute index + + + + + ENTRY_IGNOREHIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES + '_ignoreHiddenAttributes' + + hidden attribute index + + + + + OPTION_WAIT_FOR_SYNC \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC 'waitForSync' @@ -6214,30 +6537,15 @@ This is only for options that are to be sent to the ArangoDB server in a json bo - - $_from - \ArangoDBClient\Edge::_from - - - The edge's from (might be NULL for new documents) - - - mixed - - - - - $_to - \ArangoDBClient\Edge::_to - - - The edge's to (might be NULL for new documents) + + KEY_REGEX_PART + \ArangoDBClient\Document::KEY_REGEX_PART + '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' + + regular expression used for key validation - - mixed - - + $_id \ArangoDBClient\Document::_id @@ -6257,7 +6565,7 @@ This is only for options that are to be sent to the ArangoDB server in a json bo The document key (might be NULL for new documents) - + string @@ -6347,200 +6655,94 @@ This can be turned on, but has a performance penalty - - set - \ArangoDBClient\Edge::set() - - Set a document attribute - The key (attribute name) must be a string. - -This will validate the value of the attribute and might throw an -exception if the value is invalid. - + + __construct + \ArangoDBClient\Document::__construct() + + Constructs an empty document + + + array + + + + $options + null + array + + \ArangoDBClient\Document + + + createFromArray + \ArangoDBClient\Document::createFromArray() + + Factory method to construct a new document using the values passed to populate it + + \ArangoDBClient\ClientException - - string + + array - - mixed + + array - - void + + \ArangoDBClient\Document + \ArangoDBClient\Edge + \ArangoDBClient\Graph - - $key + $values - string + array - $value - - mixed + $options + array() + array + \ArangoDBClient\Document - - setFrom - \ArangoDBClient\Edge::setFrom() - - Set the 'from' vertex document-handler - - - mixed - - - \ArangoDBClient\Edge - - - - $from - - mixed - - - - getFrom - \ArangoDBClient\Edge::getFrom() - - Get the 'from' vertex document-handler (if already known) - - - mixed - - - - - setTo - \ArangoDBClient\Edge::setTo() - - Set the 'to' vertex document-handler - - - mixed - - - \ArangoDBClient\Edge - - - - $to - - mixed - - - - getTo - \ArangoDBClient\Edge::getTo() - - Get the 'to' vertex document-handler (if already known) - - - mixed - - - - - getAllForInsertUpdate - \ArangoDBClient\Edge::getAllForInsertUpdate() - - Get all document attributes for insertion/update - - - mixed - - - - - - __construct - \ArangoDBClient\Document::__construct() - - Constructs an empty document - - - array - - - - $options - null - array - - \ArangoDBClient\Document - - - createFromArray - \ArangoDBClient\Document::createFromArray() - - Factory method to construct a new document using the values passed to populate it - - - \ArangoDBClient\ClientException - - - array - - - array - - - \ArangoDBClient\Document - \ArangoDBClient\Edge - \ArangoDBClient\Graph - - - - $values - - array - - - $options - array() - array - - \ArangoDBClient\Document - - + __clone \ArangoDBClient\Document::__clone() - + Clone a document Returns the clone - - + + void \ArangoDBClient\Document - + __toString \ArangoDBClient\Document::__toString() - + Get a string representation of the document. It will not output hidden attributes. Returns the document as JSON-encoded string - - + + string \ArangoDBClient\Document - + toJson \ArangoDBClient\Document::toJson() - + Returns the document as JSON-encoded string - + array - + string @@ -6551,16 +6753,16 @@ Returns the document as JSON-encoded string \ArangoDBClient\Document - + toSerialized \ArangoDBClient\Document::toSerialized() - + Returns the document as a serialized string - + array - + string @@ -6571,19 +6773,19 @@ Returns the document as JSON-encoded string \ArangoDBClient\Document - + filterHiddenAttributes \ArangoDBClient\Document::filterHiddenAttributes() - + Returns the attributes with the hidden ones removed - + array - + array - + array @@ -6599,24 +6801,24 @@ Returns the document as JSON-encoded string \ArangoDBClient\Document - + set \ArangoDBClient\Document::set() - + Set a document attribute The key (attribute name) must be a string. This will validate the value of the attribute and might throw an exception if the value is invalid. - + \ArangoDBClient\ClientException - + string - + mixed - + void @@ -6632,25 +6834,25 @@ exception if the value is invalid. \ArangoDBClient\Document - + __set \ArangoDBClient\Document::__set() - + Set a document attribute, magic method This is a magic method that allows the object to be used without declaring all document attributes first. This function is mapped to set() internally. - + \ArangoDBClient\ClientException - - + + string - + mixed - + void @@ -6666,16 +6868,16 @@ This function is mapped to set() internally. \ArangoDBClient\Document - + get \ArangoDBClient\Document::get() - + Get a document attribute - + string - + mixed @@ -6686,17 +6888,17 @@ This function is mapped to set() internally. \ArangoDBClient\Document - + __get \ArangoDBClient\Document::__get() - + Get a document attribute, magic method This function is mapped to get() internally. - - + + string - + mixed @@ -6707,16 +6909,16 @@ This function is mapped to set() internally. \ArangoDBClient\Document - + __isset \ArangoDBClient\Document::__isset() - + Is triggered by calling isset() or empty() on inaccessible properties. - + string - + boolean @@ -6727,15 +6929,15 @@ This function is mapped to set() internally. \ArangoDBClient\Document - + __unset \ArangoDBClient\Document::__unset() - + Magic method to unset an attribute. Caution!!! This works only on the first array level. The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. - - + + $key @@ -6744,16 +6946,16 @@ The preferred method to unset attributes in the database, is to set those to nul \ArangoDBClient\Document - + getAll \ArangoDBClient\Document::getAll() - + Get all document attributes - + mixed - + array @@ -6764,28 +6966,28 @@ The preferred method to unset attributes in the database, is to set those to nul \ArangoDBClient\Document - + getAllForInsertUpdate \ArangoDBClient\Document::getAllForInsertUpdate() - + Get all document attributes for insertion/update - + mixed \ArangoDBClient\Document - + getAllAsObject \ArangoDBClient\Document::getAllAsObject() - + Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class - + mixed - + mixed @@ -6796,17 +6998,17 @@ The preferred method to unset attributes in the database, is to set those to nul \ArangoDBClient\Document - + setHiddenAttributes \ArangoDBClient\Document::setHiddenAttributes() - + Set the hidden attributes $cursor - + array - + void @@ -6817,37 +7019,37 @@ $cursor \ArangoDBClient\Document - + getHiddenAttributes \ArangoDBClient\Document::getHiddenAttributes() - + Get the hidden attributes - + array \ArangoDBClient\Document - + isIgnoreHiddenAttributes \ArangoDBClient\Document::isIgnoreHiddenAttributes() - + - + boolean \ArangoDBClient\Document - + setIgnoreHiddenAttributes \ArangoDBClient\Document::setIgnoreHiddenAttributes() - + - + boolean @@ -6858,16 +7060,16 @@ $cursor \ArangoDBClient\Document - + setChanged \ArangoDBClient\Document::setChanged() - + Set the changed flag - + boolean - + boolean @@ -6878,28 +7080,28 @@ $cursor \ArangoDBClient\Document - + getChanged \ArangoDBClient\Document::getChanged() - + Get the changed flag - + boolean \ArangoDBClient\Document - + setIsNew \ArangoDBClient\Document::setIsNew() - + Set the isNew flag - + boolean - + void @@ -6910,31 +7112,31 @@ $cursor \ArangoDBClient\Document - + getIsNew \ArangoDBClient\Document::getIsNew() - + Get the isNew flag - + boolean \ArangoDBClient\Document - + setInternalId \ArangoDBClient\Document::setInternalId() - + Set the internal document id This will throw if the id of an existing document gets updated to some other id - + \ArangoDBClient\ClientException - + string - + void @@ -6945,19 +7147,19 @@ $cursor \ArangoDBClient\Document - + setInternalKey \ArangoDBClient\Document::setInternalKey() - + Set the internal document key This will throw if the key of an existing document gets updated to some other key - + \ArangoDBClient\ClientException - + string - + void @@ -6968,97 +7170,97 @@ $cursor \ArangoDBClient\Document - + getInternalId \ArangoDBClient\Document::getInternalId() - + Get the internal document id (if already known) Document ids are generated on the server only. Document ids consist of collection id and document id, in the format collectionId/documentId - + string \ArangoDBClient\Document - + getInternalKey \ArangoDBClient\Document::getInternalKey() - + Get the internal document key (if already known) - + string \ArangoDBClient\Document - + getHandle \ArangoDBClient\Document::getHandle() - + Convenience function to get the document handle (if already known) - is an alias to getInternalId() Document handles are generated on the server only. Document handles consist of collection id and document id, in the format collectionId/documentId - + string \ArangoDBClient\Document - + getId \ArangoDBClient\Document::getId() - + Get the document id (or document handle) if already known. It is a string and consists of the collection's name and the document key (_key attribute) separated by /. Example: (collectionname/documentId) The document handle is stored in a document's _id attribute. - + mixed \ArangoDBClient\Document - + getKey \ArangoDBClient\Document::getKey() - + Get the document key (if already known). Alias function for getInternalKey() - + mixed \ArangoDBClient\Document - + getCollectionId \ArangoDBClient\Document::getCollectionId() - + Get the collection id (if already known) Collection ids are generated on the server only. Collection ids are numeric but might be bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used - + mixed \ArangoDBClient\Document - + setRevision \ArangoDBClient\Document::setRevision() - + Set the document revision Revision ids are generated on the server only. Document ids are strings, even if they look "numeric" To reliably store a document id elsewhere, a PHP string must be used - + mixed - + void @@ -7069,29 +7271,29 @@ To reliably store a document id elsewhere, a PHP string must be used \ArangoDBClient\Document - + getRevision \ArangoDBClient\Document::getRevision() - + Get the document revision (if already known) - + mixed \ArangoDBClient\Document - + jsonSerialize \ArangoDBClient\Document::jsonSerialize() - + Get all document attributes Alias function for getAll() - it's necessary for implementing JsonSerializable interface - + mixed - + array @@ -7102,2120 +7304,2289 @@ Alias function for getAll() - it's necessary for implementing JsonSerializable i \ArangoDBClient\Document + + + + + user + + + string + + + + string + + + + + + + + passwd + + + mixed|null + + + + mixed + null + + + + + + + + active + + + mixed|null + + + + mixed + null + + + + + + + + extra + + + array|null + + + + array + null + + + - eJy1V2FvGjkQ/c6vmEhIkAhK2o+k9NJrSJq211QpjVQlUWR2B/DF2CvbS0DX/Pcbe70bsrCBq45VpMB6/Oa9mfF4ePtHMklqtc7BQQ0O4L1mcqxO/oRvH79BJDhK2wXD5VggxCpKp/SC7JzpccKiezZGgGLXB7/BL7LUTpSmNfjEJHy3iFMmpV+KVLLQfDyx8KH49Obw9ZsWWM0JUBo4mw4/tmhZqLHEFpyhpt0L2t2p1SSboiHfWHJ7VIi4YiJFUMO/MbKgMdFoaJ1EAMu1REoIWuVKtofMYAwYj1cUvh3qd1uJJdDILQG8fnXoWUaCGQN9B4pzizI2cJKD/1Nzlp6rew5gMEHvv2FgpNUUmlMfkyHC1x9fvsCI4ijxoWBn9sPGfP/xjGmY8jnG4U3H/0+0sqSRxNXvHC4FqNqxVbtwa9Wq0zwO4EkBlzHOCwD/IVLSWOh/HVz+vDu9vPgLetDwxo1VtEuccUNpBPJVwipDDS48kFUOpozzHS1VR64VmKVaHKYWS5pdxO5xAc3CAFw97sM0NT50VGG0IMevVjZyAw9cCJgxwWNGGy1hzbJSHfkvT5hMxpBlw060eqDvOQ7OI0xc3QIfLSEQOJceuez42CMYyMq1n28vWyVMs2ngDnUnEaANz1WWjH3qAeoZg3Zg4sqmKnrHGm2qJcwUL9VMOhQ8glEq/ZkEg7bpSLQCelZ62cFxD2lv1i2FtP3uLlZXIaL7SxY+vZ11wU7oZOYlGx7fMAKK0t1uvqsZvB8V1o+15xyI4/XhLfR6rrIaZQK5iV83KEbdblaK5ydlU/cERST+XFrUkonz+InCinkWzKNn7x9r2xH43P+5HYPPuNgRhcv+1csU8qO9I/+us7xM4JRazo6cDy5edj1Q/9nxGgrO/V5+TqIJ3VsYr6vRPW78iQuW3rG5dsRv9+HXL1i3AHskKXBcI4XOHkFCcAojwcZVcnNm1J2tTnELXQTuOqShw7p0smtl3Gd0c7IZ/OP6G8BhNfxNAzPUFufFjdAmjrFAvb5vZq2w7i+0dnaJZ/srGqAfDNrZ0JHNKZvaYVaLDrncC3O13msvI7FUNMGjtyq0l6SfbSUdmlQrTGhk8QLupXqQKxNBcJaFo10VvPUix0FkWd+ygCCzSkeRQrrjfyuBNEO03Sj0PyfPnWarqhJH/nrO9e8m7QWxu08ZSduQMCesWgGjiWh16jJ+jODSkCxy1EkTdx1voE73uoo4s3xGA5TWbOHmqgr8TtYbNql7L8Sp0ueexw/PYUVtnd4yKJ4ezRfa/WrqVmx/am/LQ4w/vK6jylSIcj/1Lq7DCOw72cpZyAK8DpmqaxMuFdCtp15O2VLalhPrthU5pT//Y+eOZiZmmu5wdLv+TQsaN/kvupvwq2l44wwaFIV/AaDf7i0= + eJyFkM1OwzAQhO9+ir0VIkQFxxSJvwpxQeoFTpHQ1lmloY5trW1oBLw764RWKgXh436zszO+uPQrr9S0KBQUcM1oGze/gcX9ArRpycYSQmsbQ5ACMdROp06mIs76K496jQ0B7FZvh60BYoorx8LgTuAaHrAnHohY6rwEcHZ6LpOpUhY7CmJHP5xmu3BPaBKBW76QjsDkmYJwCQe4zfj4a0Z2njj2ECJndX65zD7s2g3VHzYZAx5DeKv/xKhj+0r7GJmxHzFtIuP/n3P4BdrI3bGCeJCtA8y3Vd6V+lSj4hlNi+Eo68pymJzApJJqcsqG6vvUssqCyfFMfQHFdZsR - + - ArangoDB PHP client: result set cursor + ArangoDB PHP client: collection handler - - - \Iterator - Cursor - \ArangoDBClient\Cursor - - Provides access to the results of an AQL query or another statement - The cursor might not contain all results in the beginning.<br> - -If the result set is too big to be transferred in one go, the -cursor might issue additional HTTP requests to fetch the -remaining results from the server. - - + + \ArangoDBClient\Handler + CollectionHandler + \ArangoDBClient\CollectionHandler + + Provides management of collections + The collection handler fetches collection data from the server and +creates collections on the server. + + + - - ENTRY_ID - \ArangoDBClient\Cursor::ENTRY_ID - 'id' - - result entry for cursor id + + ENTRY_DOCUMENTS + \ArangoDBClient\CollectionHandler::ENTRY_DOCUMENTS + 'documents' + + documents array index - - ENTRY_HASMORE - \ArangoDBClient\Cursor::ENTRY_HASMORE - 'hasMore' - - result entry for "hasMore" flag + + OPTION_COLLECTION + \ArangoDBClient\CollectionHandler::OPTION_COLLECTION + 'collection' + + collection parameter - - ENTRY_RESULT - \ArangoDBClient\Cursor::ENTRY_RESULT - 'result' - - result entry for result documents + + OPTION_EXAMPLE + \ArangoDBClient\CollectionHandler::OPTION_EXAMPLE + 'example' + + example parameter - - ENTRY_EXTRA - \ArangoDBClient\Cursor::ENTRY_EXTRA - 'extra' - - result entry for extra data + + OPTION_NEW_VALUE + \ArangoDBClient\CollectionHandler::OPTION_NEW_VALUE + 'newValue' + + example parameter - - ENTRY_STATS - \ArangoDBClient\Cursor::ENTRY_STATS - 'stats' - - result entry for stats + + OPTION_CREATE_COLLECTION + \ArangoDBClient\CollectionHandler::OPTION_CREATE_COLLECTION + 'createCollection' + + example parameter - - FULL_COUNT - \ArangoDBClient\Cursor::FULL_COUNT - 'fullCount' - - result entry for the full count (ignoring the outermost LIMIT) + + OPTION_ATTRIBUTE + \ArangoDBClient\CollectionHandler::OPTION_ATTRIBUTE + 'attribute' + + attribute parameter - - ENTRY_CACHE - \ArangoDBClient\Cursor::ENTRY_CACHE - 'cache' - - cache option entry + + OPTION_KEYS + \ArangoDBClient\CollectionHandler::OPTION_KEYS + 'keys' + + keys parameter - - ENTRY_CACHED - \ArangoDBClient\Cursor::ENTRY_CACHED - 'cached' - - cached result attribute - whether or not the result was served from the AQL query cache + + OPTION_STREAM + \ArangoDBClient\CollectionHandler::OPTION_STREAM + 'stream' + + stream parameter - - ENTRY_SANITIZE - \ArangoDBClient\Cursor::ENTRY_SANITIZE - '_sanitize' - - sanitize option entry + + OPTION_LEFT + \ArangoDBClient\CollectionHandler::OPTION_LEFT + 'left' + + left parameter - - ENTRY_FLAT - \ArangoDBClient\Cursor::ENTRY_FLAT - '_flat' - - "flat" option entry (will treat the results as a simple array, not documents) + + OPTION_RIGHT + \ArangoDBClient\CollectionHandler::OPTION_RIGHT + 'right' + + right parameter - - ENTRY_TYPE - \ArangoDBClient\Cursor::ENTRY_TYPE - 'objectType' - - "objectType" option entry. + + OPTION_CLOSED + \ArangoDBClient\CollectionHandler::OPTION_CLOSED + 'closed' + + closed parameter - - ENTRY_BASEURL - \ArangoDBClient\Cursor::ENTRY_BASEURL - 'baseurl' - - "baseurl" option entry. + + OPTION_LATITUDE + \ArangoDBClient\CollectionHandler::OPTION_LATITUDE + 'latitude' + + latitude parameter - - $_connection - \ArangoDBClient\Cursor::_connection - - - The connection object - - - \ArangoDBClient\Connection - - - - - $_options - \ArangoDBClient\Cursor::_options - - - Cursor options + + OPTION_LONGITUDE + \ArangoDBClient\CollectionHandler::OPTION_LONGITUDE + 'longitude' + + longitude parameter - - array - - - - $data - \ArangoDBClient\Cursor::data - - - Result Data + + + OPTION_DISTANCE + \ArangoDBClient\CollectionHandler::OPTION_DISTANCE + 'distance' + + distance parameter - - array - - - - $_result - \ArangoDBClient\Cursor::_result - - - The result set + + + OPTION_RADIUS + \ArangoDBClient\CollectionHandler::OPTION_RADIUS + 'radius' + + radius parameter - - array - - - - $_hasMore - \ArangoDBClient\Cursor::_hasMore - - - "has more" indicator - if true, the server has more results + + + OPTION_SKIP + \ArangoDBClient\CollectionHandler::OPTION_SKIP + 'skip' + + skip parameter - - boolean - - - - $_id - \ArangoDBClient\Cursor::_id - - - cursor id - might be NULL if cursor does not have an id + + + OPTION_INDEX + \ArangoDBClient\CollectionHandler::OPTION_INDEX + 'index' + + index parameter - - mixed - - - - $_position - \ArangoDBClient\Cursor::_position - - - current position in result set iteration (zero-based) + + + OPTION_LIMIT + \ArangoDBClient\CollectionHandler::OPTION_LIMIT + 'limit' + + limit parameter - - integer - - - - $_length - \ArangoDBClient\Cursor::_length - - - total length of result set (in number of documents) + + + OPTION_FIELDS + \ArangoDBClient\CollectionHandler::OPTION_FIELDS + 'fields' + + fields - - integer - - - - $_fullCount - \ArangoDBClient\Cursor::_fullCount - - - full count of the result set (ignoring the outermost LIMIT) + + + OPTION_UNIQUE + \ArangoDBClient\CollectionHandler::OPTION_UNIQUE + 'unique' + + unique - - integer - - - - $_extra - \ArangoDBClient\Cursor::_extra - - - extra data (statistics) returned from the statement + + + OPTION_TYPE + \ArangoDBClient\CollectionHandler::OPTION_TYPE + 'type' + + type - - array - - - - $_fetches - \ArangoDBClient\Cursor::_fetches - 1 - - number of HTTP calls that were made to build the cursor result + + + OPTION_SIZE + \ArangoDBClient\CollectionHandler::OPTION_SIZE + 'size' + + size option - - - $_cached - \ArangoDBClient\Cursor::_cached - - - whether or not the query result was served from the AQL query result cache + + + OPTION_GEO_INDEX + \ArangoDBClient\CollectionHandler::OPTION_GEO_INDEX + 'geo' + + geo index option - - - $_count - \ArangoDBClient\Cursor::_count - - - precalculated number of documents in the cursor, as returned by the server + + + OPTION_GEOJSON + \ArangoDBClient\CollectionHandler::OPTION_GEOJSON + 'geoJson' + + geoJson option - - integer - - - - $_documentClass - \ArangoDBClient\Cursor::_documentClass - '\ArangoDBClient\Document' - - + + + OPTION_HASH_INDEX + \ArangoDBClient\CollectionHandler::OPTION_HASH_INDEX + 'hash' + + hash index option - - string - - - - __construct - \ArangoDBClient\Cursor::__construct() - - Initialise the cursor with the first results and some metadata + + + OPTION_FULLTEXT_INDEX + \ArangoDBClient\CollectionHandler::OPTION_FULLTEXT_INDEX + 'fulltext' + + fulltext index option - - \ArangoDBClient\Connection - - - array - - - array - - - \ArangoDBClient\ClientException - - - - $connection - - \ArangoDBClient\Connection - - - $data - - array - - - $options - - array - - - - delete - \ArangoDBClient\Cursor::delete() - - Explicitly delete the cursor - This might issue an HTTP DELETE request to inform the server about -the deletion. - - \ArangoDBClient\Exception - - - boolean - - - - - getCount - \ArangoDBClient\Cursor::getCount() - - Get the total number of results in the cursor - This might issue additional HTTP requests to fetch any outstanding -results from the server - - \ArangoDBClient\Exception - - - integer - - - - getFullCount - \ArangoDBClient\Cursor::getFullCount() - - Get the full count of the cursor (ignoring the outermost LIMIT) + + + OPTION_MIN_LENGTH + \ArangoDBClient\CollectionHandler::OPTION_MIN_LENGTH + 'minLength' + + minLength option - - integer - - - - getCached - \ArangoDBClient\Cursor::getCached() - - Get the cached attribute for the result set + + + OPTION_SKIPLIST_INDEX + \ArangoDBClient\CollectionHandler::OPTION_SKIPLIST_INDEX + 'skiplist' + + skiplist index option - - boolean - - - - getAll - \ArangoDBClient\Cursor::getAll() - - Get all results as an array - This might issue additional HTTP requests to fetch any outstanding -results from the server - - \ArangoDBClient\Exception - - - array - - - - - rewind - \ArangoDBClient\Cursor::rewind() - - Rewind the cursor, necessary for Iterator + + + OPTION_PERSISTENT_INDEX + \ArangoDBClient\CollectionHandler::OPTION_PERSISTENT_INDEX + 'persistent' + + persistent index option - - void - - - - current - \ArangoDBClient\Cursor::current() - - Return the current result row, necessary for Iterator + + + OPTION_TTL_INDEX + \ArangoDBClient\CollectionHandler::OPTION_TTL_INDEX + 'ttl' + + ttl index option - - array - - - - key - \ArangoDBClient\Cursor::key() - - Return the index of the current result row, necessary for Iterator + + + OPTION_EXPIRE_AFTER + \ArangoDBClient\CollectionHandler::OPTION_EXPIRE_AFTER + 'expireAfter' + + expireAfter option - - integer - - - - next - \ArangoDBClient\Cursor::next() - - Advance the cursor, necessary for Iterator + + + OPTION_IN_BACKGROUND + \ArangoDBClient\CollectionHandler::OPTION_IN_BACKGROUND + 'inBackground' + + inBackground option - - void - - - - valid - \ArangoDBClient\Cursor::valid() - - Check if cursor can be advanced further, necessary for Iterator - This might issue additional HTTP requests to fetch any outstanding -results from the server - - \ArangoDBClient\Exception - - - boolean - + + + OPTION_SPARSE + \ArangoDBClient\CollectionHandler::OPTION_SPARSE + 'sparse' + + sparse index option + - - - add - \ArangoDBClient\Cursor::add() - - Create an array of results from the input array + + + OPTION_COUNT + \ArangoDBClient\CollectionHandler::OPTION_COUNT + 'count' + + count option - - array - - - void - - - \ArangoDBClient\ClientException - - - $data - - array - - - - addFlatFromArray - \ArangoDBClient\Cursor::addFlatFromArray() - - Create an array of results from the input array + + + OPTION_QUERY + \ArangoDBClient\CollectionHandler::OPTION_QUERY + 'query' + + query option + + + + + OPTION_CHECKSUM + \ArangoDBClient\CollectionHandler::OPTION_CHECKSUM + 'checksum' + + checksum option + + + + + OPTION_REVISION + \ArangoDBClient\CollectionHandler::OPTION_REVISION + 'revision' + + revision option + + + + + OPTION_RESPONSIBLE_SHARD + \ArangoDBClient\CollectionHandler::OPTION_RESPONSIBLE_SHARD + 'responsibleShard' + + responsible shard option + + + + + OPTION_SHARDS + \ArangoDBClient\CollectionHandler::OPTION_SHARDS + 'shards' + + shards option + + + + + OPTION_PROPERTIES + \ArangoDBClient\CollectionHandler::OPTION_PROPERTIES + 'properties' + + properties option + + + + + OPTION_FIGURES + \ArangoDBClient\CollectionHandler::OPTION_FIGURES + 'figures' + + figures option + + + + + OPTION_LOAD + \ArangoDBClient\CollectionHandler::OPTION_LOAD + 'load' + + load option + + + + + OPTION_UNLOAD + \ArangoDBClient\CollectionHandler::OPTION_UNLOAD + 'unload' + + unload option + + + + + OPTION_TRUNCATE + \ArangoDBClient\CollectionHandler::OPTION_TRUNCATE + 'truncate' + + truncate option + + + + + OPTION_RENAME + \ArangoDBClient\CollectionHandler::OPTION_RENAME + 'rename' + + rename option + + + + + OPTION_EXCLUDE_SYSTEM + \ArangoDBClient\CollectionHandler::OPTION_EXCLUDE_SYSTEM + 'excludeSystem' + + exclude system collections + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string + + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - + + string + + + + + create + \ArangoDBClient\CollectionHandler::create() + + Creates a new collection on the server + This will add the collection on the server and return its id +The id is mainly returned for backwards compatibility, but you should use the collection name for any reference to the collection. * +This will throw if the collection cannot be created + + \ArangoDBClient\Exception + + + mixed + + array - - void + + mixed - $data + $collection + mixed + + + $options + array() array - - addDocumentsFromArray - \ArangoDBClient\Cursor::addDocumentsFromArray() - - Create an array of documents from the input array - - - array + + has + \ArangoDBClient\CollectionHandler::has() + + Check if a collection exists + This will call self::get() internally and checks if there +was an exception thrown which represents an 404 request. + + \ArangoDBClient\Exception - - void + + mixed - - \ArangoDBClient\ClientException + + boolean - $data + $collection - array + mixed - - addPathsFromArray - \ArangoDBClient\Cursor::addPathsFromArray() - - Create an array of paths from the input array - - - array + + count + \ArangoDBClient\CollectionHandler::count() + + Get the number of documents in a collection + This will throw if the collection cannot be fetched from the server + + \ArangoDBClient\Exception - - void + + mixed - - \ArangoDBClient\ClientException + + integer - $data + $collection - array + mixed - - addShortestPathFromArray - \ArangoDBClient\Cursor::addShortestPathFromArray() - - Create an array of shortest paths from the input array - - - array + + get + \ArangoDBClient\CollectionHandler::get() + + Get information about a collection + This will throw if the collection cannot be fetched from the server + + \ArangoDBClient\Exception - - void + + mixed - - \ArangoDBClient\ClientException + + \ArangoDBClient\Collection - $data + $collection - array + mixed - - addDistanceToFromArray - \ArangoDBClient\Cursor::addDistanceToFromArray() - - Create an array of distances from the input array - - - array + + getProperties + \ArangoDBClient\CollectionHandler::getProperties() + + Get properties of a collection + This will throw if the collection cannot be fetched from the server + + \ArangoDBClient\Exception - - void + + mixed + + + \ArangoDBClient\Collection - $data + $collection - array + mixed - - addCommonNeighborsFromArray - \ArangoDBClient\Cursor::addCommonNeighborsFromArray() - - Create an array of common neighbors from the input array - - - array + + figures + \ArangoDBClient\CollectionHandler::figures() + + Get figures for a collection + This will throw if the collection cannot be fetched from the server + + \ArangoDBClient\Exception - - void + + mixed - - \ArangoDBClient\ClientException + + array - $data + $collection - array + mixed - - addCommonPropertiesFromArray - \ArangoDBClient\Cursor::addCommonPropertiesFromArray() - - Create an array of common properties from the input array - - - array + + getChecksum + \ArangoDBClient\CollectionHandler::getChecksum() + + Calculate a checksum of the collection. + Will calculate a checksum of the meta-data (keys and optionally revision ids) +and optionally the document data in the collection. + + \ArangoDBClient\Exception - - void + + mixed + + + boolean + + + boolean + + + array - $data + $collection - array + mixed + + + $withRevisions + false + boolean + + + $withData + false + boolean - - addFigureFromArray - \ArangoDBClient\Cursor::addFigureFromArray() - - Create an array of figuresfrom the input array - - - array + + getRevision + \ArangoDBClient\CollectionHandler::getRevision() + + Returns the Collections revision ID + The revision id is a server-generated string that clients can use to check whether data in a collection has +changed since the last revision check. + + \ArangoDBClient\Exception - - void + + mixed + + + array - $data + $collection - array + mixed - - addEdgesFromArray - \ArangoDBClient\Cursor::addEdgesFromArray() - - Create an array of Edges from the input array + + rename + \ArangoDBClient\CollectionHandler::rename() + + Rename a collection - - array + + \ArangoDBClient\Exception - - void + + mixed - - \ArangoDBClient\ClientException + + string + + + boolean - $data + $collection - array + mixed + + + $name + + string - - addVerticesFromArray - \ArangoDBClient\Cursor::addVerticesFromArray() - - Create an array of Vertex from the input array - - - array + + load + \ArangoDBClient\CollectionHandler::load() + + Load a collection into the server's memory + This will load the given collection into the server's memory. + + \ArangoDBClient\Exception - - void + + mixed - - \ArangoDBClient\ClientException + + \ArangoDBClient\HttpResponse - $data + $collection - array + mixed - - sanitize - \ArangoDBClient\Cursor::sanitize() - - Sanitize the result set rows - This will remove the _id and _rev attributes from the results if the -"sanitize" option is set - - array + + unload + \ArangoDBClient\CollectionHandler::unload() + + Unload a collection from the server's memory + This will unload the given collection from the server's memory. + + \ArangoDBClient\Exception - - array + + mixed + + + \ArangoDBClient\HttpResponse - $rows + $collection - array + mixed - - fetchOutstanding - \ArangoDBClient\Cursor::fetchOutstanding() - - Fetch outstanding results from the server - - + + truncate + \ArangoDBClient\CollectionHandler::truncate() + + Truncate a collection + This will remove all documents from the collection but will leave the metadata and indexes intact. + \ArangoDBClient\Exception - - void + + mixed - - - - updateLength - \ArangoDBClient\Cursor::updateLength() - - Set the length of the (fetched) result set - - - void + + boolean + + $collection + + mixed + - - url - \ArangoDBClient\Cursor::url() - - Return the base URL for the cursor + + drop + \ArangoDBClient\CollectionHandler::drop() + + Drop a collection - - string + + \ArangoDBClient\Exception - - - - getStatValue - \ArangoDBClient\Cursor::getStatValue() - - Get a statistical figure value from the query result - - - string + + mixed - - integer + + array + + + boolean - $name + $collection - string + mixed + + + $options + array() + array - - getMetadata - \ArangoDBClient\Cursor::getMetadata() - - Get MetaData of the current cursor + + isValidCollectionId + \ArangoDBClient\CollectionHandler::isValidCollectionId() + + Checks if the collectionId given, is valid. Returns true if it is, or false if it is not. - - array + + + boolean + + $collectionId + + + - - getExtra - \ArangoDBClient\Cursor::getExtra() - - Return the extra data of the query (statistics etc.). Contents of the result array -depend on the type of query executed - - + + getAllCollections + \ArangoDBClient\CollectionHandler::getAllCollections() + + Get list of all available collections per default with the collection names as index. + Returns empty array if none are available. + array - - - - getWarnings - \ArangoDBClient\Cursor::getWarnings() - - Return the warnings issued during query execution - - + array - - - - getWritesExecuted - \ArangoDBClient\Cursor::getWritesExecuted() - - Return the number of writes executed by the query - - - integer + + \ArangoDBClient\Exception - - - - getWritesIgnored - \ArangoDBClient\Cursor::getWritesIgnored() - - Return the number of ignored write operations from the query - - - integer + + \ArangoDBClient\ClientException + + $options + array() + array + - - getScannedFull - \ArangoDBClient\Cursor::getScannedFull() - - Return the number of documents iterated over in full scans + + getCollectionId + \ArangoDBClient\CollectionHandler::getCollectionId() + + Gets the collectionId from the given collectionObject or string/integer - - integer + + mixed - - - - getScannedIndex - \ArangoDBClient\Cursor::getScannedIndex() - - Return the number of documents iterated over in index scans - - - integer + + mixed + + $collection + + mixed + - - getFiltered - \ArangoDBClient\Cursor::getFiltered() - - Return the number of documents filtered by the query + + getCollectionName + \ArangoDBClient\CollectionHandler::getCollectionName() + + Gets the collectionId from the given collectionObject or string/integer - - integer + + mixed - - - - getFetches - \ArangoDBClient\Cursor::getFetches() - - Return the number of HTTP calls that were made to build the cursor result - - - integer + + mixed + + $collection + + mixed + - - getId - \ArangoDBClient\Cursor::getId() - - Return the cursor id, if any - - - string + + importFromFile + \ArangoDBClient\CollectionHandler::importFromFile() + + Import documents from a file + This will throw on all errors except insertion errors + + \ArangoDBClient\Exception - - - - setDocumentClass - \ArangoDBClient\Cursor::setDocumentClass() - - Sets the document class to use - - - string + + mixed - - \ArangoDBClient\Cursor + + mixed + + + array + + + array - $class + $collection - string + + + + $importFileName + + mixed + + + $options + array() + array - - eJzdXG1z2zYS/u5fgXo8ldwqdtqPTp2rz5Ebd5zEZyu56zkaD0RCEs8UqeOLZPea/367eCFBECApW2ky1YfEEheLZxeL3cUC4E9/W86XOzuH3323Q74jJwmNZvGrv5PL15fECwMWZUckYWkeZiRlGfHyJI0ToETin5fUu6MzRkjR7pQ34Q9pns3jBJ6RX2lErjPGFjSK+CMvXj4kwWyekdPirx+f//DjgGRJAAyjlPyymLwewOMwnkVsQH5hCbR+gNaHOzsRXbAU+mZGty8KMS6TeBX4LCXU81iakiwm2ZxJQVISTwlAOvnHBflvzpIHAjBpFANFQtKMZmwhZEBOI2gmhCYLjhPoiBdHGQ0iQsOw4AlfsYsJmwVRFESzg58myUvJ5Hyqdc/1GCCmmEyCGWKbMBCcRumUJQnzkVUcMTKLB9gMGVQQBGmaM0J9P8iCOKIheT0aXQJzkCXNuKxTlnlz1TYBvQeIqIA6TeIFB5SyZMWSg07DmQaRh48IeX7wIx8HL6Sg2lMBLVgsQ663lHw8z1hCMzCT/+0gPR8T/EhtxlHEPIRO4sl/4C/5UNH8vKIJDLwikj8f8v+XSbCC8SF7tyWXF2YnElG8xKepjTtNEvrgYCybgS0ZbK/E6L2iGd2Qpw9N6vxGFYvYFKZoWee6O6cpWcQJ2wUz8gMPx4E8IwFYYJKzgTbsRFEqu7BBmMRx6EAAzd9A6zoEaayBD/0KiwX7fvv+4gJRyId+DJMTp9KcrhhOxsC3db8I7pnv6D/wrV0nYINkGad8cuBU0mcdN0z8vf87S+JnE5oyf9/WcRBljm4V63rnWZzBZAxZNMvm6GK0jvuAI8oXE9A6PPBjL+dTZcOuBet6x9Mc/JAX5yB4XPM0/WAWxQlOf3wQ56CCRZxm5OL8zfloQwDY0Sn2U8fA7sGDEbR00kcfGqRZ4KX7gCTLkwicWul0Sg+7mcnzLuo9l3rlftADpwxOcE4zsmZg3AvqM+5j8yD0OQBpgkJHLknRg4KJHpMf6j2u54zHCmCCJow8RRyRal/DxOJzTJO6DDaSyKMe+mdr7/yZLxyb2fkyYSCil4dA6tuMSkUiIeaAAJhiECYPmgPYbOw9+7hLaaBjEG0KGilmf4UPuGuwueHb0dVvt+evQK29wO914LYrvcwumYZ05mT5+uT6zburIfKVDbowlz8UmnOyvxpev78YIXfRpAvzckI42Q7/Nbo6Qa6ctgtTnDtumNejk9E18uNkXfihMWjeo5Ov0Ps9A69+e/ru/VuunMI9WLrmJi1jsgDgFOP05PQ1H0rexsXLV9LQDJLGCWCFcGOZmZ3mZH0y1gC9KhDZDDelEUSF3ztKeH3y9nx0/m8u5K1qauG6C0af7VZ4kv46gPHKEkazSk4L8lGS8jRMeNEBV0Et1tTRnF2c8OG7xd5sKESaNnpYsiqWAyfL0W+XXLiypY0vht88Cbsy/fvJ9fD91QXylS0tTM9RmTQMUqb7+nWQzYWxBwnwK3QW+SSNFxAkWEZ9S2K3pAldaMko2dOy12d6Kiuy+Dwt0hXVmI8F/0kkguJPTMkE0sIL4bM2X21jKhNWwdRrzH2zeRKvIUGvpvcfxX/De48t6xl3PgkDD5xEJOS8veVDkuRe1rfrZSDRcWmLLxKRsEKxLuDos3mQPnuppfMwvHtmcq9RaipESpFam9wg9SxpIvBKdRLh8BpJhAeXJDdjCw/hhwTBlIapSobxA7luH1ZqLOtzkDcpC6dHRyoCjvf3NS0Y2KVcZpMSwKfiL2d31yrLUgy4l3Z3K/Shena01hF0EpRHOHenQsM2cUVDTZ1GTzqDSkMeA8fypzI81THoOIrAhVg2Zv2iwvfTpjoS0aVhZISV2bQkm1qH5fBQi4yLPOWrMAyOrCCB5TtLMicwmVQBsrrpyywLUPVxibhvAaea2+eE9Ac3vVsVoU6xnNBz6gFavdIpm1hYFaLRB+lbtu6Ny1lriqf51OOiYZ1Mum5BZvEQ1Pf7fe4AbQoSWeW4rt18CbTsgq/2+vua/uTzhK1hbd+XDUFEMwgO75fgtIMsfCA+C1mmx0IjJoyAY7WuFIl11KvhxXA0VGUljG9BBCmjXjgidAI5ouKEv/PeQFcHRi8q8pgxhvwswh2vM0D4whoFr1VofXh3UbwOmT9jfqUPBW0gBpHw+t0aAn9j/BL66JtxCC2z9MCmCWLe5fYeZbSC8CTYq4FMwv4+OSC9wx78W/IfgLHsG84NP1IZqAXDqUCGiiW9fqFAssdMlFbPI1lqdm6xl1+YyCVFBaNcUxq1zY4G1FqYpNEDLi5glRL5sNiork5q5clNTQmWsGhJdlEabWPGMh4FGq1DBMpvjkXWYI6BxFAhtnqj9TyARL1v+FOH7+Nqe1dqrG/3cEbnqlykUVnGvF48kjnkZoWjbSj/TIXh2gAYkml1qBaLlsGzjIRq1euuvFY90tNqPZYij8XmOMY2mfWakENgfTsCl4NRpZz21U5YsUJ4VuDl2zOlKG3qOwnDmu7+hNmlCvCO8bjiMbpSiIMgwdKUytJLsUliN79VbFTQTMlVEuBYUBUV8GPyvAGkiDcCJK+cS7OGEdsQsBpFOzNlj2kae7YiryGcZNA2JwT/G1PmcReBQXnsXnN5T5Ne+j277LyrRnnv2EObrOW+g0O2E39FcYvu85lcBGuiGszvv++M8HTOvDttE8gDi5ig/+HAwYHmCfrajrC/Oj9myWHbBBWZa6kRkIhifbZ5HFY0DOozX09Sitn/07GRDgDAH0w/CEvFNRM7cfp+IG6iVJ1Dua2W2rKeat5qLH+/MZeOf/xBvnGn3AKTH0e9rI5sQCCW6woGvbH7OYVVrqq/VZEZy7zqMjliuLIobKS0oka7II3xw5zFXUfGPXew4MsqMbIGL4iWoBZbzK+UDUUZEguQXrwozwW0e4XHFRDlDlJhvbgo1oCYZgwznlFc6qh1vyyPiwLFPgaSPQBh2gs3sSC95Zz7ggIszKgXqRKAvgzH8vd4n3z7rbn6t1A1FJFArLOQZmcwGCclBnMZx3C+13lI9Daoeg3dDqAKQhVJ0kYkjWjwk66DTBsFBxxHY/x4FHj3cNneI0dOqir2IVC349Y/EzCWOzeJAAFzNmP33WF8APrA+xxIljSbd8dxCdSfAUQ6j0EfaXa5EZhrrdX2MfkBek+PjeLuiF4VbbaPBzzjIo7eMkgvJnGSdgd1Wm34uZBdJvESrZRtDK1suX1s02CWJxvM9zNOv00cPptSTLs721Bnb9kRxKe6m92xf/v0J4b6gpER82s7hM6lgCWKG+HOFsyNhdq4umXXTfbyYMv2pN9VTHfFww562FryYzG5hnRor7q5oW1QVX6vbxJUdF4lPjryuJqNwRuYCVCZjbaPEka2rY4QZ/gFhscIutsdGnGE45jcVHwCT1Aw4ejht+OX5GY8qBJgGiWeOgjSOE881isIuo34jWo3ro+90YEPoT+I+OHJ3iYd6O0ae9F2z8olgOBRqGfMs/9VrY7H1arTdbT6lcvkhdm78IjRaAEjiTgSzGsf371tQvNONpieKuf768xTez661emqr8pMS6ytxISo9p1n1Qy/qH18jZe2AQwZbZJ94OsVpFQ0N891Im1OVYj4Lk6/+L6PFYVxB/fDh3C73kWTo921yDxeeT/lOdTPJppHuKKyRYsLKnWFSmny1M1umj+1Mt7YuSGQum9bPd1RCcZb9FPS8wlzkjjxS0tyUvVlXTJCaRlf0o815HeWZWmTWxKTsvzUbK42+2ToLqdYfYo8dUqVtoncbUF6G1FJrGVJpFbLf4W45CwAbDeTDNk004IJfq0EEnGprnjOv/bMs1hGyVFtpyEz93m0CpVx7ulTZ/Y3AmHHbhR1rTun6ytsSro/9X2j7jqmkQVvUxGbTIJlUZf5Kr2au3jUZNd3xPwcCyy3d+whlTWDF830e3fV7McYsDvTKAxLQAI0AK828uKkrYfnAf2ecYozj7jlqodGPaiO4Qa4cWPxHmUDonCWfo0Db9bomoa7eizSrPW0q4HX/7dp/pjcfIEYYOxjdFZZUxLWUqHpoF25rNiiekV+8AUUXN+h2UzHQhVP1/K1uvZjXLpEIQ118OMK/O5OwhbxSjTB0/54CQWwrcpDatoUKE5gTsV1bsFrV22KFldngtR2lK0yjFzx2jDy7+LaimJXu4NrnO0p6HQBHaNU7Ntq3W9nSd6+pavuV7Vv62qU1ehQRhGuJ4wgELJ4bryiYc7PklUalOjUHrSkAwQSMf/hppZPuO+EqI+MRojkBmGMm5hYNnq3i/Rq+GELUDkXG1b7N8tBPOzDOTPP+GEO7bDPtk75tAfN+nkQw+wPD/kbJIIop2UPBJN2li7BQpk2EfTD5eCu20+W93rydLniWh7Qkpea9WUE9+3HZc/PXs5Y9msaR7Z7B5vd+jAa47GPpjsQ1ZVDy8lN7cSSEEqetIzx+mNWccXoXvH8FTdMEfd8EsVra0LHU8LqbbBPNTWY1zMcFngtuytfCIDf+hLvfvsJ5HZLqyJxhD3Z/zGR5cFKNHTD145K4m1Lgjcv1eFp60UABTvNkvJsnQt4Uj+z2821y0ugrvpro7NXbV0HwbApfzMLHounYTih3p3pdd4nIbgw4HJ7+v7q+t1V0/F6Soo3IdBQ5viEu9bSCemHye3hW+gTVrB0gVec+X/FkgEDuEDmGA3XhX79BDXe9vuAsPq8k/aBcd6N4+1bx6aledPp6+dN+n7DMoqvZzFP9Taaa/thZNDQG3k/uOWQbtNyR5tP2rsyJFJhBdqLMwh4iYP9A7x6nPG97+qLPXTQxGdLBk4uFsyzhyW3D8GS3TMvz5oTuzbhhwi37XiyfDlHq+xrmuC7iFJxZtcnfs6tW0dbBt1Hwf2n7KGDgxGG2FOYnLs6xNmgyVZvxh30UV6SWScBpv5qxNT9b66ZrpPbog3OdSiZtoxixRf01pWmPedpAKs0/PIQSMGZEKwaUXGlsur5nirYuejmEXLJlhuKpb1lhZ9KBwljvKUYROIiVQqphmsh3EGoa2geMR8vQm0kUlq2255A4obEdiQ6R16PEYk3fLRM0yAEqbY2mc4ku40EURg2FOIJLzN6jGRiadB68U6tIFoFKV4DNEC/y1/dZ8Vmyxbr8M5br8cFvgsUf6+RTKLU2Ssi3l0HmszN+8JJnMF6C0ymXpzomWUrxc7yHhLI/kUi6Td06cj0BGUT1kJ9p3pqY1df/eI8Z+haLtQqMp4owdj0rlQOSudUtzQMaNoXoI6O+G+wIv2o3uqo9Df5KEhwSvwfOg1d7Q== - - - - ArangoDB PHP client: single database - - - - - - - - Database - \ArangoDBClient\Database - - A class for managing ArangoDB Databases - This class provides functions to manage Databases through ArangoDB's Database API<br> - - - - - - ENTRY_DATABASE_NAME - \ArangoDBClient\Database::ENTRY_DATABASE_NAME - 'name' - - Databases index - - - - - ENTRY_DATABASE_USERS - \ArangoDBClient\Database::ENTRY_DATABASE_USERS - 'users' - - Users index - - - - - create - \ArangoDBClient\Database::create() - - creates a database - This creates a new database<br> - - \ArangoDBClient\Connection - - + + import + \ArangoDBClient\CollectionHandler::import() + + Import documents into a collection + This will throw on all errors except insertion errors + + string + array - - + array - + + + array + + \ArangoDBClient\Exception - + \ArangoDBClient\ClientException - $connection + $collection - \ArangoDBClient\Connection + - $name + $importData - string + string|array + + + $options + array() + array - - delete - \ArangoDBClient\Database::delete() - - Deletes a database - This will delete an existing database. - - \ArangoDBClient\Connection + + createHashIndex + \ArangoDBClient\CollectionHandler::createHashIndex() + + Create a hash index + + + mixed - - string + + array - - + + boolean + + + boolean + + + boolean + + + array - + \ArangoDBClient\Exception - - \ArangoDBClient\ClientException - - $connection + $collection - \ArangoDBClient\Connection + mixed - $name + $fields - string + array + + + $unique + null + boolean + + + $sparse + null + boolean + + + $inBackground + false + boolean - - listDatabases - \ArangoDBClient\Database::listDatabases() - - List databases - This will list the databases that exist on the server - - \ArangoDBClient\Connection + + createFulltextIndex + \ArangoDBClient\CollectionHandler::createFulltextIndex() + + Create a fulltext index + + + mixed - - + array - - \ArangoDBClient\Exception + + integer - - \ArangoDBClient\ClientException + + boolean + + + + array + + + \ArangoDBClient\Exception - $connection + $collection - \ArangoDBClient\Connection + mixed + + + $fields + + array + + + $minLength + null + integer + + + $inBackground + false + boolean - - databases - \ArangoDBClient\Database::databases() - - List databases - This will list the databases that exist on the server - - \ArangoDBClient\Connection + + createSkipListIndex + \ArangoDBClient\CollectionHandler::createSkipListIndex() + + Create a skip-list index + + + mixed - - + array - - \ArangoDBClient\Exception + + boolean - - \ArangoDBClient\ClientException + + boolean - - - $connection - - \ArangoDBClient\Connection - - - - listUserDatabases - \ArangoDBClient\Database::listUserDatabases() - - List user databases - Retrieves the list of all databases the current user can access without -specifying a different username or password. - - \ArangoDBClient\Connection + + boolean - - + + array - + \ArangoDBClient\Exception - - \ArangoDBClient\ClientException - - $connection + $collection - \ArangoDBClient\Connection + mixed - - - getInfo - \ArangoDBClient\Database::getInfo() - - Retrieves information about the current database - This will get information about the currently used database from the server - - \ArangoDBClient\Connection + + $fields + + array + + + $unique + null + boolean + + + $sparse + null + boolean + + + $inBackground + false + boolean + + + + createPersistentIndex + \ArangoDBClient\CollectionHandler::createPersistentIndex() + + Create a persistent index + + + mixed - - + array - - \ArangoDBClient\Exception + + boolean - - \ArangoDBClient\ClientException + + boolean + + + boolean + + + + array + + + \ArangoDBClient\Exception - $connection + $collection - \ArangoDBClient\Connection + mixed + + + $fields + + array + + + $unique + null + boolean + + + $sparse + null + boolean + + + $inBackground + false + boolean - - eJztmN1vGjkQwN/3r5iHSEC0gfbunvaatNvClVRtggLodGoi5PUOsFfvh2xvCDr1f+/Y+8FHyIWk6UPV7AusPR/2zM8zhlevs3nmOJ3DQwcOwZcsmaXdtzDoD4CLCBPtgYqSmUAImWYBU0hyRvRNxvgXNkOAWuudVbCTLNfzVNIc/EWTX+ATW6K0MzzNljKazTW8q7/99uLl7y5oGZG9RMH7OOi7NC3SWYIuvEcZs2RJ2h3HSViMilzjltc/V3ughTOlYEr+SY/NaPmrjXXLXahyG6N5pEqFTKbXUYikmSdcRymtRKeFCVzpgZ7LNJ/Na5MNVU+CPzh9FciTKkQioq3bZ651prxOJ0y5ajOrGQZtnsad/mg06FQGOlES4k17rmOxV5gpNRytg5ftP2yAiq1U9pz/HDNpI2Oew7V9WFflcMd+ctqyht7Z6OKfSdcf+W/9YW9y5n/qwTE0TOAbFOUte2OFcm9b42HvYmiM5UZrhzUukWlaG1ujzc5UAkW6aqkEF7VkEfgNaQqeZDGRlCRoMwoHfPX9iFKJsDZA2Q4QaG3hlgFFaBJE5jkwcShyWhqo/IPKkEfTiDNjzLX84Q2LMzo7jXhZBb6xvUYLyWP42DQjUecyASYlW8KBpENCGUDfvh5R3BCqsUKmXWsaoBcKLjf5uuzdcMzMVu4TLD62xQsMsjwQEacAUlB4fbDKDDZ3J8YtgtyyBgqAbeQzthQpC4mfz/WgeRSKqeftwhaOTwpb7v0KJZsnW8bNc3vEPBZieyqsm9X6j05mqM9tLNZ2WAwozzsfjE7Pzyb+eNS3TlvubvMZHeRF2AB4vPmBPxz+3W3dsn/l7H67Kk+kDXeNy/Gm9yxVujmWgnyNLz7WAXQ3pf5VaTLBhKchThaSZRnKZpXBVmvNT8lt7c5u7wNpN0nKCHx1bpWJLgq8v0wsIiEgtKLAEjqLkdLmGFc67edq8XNUiyKHD6wWuRRELnHaR0HweV6QRyKk953sfrZGrlr7HIByOcbD94L8kZCskVB3QiyM2Do95hbCdIE0GBZpjqrRtbljPSnTvzR3Juz1fekO/La5KzdYtJg6Xc11jZqGZxh+IhjCB4JwZ/mgqrCjBD20kuxix1xI7gToAqkt4bWlBQuI0ikw0yLXOCIAcikpNoUxTn2TcY7KsEe/6HJdmSva19I0OurC0XSKtZbtedTO7AUmleFT99lfGkOTOPOba9+69OiGaK+3jf06okH6KdrhitEooQtRbO9GwALiboPNe2995Or/TYilJWp1HZvKNH6unD8EWUrGKeVi37r5UE7LjP5YVAlW+8/KhImIqWaVIs+zoy40Lqt/r6qABZf1HZ6sfAOoGev2 - - - - ArangoDB PHP client: failover exception - - - - - - - \ArangoDBClient\Exception - FailoverException - \ArangoDBClient\FailoverException - - Failover-Exception - This exception type will be thrown internally when a failover happens - - - - - - $_leader - \ArangoDBClient\FailoverException::_leader - - - New leader endpoint + + createTtlIndex + \ArangoDBClient\CollectionHandler::createTtlIndex() + + Create a TTL index - - string + + mixed - - - - $enableLogging - \ArangoDBClient\Exception::enableLogging - false - - - - - - - __toString - \ArangoDBClient\FailoverException::__toString() - - Return a string representation of the exception - - - string + + array - - - - setLeader - \ArangoDBClient\FailoverException::setLeader() - - Set the new leader endpoint - - - string + + \ArangoDBClient\number - - void + + boolean + + + + array + + + \ArangoDBClient\Exception - $leader + $collection - + mixed + + + $fields + + array + + + $expireAfter + + \ArangoDBClient\number + + + $inBackground + false + boolean - - getLeader - \ArangoDBClient\FailoverException::getLeader() - - Return the new leader endpoint + + createGeoIndex + \ArangoDBClient\CollectionHandler::createGeoIndex() + + Create a geo index - - string + + mixed + + + array + + + boolean + + + boolean + + + + array + + + \ArangoDBClient\Exception + + $collection + + mixed + + + $fields + + array + + + $geoJson + null + boolean + + + $inBackground + false + boolean + - - __construct - \ArangoDBClient\Exception::__construct() - - Exception constructor. - - + + index + \ArangoDBClient\CollectionHandler::index() + + Creates an index on a collection on the server + This will create an index on the collection on the server and return its id + +This will throw if the index cannot be created + + \ArangoDBClient\Exception + + + mixed + + string - - integer + + array - - \Exception + + boolean + + + array + + + + array - $message - '' + $collection + + mixed + + + $type + string - $code - 0 - integer + $attributes + array() + array - $previous - null - \Exception + $unique + false + boolean + + + $indexOptions + array() + array - \ArangoDBClient\Exception - - - enableLogging - \ArangoDBClient\Exception::enableLogging() - - Turn on exception logging - - - \ArangoDBClient\Exception - - disableLogging - \ArangoDBClient\Exception::disableLogging() - - Turn off exception logging - - - \ArangoDBClient\Exception - - - eJyVk99v2jAQx9/zV9wDEhRBWduXie5XR7dWVTVVyx6RoiMciTVztmwDRRX/ex0nDZCm05oXR7773n2+d/KnrzrXUTTq9yPow5VBztT1d3i4fYBUCmI3hgUKqdZkgB5T0k4o9qlF9jeN6V/MCKAWToImBHHlcmV8DO6QIXZES2QOoVTprRFZ7mBS/51/OPs42APcLGe3Ax+WKmMawA0Zr9569SiKGJdkfW9qtL2sffyskIc/Gsh/cmH3PsBtNcFGSAkzApcbtWEQ7MgwSrmFTU4MuB9AjloT26b9FvNWcFrM5eL0IjCnEq2tsWoqj+KI5xb2nE9RMbLgo/j68Is2IAnnxQJ4rpUoWoTQS4YHMbgE64zgrLochVMbsUZH0EnKCpfhttnhN7mVKYyWFcCQNmS9FQyMauFHQ4fbP+5uSnklHrZXOcZazaRIYbHiNHRIEqfioOqdhIRyCMVXFU+Syf1VHCcJnEJ3DF1/dJzf5fBLRu4+eOudlO52rR5jcsEFv2+a3s5/qirQtRLzf3q1NW+nrNh0XPmqNgafoXO4u130xvbeh1m7e1vSjn8w7vZNHeO/QHvs8AQSlAJt79VDGI9DeADdqSfzj4rttHpWs+mr7K5f9TMcvmlo - - - - ArangoDB PHP client: batch - - - - - - - - Batch - \ArangoDBClient\Batch - - Provides batching functionality - <br> - - - - - $_batchResponse - \ArangoDBClient\Batch::_batchResponse - - - Batch Response Object - - - \ArangoDBClient\HttpResponse + + createIndex + \ArangoDBClient\CollectionHandler::createIndex() + + Creates an index on a collection on the server + This will create an index on the collection on the server and return its id + +This will throw if the index cannot be created + + \ArangoDBClient\Exception - - - - $_processed - \ArangoDBClient\Batch::_processed - false - - Flag that signals if this batch was processed or not. Processed => true ,or not processed => false - - - boolean + + mixed - - - - $_batchParts - \ArangoDBClient\Batch::_batchParts - array() - - The array of BatchPart objects - - + array + + array + + - - - $_nextBatchPartId - \ArangoDBClient\Batch::_nextBatchPartId - - - The next batch part id + + $collection + + mixed + + + $indexOptions + + array + + + + getIndex + \ArangoDBClient\CollectionHandler::getIndex() + + Get the information about an index in a collection - - integer + string - - - - $_batchPartCursorOptions - \ArangoDBClient\Batch::_batchPartCursorOptions - array() - - An array of BatchPartCursor options - - + + string + + array + + \ArangoDBClient\Exception + + + \ArangoDBClient\ClientException + - - - $_connection - \ArangoDBClient\Batch::_connection - - - The connection object - - - \ArangoDBClient\Connection + + $collection + + string + + + $indexId + + string + + + + getIndexes + \ArangoDBClient\CollectionHandler::getIndexes() + + Get indexes of a collection + This will throw if the collection cannot be fetched from the server + + \ArangoDBClient\Exception + + + mixed + + + array - - - $_sanitize - \ArangoDBClient\Batch::_sanitize - false - - The sanitize default value + + $collection + + mixed + + + + dropIndex + \ArangoDBClient\CollectionHandler::dropIndex() + + Drop an index - + + \ArangoDBClient\Exception + + + mixed + + + mixed + + boolean - - - $_nextId - \ArangoDBClient\Batch::_nextId - 0 - - The Batch NextId + + $collection + + mixed + + + $indexHandle + null + mixed + + + + getResponsibleShard + \ArangoDBClient\CollectionHandler::getResponsibleShard() + + Get the responsible shard for a document - - integer - string + + \ArangoDBClient\Exception - - - - $_documentClass - \ArangoDBClient\Batch::_documentClass - '\ArangoDBClient\Document' - - - - - string + + mixed - - - - __construct - \ArangoDBClient\Batch::__construct() - - Constructor for Batch instance. Batch instance by default starts capturing request after initiated. - To disable this, pass startCapture=>false inside the options array parameter - - \ArangoDBClient\Connection + + mixed - - array + + string + - $connection + $collection - \ArangoDBClient\Connection + mixed - $options - array() - array + $document + + mixed - - setConnection - \ArangoDBClient\Batch::setConnection() - - Sets the connection for he current batch. (mostly internal function) + + getShards + \ArangoDBClient\CollectionHandler::getShards() + + Get the shards of a collection - - \ArangoDBClient\Connection + + \ArangoDBClient\Exception - - \ArangoDBClient\Batch + + mixed + + + array + - $connection + $collection - \ArangoDBClient\Connection + mixed - - startCapture - \ArangoDBClient\Batch::startCapture() - - Start capturing requests. To stop capturing, use stopCapture() - see ArangoDBClient\Batch::stopCapture() - - \ArangoDBClient\Batch + + any + \ArangoDBClient\CollectionHandler::any() + + Get a random document from the collection. + This will throw if the document cannot be fetched from the server + + \ArangoDBClient\Exception - - - - stopCapture - \ArangoDBClient\Batch::stopCapture() - - Stop capturing requests. If the batch has not been processed yet, more requests can be appended by calling startCapture() again. - see Batch::startCapture() - - \ArangoDBClient\ClientException + + mixed - - \ArangoDBClient\Batch + + \ArangoDBClient\Document + + + $collection + + mixed + - - isActive - \ArangoDBClient\Batch::isActive() - - Returns true, if this batch is active in its associated connection. + + all + \ArangoDBClient\CollectionHandler::all() + + Returns all documents of a collection - - boolean - - - - - isCapturing - \ArangoDBClient\Batch::isCapturing() - - Returns true, if this batch is capturing requests. - - - boolean - - - - - activate - \ArangoDBClient\Batch::activate() - - Activates the batch. This sets the batch active in its associated connection and also starts capturing. - - - \ArangoDBClient\Batch - - - - - setActive - \ArangoDBClient\Batch::setActive() - - Sets the batch active in its associated connection. - - - \ArangoDBClient\Batch - - - - - setCapture - \ArangoDBClient\Batch::setCapture() - - Sets the batch's associated connection into capture mode. - - - boolean - - - \ArangoDBClient\Batch + + mixed + + + array + + + \ArangoDBClient\Cursor + + + \ArangoDBClient\Exception + + + \ArangoDBClient\ClientException - $state + $collection - boolean + mixed - - - getActive - \ArangoDBClient\Batch::getActive() - - Gets active batch in given connection. - - - \ArangoDBClient\Connection - - - \ArangoDBClient\Batch - - - - $connection - - \ArangoDBClient\Connection + $options + array() + array - - getConnectionCaptureMode - \ArangoDBClient\Batch::getConnectionCaptureMode() - - Returns true, if given connection is in batch-capture mode. - - - \ArangoDBClient\Connection + + getAllIds + \ArangoDBClient\CollectionHandler::getAllIds() + + Get the list of all documents' ids from a collection + This will throw if the list cannot be fetched from the server + + \ArangoDBClient\Exception - - boolean + + mixed + + + array - $connection + $collection - \ArangoDBClient\Connection + mixed - - setBatchRequest - \ArangoDBClient\Batch::setBatchRequest() - - Sets connection into Batch-Request mode. This is necessary to distinguish between normal and the batch request. - - - boolean + + byExample + \ArangoDBClient\CollectionHandler::byExample() + + Get document(s) by specifying an example + This will throw if the list cannot be fetched from the server + + \ArangoDBClient\Exception - - \ArangoDBClient\Batch + + mixed - - - - $state - - boolean - - - - nextBatchPartId - \ArangoDBClient\Batch::nextBatchPartId() - - Sets the id of the next batch-part. The id can later be used to retrieve the batch-part. - - + mixed - - \ArangoDBClient\Batch + + array + + + \ArangoDBClient\cursor - $batchPartId + $collection mixed - - - nextBatchPartCursorOptions - \ArangoDBClient\Batch::nextBatchPartCursorOptions() - - Set client side cursor options (for example: sanitize) for the next batch part. - - - mixed - - - \ArangoDBClient\Batch - - - $batchPartCursorOptions + $document mixed + + $options + array() + array + - - append - \ArangoDBClient\Batch::append() - - Append the request to the batch-part - - + + firstExample + \ArangoDBClient\CollectionHandler::firstExample() + + Get the first document matching a given example. + This will throw if the document cannot be fetched from the server + + \ArangoDBClient\Exception + + mixed - + mixed - - \ArangoDBClient\HttpResponse + + array - - \ArangoDBClient\ClientException + + \ArangoDBClient\Document + - $method + $collection mixed - $request + $document mixed + + $options + array() + array + - - splitWithContentIdKey - \ArangoDBClient\Batch::splitWithContentIdKey() - - Split batch request and use ContentId as array key - - + + fulltext + \ArangoDBClient\CollectionHandler::fulltext() + + Get document(s) by a fulltext query + This will find all documents from the collection that match the fulltext query specified in query. +In order to use the fulltext operator, a fulltext index must be defined for the collection and the specified attribute. + + \ArangoDBClient\Exception + + + mixed + + mixed - + mixed - + array - - \ArangoDBClient\ClientException + + + \ArangoDBClient\cursor - $pattern + $collection mixed - $string + $attribute + + mixed + + + $query mixed + + $options + array() + array + - - process - \ArangoDBClient\Batch::process() - - Processes this batch. This sends the captured requests to the server as one batch. - - - \ArangoDBClient\HttpResponse - \ArangoDBClient\Batch - - - \ArangoDBClient\ClientException - - + + updateByExample + \ArangoDBClient\CollectionHandler::updateByExample() + + Update document(s) matching a given example + This will update the document(s) on the server + +This will throw if the document cannot be updated + \ArangoDBClient\Exception - - - - countParts - \ArangoDBClient\Batch::countParts() - - Get the total count of the batch parts - - - integer + + mixed - - - - getPart - \ArangoDBClient\Batch::getPart() - - Get the batch part identified by the array key (0. - ..n) or its id (if it was set with nextBatchPartId($id) ) - + mixed - + mixed - - \ArangoDBClient\ClientException + + mixed + + + + boolean + - $partId + $collection mixed - - - getPartResponse - \ArangoDBClient\Batch::getPartResponse() - - Get the batch part identified by the array key (0. - ..n) or its id (if it was set with nextBatchPartId($id) ) - - mixed - - - mixed - - - \ArangoDBClient\ClientException - - - $partId + $example mixed - - - getProcessedPartResponse - \ArangoDBClient\Batch::getProcessedPartResponse() - - Get the batch part identified by the array key (0. - ..n) or its id (if it was set with nextBatchPartId($id) ) - - mixed - - - mixed - - - \ArangoDBClient\ClientException - - - $partId + $newValue mixed - - - getBatchParts - \ArangoDBClient\Batch::getBatchParts() - - Returns the array of batch-parts - - - array + + $options + array() + mixed + + + + replaceByExample + \ArangoDBClient\CollectionHandler::replaceByExample() + + Replace document(s) matching a given example + This will replace the document(s) on the server + +This will throw if the document cannot be replaced + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + mixed + + + + boolean + + + $collection + + mixed + + + $example + + mixed + + + $newValue + + mixed + + + $options + array() + mixed + - - getCursorOptions - \ArangoDBClient\Batch::getCursorOptions() - - Return an array of cursor options - - + + removeByExample + \ArangoDBClient\CollectionHandler::removeByExample() + + Remove document(s) by specifying an example + This will throw on any error + + \ArangoDBClient\Exception + + + mixed + + + mixed + + array - - - - getConnection - \ArangoDBClient\Batch::getConnection() - - Return this batch's connection - - - \ArangoDBClient\Connection + + integer + + + $collection + + mixed + + + $document + + mixed + + + $options + array() + array + - - setDocumentClass - \ArangoDBClient\Batch::setDocumentClass() - - Sets the document class to use - - - string + + removeByKeys + \ArangoDBClient\CollectionHandler::removeByKeys() + + Remove document(s) by specifying an array of keys + This will throw on any error + + \ArangoDBClient\Exception - - \ArangoDBClient\Batch + + mixed + + + array + + + array + + + array + - $class + $collection - string + mixed + + + $keys + + array + + + $options + array() + array - - eJztW21z2zYS/u5fgXqck5TqxelMZ27kyK3tOI2nTeyx3Wt7iUcDiZDEhiJ1BGVb1+a/3y7eCIAgLaW5T3eaycQigcXug30H9PK71WK1tzd4/nyPPCcnOU3n2atTcvXmikyTmKXFkExoMV3AWxzw/YpOP9I5MyPPxCDxiq6LRZYT8hpefSRv6Ybl4jmP0ykjhLzov5BUBnt7KV0yDrR8QkeGlas8u48jxuXycTons3U6LeIspUlcbBQ/Lyf5sc8aCTGnmdBsDPamCeWcnArh/tjDN2Jl/DyXj8k18JilnJHLye9sWqiXesz39zQnb4piZYYdjAWz+rsaOBD/r9aTJJ76Q0Bef+nXCZ2TYkELwuM5CMtJPIPvsUKCPFBOVnk2ZZyziADgaVb0ES71ZHRMinzNSFe+ssbCmxnQYyE5JlmWMJoCf2a8y34e39OC2e/JSJILyHC7YITmOd2QbCaxvKJ5QTIBIw+tL0crdHAwr1m+HADrv7+rWTxlj4XCa4Urx1Fo0Tgt2Jzlf/IiRwU7GOM0w+5FHQLeqAALJ2lA/LN1zmFPshUq8RcCQdK8lCSbAJlmacqE+ahdCK1/Vg46GJczapgoBxwFl+Q0jYv434xEbEbXSUHuabKuVT4gqCfUrGfolXoXWFVa7jvYoovt97xxqy9Q0w8DuAJcQGU9LWBXZ/BPLh3DQwrOpu99J5ONQQKeoAJP6apYCzZy9q814wWhs4IhjyAoMBD1jWQZiWJOJwkTrqALWg3OS5A5E0TY6FiAgsuB24RRTGuaUiuwA3C6BTplFxXxwtl7S1mEI7K8j/SaD3GSkGUGbCrRFf/gq0C/8ghkKDI1AzhZ9m3yhhECVJc0jShQ2fQ9fiTT4nOgBYGPbVn6cYn9VO8IPO+TGwagsyR7ECPU6KEn/svV8aXBiZGheZ7Exy2jcy3SI7foVUGsnC2ze0bGcUSAeTLO2T2hBajTZF1AvJrl2RLGcNznKJuulxCCODyATUrBaYrXJaB98krqBEfSYgv7LwewtsOHvdHIyg1+1ztilCheLlmEepNslCJNLA1EjRKw2AtipAisJ+bdKLlhfJyCYJTM4keQQOLP0RIR10WWRLg6alzpcXlfWGMctThulfcSmAY9SYHPCdMWyY0GVD+/LFgqQZO7iJoTCbairkV7yaYL2DC+lAq6BnOAdW5WyWtk/ETwjWAwGmmm0ixf0kTkO0KuJi4uUtB5MNIp5Yx3JT9iIbXboPuQZeSMYnBcsXyGtNHyYS06ydYF+fYZgv7i22ddYH/FUgEciCPZF5CiSoFFUG9XBqtj10XJdELnRGQ8NrrfDptyV4eXzIoWHUFMpj/C1GxNgxGoH0fWW+2C8WPcsHlt1Ea+PrReWSaMrwQr4yXL56yt33XJAULaO54zN661O52SEjjknIKQ5azzX2+vxxevx+e/Xtzc3lhDFTk7cBgJKqNK3keWICrG4AeysHZl7DE57Fjw2as6iUrKHsgHRxErtCzGP+353HGAxOxk29rVjsXhYEBgnAkyUyffAHeoYQC1hXc5+CUwQBEo0BKTbAqGkKWsXwGwPt2QD4bD83e317+Nb07eXdxe/PMcM802BvVOZQ/ufERdhRtJlavB1B7bdvBSqPkR+oahm3PTH+GzmEZAe+E2WnayEc4oh6zbWFZnl3Dpj5VeXxUZ8mHYfOv31zdQhacl0MjmwIJXLS5mHNUiJCJJJRFB951BfpGtyndd4VDxmdkCT17O/HrugxB9OGyaFUKpGSxHDcIAgYsQOVy7szsittAWIBd2GFtAFYbV1YRBZCpLog0ruhAkQJVNRoShDqIcXaG/hyGQBoKhJUjbFYTQOY3TfgBTA2JFbgvFYpFnD5xI3M8fp2xlaeQuqljZqhJc8DDTBZt+9ErSWBqZwJwJF9Lvi0BmYAT05hBqWRdnPrBWzgR65ft+6XUsRxvzE0ETwPnb34h5eKanQWSo8RTMACWClK0FYU1Q2qD/FGgKt+0B2m6d0RR5d40DEoFi4eR1pxoaHCyhASlbnVrFuxY8ceEAu1WEFbqYZIBWQRaeTUWNYPk2X3f0pqMrbtzzEmffmuSqUpaRFaDV+Ko7CtmbQ2Q0esIAn8AhYJqfL7alSZ7ktobIlMSIqDTrbRbVAFAj2InySbz0I5glg0xcxykp5RZbLcwLNDur1JJ1aEj4Bb+NoJSeM+xZudn8aqplmZ0I4zv73p1x+KvSWtI8GWkt2QV5ufl/UchW3QZDJpKpXWUQUiJWEVVmIqZzB4pQVNoru8OhN1DS2xIVNUnBImfuissPiIvacl24kjl8S5v2+zPSsadhsBxcQypmYzB3NWNn4StOzxccXV+sKsXeFmqxEyJPesp6/1ePj5bbhinmF6lAyKZR7zGFqfg2Ieb3rlXHTEAgvSjGWoaJGM03WGdHMS/AIa5jvoAMrHjAVE3V++g9Sz+jAslfMbCATqkmom1bp7L3L1bbzcBCM6uVrt2bl6X7Z7qmuGyQmE56D1s3uq0j0tqEiiYTw8Igkq2xIo/ZPSuxlZPCwC5FO+nAVJfVhu3WSavXkm/bROsQ9uaYut909XeFTp2YEdGAdatv0saykz3S5SphQ9Ma74hqtKgeWGyJmFOPfxnw3M5LzVJ1kNY2Cmro7AryiSiiBGC6Y45NTEfZGpFbsmKRRQS7uTBJfVOarim2fzi/7ZKry5tbyNc7YTp6rKRjeMFmuegIgr8sKz6bxZpNso8R/SGqsPvgVdbhQq8mpxOstJX4XcO/v4+rnM3HSxHBWs8GY7qKBzxGlR20v7t6Kf88/vDwvPOnfIlPozgHPyWePosfWyVx8dfcyY+wtPsqBgcFPgzfvW/J2a27aiHnvgcdarX8jo9Uvc1K9Oy88V+NcAb5rvJiqJ9IcVqVjpTSCixUWqAKLVl6ilVGlXWq9adkpwUa0CJ9+T1YYeJa6Rp0xVREVZ/kU8c5MR/TdsXgeNfrLw6H4qimgqtgEpd5t16yHJTEXRwdX2W48/7rr90RnwjDc6cnV5lm67QIMN7xyLlwTlwHbZG0QA1x4My0PrVYH3n7WBckcM/CrVqWwWYKU37DkhXDtujlT5Z2HahzAtCON7e3V4MX/Rfkm8NvoC5EG2aR0BcgclSZ0Ycp2J9FYx6SwTiaDMZ8wwu2lHaoz5kGh4PDZiqQVhQwsIdqOUS/AH5CkB38zrP0iEwXNAfzHK2LWe/vzaRYQedDsn+4/+SKKpEZkrMk40wPb5z1xz7L8yzfH4r2TXd/HEf7w30Qb7+7L/+EP/DobX942N1fUP42y9n+8EWX7Esq+8P3f3y6g6/mDE4++VRZ3llfXuRQHXvbK7cVd3bWZVRMjTeKItW86yhhV/oCzz9K4l3y3tG+1tSOki2CDfXmGNt154+11GfoBFr2fOdNOe3O9tNVK31vi3LnRPQQgmXOKuEwg0OFUW4uwyiLquRWoKWFm6uLDB770WdSocE0qT7p/sg2jUnAihbY5A+/lPcCasK0OkGT//XIiT6JLrOPShb2BaI3R/F/iYuFkfVHtmlrMbqa52rvTh+hy3sh5jl7XCVZJIoE9WeAWDkeUlRGAfl2ORGgPgCUhVqJWx2B6N1kSnKO53GnZidHtiJBIH3DaMTydkvJ37uIWn5D10RTjPslqWD0E7i8LwcJdRYsbRvZFAWAoHZuKEKYfihOr9V2fZWLO+1k1SdMI3WgJevnqDxnUFkmZ/k9FGWwQ1mqm4xbJJ1/yg5RT7etZ/pQQ5xQ2ycfeP+Mr6f4brZOiKpfnHtw8oYRtivwqFwcf5MZjRNguE9O7NlqEfL7Gkt5qLK5vnFC1U2BB5az8oClT86pvtOFRzBxgfcLHlJi9A1yt/V8IdwDhz+TCOtTcWiBt+VkJxEmVDB54vikxoy3M2DFfqXF6Jx0bHGoYZ/MhHNh3YV12gWqFWtG4fUC9bebVZdumjvNfuPIedvP5lVWZ6VzIp+tnIo3n6d8aJl7ioQtV8VGKW6r5lB8mi0nePnjFUginQNK0uthbLfzr7cXb8/Hp5c/v3t1cv2b907kZk0UMQ3RHue2ki499qhQhZ7gFBXSX9xN/sDA5QW0Axz7D/QY1s1IpTj4Kd2ttRvocM28UFVQ+j5nWNV1ic3vj0ISVzP/GsrSRZuvQkcuoqreVha1PPiQIF5tFW1c4i6ON+dXJ9cnt5fXVf5qPbSzau2uB1SrMjnAoZBXG1enSa0k8cAyJSJPK21giAVJSVKkMdyTwwv96zypAjUiP+eJJi1bBVeCFjxuwz8+HP58/dP49OT27E1XrxPoPjo3m61Cy25lrjLsXwIbXYmB70+CtGQSAPKfiXax0MZvDis+xj2y8y9ah3ZhkkUbA0L90qcwzDntcuaBfizb4lF32+0MFhGWzw1nfLs7uK5k1Qa50b38qHK6Wldj5XWBTyjVK0l56Z6FYYiSmwH6O/B5vCgsXDY0CnoYlDoKijubjWB7ADiT9Y2a0RHB11qwgXg4tG17UiaSriIraCIbK4FLljVZn7puiQFgnepuaThvESNU3PdSF0XsiaZOA+/O5XxQ8XgWy8sxhfntAFYY7cN+v592MM3EzC2OSBvcBFSDIg1lhbx3UWn/x5D519zcMkWg6OdUWIEMEyji5WRMLVPVvkJWgAWqjuXw5yt1WbXfo98p0aw9fSvVrHqgYXdVA4W7nFTtsDakZPpwzUImypi8ysIeY17UZWYhF+yy8T+vGKvgSdcXaBMoLXFdb1VbKhdbHNVSuY0i8X8z/q/ulq5qv9C2GXpb7J+5b2D/UquhjeU2wGp/oVQV0q4dG0WyaD7BNV7qNzxPG39V5bDdI/5PR1zm/QP76j30LQXwzjibhSmbPC37rkONJGf+gC3uazzFt317WPHqsSoKV/WLqVeqf6x+ClRk2Ib1gMwKoIfm43absUj3bUaTa1V/zmVuI0QNS3puQf+sS45s4nW329mvbDnaknzdKbgvsxx9FIRfIw6Yi1FjmsSUt9WNX/EIqooPIBWds5Rr9CbyYjVG4f8AD3aCrQ== - - - - ArangoDB PHP client: connection - - - - - - - - - TraceRequest - \ArangoDBClient\TraceRequest - - Class TraceRequest - - - - - - - $_headers - \ArangoDBClient\TraceRequest::_headers - array() - - Stores each header as an array (key => value) element - - + + lookupByKeys + \ArangoDBClient\CollectionHandler::lookupByKeys() + + Bulk lookup documents by specifying an array of keys + This will throw on any error + + \ArangoDBClient\Exception + + + mixed + + array - - - - $_method - \ArangoDBClient\TraceRequest::_method - - - Stores the http method - - - string + + array - - - - $_requestUrl - \ArangoDBClient\TraceRequest::_requestUrl - - - Stores the request url - - - string + + array + - - - $_body - \ArangoDBClient\TraceRequest::_body - - - Store the string of the body - - - string + + $collection + + mixed + + + $keys + + array + + + $options + array() + array + + + + range + \ArangoDBClient\CollectionHandler::range() + + Get document(s) by specifying range + This will throw if the list cannot be fetched from the server + + \ArangoDBClient\Exception - - - - $_type - \ArangoDBClient\TraceRequest::_type - 'request' - - The http message type - - + + mixed + + string - - - - __construct - \ArangoDBClient\TraceRequest::__construct() - - Set up the request trace - - - array + + mixed - - string + + mixed - - string + + array - - string + + + \ArangoDBClient\Cursor - $headers + $collection - array + mixed - $method + $attribute string - $requestUrl + $left - string + mixed - $body + $right - string + mixed + + + $options + array() + array - - getHeaders - \ArangoDBClient\TraceRequest::getHeaders() - - Get an array of the request headers - - + + near + \ArangoDBClient\CollectionHandler::near() + + Get document(s) by specifying near + This will throw if the list cannot be fetched from the server + + \ArangoDBClient\Exception + + + mixed + + + double + + + double + + array + + + \ArangoDBClient\Cursor + + + $collection + + mixed + + + $latitude + + double + + + $longitude + + double + + + $options + array() + array + - - getMethod - \ArangoDBClient\TraceRequest::getMethod() - - Get the request method - - - string + + within + \ArangoDBClient\CollectionHandler::within() + + Get document(s) by specifying within + This will throw if the list cannot be fetched from the server + + \ArangoDBClient\Exception + + + mixed + + + double + + + double + + + integer + + + array + + + + \ArangoDBClient\Cursor + + $collection + + mixed + + + $latitude + + double + + + $longitude + + double + + + $radius + + integer + + + $options + array() + array + - - getRequestUrl - \ArangoDBClient\TraceRequest::getRequestUrl() - - Get the request url + + lazyCreateCollection + \ArangoDBClient\CollectionHandler::lazyCreateCollection() + + - - string - + + + + $collection + + + + + $options + + + - - getBody - \ArangoDBClient\TraceRequest::getBody() - - Get the body of the request + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler - - string + + \ArangoDBClient\Connection + + $connection + + \ArangoDBClient\Connection + + \ArangoDBClient\Handler - - getType - \ArangoDBClient\TraceRequest::getType() - - Get the http message type + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object - - string + + \ArangoDBClient\Connection + \ArangoDBClient\Handler - - eJylVk1vm0AQvfMr5mDJHyJ1k97skqZxVVuVKkWpe6ora40nBgUWurtYsqr+987uAsaATa1y8cfMm/fmzbDw/kMapM54NHJgBB8F47vk0yM8LZ7Aj0LkagJ+wjn6Kkw4peish5T5r2yHACVgZnJNkGUqSATF4Avj8E0hxozzWugz4fxQwizIqIAJ+kl6EOEuUDArv929vb1zQYmQ2LiEebxZuBSOkh1HF+YoqPSB0GPH4SxGScKwpmnqFM3NIiYlLAXlPOOvDKUq+rmo62KzMuS+DgHcvnlnhPhNlt+OTjAq9DUiUxKBEpD5AQTItiiASSC3mBDsAINXPIB3D3sWZTgEjDA2fAZc1HjYM2Hz83/G5jMV4Z4phN7aFpbgwY+fZEK7BBUgBEqlECNZsG3jkGS/tqKVxMIulhfWBchEdHX5HPtdRGcoDIMtAcmL+bVJtoeriTSoSbE8uiOl3gF1SPHq2hpEU+jnzfRbWkGyJz1xS+kFqlOlTLA4XxLoFQOm68ZgbYBsMJrzcA2ce9Wzg4MjuCA+WYQ66jiPGuo43DpEOwtQITpOy8isjCs3LttEoQ8vGTdnDqzXdAARKPPVoOjZLRpwq5pcyzY0ZexNp6+eCkJ5c7+u+OWV7k0baRVnvIKmmVVxwqtqaGZWDPCsQJvzp7EGc1qD8hDIt7kw+HSapdcCVSZ42zlQc3GHamFLDOr+5DVqNl0SeXZf6rra7oumsK+mRJeu6iS6ZbWcNldpei4n2qWrPvvz2swmnM71vzQ+Ur0udV37pv7liLtK1ZIKdKnSJIUq0mWemWsWhUwOqk/OycREXOivineAVf4Q3qyqif3h1PkLRzV67g== - - - - ArangoDB PHP client: connect exception - - - - - - - \ArangoDBClient\Exception - ConnectException - \ArangoDBClient\ConnectException - - Connect-Exception - This exception type will be thrown by the client when there is an error -during connecting to the server.<br> -<br> - - - - - - $enableLogging - \ArangoDBClient\Exception::enableLogging - false - - + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + mixed + + + \ArangoDBClient\ClientException + - - - __toString - \ArangoDBClient\ConnectException::__toString() - - Return a string representation of the exception - - + + $optionName + + + + \ArangoDBClient\Handler + + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + string + + \ArangoDBClient\ClientException + + + $body + + array + + \ArangoDBClient\Handler - - __construct - \ArangoDBClient\Exception::__construct() - - Exception constructor. - - - string + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array - - integer + + array - - \Exception + + array + + + array - $message - '' - string + $options + + array - $code - 0 - integer + $body + + array - $previous - null - \Exception + $includeArray + array() + array - \ArangoDBClient\Exception - - - enableLogging - \ArangoDBClient\Exception::enableLogging() - - Turn on exception logging - - - \ArangoDBClient\Exception + \ArangoDBClient\Handler - - disableLogging - \ArangoDBClient\Exception::disableLogging() - - Turn off exception logging + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name - - \ArangoDBClient\Exception - - - eJyFkk1rAjEQhu/7K+ZQ8AO/6lHFam1RSgul9igs2Tjuhq6TZZKtleJ/bxJXLVJoLpNl5nln3smO7oqsiKJusxlBE6YsKNUP9/C6eAWZKyQ7AKmJUFrAL4mFVZpcpS+eFEJ+iBQBztwsICEpSptpdjl4EgRLi7gVRCEldbFnlWYWZudbv3fbb4Fl5QTJwHybLFouneuUsAVzZEfvHd2NIhJbNK43XrUdnm3MjhO3H68mfs+UudgAuy8QdirPIUGwGesdQbJ3N6y8wy5D8t+M4EjnA5k1e6l1yYrS02781epAGuRP5M4o4bGvq+L/+zKKpE8B9Dr9YFTmwpiTl7MVN79FWhu4mPuOPBa8+9OEN7QlEwgwNkzJWDAa10kEBb0Jk/56z4Cd6Akf8Qpu/61SVXdDLMokVxI2JcnQIY6tXgaq3ggFxxH9qcTjePY8XS7jGDpQG0DNhRvrnqc9TtG+oDFuUfXGMGCH6BAdtxGLXAlTv97JYBCyLaitTn/QqlpxsrourjnVH36V7/s= - - - - ArangoDB PHP client: value validator - - - - - - - - ValueValidator - \ArangoDBClient\ValueValidator - - A simple validator for values to be stored in the database - - - - - - validate - \ArangoDBClient\ValueValidator::validate() - - Validate the value of a variable - Allowed value types are string, integer, double and boolean. Arrays are also allowed if they contain only one of the former types. - + \ArangoDBClient\ClientException - + mixed - - void + + string @@ -9223,320 +9594,508 @@ during connecting to the server.<br> mixed + \ArangoDBClient\Handler - - eJyFVE1v2zAMvftX8FAgWeAlXY/JgqXrhnY7FRiQU4CAtmlbqCwZktw0WPvfR8kfSYwAExDbEJ/4Hh+pfP1Wl3UULWazCGZwb1AV+sd3eH56hlQKUm4Jrygb8k+RodOGcR66qTF9wYIAhlMP4UAIYuNKbTgGv1HBH0dUoVIhlOr6aERROngYvu5uv9zF4IzghMrCY5U8xRyWulAUwyMZPn3k04soUliRZW4a0a5ORYAVVS3PJEPOv1CGBachIbC8SxkIBa4kYBAmaGlc2pXCrFCpr/l2fhf0pBKtha3PvR0c+hv5yoMcv2bQhSiwtX7qHJA/ueREUofr4fdS6gPLa5HuWLNuNF61EaqIWbajgkwMmW74NKDKINFaEqo5izZ4bPEoreZHm0zknv0IqVYOuXCt5JEfQYmXxR5VZFq2+UjQxpVGHyy0Rvx8S6l2QqsxqkaDFVTijeluWvGf+yJ0345xsRtDrjEKXrXIGH4QUkKg84p5eIQKB8/MAGGhZtsp63IswrtmL0TKJqHjV96o1GscaKetok8B23bILyaZCrtvre0x8P7OJHv2ebSTS43jPe/8+ZZquIL1eg393oksjMViKKJrzUW4dWM17H1EY6noG9wTXsleNdZBWlL64gmAJFXcNNs3fsTHbSdMS+gSAlq4sU2yvSbdL0syXy5Ppg7Y1QX0TPZ/qjrzo2v1EGrHQNFhPHjTya9uKhLBsx/mjhx1l3zSafmImCZc0D1j0U4vr+lyGWIxTHb9P8+uu/HJ7hLqM/4Dz/eQjg== - - - - ArangoDB PHP client: autoloader - - - - - - - - Autoloader - \ArangoDBClient\Autoloader - - Handles automatic loading of missing class files. - The autoloader can be nested with other autoloaders. It will only -process classes from its own namespace and ignore all others.<br> -<br> - - - - - EXTENSION - \ArangoDBClient\Autoloader::EXTENSION - '.php' - - Class file extension - - - - - $libDir - \ArangoDBClient\Autoloader::libDir - - - Directory with library files - - - string - - - - - init - \ArangoDBClient\Autoloader::init() - - Initialise the autoloader + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation - - \ArangoDBClient\Exception + + array - - void + + mixed + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler - - load - \ArangoDBClient\Autoloader::load() - - Handle loading of an unknown class - This will only handle class from its own namespace and ignore all others. - -This allows multiple autoloaders to be used in a nested fashion. - + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + string - - void + + \ArangoDBClient\DocumentClassable - $className + $class string + \ArangoDBClient\DocumentClassable - - checkEnvironment - \ArangoDBClient\Autoloader::checkEnvironment() - - Check the runtime environment - This will check whether the runtime environment is compatible with the -Arango PHP client. - - \ArangoDBClient\ClientException + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string - - void + + \ArangoDBClient\DocumentClassable + + $class + + string + + \ArangoDBClient\DocumentClassable - eJyVVttu2zgQffdXTIGglgOvnAZIH9x4N15HaFygaZAERRcIIFAyLXFDkVqSshO0/fcOKcmi5QaL6MGiNbczM2dGOv+rzMvBYHJ8PIBjmCsiMnn5N9xc3UDKGRVmCqQykkuyogpVrNZFSdJHklGAncHC6TohqudSoQw+EQF3htKCCOFEqSyfFctyA4vd6fTk3ekYjGLoUGj4WCRXYxRzmQk6ho9UofUzWk8GA0EKqjE27YX9sMN/RcSKU+0gF8SwFCxwJjKQayiY1vaYcqI1rBkqhk1G9zn10oQUgScUBNWGrmDLTA7S5CjodHQIS4MizkEKbgFCqWRK0bPzjyDWShbAjAa5FdBhR4jAMiEVHq21dazD80T9aZ009/8vM6aSWhHASXjq6lPnNe+69X1gxa409jqGS6ZoaqR6rnPiLFEE/7hSNDqt6sWGKNDYFpE1jybuXiq2IYaiyJX3CH2gV+xAL9RiV2SgTwY7y6TYc5RKoQ1E3+6j67vll2uYwTBEKg4PXS0FM4xwpimYvT71IZtcya2G6CmlpeniwYWiplICNpKt9pOpEo5JNLmsK5FaM2AYMBg5jbqE9tKUr6fTNKfpYyQ2TElRYCuCUYO3U2lKggnF8eXyNo4hBLxHi/svt//Ed9HN/HaOR9+u5HGbVaxoxpB2Kojj6/nn6O5mvoicj+FD19rp1N6HGNza/zwoWT0HPvmR0ZV4FJaKjie92t3nTHdshry2byblNTz+nV8U274UFTes5H4HNRhpJ63SOGdMAGlnbk10jq3ou8ORUKRoeAlHDt81IoI/HDCbaI25duuCrPo+XskG6yToQvV5cdRVxHa837OH4YdOlVOR4dzhNbM54N+gM/eZNJm0J7aGQFcJansYxnAybr2N4M1s5qEYedis8YmTo30p9Z4Lz8S3sVddoQ74zz1k9XhgO3F+c7KhWGmKrMIuY+MSukZG7NTtJlQm2J8MC0hUnPsZK/pfhdupN0Mh/Cb3XeJho71bIi+Nw8JOrVseqhKGIVFoN8IvToKbddjm1K3+F6wBtVNZlMiZBKnt9iqqtt7qxe29Tg8Y3SyterO/YnXt7+EdWw8XVI+vuEdNcFSQf6XCUhYMB3iEdKRPJZcrGgzD4djCjb9Gt7akfo8snQImzAhqeziHM/jxo/dwht09g7dvoX1qQ6Dq+wOaudRx4rf97IPhUnhFtdXzSh7ihi/xPWZXgBWdhe8BI+T4OUFVuxNrItS/SAhHnxhfIkQH/hp1z8c4p+0HyEPzqk28bWt9/gJGybR/ + + Name of argument $collection does not match with the DocBlock's name $collectionId in importFromFile() + Parameter $collectionId could not be found in importFromFile() + No summary for method lazyCreateCollection() + + eJztXW1z2ziS/p5fgUm5TvKWbM/L3n3IjLOr2EqsiWJ7JXlmchmXixZhm2uK1JKUHe/O/PfrbgAkAL6IlOWX5KSamiQk0WgAjcbTjUbjp7/NrmYvXuz85S8v2F9YN3KCy3D/DTs+OGYT3+NB8opNQt/nk8QLA3blBK7PI/gUv/77zJlcO5ecsbTgHpWhl848uQojeMd+dgI2SjifOkFArybh7C7yLq8Stpf+7ftvv/u+w5LIA4JBzN5Nzw868NoPLwPeYe94BKXvoPTOixeBM+Ux1M2tan9M23EchTeey2MGhYDeFF6y8EJrSSybML7iBe1jFzyZXEFx7ZXrJA67iMIpS6BMzKMb+A4+RyqTiDuJ8XnMoEj24XatHou9YIKvGPt2+3tq6sR34hh7QZI9kPzxzwkP3JjJf7/4z4sXWIxaj7+/MDeczLHZMXOiyLljXuDyz/LlDv05AS4T1jscDz+e7R/tnXyAv47YLmulRVs/5shqHTJzIhiHBKUhR/XoeNw/OjzbOxoMenv4V6SblS0gzD8705nP61Dt/db9cDzoIUlZ6n70Dnu/nv3SHZwQxYDf/uL483uS3Bv2uuOe3X6Skr2qXnASmADn86RWJd3xeNh/czImvtOSBVSv+V1ch+D73kcSAPy+gEycQAOmdQiNxtD+D0hKlCkg5vOLpA6pQe/tGAnh9wVkhO6oQWfYf3dAhKhEkWT7YczdWoM7OBr19mlEqUxR65zES+ZurWEcdMf98ck+jaIqV0QyDC7r0zw6fJcRVSULqLpenDiodWoQ3e+Pxt3DPaKpyhUNieN681ryNuzu909I4kSZIpm79ma1JO59/5jkDb4vIEParw6d/uF+7zckRCWKhsGbevUEt/+hLyQXSxRQuvC478blBN72e4N96h3xZQGJeeD9a87LSZwc9v8h1Jr4soBEcjerIDD+eEzF8aui0fH+zVk4Q2VWMTT9/yUa+HEBjUseyuFZROhd7ygbHyhWTOznGNamGqR+HgmtLIsUELty4quarB10RwcZb1iwaMDnvp/Ayl2T5tuTwWDc+22c0VUECmhPvWDAg8vkaiHZD31UqofvxgdIMi1XMvd8mOc1+cUpOAAVkfGrCBTQnvEohjeIy+pRP+4NR0AcMEpGPyMCNWCJnHAnfk3y4/EgowvFSgjyzzMv4t0LmPkLSfZ+O+4Pe2fdt+PeUGCVtGwJdS94A/DwMgrngbuQPAzjm+7e+3fDo5PDfaGxstJFowk6K+Z1x/K4OxyJWUvFCpHgHEH1AkJ7wN1YgL95UCQIoJWiu4VkQIsNPyIZ+ryImys+uY7n08UMHfT23o9OCJyoQkWLGL/xYq+GJhn2fumPJMBThUqGNwKjBYp654Ah4ysnWjzGw97o+Ohw1H8z6J2NDrrDfVFLSmaEVEpqoxrixSONZGmVEQWK5moUwkxLPL6Y2vHwCCbquN8jilnBwuXvch7VIPm2/+5k2JPrIBUpBEfO4t4cHHX3BR5yiibInjTiHAY2gG7oGJac/FoVGl95Mbv1fJ85rkuflRVEWxFEIJlHAfPALPPcjAZMS5d5aK16gX8nvwIwegH28zlM6lsaykk4nQE+PPd8L7nrMAD77C6cw0CHc99lc5jcVv1oJxMNsJyB6AWPOEK9JLQ+3C5uUXIVhbfMu7DJTsCMDxN2zqXd61p98ncqGLPe5wnXhyR9T+gJlqzP0MQNjfCW0Xnn/4S/IbNZRVaPYsvQKvGCS+AY1j58h422ahIW8IaQjxhfbUGXyMfhhRSceFsVK/39NHt9JIk4EWevfjqPXi8u5HuvBYDKvdpi37Ot1ywIo6nja43vsB/wOXcv+Vb29KcdoFSvulvHS96G0egumGi1buFgxpw6NYnmvIMdBv0AYx3xaXgDPOCEdUQLSQa8AHF+AkIJoxADORjawENDCWiAEXDNdlgfJQSEBv5DuYhnfOIBZHUleVN6WjFz+YUz9xMiB2SvnBsPRpKqg0qcGWAG7m43aO0/Q5gujj9CgKm3VnvObtCob0LUi0d3gC2m5qhtsQvHj/nWa5hukdastmzUZod6dut1TIV1gW5W+S8h2oK+ITRp5Rp6qmDhRpJgbS/YmsIAR3ebyzJ0ze+k5JsMwXM1fVAioFeaUEUrUngtaCWLB941NHhLKC6YmLCAJCFOHZ1tVGieC233JiCwtGqBAmhSbTCfnvPo6EJUqhoE1dJzrFgunliVpSobVBNxkOQJzaa3ziQJo5ZdjfyCuu6a8xlTY/iKfbfZpCqA8cN8bVtoFnhTQEXFVeKUnk8mPI7BsmC3OFlvIy9BdbosI9Rx79F/pL/aynStAD4oNqnHKm5cAXA4SkBP8cu7lqxAPcf1gF5IcQQNxib+HCZL1KiaqRMlP4de0E39aqIdqYMuXVzpU9A1oCphpl0IHahaWbvzdmbqo3TxkmBBrJNbCBEMF7a1+grAM5ufw/CCqRno37Q39LXFWg532afTTSr8nxeKHWhG24vPxNqql97c1L7C3wb1g/jt6qv5j+ZnGt+7BLAyP2h7s/Rb0KM8OYQa2lSP9SH0PncmV6ydtgXkegNla/c12yCNb7Obo/+fFtTQYttsPrnwojhpY/nNP9uyuFnhny/yf8OuMihe8uTXbPltb7LdXWgxmO65rrPaqZfawBWVaO2FQSA+Egq4bT+IX72SAPfXbn98Nvp4uLep8f3ni0pWf87WyAas6qWWYvXno5PhYXdAzqEG3PblotyA1bTIUnz2R9Cho3HvQyMm1eLdiM200LKM/nKEruRBWX9u0EJqzVKqZgwvgNW/vdIm5atX8GJfLALifUZ0g2A1aQ6jTXppsa902P3QS1/jpLRqpqm92VlAhbyQOhVsyaJC6WQoqdqYo4uI6eJaRMyYRYuIpTJVwlkm5DUoqUEvoZRJ4iJa73sfz4QsjQppvU8RoE7r9MdMwHZ2yLjgn2EFVmuutspXzpn9AiQIIvlN2ewREvgp3wzcpBC7YtK1cTbov++dFkh9cZW1Z/mhASKX4vXw5MOb3vDs6K1ktYhLu5ofC5agSj5zuHApVoe940F/rys8Mt298dGwiNmCuhrz+6EAyi7FMjq667FdXGVjzkcWNF2Ka5KE/uE73EPtjnvvPhYxnK+pVGwBxRHeK+YWkXp7Mw/qqtmjjeJSvgTN5r2XQ9zL9d+H7nAM+rqv7Y8XslpQXfGyKf2tHIkUrMztTbDHQwCOJ5EPy/HJcKBt+3dUkX/GYXDGg0no8rPbyJmBBd+WjcDlWtehWKcfClnEOlX9VO9AvjjgjssNIRUlsWe/SYvr3SbeM+nVIwROkSepl67d2gcTA62XCy9wWcrCFVWFdpR0uymGWrnas6HewAYPtZ4zWoEbbgaggIqz365Z+lPLc1un2sc2cnLbUF7vRGk4wVNR6s+CjdNaHuOTQ+UzFgWK9k8jMLVgEi7eYRqeHIImEtupslDhxoNwfizcGSBoRdsBWAAp2aT4Z1iEXXTbWa6oik3n3m97g5P9ngIotG1FVKQzrKCaPdxFQcFzdOOUf4blVVWU9y1P0OkYc/+CcCbMdC8AtAAQyr8jR7nYmpHO5yh16N6CgecgcSmzQpoDdnvlgR0Y8RmImQh6Cthfv/0rPPnXnMfJtsVHzkPNfiVHaHDHQqyP8Sgi1w96iYlQOJnMI7s50r28yJMNwo1sK081EBbumBJ7/zwMfe6YY2+b9VdObFjllvluWttSBU2day34yCiuzZ0kurN0LUxtbTtgRDog6zgYIehwKDShXQi5MQBNiTx+o5wTiq1UfZbVrs1e9GFqChkkJkFT365/I2fiI7+c/PP88wyrgD4Xg5iEzOxj4U81StPSxKWOd5UFB6WLPAmSGlGxPQU2T/8EPIwFsBeNd6JfN7i9Yv6Zn2rv0HePexypOy8L8/MCYwKWzrzFuzoi+NG1gx0XzaHiybHauQFaAspXdIHZqGrXGO5IV84isfLRhhE6ybQlSAiy47rjyAliZ6ItyapUh5XIePPJmZacR776+y4DvHHAfQASr16dzz3fhX+XYJBPhvtPaF19f/5UryOFO6wC8NAUBm46aScZLaRY2cWrvggh2BXffyrgK7+mt0ECNmXJH6umiRdc4K4a9bJzHs6T/wezY08nYzWgmu3iGWIr6tWtMpkkLyvHxTK7WGLzclomprbo6baGcKu/hb7sCuMKKW1WCqQeRXGxFsZlhPE47cLVimVeKlemX7OAmOWV7JOJrArRoRCSr15gxbaYkFW95Q0ghSz2xUinjK16CtEsWPMVN6Uyuef4k7mPxrajBfzZ0mYbe79Ke7O06JQnzhYx36aTEk4afUnmaBoK6LnxpiJqfYNkFA4VJ4VyWHShDVol46bcZD9D3kHYM1EX4VMWMWX2bGC01FC2K86IqRalH95ecbKHce6EFDfkBcKpkLZW7x5VXa2f6iE1GmqItL4q5HufwKXRCcvwfR66d/pQNeK9iukyvSL+nIRB4ngBjhIJ20tF6iXJ1EvVnS8XLYZ7spy5t2+N7K6wTTtaz8lHOb20JCJbqMBsg0PG354WajajbvSSBu4xOUmRBWFwfGoZTWzRXpXxqMNaqrXZW/zXKjCjUl+llk3e2TikIjFJe9ZJcTZz+vu5FZXr8woj6xy5Um5d8gBD9EApyMmeXDmJPKsZ40orIkFDIaPpTFCSbjjprpx0yk6unOASidIZRGTVd2JtdhO1e+mw0nW6XG+VTSVtEjkUS6TYXDRplIxUrtCPNBNU5PiTSSU5mitwXbMVaonhVRTkaz2UaIt2KNIYq3IeNYce6lj/1gGlKoJbc5A04jSTAuHerZQV4VW3dCuFINnSksVClIQ/oAbCknn/UX4faZ6004/w97Dyh+ydWoEBNfar0u8LJDDz2uYlboBbLob+8QIZiy50WytmIky11MCgXRsscOnd8KAOqadWWQdJMkv3wbbYwXh8nG6gmSWLBRFbXKmtgBgGU1dsTj6mUOF+mS1SrVaVxMgGlAnNidipM8TGMh4Xi43c7isUnDJiX7rgiDZ/QaIjNlvvJzy29IzV7mwt9wUdguB0HiLbVEjlQxtFPHoj9BF3bnhqRBLGQhRPh+w4bkgkzmTx7uM9vBu2b4MZi2W1hK16zVS72nX3VHK7KmiSCbiff7fEjosqa0WbyDMtEw7m/4jSE0APalQzac1FnWQMfmolWYm+2yoKMRlHn/tuWVSJYc439Z4/xHQtdRKpwIUmSCHrKLuQHKvaGMKe0ftROFsZaF3h5Gp41iz1LLrYnvTU1SPNVKy08ZmADWGPe58xKqRlTq8sykxS2GT/9V/AToy2inz0KTtSdZqPONOJ/019uIuB+ZoQg8S/ga4YyWMJRYRLQp+LJ4zLfQ76aqWr2ukm8Jw2p6l47+lxL5qw9V2BXDo4xjeO77nbmV8BCGIJL4GXHRRS8vCkj9AFlluDhLRu6DVUCF+lNHnxL8jQnkaqbRC2JUkS/sb4iP3xB/um+NAJUMC38O4CME1S/MoL7Belpi/ubVBiA9yIw6O7N47nO3gsW4uRwhQF6VHF9HSpNv0pCxWqCVrtU5elGhU+nSV3KvkSngoKRFBKWlnJkOQViPppfs4lz6+q31LnWNPCeD7KjAoDfhj7FfvIEQctybVOaorivHIBaOlpT0lH2xBSGLfmwSmDK0pchMzYvLzU6n5J51JVIoQLVSkMM/mTxIDFqPJ5hEcMO7V5yNVKIlKnPhyFIvFq2gnlp8ioHnuR/N1MQva7vWiWfmiFjlaqB9C6Xd/XHJ/tOotN9pK+PoPBuOTtT7bg7b5WHm45+PCgJXq3ddpJyRQcXrEAJoHEdEExazmlGDCU57I4ZAMwmTGUiAytWLaMl3qO75LIYumOae49LFrvpHP9dLOMXmUoj8AAtNqr7z5lvUkjc1qw6KcGqD4S+MtO9pWTo8N+k1KwrlWgg9tPLQqXPbUAe2X0XpGxaX1mO2Cr9tXj/Nqeaj/bPXEksiDgMVNaFncwTvYyv4ddgmpLlAF9t2jSlq3nRWdFS8yrClPKaH7edhKGU+Eo6CUX2VY27QIPQp7cVzJqh5YD+1HGTRzoe0Yj15/Owiix/TkOu/B8bvWzHccSitQYZE7FMuYcewlDkEJpZuVCwpc0P/u4x99w20QS8aiFb6E92PlAZEwBLL7Y36HdwavQd4X8erI7nMSxN9mLgedqQOfSgFMmTtkicaUDrCrLCKf55SWtWKU0abWEqe77AnEJ99AWpfNkIhqUTTEKG3DnTCSIdVUUguwX7Lbt2sz9NKv5HWC4kldZQhYt7aqWOAUZasW04YlBC8T+FfocMYVQJtS+B9bF+R39uc16uHTSIwWz6XTFDCYOlzFRqmgDgFmvFSQfreoGyM43omZiwZcyy/SgbsBgjquQs3OOLlqjvQ2aUHdkP4ToTQkuQlQCV6ALdBmR2tbBNEzsNoyu41fsJ4ddRfyC7b68SpJZ/Gpn5xKMgfn59iSc7sA07r7rHY52FIreufWuvR308Av19PL1MqV+2nFqNnunrqDWlvxGUpPPfAsTuq8sRPHSNn+E88INuZjudJxom8kD6ZS9RDg5GnCywDgCniJpu6d6LrX7082hFBKb+aClbMC4TSknNNEvcZcIfQ0l39Jpf2OL2VTmlX45fdWkyUXhPlDyDNbhM/WsbZHM+8VV2V0VGWQt+RUHBvvBbC6UJnuJrjp7LdpmrZfmwaALzE643Sp206mFXZgugpbVP4rdnGlXZ+mnPeIGgaxLAABrTTV+ps9/6Y1CM2riDykhordkbJzAACShGPpGr7ZF8zBACLNsKeoIDUQUkSzgTCahyKQjN9Rp1QXtK8iQf1HHAWn3FsIJ1XQDVazOkXU/TxYpp/pfP2ssonqjWeNLXn1BqKRBU541NBHtaDTaXxdIER1QF6nY3dWkisai9Tzwi+Q+B2IW/45ELHSWI8vl8STyzoXK6R732b6UadqEzK1lMedMjT1If7zt0GC7QgR+2P5uB6NTdt7M/Wsx6PFOFdCybeVH8UIXools0ay3A9r47EZWNJnO9qSiqdo+zTjKeUszn6i21qMPVCmkIg8owCH29xsnyr5Kx1r1lP7T2dzezQptvU5C4fMFTPfy9+j34GVZZjQio3G4qxM1C80D8hhnr+1EcKnLl1beU/tykqxyozfb9r5zbvqe0vZ09Qd//GHyUu5PX5ibS9wGknd/C5K+8++7PYsBS07zuxi60yyNQNV3Soya7LO12a0kRp6n005h96cPdYHGjhb1XfO7M5HtoS3GSWPYbnIMBpWesE+NbJHoThxQj9p4v8p9obXebCEmDCuVFv13Dv1+nX8lqhZ4YZlqRcnaVf5ZOKy4N1RzW6j/4fhoONa3hDIyddPXyOPcmgJqGF9um19CpgE4ZfcoVDlDbfsod2gUVJ1IjVJiDymDY0NclyE5Nw0M484N/XSR6HG6JCMtqI5OIB+0p5tmGBB7uTLxNgBZWVCcNiqjLhPwF1G36YlPywgZ1wRsZeEfkogjwLVKmQ0sn6ef2wPgYsaUCX2Hp0YyBSQvllLHRvtEW+LdBU4UK0tQekAv5ScThNoQoCq56QGIF/FXGNEkRryTDu6uNMrUcKT/Nnq17JAUMX+UQQRTudm6gFEiPXEdSKf8U3XRy2vFbfrpqaVwZSNyC4nO1icrqBZvgEGl1Eb52VT9ULQbTTWIbmlQg7gqQq9BkCitQe/oBvUY913o1en0ariVNIG20aBWd2nsUKrVzNtcKjWbrdgauXmkWmus1TBVCvZodjMMU0pVZYX25Y0xF2ggurE4JqnPTkPxrPWOqXfeSgGooXuyMXgEdZPeErQalZPy3mCuZncMUZhFSuJr1wl44dFWdmXS81MKaipXIB0xnb24DqhZFaZZqxZTtYxAjgYgRs8a1qS3e62hDfu61Jh9Odtaj6312FJ67DgVpGetybR7BNe6jH2Rugz/X6rPxuPBs1FkrB3iFW8OJtq49GEKBnTgNLzl7qZFUx4629AvnTRvKeKTEG8Bd+iVUDLi8IF4IrLiZvuVgtBaddVRXePEr6GztKF5MA0lfqin8F7SxQoq/V6xWV7CvKL0NWu7IXQGqBW9YbqaS6cZ/r5ANVGqItJbiCtVxEp0xD0c1Op6Y1kwhSnipqv08uNKN/R6nhvz/B0Pa8xz1bWPAEbwYusmKKT4Lhaam5LrBtNS3outT0hJ5CvBCcUKgCI+5QE9K0VWWOvyVxkDolNZ6i7YPGUjpaYgvtL7V++n0lTmJnm1lPhtST7x4Sva/eukd4l3UEt18GLuTupBp5DCDIOXIKvsIiFmK03tlUiGJmIcXX7h4S26vnfNxcftltPapABG9a8Oa51vT1o29CqxL1FZ7oi4HUywphYP+VWR71xxb6gCwX0chxPPSbwbXp4dQHSk3gB1XT1qABF/pK7oTs9Cbtrj/cR6uiQgp2DK0r1eSvlqo4rBOLqFKI98qtBXS83m43bmkX+cnfqsCoZYfLy/OF9JTe1ecHNZmXbPml+h4WWPlF6ToyUsaWxvlrRTDzLR3uQVrtH94m91wxkO93u/dbRha3jGVY9nqJekxGAXQ93w7ofcqdcD+UI/+ZpGtKhS9hhQLMlfv/1rPo6kIrA+Ez7hwboOwtugZYVH4a8gmkRW+G2jCuWaIlWartCYOydtl5mRNx5dKgd6X3wX8DiuwVvFadmCcBL8f4VVv16x7+moWNmCJILiQWOJhb4lUCk92d7errM83ccCEOlKf9j+7xpQvxznG5rrYRePZ68Vjb5Y68XnphcLk9mImZm78ETptuqrgSwobxxIIsLpAYccCbssVUdHmXNlC50rTx4VjpkGykzHfN6i+pmB5Vz9VEj2sRL+FkmKykz4ZV5B0jRTtLiSYCsTQB7L1DtbeCio4fUjfUFhUe7ozCJYmaGR3fyw0rXi4ZNMi2x9QfHsf2CRsNMkIAvC4E09FFfin20r7RLbUYrTLQMrD5GRr1QTSa6ljWeJnHTCaZ+VGYNXigz/PPNxuW7ttMpyZv7JOHo5yih8qiHAFvenhSseci8vYhPEN9lr9r3JeuUBZMqFZwxnyeHie+UAVPNJ8rggqx/+v9B2UWu1nEEeppyL8c5cecWOwhJPO1PSk0K4ipexJJstKW7JZqRmUV1kTjn5086g+4OtGZCebiqQ++zcVPpVTurVrTTqi0Uybn9PItP1/fan1pm8RKQv7yqNUy8cK0s82fjEWFpy9bf9DHuj46PDUf/NQN6N3hSIYH7ZxQYE3SulU3bVhS3N7gZqkUj107t/a8wrKrEI3DwNFFH3v1BGCTVZ4uazRd4DbyQ+s0HIcxI6ebP98pB3NWIUZ1JUJDwOAxvCBTSY6r6CtN92ws4SlJySeO4YOT0IumXyXc2tktXvtr+vlFUnuKtEymeqvj3fieNMFsznBfeLVTjam2LsYs96XVWYzYXu4ccH04mE74Qkq57Jn5dUEm92XsmlfwahKj8EoshSa1LluTWz5S9QvWUSLH5LuTLzmXK19CLLZha5R1oRShhwFjuBl3j/5i2Nq3EkPEbymoEzTDIeuOws4jf6FiZNO5kZM+3YgtQBjZJLCK6uPNflQTetC/MYjHhibKaKbwyGMO259L5mDNXvyZpfkjpFe2mSzNNL9WK6o4jSqpBnLc/dHAPp8P2B1bj2ptgayJKK1B9ESp/jXVyACYe6DtNq084yTMa7cN6KuJwi4gYqOViUBkbLDyIyv0j0uElN86Eb3Tu8Nc7nbgN+UE6QWL75t3p2JdA2YCG5KnNP9lmTthekmCDpOccL2Eck01u0xa7df4hnYGNZMacFMd04gUe+N/Xsi8tFn5E0Q2G6TAF6OxIhRxgUSdUZIk5cYCCBnFRbjB1JFjo0YkV3ggN9LKJO7v5rzqO77TxZYrFVTHbqfPamqEymdF+1TV5IwjaTrOEwy2E455izgeoVXQCNhhERYMLkwfxHaaKyvXkUw2zcKsi69JhuUxjz5tcH0IWLj7F8y4pUGjFhs0l13g/ewFszO4Ji28p+gGTMRybrOfYH/Q/9MXJOMWLV347e949Z8ben6b+0xdlsnRXaPR72ulqe6fsAmcFg8Z75ZhFfBFNozh47UZKDNW/Um3bOQlfYJS1cbEmXJQQ3IU9LkxzzjZkNPAd10LtEk6td3FOdQpxWJw2dMk71GweyvBRoBaqctE398UTxKe9Wbnizsidscz2BVvG+UlUi+b5b7YGfaRcIrU7V6JrmXtPr7H3v46h6js0KYlIq71bW5+A3MvkNAX0h0eo2wmFvdDIY59OwV/hX34VyG1G4WVMTkSTPvjmtzAUm1qzd5edYg0mu21ieiLE2s8tnWZQEX6l7b5NyKfnhxBFOFTuS1Y0/nZpOESioTOi+izbWQBZuZ2Qqt3mBZpVTQrWsHW9iQrl4xifexR1BzoDxz850tjCF9T0Uxb31hfzd2wed0kFOZbMzSaTUfKknI0wTrzv2tnK1zagZjR02i7yQgOvNd9vfbn/LEupVqkldMH2jEjkyZel15NW5sgwlg7xPbsv7ZLZ8njbo0xmhTRJjPrgZ2ijL46MYoo04ekxTtFE+yOai+OQWbS0uDYt3FQZvrVoNg/jR7eGFLJabyBNlIqcOSvVIuzU8u4OpEnGe3/XEelOyJ1nP8G3s6a69tamWvd06nt+U5+p0ggQis8/1a0H2yzipsUOfW7gFnPEETirDjg/pM8iR6v3W/XA8oCOXSMreAO7G4loX2gi+DECSbVWfbgefGvbCk3gmyrNRvumO9w5G/f/taR1mAHGZzzJHsibZXLnNBb4Q4TfJ/Zo4UuoVNjwr9zDjpKDU85Q8uocEr8M85LeULpVA2o9fohcF/yhwolx4UZxBUliKoEcE9hF3MEk188Bbtf+PbaO1SVPA1tqkWZs0T2/SlGPih430IJ28BspPCpQfMjYmR2oBUL4HQG4Mxd72h6NxPUBmx+A8NDDL1dMg6CfDcmflYG7poJ+6u1aWA1rLeUtehVKMdeGBQjXjggrC6YTWJwQnoJ1BXIm9cJ8IL4aqqY85Ttws8YlROoTBdpIw6uRy9KYX7qjEAOpQow7C5FKQ1Z6qeQtTPggGrNxWs0iljLGM1Fhfl2QyBOH1ENc/YmdkEMOkJ7pd/8mrJI1xqXdrJFs71NfoU/7W6LP695Wgz7VDvbrWZ+5QRxZplVQs9i+ES6UjD/ICN7ggRupAr1oWtmSyH1qK7+/Ft3LVdP8xoB73eLwgMc0q/f6qbZY1k865jlwtnz7wLUeqOx4P+29Oxj1mZpGpKPKPk97wo3iORUTLivH52oFd1IGP5sDOFaZziTULr8r7/fZkMBj3fhs3dH/XMmm+HP+0bS+dzFzMEKGbTGXO6VK7aS5o6C4apFMvoc0ix7Ygfq/MM3UTz1RZLcq9Qb/V+K0lZRhccb2qoDwjwzKlqZK+yaS4hlWkQS4EY/KuJwE7zG6zqiy51baTM1JYG+9QPOd+eEv557DWvOWzMQthGbpjbcLm4RSa4J17dINnZkFhnjzo8O+2vxMrMYz/lCdXYZY+uOJn20B1iiAyuOZ8dggapSUaKhPsKTyHC3M0hzFSIeWUF4XOVYuLL2kSZJ2s7k1V4B96w4u0bkfdZdpGdMa2jVwY+BhvcpW3u9KJ97rog9p063jJ2zAa3QWTVr5NMARgHsTwEiZI4MUisUpoTS85Y4XPgXwa0HAvvmYc57sXiKQzZGBgOa1KduE7YPY4COLgUyjknPuaTwLhVqS7Jhq1TQOb9njFdNxRwEV5b+zUCe5MyCnbhf6ZEO8tBTAoSoC0Za4RGAV84POYEi8GFn6viPPtMEFrHihfjJiWVv/G6VXBchrWxpcrhZbLJ3uo60IXzXtTEm4iFWQn03GP4k+X1ebd6Uph1/GmKyKlLvSsPtW4fIWpaq9TY0rm+YWUyM5YKqKkopbD3q9nv3QHJxLzqw742gJXfu32x2ejj4d7q8X9Kdk6uN9cCYt/KjPr6oyGVUH3k+P97rh39ubjkiEsaY001WqeXTbKfGqRekTwvyvOKz3WFpmdvUiyIxcWLT2AjeyHfOY7k3tC+0gSeRhsL6k/Crivikz50sC91W9rdM/W6F4TVTVpvzp4rxr2fPC9molfK8CX7Vsj/DXCXyP8NcJ/MIQ/7B0PuntriK+zo9aWSoxP0RsrOHErMl8Za8QK4Dj9vrhoceualscO2Kn7rY0VUaYl7hRQIEEk6pAVB2IC7UoBoRx6EfqZiCiHDFUKrImAsVGMRl8Cf/gP7bsUj0lGTKTVijGczaEoFcSd5/zKuUFrQiErGStQv9eX3MFf/K2GXJ8gx46N+TwKhy4M+EA8f4t4T1g5OdRYF/KhTilDfOvI6PURwjVOuwdOewZQ68PRL2ukpbMj9WV5rtU6OCvFC9f8TqU3e/5oS2px5NmUwa2sQWkXay1bw6k1nNI+Lj3ClWaRVn/VohodLWqYtQTucFsi1XSZyy4HcsTRTkW9JZanYirYjbIWEuUdOxuhhZS+3/6fWkjpPdAqzCuIlTzDWEtM5SWfI6lsVrP1og2/TePJ6pfdxZnUni5bYcO1XVI1hzObyThgOaeGeHdqCkQ2bwvKqHenupRKzu2V+s3cv2Z+GF7PZ5rWeK6L9eqW6/sv2CtJQM3ut14/2xNLT3lmafn11TzKSHd+q408kqAUU5TyAksmTw8aicteROAAlKf1NDOWZQ20hUazJ93kR0Y5HgiK1LTKoHQL0U2wRRuydLJJbKqFUZJx1XBZFrN/Jcty82T/z3Mhb7xaDY6O3p8cN1utll5FNuR0Lct4aVtraRLaU8p9mXqJbCeRIEvpL1fnJNJMSCDe5ByytgJhRMJzy4GZX5+WvFTdPuC7ZcazYBDMFeuIy1jFVebO9jn8AS3b3i4+5Ms2fH6hbQWoM75+CKYAO0e9U1Yw8i6vklzBOYpucUF106y9Qq6vZyjjan09Q21e1tczaOpnUQkUrokfxmgWMHm2U7hiMEzGw9vM0A0j7FLsM1ISdOM1TvoOCzH85daLcdeQbFf1giKEhDlLhWqL3ZdwWviB7puoU+sTX0exiMVG364wTit//UUWiavvaX/6FhbA4LTa6YTQoeKAL4pzRy57tUAu+RSy1Rld8q3WEg75jEQdTzzWCqM4C+O2zn5rG6r+ZleesLS52NkB2j5IQFYX3ntqoj6tKdmNodstvZuew5bbEgeeB723arMIi9BIl3897L87GGdfk0A8uZvP7M3B0ai3X/PIsNwqa3Q4+WH30bqH7xrvnX2x54Sr7ZmAOzVPATz83R/3tmPccI4X3G74oL8SRAhMkSGTQz1NL5cPIwAfTpZoKUcnDC51Qsp0UU8XElpbJGuL5KESCz27vEJfgE3ieiIuqJXPN5OBD3SQKlMgThSAVUW3WVvN3TonZNKq17ZHaa1r28Ms8QC2By7zlumhlsOOts49wy3vQXfcH5/sY4QbQWfFdUWJo8N3sgiVUI17XhB6vz8adw/3es1AdOMcPw8KpA973eEaRxOOxqAV7wFv0VsDaiLkiWMFG5HjenPjBmZ9sZBv27AsTXnCo3hzDczXwPxr2ipY4/I1Ll/j8i8flwvYUAuZyzXvq4boVU7x7n7/RMTMkFOcOmMN6dMOWBGk/7U/PugffrWgHv/QML1Eg5qc228kBXMSR94NJqvL4tacf9/tEcopnjwaJ/ZEzT460uazecOyvGA5TWc6saoa3814K3/LMm0PLigkNg25ewnL3x9/5ASwVvEfjGI2F9TjOwyryF27rdeU64hPrUTWwX740fj+T8YBwxbXk+UqWrKu7626XmR/S/+aRHf5/U0AKnw6o1MnorOsgx6mchFyLD60RCXHnb7pCRAFExG1U/uPbRRttmpW3hQWiyvnRqbOwfslBJLUGib+Dw2c4GQ8c3zPidvZWB8AgvTx/ml63WGt32HBdi55EP8uM/Sc/577GneP/w9WKlPL - + - ArangoDB PHP client: client exception + ArangoDB PHP client: single database - - + + - \ArangoDBClient\Exception - ClientException - \ArangoDBClient\ClientException + + Database + \ArangoDBClient\Database - Client-Exception - This exception type will be thrown by the client when there is an error -on the client side, i.e. something the server is not involved in.<br> -<br> + A class for managing ArangoDB Databases + This class provides functions to manage Databases through ArangoDB's Database API<br> + - - + - - $enableLogging - \ArangoDBClient\Exception::enableLogging - false - - + + ENTRY_DATABASE_NAME + \ArangoDBClient\Database::ENTRY_DATABASE_NAME + 'name' + + Databases index - - - __toString - \ArangoDBClient\ClientException::__toString() - - Return a string representation of the exception + + + ENTRY_DATABASE_USERS + \ArangoDBClient\Database::ENTRY_DATABASE_USERS + 'users' + + Users index - - - string - - - - __construct - \ArangoDBClient\Exception::__construct() - - Exception constructor. - - + + + create + \ArangoDBClient\Database::create() + + creates a database + This creates a new database<br> + + \ArangoDBClient\Connection + + string - - integer + + + array - - \Exception + + \ArangoDBClient\Exception + + + \ArangoDBClient\ClientException - $message - '' - string + $connection + + \ArangoDBClient\Connection - $code - 0 - integer + $name + + string + + + delete + \ArangoDBClient\Database::delete() + + Deletes a database + This will delete an existing database. + + \ArangoDBClient\Connection + + + string + + + + array + + + \ArangoDBClient\Exception + + + \ArangoDBClient\ClientException + + - $previous - null - \Exception + $connection + + \ArangoDBClient\Connection + + + $name + + string - \ArangoDBClient\Exception - - enableLogging - \ArangoDBClient\Exception::enableLogging() - - Turn on exception logging - + + listDatabases + \ArangoDBClient\Database::listDatabases() + + List databases + This will list the databases that exist on the server + + \ArangoDBClient\Connection + + + + array + + + \ArangoDBClient\Exception + + + \ArangoDBClient\ClientException + - \ArangoDBClient\Exception + + $connection + + \ArangoDBClient\Connection + - - disableLogging - \ArangoDBClient\Exception::disableLogging() - - Turn off exception logging - + + databases + \ArangoDBClient\Database::databases() + + List databases + This will list the databases that exist on the server + + \ArangoDBClient\Connection + + + + array + + + \ArangoDBClient\Exception + + + \ArangoDBClient\ClientException + - \ArangoDBClient\Exception + + $connection + + \ArangoDBClient\Connection + + + + listUserDatabases + \ArangoDBClient\Database::listUserDatabases() + + List user databases + Retrieves the list of all databases the current user can access without +specifying a different username or password. + + \ArangoDBClient\Connection + + + + array + + + \ArangoDBClient\Exception + + + \ArangoDBClient\ClientException + + + + $connection + + \ArangoDBClient\Connection + + + + getInfo + \ArangoDBClient\Database::getInfo() + + Retrieves information about the current database + This will get information about the currently used database from the server + + \ArangoDBClient\Connection + + + + array + + + \ArangoDBClient\Exception + + + \ArangoDBClient\ClientException + + + + $connection + + \ArangoDBClient\Connection + - eJyFUsFu4jAQvecr5rASFEHocoSqpUurVqtWqsoekSLHDIm1yTgaGyiq+u87NoFW0Ur1ZWy/ec/zXnJ105RNkowHgwQGcMuKCnv3C14eX0BXBslP2wr4prHxxpI0ht55o/RfVSDAmbaInRFUW19aFgx+K4KlR6wVUYS0bQ5sitLD4rybXP6cDMGzEUFy8FDnj0OBK1sQDuEBWdgHYY+ThFSNTt7GzrOzs4vjeXTfGfhPadynC/CHBmFvqgpyBF+y3RPkB9nhyfG+RApnRhCm2EBmy0HK0tc+Z9YypEkxBWdr9KWhIuIOeYccyGQ9GNrZaodr2aRXOV8HobZ+n6czpAMEcJlOYhC6Us61Xs9WxZ9HWjv4NP+eBFaMJqwBvKLfMoECJ3nLpIwNoxMVFRXsJs7+5XNH2ok9r1VhdPeSj5qt4uj/0m33ONZmm1dGw2ZLOj6bZd4uI6t/ERuOc4fVimfZ4ul2ucwySKE3hZ6UH5K1G10X6J/ROQmvfzGLtI/kIzkmlKnKKNfv5DSdRnAIvdXpp1u1qeerTm9PNP8BNt79Cg== + eJztmN1vGjkQwN/3r5iHSEC0gfbunvaatNvClVRtggLodGoi5PUOsFfvh2xvCDr1f+/Y+8FHyIWk6UPV7AusPR/2zM8zhlevs3nmOJ3DQwcOwZcsmaXdtzDoD4CLCBPtgYqSmUAImWYBU0hyRvRNxvgXNkOAWuudVbCTLNfzVNIc/EWTX+ATW6K0MzzNljKazTW8q7/99uLl7y5oGZG9RMH7OOi7NC3SWYIuvEcZs2RJ2h3HSViMilzjltc/V3ughTOlYEr+SY/NaPmrjXXLXahyG6N5pEqFTKbXUYikmSdcRymtRKeFCVzpgZ7LNJ/Na5MNVU+CPzh9FciTKkQioq3bZ651prxOJ0y5ajOrGQZtnsad/mg06FQGOlES4k17rmOxV5gpNRytg5ftP2yAiq1U9pz/HDNpI2Oew7V9WFflcMd+ctqyht7Z6OKfSdcf+W/9YW9y5n/qwTE0TOAbFOUte2OFcm9b42HvYmiM5UZrhzUukWlaG1ujzc5UAkW6aqkEF7VkEfgNaQqeZDGRlCRoMwoHfPX9iFKJsDZA2Q4QaG3hlgFFaBJE5jkwcShyWhqo/IPKkEfTiDNjzLX84Q2LMzo7jXhZBb6xvUYLyWP42DQjUecyASYlW8KBpENCGUDfvh5R3BCqsUKmXWsaoBcKLjf5uuzdcMzMVu4TLD62xQsMsjwQEacAUlB4fbDKDDZ3J8YtgtyyBgqAbeQzthQpC4mfz/WgeRSKqeftwhaOTwpb7v0KJZsnW8bNc3vEPBZieyqsm9X6j05mqM9tLNZ2WAwozzsfjE7Pzyb+eNS3TlvubvMZHeRF2AB4vPmBPxz+3W3dsn/l7H67Kk+kDXeNy/Gm9yxVujmWgnyNLz7WAXQ3pf5VaTLBhKchThaSZRnKZpXBVmvNT8lt7c5u7wNpN0nKCHx1bpWJLgq8v0wsIiEgtKLAEjqLkdLmGFc67edq8XNUiyKHD6wWuRRELnHaR0HweV6QRyKk953sfrZGrlr7HIByOcbD94L8kZCskVB3QiyM2Do95hbCdIE0GBZpjqrRtbljPSnTvzR3Juz1fekO/La5KzdYtJg6Xc11jZqGZxh+IhjCB4JwZ/mgqrCjBD20kuxix1xI7gToAqkt4bWlBQuI0ikw0yLXOCIAcikpNoUxTn2TcY7KsEe/6HJdmSva19I0OurC0XSKtZbtedTO7AUmleFT99lfGkOTOPOba9+69OiGaK+3jf06okH6KdrhitEooQtRbO9GwALiboPNe2995Or/TYilJWp1HZvKNH6unD8EWUrGKeVi37r5UE7LjP5YVAlW+8/KhImIqWaVIs+zoy40Lqt/r6qABZf1HZ6sfAOoGev2 - + - ArangoDB PHP client: foxx upload + ArangoDB PHP client: streaming transaction handler - - + + \ArangoDBClient\Handler - FoxxHandler - \ArangoDBClient\FoxxHandler + StreamingTransactionHandler + \ArangoDBClient\StreamingTransactionHandler - A class for uploading Foxx application zips to a database + Provides management of streaming transactions - + - + + $_pendingTransactions + \ArangoDBClient\StreamingTransactionHandler::_pendingTransactions + array() + + + + + + $_connection \ArangoDBClient\Handler::_connection - + Connection object - + \ArangoDBClient\Connection - + $_documentClass - \ArangoDBClient\Handler::_documentClass + \ArangoDBClient\DocumentClassable::_documentClass '\ArangoDBClient\Document' - + - + string - - installFoxxZip - \ArangoDBClient\FoxxHandler::installFoxxZip() - - Upload and install a foxx app. + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - - \ArangoDBClient\ClientException - - + string - - string + + + + __construct + \ArangoDBClient\StreamingTransactionHandler::__construct() + + Construct a new streaming transaction handler + + + \ArangoDBClient\Connection - - array + + + + $connection + + \ArangoDBClient\Connection + + + + create + \ArangoDBClient\StreamingTransactionHandler::create() + + Creates a streaming transaction from scratch (no collections) or from an +existing transaction object (necessary when collections need to be passed +into the transaction or when an existing transaction is resumed) + + + \ArangoDBClient\ServerException - - array + + \ArangoDBClient\StreamingTransaction - - $localZip - - string + $trx + null + \ArangoDBClient\StreamingTransaction + + + closePendingTransactions + \ArangoDBClient\StreamingTransactionHandler::closePendingTransactions() + + Closes all pending transactions created by the handler + + + + + stealTransaction + \ArangoDBClient\StreamingTransactionHandler::stealTransaction() + + Steal the transaction from the handler, so that it is not responsible anymore +for auto-aborting it on shutdown + + + string + + - $mountPoint + $id string - - $options - array() - array - - - removeFoxxApp - \ArangoDBClient\FoxxHandler::removeFoxxApp() - - Remove a foxx-app. + + getStatus + \ArangoDBClient\StreamingTransactionHandler::getStatus() + + Retrieves the status of a transaction - - \ArangoDBClient\ClientException - - - string + + \ArangoDBClient\ServerException - - array + + mixed - + array - - $mountPoint + $trx - string + mixed - - $options - array() - array + + + commit + \ArangoDBClient\StreamingTransactionHandler::commit() + + Commits a transaction + + + \ArangoDBClient\ServerException + + + mixed + + + boolean + + + + $trx + + mixed - + + abort + \ArangoDBClient\StreamingTransactionHandler::abort() + + Aborts a transaction + + + \ArangoDBClient\ServerException + + + mixed + + + boolean + + + + $trx + + mixed + + + + getRunning + \ArangoDBClient\StreamingTransactionHandler::getRunning() + + Return all currently running transactions + + + \ArangoDBClient\ServerException + + + array + + + + __construct \ArangoDBClient\Handler::__construct() - + Construct a new handler - + \ArangoDBClient\Connection @@ -9547,30 +10106,30 @@ on the client side, i.e. something the server is not involved in.<br> \ArangoDBClient\Handler - + getConnection \ArangoDBClient\Handler::getConnection() - + Return the connection object - + \ArangoDBClient\Connection \ArangoDBClient\Handler - + getConnectionOption \ArangoDBClient\Handler::getConnectionOption() - + Return a connection option This is a convenience function that calls json_encode_wrapper on the connection - - + + mixed - + \ArangoDBClient\ClientException @@ -9581,19 +10140,19 @@ This is a convenience function that calls json_encode_wrapper on the connection< \ArangoDBClient\Handler - + json_encode_wrapper \ArangoDBClient\Handler::json_encode_wrapper() - + Return a json encoded string for the array passed. This is a convenience function that calls json_encode_wrapper on the connection - + array - + string - + \ArangoDBClient\ClientException @@ -9604,23 +10163,23 @@ This is a convenience function that calls json_encode_wrapper on the connection< \ArangoDBClient\Handler - + includeOptionsInBody \ArangoDBClient\Handler::includeOptionsInBody() - + Helper function that runs through the options given and includes them into the parameters array given. Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - + array - + array - + array - + array @@ -9641,19 +10200,19 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\Handler - + makeCollection \ArangoDBClient\Handler::makeCollection() - + Turn a value into a collection name - + \ArangoDBClient\ClientException - + mixed - + string @@ -9664,17 +10223,42 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\Handler - + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler + + setDocumentClass - \ArangoDBClient\Handler::setDocumentClass() - + \ArangoDBClient\DocumentClassable::setDocumentClass() + Sets the document class to use - + string - - \ArangoDBClient\Handler + + \ArangoDBClient\DocumentClassable @@ -9682,3062 +10266,3159 @@ This is only for options that are to be sent to the ArangoDB server in a json bo string - \ArangoDBClient\Handler + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable - eJzlVlFP20gQfs+vmFapbCMnob3qHgLh4KCUnqCNoNFVByja2OtkW2d3tbsuoVX++82sjUkMSDnUt9uXON6Zb775dma8u3/omW61eltbLdiCA8PkVB39CcOTISS54NL1IVOLBRQ6VyxFGzLb1yz5xqYcoPY49MZ+kxVupgzuwWc1h3M+ldzALr6bM9s1/u9+NukYbjkzyayb8j3vlyh9a8R05uCwfnqz/fr3GJwRGE1aeD+fnMS4nStEieE9N3Mmb9G712pJNucWifEGp5377DAlZi0mZKp8hJzCMaXHtM5FwpxQEn4IbcEpYJAyxybM8o3StkImtAXwW/e1p1RGI/wTJtMcVeALx2Vqofrf+tkie0+P1haMPC3AbRDSOpbnSCOrGHYrqzvjfTcz6sZCSeLdIuGaEmhaaWbYHCyKiNm2c5Ww/B+hca8DbsZBMzejdOnZb/p4HYxHSnToiMR3ThalZr2K2BP4c1VIN1RCugrfv+ho/4aUp3cIHsO8sA4mfCok3AjkwCDoBQ1UZgy7BWgrn5kFz5pQssIVhkNh8TyaCRuOe7LyLUlYbr6j/lhzGmEeeFwUWuOe/ZsZiVnYEOv/7Kg7koXl6bHCKsuHxIc7bqLKq+d/dTHBwkE6MvHFU4lDh44ih7Xc8aoyccWtTmsAl9clblkRtEQG4YtM5HzMF8I6e48VRStmtHwdgOQ3zVIIXxKRDh33z9p9CaniFqRy4JEhJD0xEAgLhTScpWyS86j7Mtqpwyxb9aMzt434ba0QhtbAA42n3I0TJbHY13jvrHvdnQZ6td1M2M4e+h0qKbnXMow6ewQcjkxu+/3R+el4NDz9dHAUlwERbg2PBKsxPdaJc/pQpTyMYBfebm83dduYRbFK4vjTly/jDx8vPh+cnsbw1So55jKhMJcBFvYHmakABnuwzuUvS1iXAelDoyq4jiHwJVEa31fHddQQ6vnJ0aq64TE2D8MsWw9ePV1cQV1cd7MqY5hdGjSAG6CbAJaj5hG8JeCUTmYQXviOrn2hzTfvinYpwhl2PI6PMFqr8xXGK4P5nM8VTkFWD8dfMoz/58PSeFHp0A80zsr/OCAfmUPP6+XRxye6ebP2fF5rbtyWG3eP1VhULiu7CAf5elNCSIz68CqNghie4hs9r9W8BI2mgsFgAAH5CrwX0dcmQw2xmR8RY4OkzugAoOyMV+XXi6oQjbvB2se1eTzLXzcU8Cj8nW7McsFsuHKz6/f9Bo70q7vL6lV1R5xcrdjRKPsXC/JtTg== + + No summary for property $_pendingTransactions + + eJzlWEtv4zYQvvtXzMGA5MBe94Ee6m3Spmmx2UWxDZLsKQkMSppY3EikQFKxjW7+e4fUw3rZTdO9BM3BkUTOcObjN99Q+unnLM5Go/nR0QiO4FQxsZK//QoX5xcQJhyFWYA2ClnKxQoMDWsWGi4FxExECSqysoa/ZCx8YCsEqH2cOXM3yHITS0Vj8IEJuDKIKRPCDYUy2yq+ig2c1VffffPtj9NdLO/S4HxKw4lcCZzCO1RkvSXr+WgkWIqa1sbOsm/rlC6UfOQRaiAjCjClQZD3w0npZ2WjuQjtEMD3b35wYYQJ05ryKl1e7zyeFygBbgyKSEN5P/prZO0zxR+ZQRgvMxptW2o4hps7ysNOdLnYvyPCQVDseWiAgcD1P+2OM6psKS/FUutCYDFvHO6uZ9C4MRIChFxj1PYxLwLPg4SHcJ+LYvZyGVZh+cPeJ86uSNt5YMqSa9G0bE5/W89UuOLaoFrqODeRXItltazPlGJbf2xirqfghYnUeNEH0puU3p76YBJ2hrjB9sB4r2QKOlTMhDH4QhJCSVJEqCdAlHYTiNOVQ9xQrF0vMvhMNmSPIWrN1BbWMYqmL9pJjErMM+JSjTpwQU9NjG2HqvBACw8uyDWhpvMUo0mXASZWck1cRfWI6vdNiJm1GObJEKFhbNSGqDK07kGKhA5qf7/PYxB5kkygQxR+D34xflzN2A3av8qYamHIeUGP2ckKzY6Z/qRBsKf6qr4YE3wZ7QuS42H72UkmtfFbkXxSiV4sPl3+sby+PP14dXp2/f7Pj/AGvHlAHBbetBP3sN/PWoolilBGuFwrlmWoHACzE2aM4kFOhJ3Unhp57KK3Li4bGVTZuNU+aLvOzmzMo0ZUx23rG88SKTHe3Y3HI++uYeZC0mjeRz65mJRK1chsSNRuaOodLUIFj80SN7kqaLC3Um1xU6EmCZRuW8Jd0iuCYOuqpa1/exi5Ry/8rlbN50AdTKbM8JAC2AILpDIullxQgZKQkZ0beaB6mkmKsBXdFLSENUIkhWeabhNkD6BdLdqKlbkihbA5CGlcfL08a+t7SRlbVTqANjDttvf4BMa0NnZLx5AUtZ80ts8lWW5tc/gJwkIOb2v5gHHPdZkgXwmK00GFSkmlIUaFbX8DhXgop6Itlizp0oTOFizp6aVT6QYt3H6YmBngxoqlRbusER4kFK7YprIK88hC7Qgwc5DYLSEzcls1pGH1pI5ip1r8Z211jg7SUtsUWgLGoy4jcypNc2jnXZ1N9sJ0iRQcPhLXLCraMJNreypiA3L+otaR8g0VY9krhntr2RUJ2zY4lrQFdl3XpUy4rk9ui1ttu2DxaM1NDDuRBKtYNBqBV2ToHcSdpPHKTXNqu78PcTquMDoBElxD/abXnmz9lWq5cmrZbD2ACUn0kIVfYDBpqGK5mfW8ZzQpeuBTWzrHhNrIYhHkPIno3h9sVVMoaNNsDs9qJbvpJZUOdJFyKxqdxCFbGVKT91yZIe3dly/QGghlmnJjh/qHAJf/YO0Mgle1nOEwq8Kxv/0DuA1Cv45aCaRMnPzkaHEuAASdhyEdOKkvlXG6g2Ql5pI0Qa25xoPlUrh6NbXyLH7sPerlL6gieiPxmrVR7sju5NM/5Jxa4r9OZhVHoq9BrPLc8X/gVYQJ0jvRSwT6EK3s70DHd72TDmJhruy7N51WVS5E/xPIS/jWac3Ff9qdw2tNwR1hO6+uX6+fXxZr+j0i/YvW2d+F//7KNdx8msh0WhAxzn1jWrKEM+2f1V8Oyu9Ji4UbJsm5JbTYCoW+Lb9cBbcHvktZgfobsOoKXQ== - + - ArangoDB PHP client: single user document + ArangoDB PHP client: batchpart - + - - \ArangoDBClient\Document - User - \ArangoDBClient\User - - Value object representing a single User document - <br> - - - + + + BatchPart + \ArangoDBClient\BatchPart + + Provides batch part functionality + + + - - ENTRY_ID - \ArangoDBClient\Document::ENTRY_ID - '_id' - - Document id index - - - - - ENTRY_KEY - \ArangoDBClient\Document::ENTRY_KEY - '_key' - - Document key index - - - - - ENTRY_REV - \ArangoDBClient\Document::ENTRY_REV - '_rev' - - Revision id index - - - - - ENTRY_ISNEW - \ArangoDBClient\Document::ENTRY_ISNEW - '_isNew' - - isNew id index - - - - - ENTRY_HIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES - '_hiddenAttributes' - - hidden attribute index - - - - - ENTRY_IGNOREHIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES - '_ignoreHiddenAttributes' - - hidden attribute index - - - - - OPTION_WAIT_FOR_SYNC - \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC - 'waitForSync' - - waitForSync option index - - - - - OPTION_POLICY - \ArangoDBClient\Document::OPTION_POLICY - 'policy' - - policy option index - - - - - OPTION_KEEPNULL - \ArangoDBClient\Document::OPTION_KEEPNULL - 'keepNull' - - keepNull option index - - - - - $_id - \ArangoDBClient\Document::_id - - - The document id (might be NULL for new documents) + + $_cursorOptions + \ArangoDBClient\BatchPart::_cursorOptions + array() + + An array of BatchPartCursor options - - string + + array - - $_key - \ArangoDBClient\Document::_key + + $_id + \ArangoDBClient\BatchPart::_id - - The document key (might be NULL for new documents) + + An array of BatchPartCursor options - - string + + array - - $_rev - \ArangoDBClient\Document::_rev + + $_type + \ArangoDBClient\BatchPart::_type - - The document revision (might be NULL for new documents) + + An array of BatchPartCursor options - - mixed + + array - - $_values - \ArangoDBClient\Document::_values + + $_request + \ArangoDBClient\BatchPart::_request array() - - The document attributes (names/values) + + An array of BatchPartCursor options - + array - - $_changed - \ArangoDBClient\Document::_changed - false - - Flag to indicate whether document was changed locally + + $_response + \ArangoDBClient\BatchPart::_response + array() + + An array of BatchPartCursor options - - boolean + + \ArangoDBClient\HttpResponse - - $_isNew - \ArangoDBClient\Document::_isNew - true - - Flag to indicate whether document is a new document (never been saved to the server) - - - boolean - - - - - $_doValidate - \ArangoDBClient\Document::_doValidate - false - - Flag to indicate whether validation of document values should be performed -This can be turned on, but has a performance penalty + + $_batch + \ArangoDBClient\BatchPart::_batch + + + The batch that this instance is part of - - boolean + + \ArangoDBClient\Batch - - $_hiddenAttributes - \ArangoDBClient\Document::_hiddenAttributes - array() - - An array, that defines which attributes should be treated as hidden. + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + - - array + + string - - $_ignoreHiddenAttributes - \ArangoDBClient\Document::_ignoreHiddenAttributes - false - - Flag to indicate whether hidden attributes should be ignored or included in returned data-sets + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - - boolean + + string - + __construct - \ArangoDBClient\Document::__construct() - - Constructs an empty document + \ArangoDBClient\BatchPart::__construct() + + Constructor - - array + + \ArangoDBClient\Batch - - - $options - null - array - - \ArangoDBClient\Document - - - createFromArray - \ArangoDBClient\Document::createFromArray() - - Factory method to construct a new document using the values passed to populate it - - - \ArangoDBClient\ClientException + + mixed - - array + + mixed - - array + + mixed - - \ArangoDBClient\Document - \ArangoDBClient\Edge - \ArangoDBClient\Graph + + mixed + + + mixed - $values + $batch - array + \ArangoDBClient\Batch - $options - array() - array + $id + + mixed + + + $type + + mixed + + + $request + + mixed + + + $response + + mixed - \ArangoDBClient\Document - - - __clone - \ArangoDBClient\Document::__clone() - - Clone a document - Returns the clone - - - void - - - \ArangoDBClient\Document - - - __toString - \ArangoDBClient\Document::__toString() - - Get a string representation of the document. - It will not output hidden attributes. - -Returns the document as JSON-encoded string - - - string - - - \ArangoDBClient\Document - - - toJson - \ArangoDBClient\Document::toJson() - - Returns the document as JSON-encoded string - - - array - - - string - - $options - array() - array + + mixed - \ArangoDBClient\Document - - toSerialized - \ArangoDBClient\Document::toSerialized() - - Returns the document as a serialized string + + setBatch + \ArangoDBClient\BatchPart::setBatch() + + Sets the id for the current batch part. - - array + + \ArangoDBClient\Batch - - string + + \ArangoDBClient\BatchPart - $options - array() - array + $batch + + \ArangoDBClient\Batch - \ArangoDBClient\Document - - filterHiddenAttributes - \ArangoDBClient\Document::filterHiddenAttributes() - - Returns the attributes with the hidden ones removed + + setId + \ArangoDBClient\BatchPart::setId() + + Sets the id for the current batch part. - - array - - - array + + mixed - - array + + \ArangoDBClient\BatchPart - $attributes + $id - array - - - $_hiddenAttributes - array() - array + mixed - \ArangoDBClient\Document - - set - \ArangoDBClient\Document::set() - - Set a document attribute - The key (attribute name) must be a string. -This will validate the value of the attribute and might throw an -exception if the value is invalid. - - \ArangoDBClient\ClientException - - - string + + getId + \ArangoDBClient\BatchPart::getId() + + Gets the id for the current batch part. + + + mixed - + + + + setType + \ArangoDBClient\BatchPart::setType() + + Sets the type for the current batch part. + + mixed - - void + + \ArangoDBClient\BatchPart - $key - - string - - - $value + $type mixed - \ArangoDBClient\Document - - __set - \ArangoDBClient\Document::__set() - - Set a document attribute, magic method - This is a magic method that allows the object to be used without -declaring all document attributes first. -This function is mapped to set() internally. - - \ArangoDBClient\ClientException - - - - string + + getType + \ArangoDBClient\BatchPart::getType() + + Gets the type for the current batch part. + + + mixed - + + + + setRequest + \ArangoDBClient\BatchPart::setRequest() + + Sets the request for the current batch part. + + mixed - - void + + \ArangoDBClient\BatchPart - $key + $request - string + mixed - - $value - - mixed - - \ArangoDBClient\Document - - get - \ArangoDBClient\Document::get() - - Get a document attribute + + getRequest + \ArangoDBClient\BatchPart::getRequest() + + Gets the request for the current batch part. - - string + + array - + + + + setResponse + \ArangoDBClient\BatchPart::setResponse() + + Sets the response for the current batch part. + + mixed + + \ArangoDBClient\BatchPart + - $key + $response - string + mixed - \ArangoDBClient\Document - - __get - \ArangoDBClient\Document::__get() - - Get a document attribute, magic method - This function is mapped to get() internally. - - - string + + getResponse + \ArangoDBClient\BatchPart::getResponse() + + Gets the response for the current batch part. + + + \ArangoDBClient\HttpResponse + + + + + getHttpCode + \ArangoDBClient\BatchPart::getHttpCode() + + Gets the HttpCode for the current batch part. + + + integer + + + + + getProcessedResponse + \ArangoDBClient\BatchPart::getProcessedResponse() + + Get the batch part identified by the array key (0. + ..n) or its id (if it was set with nextBatchPartId($id) ) + + \ArangoDBClient\ClientException - + mixed - - $key - - string - - \ArangoDBClient\Document - - __isset - \ArangoDBClient\Document::__isset() - - Is triggered by calling isset() or empty() on inaccessible properties. + + getCursorOptions + \ArangoDBClient\BatchPart::getCursorOptions() + + Return an array of cursor options + + + array + + + + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use - + string - - boolean + + \ArangoDBClient\DocumentClassable - $key + $class string - \ArangoDBClient\Document + \ArangoDBClient\DocumentClassable - - __unset - \ArangoDBClient\Document::__unset() - - Magic method to unset an attribute. - Caution!!! This works only on the first array level. -The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. - - + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable + - $key + $class - + string - \ArangoDBClient\Document + \ArangoDBClient\DocumentClassable - - getAll - \ArangoDBClient\Document::getAll() - - Get all document attributes + + eJzdWltzGjcUfudXqDPMsHgIbl6dksbBJHFnknpsHtIShhG7AhQvu1TS2qGN/3uPLiu0dwNpnck+JFntuXznfOfoRn75dbPatFqnJyctdILOGY6W8cVrdPXuCvkhJZE4Q3Ms/NUGMwESUujVBvu3eEms9FAJqk84EauYIfQGPt2i93hLmBrnNPIJQuh5/7m2ctpqRXhNONjKG3ph4Vyx+I4GhGsISGJAiyTyBY0jHFKxzSNCZZhS36l3cN3yQ8w5ei3NXsnI/mnJ78qtfE7Q5XoTg7f2LIj9ZA2mhkoj513Jnqq/E07QhSuL5yGBUPKGzyOEGcNbFC92/ocJ45C2eCNtcyOaary6w8zotGfzVIVnvG8YvcOCgICvTP2uLaEBmkyfAAQNnsCp2G6eIuGM/JUQLr5xqt8JsbmG9oDP2on+ZyUGI1kBYrwipofECgv4g3JEIy6w7Az4t+qseFEGRGFO81DhXn0rcTsETIIlvohZ3jR4xOvUuIYGj7A44/ln4oueg1dhnJMwjpYciThnaU2/kAC1aYD0IyOGF0j6zqa00Efj9wmXhlASUWAO4ShA9zSUIxtoW7AiYqXECbsjDPKk3vw4EtDaz8DoiuCAsHIAsggtAPViIJgyAf8q+TIEFFAuaLRMKF8pmYAuFoSBl1RaWwAEMQOPUoURkbAI0DAG+YFXnoSC98vBpFYUmPQFGAGfVQqmjrSCeanTMCWMTC3jsJdWNQrpLejiiAr6NzFM+jgqJtogO7UOV8BJSFg/WzSnur42yTykvp2J0Wzmp2Xm6UrqyTroaS56Ngu9XXg9i7urTOrZXz7tFC900gKHHCYU+8mGOtAdPVsTtiReOi4dArXPXi6J6W8zCXvd7ouWNUMXyKMQvbCKk052kelMu10HkvKtLYNWZompM7ED/rBzTr4Ihn3hYB59HF/PLt/MRh8vb8Y3jtbOpWpSk9pSgcvAg4SXfhoDBZ4iovTztabGSzmqENKseZa/olh22Zvo/J+djT6Mr/+Y3Zx/uBxf/jmaAnOWYG3ioThp3RDBVVlCpy9gklbNnzDVls480jyh5SVM6+42HWlZl1V1Pu/5OjVha0AD49EpM+NMyf03odoZ99g4TflURAjQBtLLvrG9PSw2Y1sFVwt8qYDnUbvQFPjm3Ksp/tDsS+Vj8+/0aAUHCuJAezuYh33j3IcJFUIDFxp8ExvpKnkoIUb/WE4KE2MFM7vNZyp5MD8HRG4cqNWwiaI0ogaWbBTNRJnNwuFMZbbUR1BVWJ4qybK7dCt7BF37x288uGeLZtpMdI28pfE0AZfeh3FwCHAa1bMBeFPrDXgzkanXnWJdCLnTBCwugJwuKBTUfKs+6sPeLdki7+d+vx91Ye+OKMQO65AHmz8q0D3msnDg1CFWKII9ma01sxSibj4BYsXie470rcboi0/URqd0rkTtjbLUlKkrFvtEbsMrKc5ffgws25lxZzM2I8GS5IXtmFPrbbcXSijZ2eSQJci2507j+e2xj8FQZ0EZF52zzBfl6zOHiN3H6T/l9zcQcH2mj9yr/2Q269LIpEMYixnsrtHXryg7hAYDc2TIo7M47AHCBVJ1ZiiicW3Ahp/yD+Re+s0fVDLyNs+uzyx/Z2c+I3CQf8Pi9bms3jTYVKozdQ5MRT8PiID/qqDLAFQAfiiMzAHY7YsSriFfFt1jGH805ceStA9BR5BTS0hl1hpT9kSNYW9tBka3kAR9kLu8mDaVuTkr5AX2Ky05Y/1wZWWn4W9aUrWp+l7KaQQgn6KG+A9WRJOS1MEujmC1QNtUv9PXd2nGRxdvRzdTBJuedoAFrqQt9TiZNtartFO/Ju3FlR+HIVEbo1rCHs2TU0lDa7qi7fZptkfg/F5azo37f2w8fQ2Yy47+hMOwdHy+LUtmodUO7LRCo9W4yt4rF+500eBl+Qa8fnvmpjci90iD9zI3iDqqOIo0ZV63V1pGhy0RjKzju/r19JDOmpQWk/EW6GzpMk6Hpr1yFbqMYBLLqKRD04JGSRGXRC6fzEBAFjgJRTEJ6mSnicke7rzOME7CAEWxAG1B2JpGzrFfToHqTq3faSbjoXjL0HhgvzaXO87vl37tz5bubRB6ttPKimd/O3QPpLmuqr9vyNz32xgezC/7MxxSzD17roa5Vw73UOeTYBQvScQ/mf8pMP9kpWQi/wUUOgYo + + + + ArangoDB PHP client: foxx upload + + + + + + + \ArangoDBClient\Handler + FoxxHandler + \ArangoDBClient\FoxxHandler + + A class for uploading Foxx application zips to a database + + + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object - - mixed + + \ArangoDBClient\Connection - - array + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string - - $options - array() - mixed - - \ArangoDBClient\Document - - - getAllForInsertUpdate - \ArangoDBClient\Document::getAllForInsertUpdate() - - Get all document attributes for insertion/update + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - - mixed + + string - \ArangoDBClient\Document - - - getAllAsObject - \ArangoDBClient\Document::getAllAsObject() - - Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class + + + installFoxxZip + \ArangoDBClient\FoxxHandler::installFoxxZip() + + Upload and install a foxx app. - - mixed + + \ArangoDBClient\ClientException - - mixed + + string + + + string + + + array + + + array + + + $localZip + + string + + + $mountPoint + + string + $options array() - mixed + array - \ArangoDBClient\Document - - setHiddenAttributes - \ArangoDBClient\Document::setHiddenAttributes() - - Set the hidden attributes -$cursor + + removeFoxxApp + \ArangoDBClient\FoxxHandler::removeFoxxApp() + + Remove a foxx-app. - + + \ArangoDBClient\ClientException + + + string + + array - - void + + array + - $attributes + $mountPoint + string + + + $options + array() array - \ArangoDBClient\Document - - getHiddenAttributes - \ArangoDBClient\Document::getHiddenAttributes() - - Get the hidden attributes + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler - - array + + \ArangoDBClient\Connection - \ArangoDBClient\Document + + $connection + + \ArangoDBClient\Connection + + \ArangoDBClient\Handler - - isIgnoreHiddenAttributes - \ArangoDBClient\Document::isIgnoreHiddenAttributes() - - + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object - - boolean + + \ArangoDBClient\Connection - \ArangoDBClient\Document + \ArangoDBClient\Handler - - setIgnoreHiddenAttributes - \ArangoDBClient\Document::setIgnoreHiddenAttributes() - - + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection - - boolean + + + mixed + + + \ArangoDBClient\ClientException - $ignoreHiddenAttributes + $optionName - boolean + - \ArangoDBClient\Document + \ArangoDBClient\Handler - - setChanged - \ArangoDBClient\Document::setChanged() - - Set the changed flag - - - boolean + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array - - boolean + + string + + + \ArangoDBClient\ClientException - $value + $body - boolean + array - \ArangoDBClient\Document + \ArangoDBClient\Handler - - getChanged - \ArangoDBClient\Document::getChanged() - - Get the changed flag - - - boolean + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array + + + array + + + array + + + array - \ArangoDBClient\Document + + $options + + array + + + $body + + array + + + $includeArray + array() + array + + \ArangoDBClient\Handler - - setIsNew - \ArangoDBClient\Document::setIsNew() - - Set the isNew flag + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name - - boolean + + \ArangoDBClient\ClientException - - void + + mixed + + + string - $isNew + $value - boolean + mixed - \ArangoDBClient\Document + \ArangoDBClient\Handler - - getIsNew - \ArangoDBClient\Document::getIsNew() - - Get the isNew flag + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation - - boolean + + array + + + mixed - \ArangoDBClient\Document + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler - - setInternalId - \ArangoDBClient\Document::setInternalId() - - Set the internal document id - This will throw if the id of an existing document gets updated to some other id - - \ArangoDBClient\ClientException - - + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + string - - void + + \ArangoDBClient\DocumentClassable - $id + $class string - \ArangoDBClient\Document + \ArangoDBClient\DocumentClassable - - setInternalKey - \ArangoDBClient\Document::setInternalKey() - - Set the internal document key - This will throw if the key of an existing document gets updated to some other key - - \ArangoDBClient\ClientException - - + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + string - - void + + \ArangoDBClient\DocumentClassable - $key + $class string - \ArangoDBClient\Document + \ArangoDBClient\DocumentClassable - - getInternalId - \ArangoDBClient\Document::getInternalId() - - Get the internal document id (if already known) - Document ids are generated on the server only. Document ids consist of collection id and -document id, in the format collectionId/documentId - - string + + eJzlVlFP20gQfs+vmFapbCMnob3qHgLh4KCUnqCNoNFVByja2OtkW2d3tbsuoVX++82sjUkMSDnUt9uXON6Zb775dma8u3/omW61eltbLdiCA8PkVB39CcOTISS54NL1IVOLBRQ6VyxFGzLb1yz5xqYcoPY49MZ+kxVupgzuwWc1h3M+ldzALr6bM9s1/u9+NukYbjkzyayb8j3vlyh9a8R05uCwfnqz/fr3GJwRGE1aeD+fnMS4nStEieE9N3Mmb9G712pJNucWifEGp5377DAlZi0mZKp8hJzCMaXHtM5FwpxQEn4IbcEpYJAyxybM8o3StkImtAXwW/e1p1RGI/wTJtMcVeALx2Vqofrf+tkie0+P1haMPC3AbRDSOpbnSCOrGHYrqzvjfTcz6sZCSeLdIuGaEmhaaWbYHCyKiNm2c5Ww/B+hca8DbsZBMzejdOnZb/p4HYxHSnToiMR3ThalZr2K2BP4c1VIN1RCugrfv+ho/4aUp3cIHsO8sA4mfCok3AjkwCDoBQ1UZgy7BWgrn5kFz5pQssIVhkNh8TyaCRuOe7LyLUlYbr6j/lhzGmEeeFwUWuOe/ZsZiVnYEOv/7Kg7koXl6bHCKsuHxIc7bqLKq+d/dTHBwkE6MvHFU4lDh44ih7Xc8aoyccWtTmsAl9clblkRtEQG4YtM5HzMF8I6e48VRStmtHwdgOQ3zVIIXxKRDh33z9p9CaniFqRy4JEhJD0xEAgLhTScpWyS86j7Mtqpwyxb9aMzt434ba0QhtbAA42n3I0TJbHY13jvrHvdnQZ6td1M2M4e+h0qKbnXMow6ewQcjkxu+/3R+el4NDz9dHAUlwERbg2PBKsxPdaJc/pQpTyMYBfebm83dduYRbFK4vjTly/jDx8vPh+cnsbw1So55jKhMJcBFvYHmakABnuwzuUvS1iXAelDoyq4jiHwJVEa31fHddQQ6vnJ0aq64TE2D8MsWw9ePV1cQV1cd7MqY5hdGjSAG6CbAJaj5hG8JeCUTmYQXviOrn2hzTfvinYpwhl2PI6PMFqr8xXGK4P5nM8VTkFWD8dfMoz/58PSeFHp0A80zsr/OCAfmUPP6+XRxye6ebP2fF5rbtyWG3eP1VhULiu7CAf5elNCSIz68CqNghie4hs9r9W8BI2mgsFgAAH5CrwX0dcmQw2xmR8RY4OkzugAoOyMV+XXi6oQjbvB2se1eTzLXzcU8Cj8nW7McsFsuHKz6/f9Bo70q7vL6lV1R5xcrdjRKPsXC/JtTg== + + + + ArangoDB PHP client: connection + + + + + + + + Connection + \ArangoDBClient\Connection + + Provides access to the ArangoDB server + As all access is done using HTTP, we do not need to establish a +persistent connection and keep its state.<br> +Instead, connections are established on the fly for each request +and are destroyed afterwards.<br> + + + + + $_options + \ArangoDBClient\Connection::_options + + + Connection options + + + array - \ArangoDBClient\Document - - - getInternalKey - \ArangoDBClient\Document::getInternalKey() - - Get the internal document key (if already known) + + + $_httpHeader + \ArangoDBClient\Connection::_httpHeader + '' + + Pre-assembled HTTP headers string for connection +This is pre-calculated when connection options are set/changed, to avoid +calculation of the same HTTP header values in each request done via the +connection - + string - \ArangoDBClient\Document - - - getHandle - \ArangoDBClient\Document::getHandle() - - Convenience function to get the document handle (if already known) - is an alias to getInternalId() - Document handles are generated on the server only. Document handles consist of collection id and -document id, in the format collectionId/documentId - + + + $_baseUrl + \ArangoDBClient\Connection::_baseUrl + '' + + Pre-assembled base URL for the current database +This is pre-calculated when connection options are set/changed, to avoid +calculation of the same base URL in each request done via the +connection + + string - \ArangoDBClient\Document - - - getId - \ArangoDBClient\Document::getId() - - Get the document id (or document handle) if already known. - It is a string and consists of the collection's name and the document key (_key attribute) separated by /. -Example: (collectionname/documentId) - -The document handle is stored in a document's _id attribute. - - mixed + + + $_handle + \ArangoDBClient\Connection::_handle + + + Connection handle, used in case of keep-alive + + + resource - \ArangoDBClient\Document - - - getKey - \ArangoDBClient\Document::getKey() - - Get the document key (if already known). - Alias function for getInternalKey() - - mixed + + + $_useKeepAlive + \ArangoDBClient\Connection::_useKeepAlive + + + Flag if keep-alive connections are used + + + boolean - \ArangoDBClient\Document - - - getCollectionId - \ArangoDBClient\Document::getCollectionId() - - Get the collection id (if already known) - Collection ids are generated on the server only. Collection ids are numeric but might be -bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used - - mixed - - - \ArangoDBClient\Document - - - setRevision - \ArangoDBClient\Document::setRevision() - - Set the document revision - Revision ids are generated on the server only. - -Document ids are strings, even if they look "numeric" -To reliably store a document id elsewhere, a PHP string must be used - - mixed - - - void - - - - $rev - - mixed - - \ArangoDBClient\Document - - - getRevision - \ArangoDBClient\Document::getRevision() - - Get the document revision (if already known) - - - mixed - - - \ArangoDBClient\Document - - - jsonSerialize - \ArangoDBClient\Document::jsonSerialize() - - Get all document attributes -Alias function for getAll() - it's necessary for implementing JsonSerializable interface + + + $_batches + \ArangoDBClient\Connection::_batches + array() + + Batches Array - - mixed - - + array - - $options - array() - mixed - - \ArangoDBClient\Document - - - - - - user - - - string - - - - string - - - - - - - passwd - - - mixed|null - - - - mixed - null + + $_activeBatch + \ArangoDBClient\Connection::_activeBatch + + + $_activeBatch object + + + \ArangoDBClient\Batch - - - - - active - - - mixed|null - - - - mixed - null + + $_captureBatch + \ArangoDBClient\Connection::_captureBatch + false + + $_captureBatch boolean + + + boolean - - - - - extra - - - array|null - - - - array - null + + $_batchRequest + \ArangoDBClient\Connection::_batchRequest + false + + $_batchRequest boolean + + + boolean - - eJyFkM1OwzAQhO9+ir0VIkQFxxSJvwpxQeoFTpHQ1lmloY5trW1oBLw764RWKgXh436zszO+uPQrr9S0KBQUcM1oGze/gcX9ArRpycYSQmsbQ5ACMdROp06mIs76K496jQ0B7FZvh60BYoorx8LgTuAaHrAnHohY6rwEcHZ6LpOpUhY7CmJHP5xmu3BPaBKBW76QjsDkmYJwCQe4zfj4a0Z2njj2ECJndX65zD7s2g3VHzYZAx5DeKv/xKhj+0r7GJmxHzFtIuP/n3P4BdrI3bGCeJCtA8y3Vd6V+lSj4hlNi+Eo68pymJzApJJqcsqG6vvUssqCyfFMfQHFdZsR - - - - ArangoDB PHP client: bind variables - - - - - - - - BindVars - \ArangoDBClient\BindVars - - A simple container for bind variables - This container also handles validation of the bind values.<br> -<br> - - - - - $_values - \ArangoDBClient\BindVars::_values - array() - - Current bind values + + $_database + \ArangoDBClient\Connection::_database + '' + + $_database string - - array + + string - - getAll - \ArangoDBClient\BindVars::getAll() - - Get all registered bind variables + + __construct + \ArangoDBClient\Connection::__construct() + + Set up the connection object, validate the options provided - + + \ArangoDBClient\Exception + + array + + $options + + array + - - getCount - \ArangoDBClient\BindVars::getCount() - - Get the number of bind variables registered + + __destruct + \ArangoDBClient\Connection::__destruct() + + Close existing connection handle if a keep-alive connection was used - - integer + + void - - set - \ArangoDBClient\BindVars::set() - - Set the value of a single bind variable or set all bind variables at once - This will also validate the bind values. - -Allowed value types for bind parameters are string, int, -double, bool and array. Arrays must not contain any other -than these types. - + + setOption + \ArangoDBClient\Connection::setOption() + + Set an option set for the connection + + \ArangoDBClient\ClientException - + string - integer - array - + string - - void - $name - string|integer|array + string $value - null + string - - get - \ArangoDBClient\BindVars::get() - - Get the value of a bind variable with a specific name + + getOptions + \ArangoDBClient\Connection::getOptions() + + Get the options set for the connection - - string - - - mixed + + \ArangoDBClient\ConnectionOptions - - $name + + + getOption + \ArangoDBClient\Connection::getOption() + + Get an option set for the connection + + + \ArangoDBClient\ClientException + + + string + + + mixed + + + + $name string - - eJylVlFP2zAQfs+vuEmVaKsWGI8tMKCbQHsZGhMvgCo3vSYWrh3ZDqVa+993dhzapA1sml8CuTvf9919d+nplyzNouio242gC5eayUR9vYLbm1uIBUdpBzDhcgovTHM2EWjIzXleZCx+ZgkCvAWNvL83stymSpMNvjMJdxZxzqT0plhlS82T1MLo7a+T488nPbCUIUFp4Ho+uemRWahEYg+uUVP0kqKPokiyORrKjbW0ww0HMHyeCYRYScu4RA0zwrKXxa+Umy0/JoyClMkpeZCv4FNmuZKgZmBTLK8QOZrD04k+dzeE58clMVzGzgRwfHjiucSCGQNXdOk90yb6HTmjJ+FOF0a51hS9nTaYSo8L4gNMa7YMb478M9P8hVmE1riIgjN4eKIC1e6/RkuMBWhMuLGocbpTpGo2jTbXskgI/fCk2vzNJQFZPhE8hlkuY1/YBO2lEO2ONxYFcCckallqT/88sBh683ovDdcdmc8n1EPCUwWwBa2BEKci9/8hvpHLSOXSNrGJvbHKqdNE6i6Q8m6+xqRqmQisggMStgltrKFmFhQprkbZC37Byd1rPWgcd+RdC6MmqQUGK9hlRgnehipjmoaSCkRJNYKhOZZJz1W1V8ZPFRWLRnmiFGWmGK+dQ5oTehiY58aCVLYcRXIhYREmXV5gaSodSBOy1wFe2FSrhYFi4L69xpi5ptS9PNSAcEUAV4WGW26rgNOAe9YVAD9+EqAg9wW36Z5y780Am9MqKtcPFdxZSA3KfFH8fdFR89sefa9McUZCFqKuQT6DNjdjz6EI6HS2zO4QJmRxCoUZmAk31v3cuXeG+0I8Sg8GpY7aIWRYiVhX/qtOAOH1+TYRa0BBba4mDfi5DHQ7sFoBvSgK3cBoN9tDuwjoFEmfXHZvGf4vxX2g3fG6BImLujTbB1cVkfmim1TlgjZoOUVuvonzQWNB1x8sxa39UdV0oWMwGcZ8Ropy6d+bljAjDSPSIN85f6Wl0d+g2BfUuE1DV/co+ZPX8fgZl2N8pd1s3magul3rggiw3IBs6S16/7vzUEil3NTk7j/cY9IDM+3y8z0Y+Lc9OHgsf8c8hl8Bk8fSyfXxDz43w2I= - - - - ArangoDB PHP client: collection handler - - - - - - - \ArangoDBClient\Handler - CollectionHandler - \ArangoDBClient\CollectionHandler - - Provides management of collections - The collection handler fetches collection data from the server and -creates collections on the server. - - - - - - ENTRY_DOCUMENTS - \ArangoDBClient\CollectionHandler::ENTRY_DOCUMENTS - 'documents' - - documents array index + + get + \ArangoDBClient\Connection::get() + + Issue an HTTP GET request + + \ArangoDBClient\Exception + + + string + + + array + + + \ArangoDBClient\HttpResponse + - - - OPTION_COLLECTION - \ArangoDBClient\CollectionHandler::OPTION_COLLECTION - 'collection' - - collection parameter + + $url + + string + + + $customHeaders + array() + array + + + + post + \ArangoDBClient\Connection::post() + + Issue an HTTP POST request with the data provided + + \ArangoDBClient\Exception + + + string + + + string + + + array + + + \ArangoDBClient\HttpResponse + - - - OPTION_EXAMPLE - \ArangoDBClient\CollectionHandler::OPTION_EXAMPLE - 'example' - - example parameter + + $url + + string + + + $data + + string + + + $customHeaders + array() + array + + + + put + \ArangoDBClient\Connection::put() + + Issue an HTTP PUT request with the data provided + + \ArangoDBClient\Exception + + + string + + + string + + + array + + + \ArangoDBClient\HttpResponse + - - - OPTION_NEW_VALUE - \ArangoDBClient\CollectionHandler::OPTION_NEW_VALUE - 'newValue' - - example parameter + + $url + + string + + + $data + + string + + + $customHeaders + array() + array + + + + head + \ArangoDBClient\Connection::head() + + Issue an HTTP Head request with the data provided + + \ArangoDBClient\Exception + + + string + + + array + + + \ArangoDBClient\HttpResponse + - - - OPTION_CREATE_COLLECTION - \ArangoDBClient\CollectionHandler::OPTION_CREATE_COLLECTION - 'createCollection' - - example parameter + + $url + + string + + + $customHeaders + array() + array + + + + patch + \ArangoDBClient\Connection::patch() + + Issue an HTTP PATCH request with the data provided + + \ArangoDBClient\Exception + + + string + + + string + + + array + + + \ArangoDBClient\HttpResponse + - - - OPTION_ATTRIBUTE - \ArangoDBClient\CollectionHandler::OPTION_ATTRIBUTE - 'attribute' - - attribute parameter - - - - - OPTION_KEYS - \ArangoDBClient\CollectionHandler::OPTION_KEYS - 'keys' - - keys parameter + + $url + + string + + + $data + + string + + + $customHeaders + array() + array + + + + delete + \ArangoDBClient\Connection::delete() + + Issue an HTTP DELETE request with the data provided + + \ArangoDBClient\Exception + + + string + + + array + + + string + + + \ArangoDBClient\HttpResponse + - - - OPTION_LEFT - \ArangoDBClient\CollectionHandler::OPTION_LEFT - 'left' - - left parameter + + $url + + string + + + $customHeaders + array() + array + + + $data + '' + string + + + + handleFailover + \ArangoDBClient\Connection::handleFailover() + + Execute the specified callback, and try again if it fails because +the target server is not available. In this case, try again with failing +over to an alternative server (the new leader) until the maximum number +of failover attempts have been made + + \ArangoDBClient\Exception + + + mixed + + + \ArangoDBClient\HttpResponse + - - - OPTION_RIGHT - \ArangoDBClient\CollectionHandler::OPTION_RIGHT - 'right' - - right parameter + + $cb + + mixed + + + + updateHttpHeader + \ArangoDBClient\Connection::updateHttpHeader() + + Recalculate the static HTTP header string used for all HTTP requests in this connection - - - OPTION_CLOSED - \ArangoDBClient\CollectionHandler::OPTION_CLOSED - 'closed' - - closed parameter - + + + getHandle + \ArangoDBClient\Connection::getHandle() + + Get a connection handle + If keep-alive connections are used, the handle will be stored and re-used + + \ArangoDBClient\ClientException + + + \ArangoDBClient\ConnectException + + + resource + - - - OPTION_LATITUDE - \ArangoDBClient\CollectionHandler::OPTION_LATITUDE - 'latitude' - - latitude parameter + + + closeHandle + \ArangoDBClient\Connection::closeHandle() + + Close an existing connection handle + + void + - - - OPTION_LONGITUDE - \ArangoDBClient\CollectionHandler::OPTION_LONGITUDE - 'longitude' - - longitude parameter - + + + executeRequest + \ArangoDBClient\Connection::executeRequest() + + Execute an HTTP request and return the results + This function will throw if no connection to the server can be established or if +there is a problem during data exchange with the server. + +will restore it. + + \ArangoDBClient\Exception + + + string + + + string + + + string + + + array + + + \ArangoDBClient\HttpResponse + - - - OPTION_DISTANCE - \ArangoDBClient\CollectionHandler::OPTION_DISTANCE - 'distance' - - distance parameter + + $method + + string + + + $url + + string + + + $data + + string + + + $customHeaders + array() + array + + + + parseResponse + \ArangoDBClient\Connection::parseResponse() + + Parse the response return the body values as an assoc array + + \ArangoDBClient\Exception + + + \ArangoDBClient\HttpResponse + + + \ArangoDBClient\HttpResponse + - - - OPTION_RADIUS - \ArangoDBClient\CollectionHandler::OPTION_RADIUS - 'radius' - - radius parameter + + $response + + \ArangoDBClient\HttpResponse + + + + stopCaptureBatch + \ArangoDBClient\Connection::stopCaptureBatch() + + Stop capturing commands + + \ArangoDBClient\Batch + - - - OPTION_SKIP - \ArangoDBClient\CollectionHandler::OPTION_SKIP - 'skip' - - skip parameter + + + setActiveBatch + \ArangoDBClient\Connection::setActiveBatch() + + Sets the active Batch for this connection + + \ArangoDBClient\Batch + + + \ArangoDBClient\Batch + - - - OPTION_INDEX - \ArangoDBClient\CollectionHandler::OPTION_INDEX - 'index' - - index parameter + + $batch + + \ArangoDBClient\Batch + + + + getActiveBatch + \ArangoDBClient\Connection::getActiveBatch() + + returns the active batch + + \ArangoDBClient\Batch + - - - OPTION_LIMIT - \ArangoDBClient\CollectionHandler::OPTION_LIMIT - 'limit' - - limit parameter - - - - - OPTION_FIELDS - \ArangoDBClient\CollectionHandler::OPTION_FIELDS - 'fields' - - fields + + + setCaptureBatch + \ArangoDBClient\Connection::setCaptureBatch() + + Sets the batch capture state (true, if capturing) + + boolean + - - - OPTION_UNIQUE - \ArangoDBClient\CollectionHandler::OPTION_UNIQUE - 'unique' - - unique + + $state + + boolean + + + + setBatchRequest + \ArangoDBClient\Connection::setBatchRequest() + + Sets connection into Batch-request mode. This is needed for some operations to act differently when in this mode. + + boolean + - - - OPTION_TYPE - \ArangoDBClient\CollectionHandler::OPTION_TYPE - 'type' - - type + + $state + + boolean + + + + isInBatchCaptureMode + \ArangoDBClient\Connection::isInBatchCaptureMode() + + Returns true if this connection is in Batch-Capture mode + + boolean + - - - OPTION_SIZE - \ArangoDBClient\CollectionHandler::OPTION_SIZE - 'size' - - size option + + + getBatches + \ArangoDBClient\Connection::getBatches() + + returns the active batch - - - OPTION_GEO_INDEX - \ArangoDBClient\CollectionHandler::OPTION_GEO_INDEX - 'geo' - - geo index option + + + doBatch + \ArangoDBClient\Connection::doBatch() + + This is a helper function to executeRequest that captures requests if we're in batch mode + + mixed + + + string + + + mixed + + + \ArangoDBClient\ClientException + - - - OPTION_IGNORE_NULL - \ArangoDBClient\CollectionHandler::OPTION_IGNORE_NULL - 'ignoreNull' - - ignoreNull option - + + $method + + mixed + + + $request + + string + + + + detect_utf + \ArangoDBClient\Connection::detect_utf() + + This function checks that the encoding of a string is utf. + It only checks for printable characters. + + array + + + boolean + - - - OPTION_CONSTRAINT - \ArangoDBClient\CollectionHandler::OPTION_CONSTRAINT - 'constraint' - - constraint option - + + $string + + array + + + + check_encoding + \ArangoDBClient\Connection::check_encoding() + + This function checks that the encoding of the keys and +values of the array are utf-8, recursively. + It will raise an exception if it encounters wrong encoded strings. + + array + + + \ArangoDBClient\ClientException + - - - OPTION_GEOJSON - \ArangoDBClient\CollectionHandler::OPTION_GEOJSON - 'geoJson' - - geoJson option - + + $data + + array + + + + json_encode_wrapper + \ArangoDBClient\Connection::json_encode_wrapper() + + This is a json_encode() wrapper that also checks if the data is utf-8 conform. + internally it calls the check_encoding() method. If that method does not throw +an Exception, this method will happily return the json_encoded data. + + mixed + + + mixed + + + string + + + \ArangoDBClient\ClientException + - - - OPTION_HASH_INDEX - \ArangoDBClient\CollectionHandler::OPTION_HASH_INDEX - 'hash' - - hash index option - + + $data + + mixed + + + $options + 0 + mixed + + + + setDatabase + \ArangoDBClient\Connection::setDatabase() + + Set the database to use with this connection + Sets the database to use with this connection, for example: 'my_database'<br> +Further calls to the database will be addressed to the given database. + + string + - - - OPTION_FULLTEXT_INDEX - \ArangoDBClient\CollectionHandler::OPTION_FULLTEXT_INDEX - 'fulltext' - - fulltext index option + + $database + + string + + + + getDatabase + \ArangoDBClient\Connection::getDatabase() + + Get the database to use with this connection, for example: 'my_database' + + string + - - - OPTION_MIN_LENGTH - \ArangoDBClient\CollectionHandler::OPTION_MIN_LENGTH - 'minLength' - - minLength option + + + test + \ArangoDBClient\Connection::test() + + Test if a connection can be made using the specified connection options, +i.e. endpoint (host/port), username, password + + boolean + - - - OPTION_SKIPLIST_INDEX - \ArangoDBClient\CollectionHandler::OPTION_SKIPLIST_INDEX - 'skiplist' - - skiplist index option - - - - - OPTION_PERSISTENT_INDEX - \ArangoDBClient\CollectionHandler::OPTION_PERSISTENT_INDEX - 'persistent' - - persistent index option - - - - - OPTION_SPARSE - \ArangoDBClient\CollectionHandler::OPTION_SPARSE - 'sparse' - - sparse index option - - - - - OPTION_COUNT - \ArangoDBClient\CollectionHandler::OPTION_COUNT - 'count' - - count option - - - - - OPTION_QUERY - \ArangoDBClient\CollectionHandler::OPTION_QUERY - 'query' - - query option - - - - - OPTION_CHECKSUM - \ArangoDBClient\CollectionHandler::OPTION_CHECKSUM - 'checksum' - - checksum option - - - - - OPTION_REVISION - \ArangoDBClient\CollectionHandler::OPTION_REVISION - 'revision' - - revision option - - - - - OPTION_PROPERTIES - \ArangoDBClient\CollectionHandler::OPTION_PROPERTIES - 'properties' - - properties option - - - - - OPTION_FIGURES - \ArangoDBClient\CollectionHandler::OPTION_FIGURES - 'figures' - - figures option + + + getCurrentEndpoint + \ArangoDBClient\Connection::getCurrentEndpoint() + + Returns the current endpoint we are currently connected to +(or, if no connection has been established yet, the next endpoint +that we will connect to) + + string + - - - OPTION_LOAD - \ArangoDBClient\CollectionHandler::OPTION_LOAD - 'load' - - load option + + + notify + \ArangoDBClient\Connection::notify() + + Calls the notification callback function to inform to make the +client application aware of some failure so it can do something +appropriate (e.g. logging) + + void + - - - OPTION_UNLOAD - \ArangoDBClient\CollectionHandler::OPTION_UNLOAD - 'unload' - - unload option + + $message + + + + + + + Argument $message is missing from the Docblock of notify + + eJztPWtzG7eu3/MrmHN9Kjkjy25uT6fXqXOr2ErsNrE9frS3k2Y0qxVlbbPa1d2HHZ3T/PcDgI/lcsmV5Dz6mKPJTCwtCYAgAAIgyP32fxezxYMHu48ePWCP2CALkpv06Bk7Pz5nYRzxpNhnYZokPCyiNIEm2Oq7RRC+DW44Y7rDIbWlh0FZzNIMnrHvg4RdFpzPgyShR2G6WGbRzaxgh/qvx3tfPu6xIosAYJKzF/PxcQ8ex+lNwnvsBc+g9xJ67z54kARzngNubqF9ouk/z9LbaMJzFoQhz3NWpKyYVc1ZzrNbnslhDKBZHKumUc4macJZmUfJDTu+ujrvsTsOv7EkLVjC+QSh8bwIxnGUz1iAIBY8y6O8ABoMLrEgmbC3nC9YVOQMOhS8/+04e4odThJoHUx6RnOgIuMVYMADIJDqabxkU+AkD8IZy/j/l9AGYSB47ALjLLJ0CR2CacGzuyCb5ArR6mmCYYb4iLG9/mPibxgHwIfDarb/9QAfE2vx88h4xtIF0S6fqAbf3QYZ0JYFS/nLLv2/yKJb4ALbGsluMGMW6POM7wB6Ph/HMCBkP5sBo4C/wMEMpwRZYYqi6Hc1i2juFtA/DOKwjAHRhN3NeGJOicRLfMt5sRvOgCEc5gHmNLhNo4mCp2BQpynNQw5iZ1LEboMY5oJFSW1qhPjcRgF20uBsgmucEiPzsGpWFItjgfCAdTpP6HE728ZBztn1xUviFZIellmGwjkJQLrg4efmmiboE/MK8VxnsWRUi9jCACYx2JUyh+ECUSESCBSjuu4EcXTLXbgznqdlFnLfTBHQJt7ncXDDIhN4Q+2RDhfGcZrGHmzQ5QcAOEB4TZzPgiKcgXAODCVcWzvHsvMBe/2mCXprFADlt5xQsHT8KwzEhYGeezAYEFwIwmBRlJnEgDzggVMY6o9sJDUoB2waxLmDU3K4F1Ii742tBqUFm9LBuiSvL+O6v1vIL3nByoXQekODaZZ6aLKiCcLB50qtF2K1bAhgMcvSu5wN34V84VLHRZAFcyFIbEsB2wF1ioooiB0GpA5ADqyE5S5k0zIRTUcj6AcMKMOiWwe9Te3FYoSfrQKs185TtZaIHw9gib4zNP1MPOxqIE8a/U1Fgv5dC+7rBrD9/bPzq5Oz09Hh2enp8BD/fMMODmA+EM4OAeo0EYHlPJJztwGOo8HV4NngcvhmW861AbFc4Fwe6wWiK5G+b5q+OAWJ4e/AScE1NLQtIZqnwG2g2F2QO+1TxkG7EmbYf9+MkoeCE2pPIWDtOqfhiy9gWRope6vbCGK3tw0Q+PluGuL47GbVDLz3sAWVJVDiiUtbtWJ6FyGpFcKFWqEb0mXZQo+VgWrQ/7DMpGYfuzG5FdBY/G+3dvMYSBeC0yVcPQnFyW8iAsXVL3TD06Pzs5PTK/bbbzVGr9P3+OzyXv3Ozy7u1e/H4cXJ859Hh8P7dT88OT8eXlzep+vg5cuzn0aXw5fPR5cnL06HRxqCLaAkM8Iy1cWm23lVwnKBoQVKnxTEDusrMejDF3LrTY0Ejy3MOLpq/U5Nyn228TUNB4yUBGuYkt1dli94iAab1Ea52DmHCAl+rJnuDUTo6uTV8Oz6yuYEooOBoooV0ZynpRr0PlvQOk0+YwGjm6Pog3I6jFYNIhK0ga3Aj4A/AkJGkgirl9afJ7W+7ytWMw7L+9rMqBYKDz8MyzsFb7Euip51CkZRQHx8B3ZfUisWoQpWTTg2o1gtOx5664FEndDaOmezsSmj6y9iL6TgqAV/PXstl6nGUFvt6Y2yp3ljzZLwLA1ro/mzrTCeBcZmxTx6x9uX7Jv6cmKzACPNrECtE+hlK9NDcXNJ2iHNLJtbJ3kONg/4RWH2i+FVle9wsmhN5pQQEu4QOIhBne4r2wrBDqdzIYKNdIYcDQrpBc8XMBK+in9dxNpT3nENOsVV7WIlzNDzIIpTMMNdBbi7jZ4Yk7DrUG1N3cokpWj1BVT+jodlwWWQ0hU6Fy94tr//anh1fHY0Ah71mIDe6TQwGPPbJBnYmXPFna7Gbuq+V7Pr836OHoTKENxFhVgU0OR8YKhiygMIBOFpSoRqRQh3IOqbLDHRsUi1GH5S2UE8aoKRhE8sQwLFJxAl5K6SJTeWzyVO159Hmq7/iMJU/jVk6fqPIUqI7pPLkk+UPomAYCr7z7lUHQ8HR3+AtWpwdXj8WcwLIVppYBYyZTpZfg7pIWybGRj2B7UwyN4/hI05Gr4cXg0/g5WRiDYzNB6xm/CYF9yUu3vLlAC1yibJSaIk+Ee3TxL4RxEsweXfSbKGgjyRVMEszzTiE9yli8dB+LZHW8hFtmTBTRAlmBuIID4FTuVszMOgrDYKKV8TZBDXyL1zzEFh1iq4hebBOOZ9doLb1ZiagsC/Z4AlCUao1Z4Gw6mg3cOEBXHBsyTA/SAFu4voMFsWE4NgppIiiomIefAumpdzlpTzMe7gS3BTQkBQg6Lg80WRs1kAEMecQ8ALUFZpDAgxB0IRgMoVVM9S/FWJUP1nncV1faqmoLiTMsS92aWI/uUcaLl3ayyF6iAuYyDP2Y2KEcQsb6x4ckup8gXqmgJYt5mlWls5SAFub82jMEsxedYtslqCBxNMD62wH5Xwlr8q4yJaxHyYTBZplBR5t5Gc290VohrNoR0J0j77FROkuE2sijaMz90sgnaCBEeeD2Ww+St+lIqF466V48PPe0CNy2i3OeVbTkRq4BZXYNIkw54eNFIh/tzb88HJy7Mfhxcqh/rGh1KxTCZSM9xax235Ow5KhyUt4zTD5PKdt7ckCjQ5mi67HcFiodkEDTVb5p8llo6DX5rflObe4u4W752/Av1hCuqdlFwZHaSflBfJWHI9MDNr7IRV5jHni+7jPRD/L/f29lxT+8D9zchLAkVgBogKVe6DghQVlSVLTUHcgqUQmonNcv0j0H6hOVh/1iK1W3zBGqKy8xTs7qEo4VDKY4st4MvmQRz9kyhRrfb39c/HEHFi8q0LKOwFR6TQc0xamWS/NoC+cSbSLfFJUjZPM6WpebU4KB6qnCd4DkXqkiRjo8SywR8KvSl9tR/cpgJEYR5kb0nwuOQpC3B1JCQ47w6e4M813sGM4GQ3h+s3Q9oENdYitwUiNSrjCemMZEQfVd9eiAM2iaZTTuVAaimfYj4ij4CVDbjmDu0mluviZHj5hj1le+yLL5y6CtQmuO2CzNqGhvdG4jOOlmwKJS1SEKIgWTaYQGVcSrV9Ns5v35rSpUTHFJsy0Ua1KTZezdPS48QB9DLhBiT8XaHRNeG7LQt28tkUSdZGdsXq7pQnaWqaeuK0MarXn31tBfOlRM1eWrXv+pdcYzd1poDaG4wsNFs+hh0DoFoT8xlZShq+LGVEt1zPAvjq4KmXmUNJN1iem7L/QWs0fv5jjI3PJsb4r2B1QoyV/2N01jM6Lv23/HnEmfEwnc/BMMDPItcgTEyje5ms8I7bnE3AHWMZAKwaKWUYuLaAxXLBc8bzMFhAIJ6lcwo9HtThNPM6F1xXa8uCmaCIwlpxukzQUYEzlhwgdnouE4ukYyJfYxcieNIDzUINOzmgamjMinUzJTY8e2kWMWqDvHHEg5pZ2U9oewV87GqA2+zhgWlgr34+H46uT0/+rxFuNSnuH7Achp4U024H7fE++3v+97zTYzV8x7RJq/H17GG6K15MM7Su6RhcXx2PcACY8tys1/Xl8KJp3UAag8mEieM50T8DvQ1k5Va2ai1+pGq0A6rk//qrEU/CdMK7voBwIwqxxm2/w/ofCux8cHn509GbGhh7FW2f8AYFnYHJAxQFKQ0fSquY0CaUJs+bjSxRs8er/vxAuTNqm30iZFYRO+SnXbcqzFrD7kXcBqqn4FcV9Ae0feAxCsZhkt3RZLw7ypd5weedRk3det2xqLPMYqk5Ni1rFCtTKVmzdNtK+56sPGfSoyVD1n1TLDPGFSTN8ARZgvvbO65y79aqNJ1tVmWY4Cj5KNWgfqkfR/vFTnW0L0dohQnsRlXl9TrPDevMQe4N3iKvFBcDXZELCy38obbBlEzIdgcWfss6ocs04+FbHEG93DcvcJ7o9EYjc/dwytNpd6ul3lW4YgqcDxZ+VEJKkWc+e98klk4VmJOrxitGSc/VJDlyjvY+QYvGXwylzjtdZ6AF4KE3R/1VuaUsq+4JPwf+yTxeW9rRrs++FLHlDGcYhzOxj9bI+e77E4713DK45IYQgWcGP0jxqDKa6BzTppMeU+U2aVkyDZ+Qvop/tqU32b/2qQuPSFk6dNAUF2PELokSrLHtmzij4q74dts68wgKq1kL+a1hNGoSKRuZgzNZcy8TscZhlHp40GBmUsaxbOzf0FXFAqpKQNhtYoaIa/IyLuzyDjrtqVlBll8IPowahNDgtjwvLfMqGHmOraPJmG1RcAvaLgHYVJ8A4jtnk5KiD9qih2iHkixVKYOA27fII4KAclyJWFTYjzescZhz8KQmiss7dXaJh56eVHDDrJ4rCm+M5vRdlvhhjLVuLQ50xVyIeIaRM8ShiEDGcxzYCpZp85IdWwWskgXJKKtAYe1aMFkK7nD2HgrnytgSg1VykC+TsDodaaodKBlh7drVPaSA5LzWHrw2zd/g8ufTQyoJc4U8Jub6RoxhqExw6pjkK+KN4pE5lpI8O9vX69OD+ukaYZmrE8/AX6clrp8fPZA8wqE01k3VpX7A9UAMrmWfrgqv0+kUOHoJTPUvuc+wJOp8cHHVY9Yevwab6eOuJvfGZRRPtHzVUfcccUGPuYWwUSXzsYclOGxvvDl8+t97sO8/hgyQgJ2L8g3Ze5I+ExV8miQ5SAezESmuTaTYFTBfJlOt+7rhBnvx7WGV95i13XRzsXBK+u858R8yFFu61XkbATcLQv68JJO4vhd+dTE4HL55YtkvBcoRLmG9EqMGGa1AXjFejXt4ejw4PRweSSJccgfOCUzFTBaN1aeLyujwh1c8z4MbqqSjudPT0TDymlkzvQA2IYpHGqvLSCn+dDHAuMJvWmwk5NeP37jFY3tt61Rh6eQQ4nS8uvzeKRAwV+mCC+8xT8O3nKoHCr4vYqc53dGjvUUrBAIHEUOtuo/oCFjkZBuRux2VyKZoYtDWOE8fgqtLPhb6vDe0iSCrMrEwzmUoffKpxp3ES/QwShj5MieJhX5qtyBybKXTDtBVhIco/YVwksO1jsIvt+QI6EvyKRbc6cOnlWhqofwc48JhXAVvQQwa49IbXzjs9kHiZkSJyiLkaARzNBK/6YjySXM0osXrDqKcjHA/yhfpg7R1dI0LetoyTFGbTHjxjNhL6jv3gXAzWadZ1I5UMJlEKMtBrDfMitRA4lwO71vmaA6mGgbVb6it7ISMmbPXlrzN56XaYrlHuZiGBSbJD8cuDnGCECeKNRjw1s2v5CzUCPZyQ3HEd1WFt5M727SitevYsb9PtWMnLhhp1DJ0//aCahbUzq2o8bsLokIdqK8C306ubdbfeuyrvW/aqNWY6WC1YKHB4DU2bRWAdTdv3zf50JIfW3/Yvxjj7rjG7fByH7ryVB67MMdCYSE9rvPVxkdlaJzWyGGzVdE/MsAMtLvSoFsuRK8KOC3YmxvxVgeqgvIRnSgadOVNeMXLcGYkN7xNa3wU6790m7Z79gNg7yFukDSePEsnS/i1HYlewbzNtp1PnEXgHldLIKrcrYyHHC9b6Kn1fY2y49pXFSqp4TrTEy0q+NMsTRe5zHLL4qaEi6z1Apw6lYRpphPP0YVVGUMh5UYWkQ6rykvugpzOauSwpteuDtswO2dqj6FaO3UaAFleLhZxVJ2XMIv/P+S8mnmWxk1Mo6phJkUSV0iPrDbcWNXlW/Z4b4/99psB5ekBmL49h2eLBTkQyTO6J6Jx1GGLZsMmQSiFw52i1g+d+5sSnekCYYZ3GqFjzQs6/hMl9RmpkpgmSar1Afs1T5PRhIutTWysI2kXaunlNyrpzRFU6UCJxUwEyp9ed3iWpdlpOe+0V3G5OlCy5Muv/ucf2+ahRAe12AaGKOqD8lm0wKLBOOaY0gaFS5ObVJ9scnzW8B2+s+iTIWoHgkLjETK3Y1camZ91F/x7senrNdj0NY6Q/IG4WQ9gNTfbVQWe4AaTHFaHv/x8jbXfWlMJ4Rcpt7V+p4x34Oqgmd8zlWSLYMGoWFxBZZ1SR82nxu2nkGDYvjkELNo1Xw+E92HrStccxMY15BrP/cj788YEH0mvPTHAykn/iAHAhhZZD7Qt9F3ynApbsdhbdnf7WjajxZZ8xWY/l9dkssXgI9GpGmd7AbKfvb4EN34amVK1HOdVwYGwa1icKkrek6UsIP3H3n9XazNaUrGiTrBA+LZeilH3R9CYQ2df2T1PeAb+EpIQhZyVSVWRkNX8q7bpaepBxwEQ3GUkxHcEzMfWZhFKkmqvZZqWCZU3katMFraqtX3QROIUptpickEOPQUjiofu+jK3D++4cbJIwX+gPRthyeZzmDrfrq7Y1dlhF/RV1K+Iq3PZuHn7rudqSMB4aGwSect2W67LNUcoW9du8JVjbQyWFzWaBWiRFXAVHlvBgmgudpCACRraDcBKJAMwLiHgrRw0edbOLF4MqoF1BW4fw8xrkNWW2GYMs/iVeab544ztpj62FffabTS/Yi6kAImr7sX51h6Vsilx33bPs7xXWWSOOQUOVIGC5NDuggArkMxBBeXelm4UFSydTldNbE0JBK41VUE0bmeDWa+XAGHUd0cXnADVfX3dOibgZVl+nuKFfQueBaJIE+9ECIvKv4yX4jZ2VaxPgNZiY64mp1b6RwxOJS/1NsMc+qE5AkaiXop0LaCeYGQD7m6teX8Vo58ZW7QrGG3t5q5gtDaDKCG0DRXlVqFkJNViR842McyjP83L1a2xRPlJQtAksFcU7LfrjSk63oGsUHSv/spb3VfRIO9v96JXchiwGe1BuW6TUJNSzIJCqWBuHB7BvEEHC7USQzHdgikusahKsnaAAC5rsNRrApSidOkGQrw7rt/ve+yFqrxSfQQ89Q1Lr/AAX+4sfyM3y0e+UUZHxWxxEPJZGmPYIy9QV7DEWzOME0VyBoQ6U1vBOUDJ3y3ga/3qj6r6rSIF/bg6ORG+IIGr6xgIAfiAMMnJDd3d4pFrwW+SlQWWe2CNaSl2/2o4KjfEmDt/dbaz8NtTZOYvLLENgVmVYpQ+sjWrXOre4CN5gb70GURzVRJaw1jbja4ti3YxSa1shr5A8I1p1Ulr2YzhG/4Xvj1GYJWSaeaLPIUyTe+gXr4pBZmETJQ1Q4iDc4m3JisVgQ5lMdWidlKITWHZF9cfOo5BDn44A+UCOc1ya32xtE+WBkoM+mYq3C1FsC22FhcnZborAq+vnu98o1Z0IaIuMyiPuBnXRBWgVSMYXlfS4joGsMj4zWhOE9vZ3S0xRy8b2yGQynv7ygPlc6Nw0WdY15oi/P6WL3NDjVWqXT4VfKZDG8UUOZSBXc5yENR4ac6oKJsNIlU7rYIxcZsT4iwTnFV2l6WAW5w/mcgJsOfammQxs6umuPVkSOskEriR4ktXlLw4pvGhkXugqhjn5DnnDYSc3jgjemK8sAV8ZwdP1RXfFigLnWizKoVON1Phvv94CVYwjsZZkC1NPwKMLow9juURGyxT0BXOFnLVa0TprrzbmY9HUtgVozqtFQVEFCUM5mNFi7OxTOqoO5yBLZTRaeKjZz3WIVXtyNR+vUbVBR8/LdtWZ2iKCKQWSqERMV5qPumznyqBJVuR4HMpuPviknyked20lmPIUgI8g6ann2PYao/NP3DxMoDa0F0X1PsH35rjpc0nebEYuU/KaAph8u1ueOQn5/F0f9+0z/TkLyUuzTEaN/D/CaWj9otXVsSobaO94k0Jq4MQ2jyU5yK3YZlC7yoTyyZwMjV8dr0UCccGmATRH1j4eeVNJ3SbYBzThV3oassguE70tgw/+nhekjDJcET72zRHCiosrHqO5D67bE+rL26zR4DR2Ds3xiTKFT0LrbzgTx0iMdda0dvdXr0CwXwdgqq2qbMTWeDxyQwXThYmStfDgPBBUYEVwBpgR3KWu6oIWg3igO21Hedc42jw8fDwhxFo0Dd4Svj52cWrN96yeLc8k4fxxBJgRQheLenzQsxSIXMS7DH+xr6/xEtBzi4Oh6OzZ98PD6+aL+q4F+gNc9OORJaWQDogDVJI13aIg1ttKVudClynb0+8z/JdgNc8gsGaL/U56I54caUA+rzMaLtDqnFaR6COLgeTCYwslzd76PywaudRPPP4lqC3SXyrNNdec6KPcdvh7dpyq9/zhWGmAvekAUhTuManBsiGtPlrVz50Zlut0KrMl2b1itRXnXOV7jZWH0wV0UvP6nXsKFB4Xax8/6t1cW7jjXY6IRT1eb+6Yao7S/Nid5FmeDUI8CoTL+VaBHl+l2a+vA3GyFgKpbOb9dxtGYacT/LVoXKVzcMEbOMO1+ZVh1UmpHudxSCT1xcvR4OjVyf0dq1LfG2RaZ/Wv5mwGTTXIFh7b5sDsFaf9QHY4lOF/Z57Il1ZaOPFqnrm7ziF7FUKXc4gWScFoZtmveah2xldLAmWyzxouxTH17nrdr9HwnNRN9JVpeSNvGl9wd9xk66AEf1Nqr2q2Sg1twXO/S6gtjL1NSpFzIPj2suja6+iMJDa7LgrOSJ3Ef+aB2/J6Cso4jXXLMC6QwkhuENegFNEaV1VnwceKbmWmOWkJ5SQ1a7iYpGliyyiLTDev+mzOL25cW1+ed+faCdT5WVeW3NR2LB9r/Xl9OyKXpM3ePny2eDwhzcVOMVysPz06udREEdBbpwvAxcJf4dI+Bf1fm7lBo5/qZphmem/AdBMboQ= + + + + ArangoDB PHP client: connection + + + + + + + + + TraceResponse + \ArangoDBClient\TraceResponse + + Class TraceResponse + + + + + + + $_headers + \ArangoDBClient\TraceResponse::_headers + array() + + Stores each header as an array (key => value) element + + array + - - - OPTION_TRUNCATE - \ArangoDBClient\CollectionHandler::OPTION_TRUNCATE - 'truncate' - - truncate option + + + $_httpCode + \ArangoDBClient\TraceResponse::_httpCode + + + The http status code + + integer + - - - OPTION_RENAME - \ArangoDBClient\CollectionHandler::OPTION_RENAME - 'rename' - - rename option + + + $_body + \ArangoDBClient\TraceResponse::_body + + + The raw body of the response + + string + - - - OPTION_EXCLUDE_SYSTEM - \ArangoDBClient\CollectionHandler::OPTION_EXCLUDE_SYSTEM - 'excludeSystem' - - exclude system collections + + + $_type + \ArangoDBClient\TraceResponse::_type + 'response' + + The type of http message + + string + - - - $_connection - \ArangoDBClient\Handler::_connection + + + $_timeTaken + \ArangoDBClient\TraceResponse::_timeTaken - - Connection object + + The time taken to send and receive a response in seconds - - \ArangoDBClient\Connection + + float - - $_documentClass - \ArangoDBClient\Handler::_documentClass - '\ArangoDBClient\Document' - - + + $_httpCodeDefinitions + \ArangoDBClient\TraceResponse::_httpCodeDefinitions + array(100 => 'Continue', 101 => 'Switching Protocols', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Timeout', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Requested Range Not Satisfiable', 417 => 'Expectation Failed', 418 => 'I\'m a teapot', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Timeout', 505 => 'HTTP Version Not Supported') + + Used to look up the definition for an http code - - string + + array - - create - \ArangoDBClient\CollectionHandler::create() - - Creates a new collection on the server - This will add the collection on the server and return its id -The id is mainly returned for backwards compatibility, but you should use the collection name for any reference to the collection. * -This will throw if the collection cannot be created - - \ArangoDBClient\Exception - - - mixed - - + + __construct + \ArangoDBClient\TraceResponse::__construct() + + Set up the response trace + + array - - mixed + + integer + + string + + - $collection + $headers - mixed + array - $options - array() - array + $httpCode + + integer - - - has - \ArangoDBClient\CollectionHandler::has() - - Check if a collection exists - This will call self::get() internally and checks if there -was an exception thrown which represents an 404 request. - - \ArangoDBClient\Exception - - - mixed - - - boolean - - - $collection + $body - mixed + string - - - count - \ArangoDBClient\CollectionHandler::count() - - Get the number of documents in a collection - This will throw if the collection cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed - - - integer - - - $collection + $timeTaken - mixed + - - get - \ArangoDBClient\CollectionHandler::get() - - Get information about a collection - This will throw if the collection cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed - - - \ArangoDBClient\Collection + + getHeaders + \ArangoDBClient\TraceResponse::getHeaders() + + Get an array of the response headers + + + array - - $collection - - mixed - - - getProperties - \ArangoDBClient\CollectionHandler::getProperties() - - Get properties of a collection - This will throw if the collection cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed - - - \ArangoDBClient\Collection + + getHttpCode + \ArangoDBClient\TraceResponse::getHttpCode() + + Get the http response code + + + integer - - $collection - - mixed - - - figures - \ArangoDBClient\CollectionHandler::figures() - - Get figures for a collection - This will throw if the collection cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed + + getHttpCodeDefinition + \ArangoDBClient\TraceResponse::getHttpCodeDefinition() + + Get the http code definition + + + \ArangoDBClient\ClientException - - array + + string - - $collection - - mixed - - - getChecksum - \ArangoDBClient\CollectionHandler::getChecksum() - - Calculate a checksum of the collection. - Will calculate a checksum of the meta-data (keys and optionally revision ids) -and optionally the document data in the collection. - - \ArangoDBClient\Exception - - - mixed - - - boolean - - - boolean - - - array + + getBody + \ArangoDBClient\TraceResponse::getBody() + + Get the response body + + + string - - $collectionId - - mixed - - - $withRevisions - false - boolean - - - $withData - false - boolean - - - getRevision - \ArangoDBClient\CollectionHandler::getRevision() - - Returns the Collections revision ID - The revision id is a server-generated string that clients can use to check whether data in a collection has -changed since the last revision check. - - \ArangoDBClient\Exception - - - mixed - - - array + + getType + \ArangoDBClient\TraceResponse::getType() + + Get the http message type + + + string - - $collectionId - - mixed - - - rename - \ArangoDBClient\CollectionHandler::rename() - - Rename a collection + + getTimeTaken + \ArangoDBClient\TraceResponse::getTimeTaken() + + Get the time taken for this request + + + + + eJylV9ty2zYQfddXbGc8I9kjJ5FvbZ0mjaM4ttu40dhKX+KMByZXEsYUwACgHDXTf+/iQoqgaGva8sEX7sHu2YMFdvnLr/ks7zzf2enADpwoJqby3VsYnY8gyTgKcwyJFAITw6UgiEW9yVlyz6YIUC0YOqwzssLMpCIb/MYEXBvEOROiYXpP6xKuYTgryIEzJjJfKj6dGRhWf+29GOz1wShO0YSGs/ndeZ/MmZwK7MMZKnK9pNXPOx3B5qiJGDY4veyUyQ0zpjWMFWGuCCqFxjKhJ4k9ma3mIrEmgMGzfcckaQnzvWMRjod9dkgWqVADsmQGM2QpKmAaSC+mFFtC7x6X8Oo1LFhW4DZghnMX0C0ufbxZMOXx4c1z9ztXfMEMwtatd6zhFXz+QjI0KIxnCDNjctCGmULTNqfYFoFXgdf80+ohrWr3rdgD3Ml0CXICxv5fab4eQ9MWW7Vbw1gn7SHMMkfr3qVB269pm/61e+fkFXRLft1HYvE5/WD3KMBI0ChS2q6UskqQLxBYlR8JRmY6NKlu4zLJJHtMUBtjbEOsU/ikMbWBMynvocidoilOuOD2YMKEqpeqxwnx2EY+WSphK99VLl3ZeLQt7hcvbD12h1IYLgrs9mumgTNdP3CTzEhnGClpZCIzXUPtBQcff49e+qVDhUQjjSx7znKSJJg3TfvO9IcUuyfu3HIqYLsHF4JkmDPLPsIfBDxY9nSOIuOhM9JJRdNqP3L2EVOGs6wFsR8Suywyw/MM6eaQPEEdQXyal3JBmzhytxY5yZYRxif8XhYijd77bK8R4SNtuopsZWYGLmXKJxzjpT43Kh27Jd/icD862xjnuVRMLeEKU07FXE/tIKT2lqVk/lqgjq0+q0/C3578ryj6QUhoxJb27nIOKEAM2Q85qzuepigi2yq3piYHIbFLpLgpWMhJlsmHhvOjyoGvInaXYQTwEjhpwFYS0eSJK592tj+FUnFKwJgOqyxiRX4uD8kk47GUAy/lmRQRh4HX8AOKqZm1Rh0EGZW7Uvxpf8941kDtR9xOKROzhLGU8IGpaRzyoA7d/XR14XFSTCNYKB6hi5xKhM4gXFKJMBjTfRkBj+r+CHZFTRLdrlyTmHrCm8IPvPCn33KqN/ZYRl7ti5vunC5XgyyXdUEPQ21e0HlUgk7mNaoFddFTpaSKcIOqDC7muW+kUaTDUKi2ys/oGnpgy8hanj+1oGMNVO0L4tpI6TBUa1jfUhuHoWbPx+MR/Eld2WbtNCrlDeCWTn1NV1O48qsmY+x80bzlc6bYPIwQsFW2f9h1S/3rslsGY2Mp9Xr7/1bZDsLSZlsp4b6vwpZr8/bx8PC6DGWtjYXh2aoaXtyWijs6PjAphJs64faWSp+cFonplVn1VyT7nkC/5m7b+fneWQWacb37upqIgJpb6enlOqrM3qGqIacJq7K2MD+kNCEVIQupdXeL+Xttn89on6sRsDE1NTas0lOhKZRo6+0NEadozr2LXlOd4KMh0lMsq6Ko6LUNHcHv2gDZwiyIvJFatBkbuFlKtRmpyc7MlHygQd/N8qffbIdYoSrybaPj4/xX49NaJnwCvR+4pjGj18ymNnR9DrZIky/b2zVH9nHcQeBDk36PLkT6aOBpTYJcyQVPMX3W3V5VaNDuCY03stq0CVVt1C6A/ybvW3KwqTRWB3BDWYTvBPfx8L9Y2Ua4iZUNsolV7cvCjvF2Jblx3XQjhfJK2cijefcQHfehekvFwnQv+lw9PnamPnRvyk/vm/Dpe3cTIW1F/QNKpHLw + + + + ArangoDB PHP client: autoloader + + + + + + + + Autoloader + \ArangoDBClient\Autoloader + + Handles automatic loading of missing class files. + The autoloader can be nested with other autoloaders. It will only +process classes from its own namespace and ignore all others.<br> +<br> + + + + + EXTENSION + \ArangoDBClient\Autoloader::EXTENSION + '.php' + + Class file extension + + + + + $libDir + \ArangoDBClient\Autoloader::libDir + + + Directory with library files + + + string + + + + + init + \ArangoDBClient\Autoloader::init() + + Initialise the autoloader - + \ArangoDBClient\Exception - - mixed + + void - + + + + load + \ArangoDBClient\Autoloader::load() + + Handle loading of an unknown class + This will only handle class from its own namespace and ignore all others. + +This allows multiple autoloaders to be used in a nested fashion. + string - - boolean + + void - $collection - - mixed - - - $name + $className string - - load - \ArangoDBClient\CollectionHandler::load() - - Load a collection into the server's memory - This will load the given collection into the server's memory. - - \ArangoDBClient\Exception - - - mixed + + checkEnvironment + \ArangoDBClient\Autoloader::checkEnvironment() + + Check the runtime environment + This will check whether the runtime environment is compatible with the +Arango PHP client. + + \ArangoDBClient\ClientException - - \ArangoDBClient\HttpResponse + + void - - $collection - - mixed - - - unload - \ArangoDBClient\CollectionHandler::unload() - - Unload a collection from the server's memory - This will unload the given collection from the server's memory. - - \ArangoDBClient\Exception - - - mixed - - - \ArangoDBClient\HttpResponse - + + eJyVVttu2zgQffdXTIGglgOvnAZIH9x4N15HaFygaZAERRcIIFAyLXFDkVqSshO0/fcOKcmi5QaL6MGiNbczM2dGOv+rzMvBYHJ8PIBjmCsiMnn5N9xc3UDKGRVmCqQykkuyogpVrNZFSdJHklGAncHC6TohqudSoQw+EQF3htKCCOFEqSyfFctyA4vd6fTk3ekYjGLoUGj4WCRXYxRzmQk6ho9UofUzWk8GA0EKqjE27YX9sMN/RcSKU+0gF8SwFCxwJjKQayiY1vaYcqI1rBkqhk1G9zn10oQUgScUBNWGrmDLTA7S5CjodHQIS4MizkEKbgFCqWRK0bPzjyDWShbAjAa5FdBhR4jAMiEVHq21dazD80T9aZ009/8vM6aSWhHASXjq6lPnNe+69X1gxa409jqGS6ZoaqR6rnPiLFEE/7hSNDqt6sWGKNDYFpE1jybuXiq2IYaiyJX3CH2gV+xAL9RiV2SgTwY7y6TYc5RKoQ1E3+6j67vll2uYwTBEKg4PXS0FM4xwpimYvT71IZtcya2G6CmlpeniwYWiplICNpKt9pOpEo5JNLmsK5FaM2AYMBg5jbqE9tKUr6fTNKfpYyQ2TElRYCuCUYO3U2lKggnF8eXyNo4hBLxHi/svt//Ed9HN/HaOR9+u5HGbVaxoxpB2Kojj6/nn6O5mvoicj+FD19rp1N6HGNza/zwoWT0HPvmR0ZV4FJaKjie92t3nTHdshry2byblNTz+nV8U274UFTes5H4HNRhpJ63SOGdMAGlnbk10jq3ou8ORUKRoeAlHDt81IoI/HDCbaI25duuCrPo+XskG6yToQvV5cdRVxHa837OH4YdOlVOR4dzhNbM54N+gM/eZNJm0J7aGQFcJansYxnAybr2N4M1s5qEYedis8YmTo30p9Z4Lz8S3sVddoQ74zz1k9XhgO3F+c7KhWGmKrMIuY+MSukZG7NTtJlQm2J8MC0hUnPsZK/pfhdupN0Mh/Cb3XeJho71bIi+Nw8JOrVseqhKGIVFoN8IvToKbddjm1K3+F6wBtVNZlMiZBKnt9iqqtt7qxe29Tg8Y3SyterO/YnXt7+EdWw8XVI+vuEdNcFSQf6XCUhYMB3iEdKRPJZcrGgzD4djCjb9Gt7akfo8snQImzAhqeziHM/jxo/dwht09g7dvoX1qQ6Dq+wOaudRx4rf97IPhUnhFtdXzSh7ihi/xPWZXgBWdhe8BI+T4OUFVuxNrItS/SAhHnxhfIkQH/hp1z8c4p+0HyEPzqk28bWt9/gJGybR/ + + + + ArangoDB PHP client: server exception + + + + + + + \ArangoDBClient\Exception + ServerException + \ArangoDBClient\ServerException + + Server-Exception + This exception type will be thrown by the client when the server returns an +error in response to a client request. + +The exception code is the HTTP status code as returned by +the server. +In case the server provides additional details +about the error, these details can be queried using the +getDetails() function.<br> +<br> + + + + + + ENTRY_CODE + \ArangoDBClient\ServerException::ENTRY_CODE + 'errorNum' + + Error number index + - - $collection - - mixed - - - - truncate - \ArangoDBClient\CollectionHandler::truncate() - - Truncate a collection - This will remove all documents from the collection but will leave the metadata and indexes intact. - - \ArangoDBClient\Exception - - - mixed - - - boolean - + + + ENTRY_MESSAGE + \ArangoDBClient\ServerException::ENTRY_MESSAGE + 'errorMessage' + + Error message index + - - $collection - - mixed - - - - drop - \ArangoDBClient\CollectionHandler::drop() - - Drop a collection + + + $_details + \ArangoDBClient\ServerException::_details + array() + + Optional details for the exception - - \ArangoDBClient\Exception - - - mixed - - + array - - boolean - - - $collection - - mixed - - - $options - array() - array - - - - isValidCollectionId - \ArangoDBClient\CollectionHandler::isValidCollectionId() - - Checks if the collectionId given, is valid. Returns true if it is, or false if it is not. + + + $enableLogging + \ArangoDBClient\Exception::enableLogging + false + + - - - boolean + + + + __toString + \ArangoDBClient\ServerException::__toString() + + Return a string representation of the exception + + + string - - $collectionId - - - - - getAllCollections - \ArangoDBClient\CollectionHandler::getAllCollections() - - Get list of all available collections per default with the collection names as index. - Returns empty array if none are available. - - array - - + + setDetails + \ArangoDBClient\ServerException::setDetails() + + Set exception details + If the server provides additional details about the error +that occurred, they will be put here. + array - - \ArangoDBClient\Exception - - - \ArangoDBClient\ClientException + + void - $options - array() + $details + array - - getCollectionId - \ArangoDBClient\CollectionHandler::getCollectionId() - - Gets the collectionId from the given collectionObject or string/integer - - - mixed - - - mixed + + getDetails + \ArangoDBClient\ServerException::getDetails() + + Get exception details + If the server has provided additional details about the error +that occurred, they can be queries using the method + + array - - $collection - - mixed - - - getCollectionName - \ArangoDBClient\CollectionHandler::getCollectionName() - - Gets the collectionId from the given collectionObject or string/integer - - - mixed - - - mixed + + getServerCode + \ArangoDBClient\ServerException::getServerCode() + + Get server error code + If the server has provided additional details about the error +that occurred, this will return the server error code + + integer - - $collection - - mixed - - - importFromFile - \ArangoDBClient\CollectionHandler::importFromFile() - - Import documents from a file - This will throw on all errors except insertion errors - - \ArangoDBClient\Exception - - - mixed + + getServerMessage + \ArangoDBClient\ServerException::getServerMessage() + + Get server error message + If the server has provided additional details about the error +that occurred, this will return the server error string + + string - - mixed + + + + __construct + \ArangoDBClient\Exception::__construct() + + Exception constructor. + + + string - - array + + integer - - array + + \Exception - $collectionId - - mixed - + $message + '' + string + - $importFileName - - mixed + $code + 0 + integer - $options - array() - array + $previous + null + \Exception + \ArangoDBClient\Exception - - import - \ArangoDBClient\CollectionHandler::import() - - Import documents into a collection - This will throw on all errors except insertion errors - - - string - array - - - array - - - - array - - - \ArangoDBClient\Exception + + enableLogging + \ArangoDBClient\Exception::enableLogging() + + Turn on exception logging + + + \ArangoDBClient\Exception + + + disableLogging + \ArangoDBClient\Exception::disableLogging() + + Turn off exception logging + + + \ArangoDBClient\Exception + + + eJzNVk1v2kAQvfMr5hAJiICkOZI0bUoQadV8KOZSJZG12ANe1azd3TUJqvrfO7teG+MASVOpKhcb78yb2ffejn3yIY3SRuNgf78B+3AmmZgl55/g5uIGgpij0H1QKBcoAZ8CTDVPBAWa2I8pC76zGQKUaQObYRdZpqNE0hp8YQI8jThnQtilIEmXks8iDYPy7ujw3VEHtOQEKBSM5pOLDi3HyUxgB0YoKXtJ2QeNhmBzVFQba2WPy114tuHusNbwOOJqtQvQyxThkccxTBB0JJNHAZMl3aHbOTxGKOx/x4BEnUnqjtl9oJS0QS7osUoToQgkAVbkSvyRodK9sjZWSgdJiEDNGOyL8fgGlGY6U/lzplwhDKkfk7xqwcDBZwJgptyqs1QmCx4itRaG3JRgMYSoGY+VyWCTJNM23jbdMbcE4CIITRgOqGHJqWimuJiZEJM6Q32eh7XaMM1EYNB7JxN5albddc0OG8xAgIHxyWHvyGoYxEwpJ1OpEvGjUYQKVrr9bBgDWVXNbx+u0/XNwZQk0FVuXWSRQF1JNgcmJVu6Zwf2mkq+YBphzy+g3sPdA3moVnFoVRbZfIJG7BCf1mACEl7D8Gp8+80fXJ8PCaVpOb7K5s1taORfZZjaDXc59Lyz0QrxMs/agHpr7ULeU3SASDqJKXmSyGeW12S6m6LcbUVydzPKOnnZJOZBaQfwfZ14NqvVtgG5cObnwH1/8PXM83wfetDsQ5Mue5rOY/eUDJYbYUDmJ4/Rem3ZbbzVPraov57t30NdOVyl79d2+Xn6yvNSPywFgI6YhiQIMikxtCdoWU6PlBIilNjb4T7YKwp03QPS5aWuC20WCQ93KqBWx3S9Wl0PR2vF9UXkNnZHf8xuRCPMMRz+JcNro0mtRhOdIXq/hFvoyimo8Lze9WYKq5Nus4lr3O0irHhn2vNuxvo/IYxeKdaSrt9Kha2NFJRxemd1t0ZvZax6dGuk8Sm0uCJjtmq83SmMp/3+amg+tNuVvO2EP088LrOcDM+Tqcm8vVfL5cbzf6FYPotfnNjb239BuXK2vkk894p6k35F7i4JRRbHhWy0aj8bfBZzplq1j4d+3y52oHlffETeuw+RyX0ttklW+A1ZRFRS + + + + ArangoDB PHP client: user document handler + + + + + + + \ArangoDBClient\Handler + UserHandler + \ArangoDBClient\UserHandler + + A handler that manages users + . +A user-document handler that fetches vertices from the server and +persists them on the server. It does so by issuing the +appropriate HTTP requests to the server. + + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection - - \ArangoDBClient\ClientException + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string - - $collection - - - - - $importData - - string|array - - - $options - array() - array - - - - createHashIndex - \ArangoDBClient\CollectionHandler::createHashIndex() - - Create a hash index + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - + string - - array + + + + addUser + \ArangoDBClient\UserHandler::addUser() + + save a user to the user-collection + This will save the user to the users collection. It will additionally grant the user permissions +for the current database + +This will throw if the user cannot be saved + + \ArangoDBClient\Exception - - boolean + + string - - boolean + + mixed + + + mixed - - + array - - \ArangoDBClient\Exception + + boolean + - $collectionId + $username string - $fields - - array + $passwd + null + mixed - $unique + $active null - boolean + mixed - $sparse + $extra null - boolean + array - - createFulltextIndex - \ArangoDBClient\CollectionHandler::createFulltextIndex() - - Create a fulltext index - - + + replaceUser + \ArangoDBClient\UserHandler::replaceUser() + + Replace an existing user, identified by its username + This will replace the user-document on the server + +This will throw if the document cannot be replaced + + \ArangoDBClient\Exception + + string - - array + + mixed - - integer + + mixed - - + array - - \ArangoDBClient\Exception + + boolean - $collectionId + $username string - $fields - - array + $passwd + null + mixed - $minLength + $active null - integer + mixed + + + $extra + null + array - - createSkipListIndex - \ArangoDBClient\CollectionHandler::createSkipListIndex() - - Create a skip-list index - - - string + + updateUser + \ArangoDBClient\UserHandler::updateUser() + + Update an existing user, identified by the username + This will update the user-document on the server + +This will throw if the document cannot be updated + + \ArangoDBClient\Exception - - array + + string - - boolean + + mixed - - boolean + + mixed - - + array - - \ArangoDBClient\Exception + + boolean - $collectionId + $username string - $fields - - array + $passwd + null + mixed - $unique + $active null - boolean + mixed - $sparse + $extra null - boolean + array - - createPersistentIndex - \ArangoDBClient\CollectionHandler::createPersistentIndex() - - Create a persistent index - - + + get + \ArangoDBClient\UserHandler::get() + + Get a single user-document, identified by the username + This will throw if the document cannot be fetched from the server + + \ArangoDBClient\Exception + + string - - array - - - boolean + + \ArangoDBClient\User - - boolean + + + $username + + string + + + + removeUser + \ArangoDBClient\UserHandler::removeUser() + + Remove a user, identified by the username + + + \ArangoDBClient\Exception - - - array + + string - - \ArangoDBClient\Exception + + boolean - $collectionId + $username string + + + grantPermissions + \ArangoDBClient\UserHandler::grantPermissions() + + Grant R/W permissions to a user, for a specific database + + + \ArangoDBClient\Exception + + + string + + + string + + + boolean + + + - $fields + $username - array - - - $unique - null - boolean + string - $sparse - null - boolean + $databaseName + + string - - createGeoIndex - \ArangoDBClient\CollectionHandler::createGeoIndex() - - Create a geo index + + grantDatabasePermissions + \ArangoDBClient\UserHandler::grantDatabasePermissions() + + Grant R/W permissions to a user, for a specific database - + string - - array - - - boolean + + string - - boolean + + string - + boolean - - - array - - - \ArangoDBClient\Exception - - $collectionId + $username string - $fields + $databaseName - array - - - $geoJson - null - boolean - - - $constraint - null - boolean + string - $ignoreNull - null - boolean + $permissions + 'rw' + string - - index - \ArangoDBClient\CollectionHandler::index() - - Creates an index on a collection on the server - This will create an index on the collection on the server and return its id - -This will throw if the index cannot be created - + + revokePermissions + \ArangoDBClient\UserHandler::revokePermissions() + + Revoke R/W permissions for a user, for a specific database + + \ArangoDBClient\Exception - - mixed - - + string - - array + + string - + boolean - - array - - - array - + - $collectionId + $username - mixed - - - $type - '' string - $attributes - array() - array + $databaseName + + string + + + revokeDatabasePermissions + \ArangoDBClient\UserHandler::revokeDatabasePermissions() + + Revoke R/W permissions for a user, for a specific database + + + \ArangoDBClient\Exception + + + string + + + string + + + boolean + + - $unique - false - boolean + $username + + string - $indexOptions - array() - array + $databaseName + + string - - getIndex - \ArangoDBClient\CollectionHandler::getIndex() - - Get the information about an index in a collection + + grantCollectionPermissions + \ArangoDBClient\UserHandler::grantCollectionPermissions() + + Grant R/W permissions to a user, for a specific collection - + string - + string - - array + + string - - \ArangoDBClient\Exception + + string - - \ArangoDBClient\ClientException + + boolean - $collection + $username string - $indexId + $databaseName string - - - getIndexes - \ArangoDBClient\CollectionHandler::getIndexes() - - Get indexes of a collection - This will throw if the collection cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed - - - array - - - $collectionId + $collectionName - mixed + string + + + $permissions + 'rw' + string - - dropIndex - \ArangoDBClient\CollectionHandler::dropIndex() - - Drop an index + + revokeCollectionPermissions + \ArangoDBClient\UserHandler::revokeCollectionPermissions() + + Revoke R/W permissions for a user, for a specific database - + \ArangoDBClient\Exception - - mixed + + string + + + string + + + string - + boolean - $indexHandle + $username - mixed + string + + + $databaseName + + string + + + $collectionName + + string - - any - \ArangoDBClient\CollectionHandler::any() - - Get a random document from the collection. - This will throw if the document cannot be fetched from the server - + + getDatabases + \ArangoDBClient\UserHandler::getDatabases() + + Gets the list of databases a user has access to + + \ArangoDBClient\Exception - - mixed + + string - - \ArangoDBClient\Document + + array - - $collectionId + $username - mixed + string - - all - \ArangoDBClient\CollectionHandler::all() - - Returns all documents of a collection + + getDatabasePermissionLevel + \ArangoDBClient\UserHandler::getDatabasePermissionLevel() + + Gets the list of collections a user has access to - - mixed + + string - - array + + string - - \ArangoDBClient\Cursor - - - \ArangoDBClient\Exception - - - \ArangoDBClient\ClientException + + string - $collectionId + $username - mixed - - - $options - array() - array + string - - - getAllIds - \ArangoDBClient\CollectionHandler::getAllIds() - - Get the list of all documents' ids from a collection - This will throw if the list cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed - - - array - - - $collection + $databaseName - mixed + string - - byExample - \ArangoDBClient\CollectionHandler::byExample() - - Get document(s) by specifying an example - This will throw if the list cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed + + getCollectionPermissionLevel + \ArangoDBClient\UserHandler::getCollectionPermissionLevel() + + Gets the list of collections a user has access to + + + string - - mixed + + string - - array + + string - - \ArangoDBClient\cursor + + string - $collectionId + $username - mixed + string - $document + $databaseName - mixed + string - $options - array() - array + $collectionName + + string - - firstExample - \ArangoDBClient\CollectionHandler::firstExample() - - Get the first document matching a given example. - This will throw if the document cannot be fetched from the server - - \ArangoDBClient\Exception + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler + + + \ArangoDBClient\Connection - - mixed + + + $connection + + \ArangoDBClient\Connection + + \ArangoDBClient\Handler + + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection - + + \ArangoDBClient\Handler + + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + mixed - - array - - - \ArangoDBClient\Document + + \ArangoDBClient\ClientException - - $collectionId + $optionName - mixed + + \ArangoDBClient\Handler + + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + + string + + + \ArangoDBClient\ClientException + + - $document + $body - mixed - - - $options - array() array + \ArangoDBClient\Handler - - fulltext - \ArangoDBClient\CollectionHandler::fulltext() - - Get document(s) by a fulltext query - This will find all documents from the collection that match the fulltext query specified in query. -In order to use the fulltext operator, a fulltext index must be defined for the collection and the specified attribute. - - \ArangoDBClient\Exception - - - mixed - - - mixed + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array - - mixed + + array - + array - - \ArangoDBClient\cursor + + array - $collection - - mixed - - - $attribute + $options - mixed + array - $query + $body - mixed + array - $options + $includeArray array() array + \ArangoDBClient\Handler - - updateByExample - \ArangoDBClient\CollectionHandler::updateByExample() - - Update document(s) matching a given example - This will update the document(s) on the server - -This will throw if the document cannot be updated - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name + + + \ArangoDBClient\ClientException - + mixed - - boolean + + string - - $collectionId - - mixed - - - $example - - mixed - - - $newValue + $value mixed - - $options - array() - mixed - + \ArangoDBClient\Handler - - replaceByExample - \ArangoDBClient\CollectionHandler::replaceByExample() - - Replace document(s) matching a given example - This will replace the document(s) on the server - -This will throw if the document cannot be replaced - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array - + mixed - - boolean - - - - $collectionId + + $headers - mixed + array - $example + $collection mixed + \ArangoDBClient\Handler + + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + + string + + + \ArangoDBClient\DocumentClassable + + - $newValue + $class - mixed - - - $options - array() - mixed + string + \ArangoDBClient\DocumentClassable - - removeByExample - \ArangoDBClient\CollectionHandler::removeByExample() - - Remove document(s) by specifying an example - This will throw on any error - - \ArangoDBClient\Exception + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string - - mixed + + \ArangoDBClient\DocumentClassable - - mixed + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + eJztWm1v2zYQ/u5fcQMK2A6cBNtHd+7apS/p0BVB1mAfkiKlJdrmSosaScUxivz3HUlRr5bfErfuGqFALfHueLx7+Bx10a+/xZO41To+OGjBAbyQJBqLl7/D2ekZBJzRSPchUVRCKIJkircwIVHIqURpo/A8JsFnMqYAme6JVbODJNETIXEMXuPgZ/iTzK0mPFcsCowSwM9Hv+CT41YrIlOq0BytWHqae+cnBz0hGqYkwpmV9U+Z8SMnZO4Pq/46lRHVwQRVbqjULMAfIymmOEQBdfAhoLAxEqNFprQyQ1MQUUHkCN5qjAbqKgHDOTClEhaNjYTRJHEsRSwZ0RROP3w4A0n/Tag1JYpW1opfPUoBJ0rBBRo5TddFbzWNQgXpfetLq2UUbMjMdQCK3FAgLo2pEzZEgeCcBpqJKJX0Ch8mTMGMce5UvUJRWUGubSNixUkYMvOEcD6HMa5H58oY0inGCkeVn2ckpB0PEilNqkKiyZAo2uiOnkgxAzbKrQYkioSGIbWuhhXN51ZBwavbgMYLForRl2QKSkuTwSfGokEhHOKcFOxPUZiMKAyjEz5yXuE/RCH6LeT8qGJ1ym5pCPAkxozN8Edq1QXDPBMyLJt8O4JI5GNoXMU0YCNGw571gk5jPffu2ogMrcGwaW6CCbqhdm4SgYhdcmDEydhtCD8BBnhCcQqZrxand+qpY7rsjc9JSEck4dqCQya06gmRkszRE4SpJFDzxA3PmJ7gzyFDGTkHJ2vQAGQokhxER9X8SaoTGcFQCE7R7KF1oWcQ4tAhEh5WweG3ld1S9smx/T9OhpwFMEoii2oDZrPPOhkselkuBxAlnPey+Gb3znN327VWv7g58LJ2Xnpa8hfK0pnd0J3u08Wyh8/sYoxs5kujaOZh6mujYOZ6uohGwTRzg3R1BTmboeo1qOqPqX7BuVldrmngY0dORBQ5Ful00XmhdOdCctXvX5y/u77469V5zwv/o0R0TaNAhPR6JpFmTWqMB92iZY3wyUNuruPjMi0pqmuEBCxaSESqZMl7bXjtLFcuAaRhYfjgZWqz0y3k+Q4JDCsSdK4yisIwdwtLuMvXloLdQNxZuKtR/TmNuamguBfoLRYwwxPGO9wSIS7Mbl5btLQrm8brRraVqbGsYGQ1tVQQ12PrTDdn7NT+1yPtHpKcaKt0MQa86OpY2Ootih49svu+sbsxzGdkrlKGrwFMUrskxL2UQi4l9jTL+0Lu+8zY+QSS1/RQEbn6lHJk0n5/mDAe4n2Nvy+zGH8sWmwqAYnumNk25P1F3Fglx4s4NKfyVdzo4biUGxNna1fU6MzvETOmDj0S4/+ZGF2S94UXm+kOF9Yxk8FPg4w1u5Vj39oke9dg1k26wmyzj01mbbBWWPUBrdJ34SxoCXkn/GvOo2sw8OKKsTEnv8HTODIBbmxeYdKtaHkVr7r+T1ht+zwYz2Y/CwTXsHkN+s0La62CLPdx8c7F+Odbtr4HffG+F2AkVTG+7li0N7/mWOiU3vUsoQ1yfSv2hzIaRTHHjQolL9vXTL2nszYMnsGIcEU/FgWvfaRObC8s86b8/GkVhhW9fj+QFNnuNUb5hWFjd6joZY50GzF7Tqci66htANOHhVWvVMttVWMqrdYh5XTB8WFn52kTj3LZqGIQ38LtLo0RBQbOpn84Ra5hQ8YZFnffChQ8hFig+TnYaOAyfPkDe6jAZxYjJUjcmwxrBgzLReGZnc7YSQnRzb8GjboM1DbDWpRo+6bnx3+XOhSYWA84EyviTyVBU9d0W7SZaymRVTX9/O8dVv0x0z9egwq3B2RmKaSIrMAcUY3rxQZ5v28bNr79clbq+ihNSbgU3Eu7PcWlVxHvaafQNFrgQ7O5HeNjD2BQtVBcDloo3qYin+Tsk10eUnd4OJMMX8E66Um828NhURgWEZ8vAdzqrG+Srl7Z/QG05axdK8RpKbwsHf7adjJb7J7U/kiC172Zrgdt72q74vY3fiM/pzfiM61h2QH4key2ITtpQ7ot2znt+9Ndoxdb8N0jSB7iiLZxPjblrnYkItr+EVhr0wLc9Hf2dXB3H+TBdmU4d7eC33xg02K+F+X8JHN/zYJeDsR3WuFr63gs+d/Rrvo6deGeO2OfS8W+wf8NdR+VAWdKFyGk/BdaE4OCIKDKlJSddpAaMOb+NlFEt/0yL2vR5B5n3adFPjc2Kv0pRO2iY1mEwlfsXvrTr5G+bKMsVrD2x/VRkGN0PRzs+KRaTHMDSkpmV+Y655V39Iby9U+dDwKEZcfHHwYXD1XzFmBj7Vpnv7Fq+up0M2QtqlnLsbW6bu0CbMsL0DdFH/6znxNfE86I6pTaCHYAl3WFySBjGqmr9PPk4VVBro2z/Qcr0Cf/ + + + + ArangoDB PHP client: AQL query result cache handling + + + + + + + \ArangoDBClient\Handler + QueryCacheHandler + \ArangoDBClient\QueryCacheHandler + + A base class for REST-based handlers + + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string + + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string + + + + + enable + \ArangoDBClient\QueryCacheHandler::enable() + + Globally turns on the AQL query result cache + + + \ArangoDBClient\Exception + + + + + disable + \ArangoDBClient\QueryCacheHandler::disable() + + Globally turns off the AQL query result cache + + + \ArangoDBClient\Exception + + + + + enableDemandMode + \ArangoDBClient\QueryCacheHandler::enableDemandMode() + + Globally sets the AQL query result cache to demand mode + + + \ArangoDBClient\Exception + + + + + clear + \ArangoDBClient\QueryCacheHandler::clear() + + Clears the AQL query result cache for the current database + + + \ArangoDBClient\Exception - + + + + getEntries + \ArangoDBClient\QueryCacheHandler::getEntries() + + Returns the entries from the query cache in current database + + + \ArangoDBClient\Exception + + array - - integer + + + + setProperties + \ArangoDBClient\QueryCacheHandler::setProperties() + + Adjusts the global AQL query result cache properties + + + \ArangoDBClient\Exception + + + array + + + array - - $collectionId - - mixed - - - $document + $properties - mixed - - - $options - array() array - - removeByKeys - \ArangoDBClient\CollectionHandler::removeByKeys() - - Remove document(s) by specifying an array of keys - This will throw on any error - + + getProperties + \ArangoDBClient\QueryCacheHandler::getProperties() + + Returns the AQL query result cache properties + + \ArangoDBClient\Exception - - mixed - - + array - - array - - - array + + + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler + + + \ArangoDBClient\Connection - - $collectionId + $connection - mixed + \ArangoDBClient\Connection + \ArangoDBClient\Handler + + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection + + + \ArangoDBClient\Handler + + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + + mixed + + + \ArangoDBClient\ClientException + + - $keys + $optionName - array + + \ArangoDBClient\Handler + + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + + string + + + \ArangoDBClient\ClientException + + - $options - array() + $body + array + \ArangoDBClient\Handler - - lookupByKeys - \ArangoDBClient\CollectionHandler::lookupByKeys() - - Bulk lookup documents by specifying an array of keys - This will throw on any error - - \ArangoDBClient\Exception - - - mixed + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array - + array - + array - + array - - $collectionId + $options - mixed + array - $keys + $body array - $options + $includeArray array() array + \ArangoDBClient\Handler - - range - \ArangoDBClient\CollectionHandler::range() - - Get document(s) by specifying range - This will throw if the list cannot be fetched from the server - - \ArangoDBClient\Exception + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name + + + \ArangoDBClient\ClientException - + mixed - + string - - mixed - - - mixed - - - array - - - \ArangoDBClient\Cursor - - $collectionId - - mixed - - - $attribute - - string - - - $left + $value mixed - - $right - - mixed - - - $options - array() - array - + \ArangoDBClient\Handler - - near - \ArangoDBClient\CollectionHandler::near() - - Get document(s) by specifying near - This will throw if the list cannot be fetched from the server - - \ArangoDBClient\Exception - - - mixed - - - double - - - double - - + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + array - - \ArangoDBClient\Cursor - - - - $collectionId - - mixed - - - $latitude - - double - - - $longitude - - double - - - $options - array() - array - - - - within - \ArangoDBClient\CollectionHandler::within() - - Get document(s) by specifying within - This will throw if the list cannot be fetched from the server - - \ArangoDBClient\Exception - - + mixed - - double - - - double - - - integer - - - array - - - \ArangoDBClient\Cursor - - - $collectionId - - mixed - - - $latitude - - double - - - $longitude - - double - - - $radius + + $headers - integer - - - $options - array() array - - - createCollectionIfOptions - \ArangoDBClient\CollectionHandler::createCollectionIfOptions() - - - - - - $collection - - - - $options - - - - - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler - - - \ArangoDBClient\Connection - - - - $connection - - \ArangoDBClient\Connection + mixed \ArangoDBClient\Handler - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object - - - \ArangoDBClient\Connection - - - \ArangoDBClient\Handler - - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use - - - mixed - - - \ArangoDBClient\ClientException - - - - $optionName - - - - \ArangoDBClient\Handler - - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - - array - - + string - - \ArangoDBClient\ClientException - - - - $body - - array - - \ArangoDBClient\Handler - - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - - array - - - array - - - array - - - array - - - - $options - - array - - - $body - - array - - - $includeArray - array() - array - - \ArangoDBClient\Handler - - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name - - - \ArangoDBClient\ClientException - - - mixed - - - string + + \ArangoDBClient\DocumentClassable - $value + $class - mixed + string - \ArangoDBClient\Handler + \ArangoDBClient\DocumentClassable - - setDocumentClass - \ArangoDBClient\Handler::setDocumentClass() - - Sets the document class to use + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use - + string - - \ArangoDBClient\Handler + + \ArangoDBClient\DocumentClassable @@ -12745,2679 +13426,2032 @@ This is only for options that are to be sent to the ArangoDB server in a json bo string - \ArangoDBClient\Handler + \ArangoDBClient\DocumentClassable - No summary for method createCollectionIfOptions() + No summary for class \ArangoDBClient\QueryCacheHandler - eJztXetz20aS/+6/AnGpltQWJTnZrfvgRN6lJdpiIks6kYrjdVQqiABFrECAB4CSdZv879fd8x48CFDUwz6yUrENYHp6Ht3z656enp/+MZvMXrzY+etfXzh/dbqJG13F+2+dk4MTZxQGfpS9dkZxGPqjLIgjZ+JGXugn8Cl+/c+ZO7p2r3zHkQX3qAy9dOfZJE7gnfOzGzmDzPenbhTRq1E8u0uCq0nm7Mm//fDq+x86TpYEQDBKnffTy4MOvA7jq8jvOO/9BErfQemdFy8id+qnULdvVfujbMdJEt8Enp86UAjoTeGlE4+1lqS8CcOJX9A+Z+xnowkU1155buY64ySeOhmUSf3kBr6Dz5HKKPHdzPg8daCI+nC7Vo+lQTTCV47zavsHauoodNMUe4GTPeD8+V8yP/JSh//7xX9evMBi1Hr8/dXx4tEcm506bpK4d04Qef4X/nKH/hwBl5nTOxqefrrYP947+wB/HTi7TksWbf2YI6t1yMxNYBwynA05qscnw/7x0cXe8eFhbw//inRV2QLC/hd3Ogv9OlR7v3U/nBz2kCQvdT96R72PF792D8+IYuTf/uqG83uS3DvtdYc9u/00S/aqesHNQAAu51mtSrrD4Wn/7dmQ+JYlC6he+3dpHYK/9D7RBMDvC8iE/jirQ+aw926IZPD7AjJM3GvQOe2/PyBCVKJoMoZx6nu1xuPweNDbp0GgMkWtc7Mgm3u1ev6wO+wPz/ap40W5IpJxdFWf5vHRe0VUlCyg6gVp5qKiqEF0vz8Ydo/2iKYoVzQkrhfMa02R0+5+/4wmCStTQCy9DmZ1SA1+6Z8gIfy+gAwprDp0+kf7vd+QEJUoGoZgGtSbuP0PfTZzsUQBpXHgh15aTuBdv3e4T73DviwgMY+C/5n75STOjvr/zTQR+7KARHY3qyAw/HRCxfGrotEJ/td34hnqn4qh6f+LaODHBTSu/JgPzyJC73vHanygWNE4X0Vx4h/Nw3Ahtf77o+PT3sXR2eEhjbcsWbhQQcHEDXDhX0B27/hoMDzt9o+GbJUSBYtb/nMKa1+Ndv88YFqfFykgNnHTSc1+POgODlRHYsGi2Qk9kQEyqEnzHXTjsPfbUNEVBApoT4Po0I+usslCsh/6uAIcvR8eIElZrkRRhKCUavKL+uIQ9JniVxAooD3zkxTeIO6rR/2kdzoA4oCBFH1FpIh7UCipX5f3k+7pgIkUFSucsPNac/VMTNN5IVugMpK7hWRAxZx+QjL0eRE3E390nc6nixk66O39Mjj7QDzxQkUrjH8TpEENyTnt/dofcMAkChWNbxLD6GQBgO6FI3t6DIM77PdIMauChfr9ap7UIPmu//7stMcVPRUpXP1dbyGlw+PuPlvw3SJQsscNC9cBXKqDb8O64F+LQsNJkDq3AShU1/Pos7KCaL/A0GTzJHICMBUCT9GAqe05AVpQQRTe8a8AbY3BprsEK+bWTTy0eKYzAECXQRhkdx0HAKhzF8+ddBLPQ8+Zg4BY9aPtRjTAmgOiYz/xEctksfXhdnGLskkS3zrB2CY7AtMyzpxLn9tintUn/6SCqdP7MvL1IZHvCR6AmvsCTdzQCG8ZnXf5b/gbMqsqsnoUW+bAAhJEV8Ax6Et8h422amJW2QabHym+2oIu4Y/BVOUvtkWx0t9PszfHnIib+M7rny6TN4sLhcEbhhD0p1vOD87WGwdW1akbau3uOH/D57535W+ppz/tAJF6Nd26QfYuTgZ30ajFa8IxTH3qyyyZg4UP/QTNhyFO/Gl84yIa8BOXNYyGPogQv2YwF6HzUyAFIxoFaAAADQC3186O08eJAXMF/sPpkM78UQBQzOPkzUnTSh3PH7vzMCNyQHbi3gQwgFQdVOLOYHnxve0GLf13DFLihgMETqKl2jPnBm3LJgSDdHAHS9BUDhQQHLth6m+9AelKtOa0eWM2O9SjW29SKqjP32YV/xqjbROKOaIq1hbXiupveHGnHURbUxjU5G5zWWai+fTST47HgwlqnRYxw56hrKT0lLSKpUQaVEFEfkHLV3U0oRNRAZrRykBP69Lemb2xdQ3XuEzZbKGeNXxTlgpjq8ZsfhkGI8B4kf5Ne0OXUkun7Dqfzzep8H9eCHZA6tpBesEUlF56c1P7Cn8bpKnZb1dXiT+an2l879IqpRwc7c3Sb2F2+tkR1NCmeqwPYSR9dzRx2rItbupsYP/vvnE2SIZsdnP0/9OCGlrOtjMfjYMkzdpYfvPPNi9uVvjni/zfsKsMild+9lEpsvams7sLLQbMnOs6q516qQ3UT0RrL44i9hHT3237Qfr6NUcJH7v94cXg09Hepsb3ny8qWf1ZaZ0GrOqllmL15+Oz06PuIZmQDbjtczXXgFVZZCk++wPoUMD7HxoxKVRiIzZloWUZ/fUYHU6HZf25gQu5Y0kpVTOEF8DqP15rQvn6NbzYZ7qavVdENwibkOYw2qSXZg7jo+6HnnyNQmnVTKK92VlAhXwVOhVsyaJCUhhKqjZkdBExfboWETOkaBExOadKOFOTvAYlMegllNRMXETrl96nCzaXBoW0YM3jc06ndf6jmmA7OwTV/C9Z4jqjcA5tSLSVsFJmjoyVGybjd2Vyw+be54K5dvbhbe/04vjdxeCge7o/OC+Y6XY1pTINix8tkzlGB2L9b2/m18JS3ogjcpwXcaXRLJZcsBxn0PE+li1QDu1NAFsxrF1nSQga4ez0UNtS6Igi/07j6AKsqNjzL24TAK1+0uYco8bQhxHrDOORy5drWT/Ve8hfHPiuByQ0lllJ7L7vZHG9j9h7h1tnBAJoV0taW+3WPqAchOTjAExOycKEqgJoL8wnwVArV7tamDewwadazxmtQGebodOgYvXbNUt/bgVe61z72FbeXhvK653IsRs8ZaX+LPDw1rL8z46E7c8KFDl6E0B7gPIW0hqenh3tddlGkChU6IQhTLfYBUPanRwwWAAp2aT8L6AHPLTDLBujwjve+23v8Gy/J3Qkbd8RFW7hFFSzhx4lnHiujo/9L4DLRUV5H8EIrcjUD8e01IHKCSJQWKDFwXREhwdzU3EnQiIN81vAmC4S53OWzebIuZ0EAEUTfwbTjG2oRs7fX/0dnvzP3E+zbYuPnKfB+UiWbQRmPdbn+ElChgpa+0QoHo3mid0c7iZY5JGAyY1sC48DEGZmUYnJcRnHoe+aY29bFhM3NQwDy4IwAT9XQVP3WtvYNIprspMld5ZiBdHW3DoD0gGq42CEoMOh0Ii8SdzBA01JAv9G2EeCLak+y2rXpBcNVE0hw4zJ0Nqw69/IWRnIr09+Fv/LDKuAPmeDmMWO2cfMWDZK0/rocx3vCRAJpYuMGU6NqNjGis3Tv2FJxgLYi8Y71q8bemOF1rJF7T06Y9BXJc1qFUIQRIYAlkreYu8cC6zw7ECKB/HWNZQN3CraquoCs1HV1jl651crRbLkPAnF33cdAAYHfggr/uvXl/Mg9ODfJWDhs+EqYOpR31Q41+uQuMSpQCYka8CNLmQbFCazeFFmux277PvPBdzkl9w2DNAmL/lj1SwOojF6MKlv3ct4nv0/mLx7OhmrAdVsF09gW4+ubhFQ83fZ2Vs8U5eZp2XT1J56Ou5njrd30JddZkcgpc3KCalvVo3Xk3GZyXgiu/Cr0apq33GVqvWRpqzYCaWdum9+wjLHOZuressbrPi82FczO/kW9lNMzYI1X3BTOif33HA0D9EWdrXYBHu22bbYR24Olhad+pm7Rcy3KUgSzUNmHpO1KKMWAi/dFEStb5CMgIksSDgHFReaiFVz3Jg3feXLaDLfBUVhmmzgzvQpb1yqKIpmyQ9vJz7ZrEgwps3aIGKGv2yy3keiulo/0U1iSMQ4aR1WyPc+IUzttxzfl7F3p49XI96rmC5TLuzPURxlbhDhKNGMeylIvaSJ9VJ058tFK+IeL9c2pkfHHttdZkF2tL7jj4R6WiEyw/pNLM+jg84LlZlRDfotI++E3JZYG34G1FtGc1rkwDYedZyWaJl6i/9aBUwUGqvUmMm7/06pSEpzWyn2VMlJfz+3iPq6FGHwgssXx60rP8IoCNADXLSziZvxkxkpLq4sxiZmM1LOezGvDbfZxJUCOpq40RUSpRMHyGropposE7V7qS1Taa1icdYkx6W9eMHtIkkRU8WUlMeY/iKY7cmmIvl7K/Bbs5VoAdyyxxP/lguesijzMnqwwRZtIMg4sXLeNX8bqtfw1gV9yoKJcpA08UmsIuZ9rZwxzOltRlawIIVyPAdT3BxN9aLMDiZnICsRpL+6YeCVlYK5ajsIKzZa9hjgdkPapNMHABWj7Q2BodO3WvS9KbUXXLL9i8oW+0XfPynbxJpnbaMBKxMw5OTc2gOtsS8mvy8QMeUdzovUIW7tmB0Y8dhFprFbqcNinUotJdodwgJXwY0f1SG1KkV8X6G1Je8gy2ZyH27LORgOT+QGnlmyWNKwJ2oaTN+igEFXYexhxdbvA0kNbjzaMtNqVYkE57VMKs7YlqfRbsvMXywXfN+0UDLKiH2rksH6Yi0bjy8bbFv+ftJhi8dQ7OPX8qRR/LNPodBq+0kKgNZ7GGzPVhTfvfGlP4OwP9qSdDTFx62rzB0t3qd+IlFZNXwT8Q//j4XnkUVGRJ80ExoDZdkSs5/Es5XZLQ9gttQ8vSGdyB62Rx5oeCRJwEobB4hr32MMZ4lwHFkW0nLigVSeRECYryn4gjFIrR8NzlV8IO+lTecvf4EuT9Ek548+q1MZ5/lYQZ34P8SHuxiJrskb9OZbGO4Bj8MvItxItj0/9EHnLSfROA7nm8Cg5L2pvO7pIVWOoV0Jy3Vw0t7gXNhWDjIgiCWCDF52UOrILSkfoec2t2gx8TO0UYU0VYrHYt1tiQYn/J25evzxh/Nd8ZEKoIBv4d0Y0FxW/CqI7Bel7hzclxMnUhAduDduELqXod7hKZ58lcea5AE0TSooeQrqPYIH0tMuRsWfzrI7kTNkDGMQsXgnWVnJkOQ1ovhp7vklj7iJ31JH3WRhPORjBhziER/nI/aRyw5m0bYQ6V0KIczFNsqTYZyOtpkp0H3NY0EGV5RvA5mxeXmp1f2SzrCJ88ZjUSkMM3lE2YCluIb5STByw05tHnK10hSpUx+OQtH0atoJ5WekqB571f/dzJ3zu40CSj+0VpRK9QAqthuGmge/XWf1VC/p6wsYjCu//dmeeLtvxLYMH3x40GK92zrvSDIFRzOoWnPJUquHWcs5hRfifC6LZzdgnBmei+HsVpik4qXeDk5J0Dr3wDX3iBctbnyX6HyzjF5lGBpb8GlpF999Vr1JI3NesMJL41QfCfypc2vl5Ogom4acis6xsQr0JfpziyKxz61TBpWBoUXWqfWZvalQFROS5td2qf1sh80xOygNazpbFncwBPsqv8VTAtNLlAF9t0hoSy04S1Stwyr8ePHIB1W3Vzo6OcNR/Zudy/GMgAe9i/WSxdCunHaByyFP7hsZtZxp8Rjjxo6rPaOR609ncZLZDiDXGQehb/WzHYMVs2P0ZB+m/DgD9hKGz8XcbsydNlh+a7cwEmVBHAqnE1Aj30GTyNTcop1wbCFt/tFO9yQOPTaFA94jbuba4SHF2HM1uHNpzMnTK7BMB3RCUyQl8EnEgqyVigwIrRbrqjBkoIudwNqiRHQOC2Z2phjjD9BzxlIbeiJ+hvcLdtt2beZ+mtX8DmBcySuVv0FLGKjlWUCGWint2mO4DbE/QT8lJhpR8zoMwMC4vKM/t50erp70SCBtOrszA9nxedSAKNoAY9ZrBc2PVnUDeOcbQV8p40tYZvqRAYBhrifAs3uJbl2jvQ2aUHdkP8ToIYrGMeqBCagDfY5whetishbnNk6u09fOT64zSfyxs/tykmWz9PXOzhXYA/PL7VE83QEx7r7vHQ12BJDeuQ2ugx3c3mAa6uWbZUr9tOPWbPZO3Ylae+Y3mjX5nI0g0H1hJLKXtgXE/Bde7DNxp8Nq2w4/cZ3iVGN+jgacLLCPgKeEm+9Sz0nTX+6YSVRsZjLlcwPGbUrZTIl+iceE6WsoiTpb+ZJN57B6bOp39aLAkKJ3+ZAcLnwUxgZkLmCpvhDP2hZ9C9drZXdFxFt9V2M/ms2ZUnVeouvOXqu2ndZL81jaOJ5H3naJx1Gs/dwtSrRygXuC4Zz9VwcfUOxAg0jtJVCCteoaPx2R1Ty0uAAjsNd/8LnCuoyHfjKgQNMYIzvp1TZrIUbEYeYeQR3xAwub4wXc0ShO2CMWa0FLM6hoRob8kDpYkD1ciDlE6w3osTqH1/08XqTB6n/9rAGL6I1mjS959RVBlwZNedb4hbWj0Wh/W0iGdUBdOGN3V5MqGk+t5wFyOPc5pLP4d8xC/VWmKM9PR0lwyVRO96Tv7PM5TbuvueUs9X1HjD3M/nTbpcH22BT42/b3Oxi/s/N2Hl6zQU93qtCYbVM/ireaQ4oiSJYDZLiK1gdjBRQbH/nMprM9roaqdlwVezmfq/KsakgAPalCXRX5UQEvOf+8cRP1lZwJoh/1n87m9q4qtPUmi5nnGGDfy9+T36OXZdnDrF6mjpJEzULziPzO6rWdLE06jmldPrcz86vKtX6mQbHFuT8W+X3MmGYFMhUFGfSrb18YfNmHtVWGeyO10HmnsDXyoR0xwOq79u8uWHaPNmu2xqY9wimYOHqOONFRRTNh5IIu0rrvde4LrfVmCzFHVWnn679L6Pbr/CtWNVucl6mWlaxd5Z+FEwM3bGru1fQ/nByfDvV9GkWmbroitiujy3PDgwy2ucPy4AJKUTmzi40SDvtzx0/s5cuzygk4v8ESt3NWTfhuZH/PHU1j6dplQXESByumnVWZQoLtqPIMuQATeUF2VK2MOs82XUTdpsc+tbsH8Np1xSpHK1yfBQzuHEAnb0+yaWgTsZwOVs4meR6TJ8bVh6n2aliV7RL5Ih5t05mvYWyAOnIsdrmFInqPJx6zFzbi81hb/+xgJkYut6egl/tsBZFiEn8U3zaO4KbgqGgzlWpgDDaogSUU12tgJOp4H4p60CCuss13VKfyrtRZKo1UkeJqpqSvFNklJbaxwGKaF+xbldGeylH0bBAF0/nUCXmm+zFaFl7Kjo8W8N9Ept7xnniOciV4qyVbqt+WFSdJocF8V7cK0A64JLGS+W7ehHDfOY+3Emypew2exaSn0FKncpFiy0iQLlyPkM6jLkcDfs3DcxQd5O0QeFsvSw+/LJkXgNxXTO0bQtZyel85PZE9+hwlVXG3ltWHl1X7Op37Squ8cuq5mX3iRihbwmJKzCDvi6o07rS7qkwpZTdZuMZlVpWUtMu0LG7YG+r8+8j4ez9+jsINbNWSajEeUqy1npXPtE5cVtx5PQ2kkd8YposjJ1KaylpjvkFF6rYzvS5Fqrw61S8NqtPubCPkroisRM/IC+bupWAoboJHultJU+JaFy3xTRKdylL3LuUpG3nVGPGV3nWUU5n85qdcbi1UJjzcX0IQ4yKkEuTELydgvy1eFh++JmdeR14D10Ft2ZEuA9qJVyCtBGCpLPSOrbe1VyxpDgsN8PxxgPdYhcG1zz5ut9zWJu37i391nBbovtamVWkJOsN9sh223YWJeMSSxb8ydZ3JvaFHGPdpGo8CNwtu/PLThKwP9QaISwbRCc+27cRFc/KowebqVHbJFlSRsLLhx00fqYy1cUHVqWMtfiZCxHzYWrYwZc+JOhdRb2ei7+kJSzAN2EnxrRc5f7xTdkmFlcuOXQL6Rm9q8cUKGjQsvxdBcdgcIZa0U9/c0d7klabR0+xvdbcRuFKWI9TwwIe+j1CRzkUxb1x1sIFwBnNs546AHPAX+jEQuZMkStljQHs4f3/19/z+TdVpVRViHnjwCi8iS5jhdh3Ft1HLjjfHX8GODq/8VaPK+RrBlZGuihxvTnpKxXncBHSXCChr9l3kp2nL2o0s4K3iGEmdLR2Rb7wgW7NYRavTjpda6Bz3Fy1iJWWpOpZb0S5baHQ8+XY/HjWx1W1HtiOHV2tnNuNS+7mQ7GNlMSuaKSKXxdeSP3klOe9YWtUtNQ/9lB/B3MKgr4YplLkJV33GWVtRl1xQVarala4UD58tj+WciIolvtE0IAoHgPFDXyLeCftn2zoq6+wIXeeVAbSHSAvBlYfGaG4icIZ38aaLEBfM1k6rY7RNH6f7pCWQSodV+fkVYkL+9+/PzzcLxrUqRRuqC9cB3eqBeMjAn4IEOvZJ9hLtIUk01B0Po0JqKhAZ57RltqGac+efLCHo99s/VE4hN7pboEYuRI17IZg0SnjN5wUppCsgeIUCKobXtXDmXL9dq3v0qRpvUuZ0feJ7IhvxwuzXBPYp9bUMJcoHKwm9ZfZTSQp3g1AVMIuku6VgeRWZH8yEU9ULbeV5wGVOBJalj9Bi6ZcNo79HDD1Fx16kbhRk8kJfxtUwYSiaJ+u6wEZGnnOR+De644HEjB8Xl31bECfbKJKacTUJPLAqurIuDNod+JnhAmHfGAxhciNu0iuG6vdkzS+HwnU9yuYyS3pKyWjpDAFZG3nu5ik+h/cHVuPam8wxpyLo6w8inRUJxuKmccw1Q/4gkMe7eN5KfC4lLLEwHyw686AFw7NjDiwnBN4ohuIC3ejd0W1jvteAH5wnSCzf/Fv9PBG/fFocU9EvHm4wgfPx1DR7LvHCK3ZJ9RY5xrSE9hiSxm/VznxaDKXbEh6FwTSwL4pifSbcgRksvSn0dsLirzGBDFVnTHF25fJ1MFOXSx9zFjo0YkV3MAF9LCIC6cBUTe6282SJxVYx2an7JcDLzd0pXUBkk2czYdvhrOEw82G49DEEmeplXQCNhhFhQMLkwfxH6dG9vXmSgjRuFRwxekxTEsa8ZNekMtEJpc9f8XLNaUrnPyUz4bq7H72Ft2YosuDQCjVGMuYjk8scp4f9D/0hMkk7B9XfYhCCU/ztufxX46BZE4QcHi52eukgxIQYJGxgSWU5SPJWvGnngqkF7pCFi72IZeltTLjC8vAXAT4zt00OpqAni6Si8Krk9manEGPVOS8pvE16/iwV0I13V4gMC02dC0TxKW+5aZhGH5t6j5vt2BLY96pvuuHHCJxGGmLhkRJda9xLvOjC3sb351bfcqPL4Hc8qRCBdDajReb0097g7HCYTypU4ct9H3OfKCXQU7YczTw7M3JJ2sARW2x2l5exBkJu3r5LaN7MlaRO8zC+qCKGrPBMT9EVw4LY53PTr4SXmfPK+x7aR+IW47YiU+mzBppVngTRsna6icce05k/CsZ3hBXxrlh3OluYkOUeimIFPgT6LZ2iRU42+WMOBd5yNRnJuym9DrHMJOTabvJqe08z+DrOLAliAp0332+/2n7FAmLoml4Z8XIjThw7wkrr8EtNeBk6tXyfQ9j3OYL9PO3HpzMgm5zgfnATstFx5EcxIhtx9JhmZKODy82n4pNbo7W4NKzVVRirtWo1jNlHt2UXslhu3o6EeSv9i+KRdpGTSipaCTov73psvcmFl4gW1zNaG3ulzfPJ8qxxDpjIZXC3jutW8lyQ59MKuvtOfa5nutsv46QypQ3Dj7mlm2GagIGlMgC5Ins/V6r3W/fDySGG1lApdeaaqcluypISoo3JQgdtvS5jns4N++BJvAoKR3P6splvu8O9g0H/Xz0NNRvAmxVo50jWJJsrt7nAj8F8HrlfEydIvcKr8orwiVLPM/LoHhHM3H7k39IxfUJkP36NXhP8o8BpMg6SVOFPWHegRxjQYRlEuUZ5/vup9Ps6baG1CVPA1tqEWZswT2/ClGPgh43CILW8BsZPDIxXFLeSK7UAGN8DEDeGXu/6p4NhPQBmx8c8NBDL1dMgIEdht4ty8LZ0QE7dXSnLwazlzCCXQSmmGgegPRdfEkcqnhAbg3IGcTHDmW+EuShETX08teipo4xGaXaVVZx0cjk+ZNpHcc5GHFrReBJ6X9UudbqFIe+L+cQoLo35JGOOIjXUFyF+toi5NFimcuwMhSdMeqzb9R/Pem6MS70E587aW76Gmvy3hprVv28Eaq695dW1PnNvObJIq6RgsT8W9+OxU0fymBg/fSSWhS1+bJaW4mfpohecWieSpAR1+Nr34NFlFZC6Oxye9t+eDXuOeTqzosh/n/VOP7HnWIQ1Ye1nVr9n42fOFaZjJTULr8pJLTKJNfRS17JEvh43sm3mnM08PIWqWzplPuRSc2fOaOhuFKRTLz3DIv8zI36vPArLHtyxqAgfBP1W417mlGF8WXp+RnlGJqGkKbIfOLeTAJ4b9owGlhBG8WymDDCYPWdVWXIrQidnXjhtzMF96YfxLSViwFrzNsvGLIYl585pE6qOp9CE4DKgDPDK9sGEEdDn329/z9ZQmAJTP5vE8nhdXiOon2291CnCLvD0Z5jSpMUayjNNCCSG7qlkDmMkorTp+DWdjGOJ00kOVCeLvPsCtkNvBInW7ai+TKuGrtJtIxcGssWbAPjtAJRZoC5uoDbdukH2Lk4Gd9GolW8TDAEA+xRegoxEQcrOb8eWhHGhlRdfU8OD9NrxUeSDiJ1tJ9MAy2lVOuPQBYPFRfgFn0IhvHtWeRMQKCW6U6FR2zSYaI9XSqcHGdDj9w5M3ejOBIu8XehZiTHvPcA4VgJmm3JqwCjgg9BPKQNJZCHvigjcDr8BeR4JLwoTS6t/1X20XAxrI8MKULj8cdO6fmvG7NvSmA6u8DpKZz2KE5tXm/dhCwVcx4UtiJT6rVV9onH5CqWqrlOjJPOkcRu83UuFbVTUctT7ePFr9/CMI3bR1m8tOuRjtz+8GHw62lstapdk66B2cxEr/onsQquD/KsC3mcn+91h7+LtpyXjRGSNJFU1D/MaZT63SBdW3Lr8UFtQdq4Dzg5fE1rnFSd/Z6E7uicwTziRh0HmnPoamjeH5lbXrbG5s8bm2lQVcvvNgXPRsOeDzoUkfh3wnHO7xudrfL7G52t8Llm6Fz4/7Z0cdvfWAF1nRywLlQidAh5WcAiVZW0yFoQVgGn6fY0B1c79bua9b5hL3W9tpKfd98qW/gxxpEtmGMwUaJeEc3z0WWxkxmIDFCZkSBHhXqPIhj6H7eJmYIGmtMtz1Vxo4U2cBISpYmBg4t6gLSBwEd9hr9/rS+57L/5Ww51PkDLGxngBRQwXhkkgGr9FfMdslJxdXBfioVopR3jr4OH1qbo1LquHy54BtPpw/OsaWenscOWoASv8oyGukuDg2r8Tqbm+CnTFdTaybU7DLdUm2cta49bwaQ2ftI9LXVAik5ScAVq0oKvF1jothjO8FrCcTUodbDlQw047CuottkIVU8Fu5LXQVN6xk+lZyOiH7f+qhYx+AVolafGwmkfNkZcrhdmr+HMspUTYWS/Sjri5XnbIypfZxcnDni5BX8O1nFM1h1OJLQ5YzmnB3ln3uyshLSgj3p3rs5Rzbq/Mb+fhtRPG8fV8pqmI57o4r3R5vv8CvZJ8yc791udne47nKU/yLL+emgf84nmkttloBkkMUcoLLJG+PH6DZcXOPpSn9VOZwrwG2uAiAZK78Mioj8dkEiFZCj23EM1EW7RdSud92JZXnGSKq4bLMFMAK1qGm+eif/KFu/HqdHh8/MvZSbPVaelVY4PLZllSR9sak3lWzym9o3T42P4eRpYyPK7O36OZiEC8yVFcbcXB4IDnluYxvx41X4vEBUj2MdctM7oEQ1ImToddOcfux3O3L+EPaNz2dvFRV2cj9Meaa1+cdA1jgPrOJeqZsoJJcDXJcgXnOHuLC4r79OwVcX17QBlX69sDavOyvj1A00CLSuDkGoVxipaAw084MlcL5hAIogy0n4tuFTRFsc9ISdB1qCj0HSfG8JXbIMVdQDJXxQuK12EWLBWqPe2+hjOzD3QdQp1an/i2hEUsNvq2wV0LKtBV33H+/AqWs+i82kWEWCC3ZaYfdMXp2eHLWC2ISm4BtdqiF73VWsKHrkjUcZ5jrTAqszht6+y3tqFqvI2UXRtrcbGzA7RDGFFVF95jZgI5rSnq+rDtlt5Nj7whtsTR38PeO7GVg0VoUMu/Pu2/Pxiqr2nsn9wpZ3bc4fGgt1/z8CzfyGp0TPdhd7m6R+8b72x9tSdmq62RyHdrRtR/VcaIF4Om9UHSQGlluMzzH7cbxFN5qWucAIJwVc6gHJ04utIJCftDPF1IaG1WrM2Kh8qR8+xS5HwFhoUXsFCdVj51ikIc6NUUeD7NBAoVRbedtpDdOodOZNVrA6K01rUB0dCAwOU7Zz+I5a2jrVtPu8t82B32h2f7GERG+FcwWFHi+Og9L0IlRDueFw7e7w+G3aO9XjMk3DhlzYOi4aNe93QNhgkMY1BI8IB3ta3hsCAUsEj9jcT1grlxR6+u6vnbNiwqUz/zk3RzDavXsPpb8tavUfUaVa9R9XND1QwH1MTVfA37VgB2lV+6u98/Y0En5Jemdq8BueyAFQHyj/3hQf/om4Xk+IeGyDmQ0ya6/YZTMCU2CW4wbZoUWQZO1GW//TGfbVYSWcGOJZh0kot1HCxPFxR/lrYVuQNYfEO8I1ZI6WkPcwQpYdVIF4fbFu9R3fCz/23MxbCpknc2qPncOk/zHSPahAvVQ8ea8jLvIebXEMvsonaHD+9mfit/FzFtRy4oxDYpfe8K1u4//siJYK3ifzOK2VzQnNtxsIrc5dR6TbmO+NzKeB3O3340vv/T8QGAF9ejkg8tWdcPVl1Fo5Yld/n9VEBZ/nRGp1JYZ1kHQUz1yiSZfWjJSY47fZMV8BWmFWpL+9XZKNrc1azUKayME/eGJ8LBWxoYDNYaxv4PDRyhOrpww8AtlEB63XFavwPacK/8KP2d59u5/D33Ne5W/x8iMl+r + eJzVV9tO20AQffdXjBBSEpRAW6kvplDSEBFVVAqpeKigitb2ODFd77q760KE+PfObpz7BdOGByzFt9k5M3M8Z+x8+pwNM887Ojjw4ACaiomBPP8C3U4XQp6gMD40ry7hd45qBAp1zg2ELBwiDJmIeCIG5GddzzIW/mIDBJiitByAM7LcDKUiG3xlAr4bxJQJ4UyhzEYqGQwNtKZnH969/1gHoxICFBou0qBTJzOXA4F1uEBF3iPyPvI8wVLUFBuXwh57XsiZ1nBlU2/ZlDs2Y1SADwZFpKG49h49z2bmOLDbAVxwGTDOR2ByRfGlAEMVryei8Jm4npmhkvca2g8hZiaRojAcuWOWBzwJIc5FaG2AggUcqzVnfBwvpW0/VxxO4FrxDvIMle8HecIjuq7ST/v+de+yf3Xd7v3ot5qtTrsON5VMSVppEtSVn7XjGZQZJrpxOkDTkkKgC1utNU6z3FRtmPpkxZ2Woo8ilBH27xXLCKx6U0npsgInp1CRgnAL4CfvWcri+LU4ixL9dkiL43KsaTR6C2FgJERWMxFY8B303LlD+0Zgb4LIcfELXC5R2eLI1FYOY5pA1hzmStGEgIgZFjD9f2yGNuwuKCxDW4QcDTrmpjzY/TIXPRyr0FZLlSp6LBArmbobY2bGlCTiX9mY2pWLBUwpNoLGNBwhzwVaoHAtj1Rre+y6k34s0lhsxqIbTjbySzcm5E69ivoKZ7fmq7bLNzViM7rLdaHmgdP3poaciealpGdMsRQK0vdnOM7emHvMG+IdTpC2b8aphnN5Ty/6OXfCExAg5BojvxxUA1L20HPZaN+eJ2megsjTgN7IMi4S1WXzYmZTkfcJ5zCUPCoHRRUtt/7zldBY8mEmsTVZUEdLW1dcLwdKi90rIDFLo/4QulLrhCY2/GE8J+6ZKpnonhR7ddrHMR0owN4Ydu9wm4S3DjtKsTttgupK960IN5DRqGtbVVvRzRbOycuJ220vUPiSqDMpNG6Rdam3zVyytQ36d3FKTID58btz6Zd+WIOFh7V2qL4y78+M0010PhWf7n3GE6arKx/wvu/MdajcTv4i3BYf/8HtyuoK4f4FYBu70Q== - + - ArangoDB PHP client: single document + ArangoDB PHP client: http helper methods - - - + - - \ArangoDBClient\Document - Graph - \ArangoDBClient\Graph - - Value object representing a graph - <br> - - - + + + HttpHelper + \ArangoDBClient\HttpHelper + + Helper methods for HTTP request/response handling + + + - - ENTRY_EDGE_DEFINITIONS - \ArangoDBClient\Graph::ENTRY_EDGE_DEFINITIONS - 'edgeDefinitions' - - Graph edge definitions + + METHOD_POST + \ArangoDBClient\HttpHelper::METHOD_POST + 'POST' + + HTTP POST string constant - - ENTRY_FROM - \ArangoDBClient\Graph::ENTRY_FROM - 'from' + + METHOD_PUT + \ArangoDBClient\HttpHelper::METHOD_PUT + 'PUT' + + HTTP PUT string constant + + + + + METHOD_DELETE + \ArangoDBClient\HttpHelper::METHOD_DELETE + 'DELETE' - Graph edge definitions from collections + HTTP DELETE string constant - ENTRY_TO - \ArangoDBClient\Graph::ENTRY_TO - 'to' + METHOD_GET + \ArangoDBClient\HttpHelper::METHOD_GET + 'GET' - Graph edge definitions to collections + HTTP GET string constant - ENTRY_COLLECTION - \ArangoDBClient\Graph::ENTRY_COLLECTION - 'collection' + METHOD_HEAD + \ArangoDBClient\HttpHelper::METHOD_HEAD + 'HEAD' - Graph edge definitions collections + HTTP HEAD string constant - ENTRY_ORPHAN_COLLECTIONS - \ArangoDBClient\Graph::ENTRY_ORPHAN_COLLECTIONS - 'orphanCollections' + METHOD_PATCH + \ArangoDBClient\HttpHelper::METHOD_PATCH + 'PATCH' - Graph orphan collections - - - - - ENTRY_ID - \ArangoDBClient\Document::ENTRY_ID - '_id' - - Document id index - - - - - ENTRY_KEY - \ArangoDBClient\Document::ENTRY_KEY - '_key' - - Document key index - - - - - ENTRY_REV - \ArangoDBClient\Document::ENTRY_REV - '_rev' - - Revision id index + HTTP PATCH string constant - - ENTRY_ISNEW - \ArangoDBClient\Document::ENTRY_ISNEW - '_isNew' - - isNew id index + + CHUNK_SIZE + \ArangoDBClient\HttpHelper::CHUNK_SIZE + 8192 + + Chunk size (number of bytes processed in one batch) - - ENTRY_HIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES - '_hiddenAttributes' - - hidden attribute index + + EOL + \ArangoDBClient\HttpHelper::EOL + "\r\n" + + End of line mark used in HTTP - - ENTRY_IGNOREHIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES - '_ignoreHiddenAttributes' - - hidden attribute index + + SEPARATOR + \ArangoDBClient\HttpHelper::SEPARATOR + "\r\n\r\n" + + Separator between header and body - - OPTION_WAIT_FOR_SYNC - \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC - 'waitForSync' - - waitForSync option index + + PROTOCOL + \ArangoDBClient\HttpHelper::PROTOCOL + 'HTTP/1.1' + + HTTP protocol version used, hard-coded to version 1.1 - - OPTION_POLICY - \ArangoDBClient\Document::OPTION_POLICY - 'policy' - - policy option index + + MIME_BOUNDARY + \ArangoDBClient\HttpHelper::MIME_BOUNDARY + 'XXXsubpartXXX' + + Boundary string for batch request parts - - OPTION_KEEPNULL - \ArangoDBClient\Document::OPTION_KEEPNULL - 'keepNull' - - keepNull option index + + ASYNC_HEADER + \ArangoDBClient\HttpHelper::ASYNC_HEADER + 'X-Arango-Async' + + HTTP Header for making an operation asynchronous - - $_edgeDefinitions - \ArangoDBClient\Graph::_edgeDefinitions - array() - - The list of edge definitions defining the graph. - - - array<mixed,\ArangoDBClient\EdgeDefinition> + + createConnection + \ArangoDBClient\HttpHelper::createConnection() + + Create a one-time HTTP connection by opening a socket to the server + It is the caller's responsibility to close the socket + + \ArangoDBClient\ConnectException - - - - $_orphanCollections - \ArangoDBClient\Graph::_orphanCollections - array() - - The list of orphan collections defining the graph. - These collections are not used in any edge definition of the graph. - - array + + \ArangoDBClient\ConnectionOptions + + + resource - - - $_id - \ArangoDBClient\Document::_id - - - The document id (might be NULL for new documents) + + $options + + \ArangoDBClient\ConnectionOptions + + + + buildRequest + \ArangoDBClient\HttpHelper::buildRequest() + + Create a request string (header and body) - + + \ArangoDBClient\ConnectionOptions + + string - - - - $_key - \ArangoDBClient\Document::_key - - - The document key (might be NULL for new documents) - - + string - - - - $_rev - \ArangoDBClient\Document::_rev - - - The document revision (might be NULL for new documents) - - - mixed + + string - - - - $_values - \ArangoDBClient\Document::_values - array() - - The document attributes (names/values) - - + + string + + array - - - - $_changed - \ArangoDBClient\Document::_changed - false - - Flag to indicate whether document was changed locally - - - boolean + + string - - - - $_isNew - \ArangoDBClient\Document::_isNew - true - - Flag to indicate whether document is a new document (never been saved to the server) - - - boolean + + \ArangoDBClient\ClientException - - - $_doValidate - \ArangoDBClient\Document::_doValidate - false - - Flag to indicate whether validation of document values should be performed -This can be turned on, but has a performance penalty - - - boolean - - - - - $_hiddenAttributes - \ArangoDBClient\Document::_hiddenAttributes - array() - - An array, that defines which attributes should be treated as hidden. - - - array - - - - - $_ignoreHiddenAttributes - \ArangoDBClient\Document::_ignoreHiddenAttributes - false - - Flag to indicate whether hidden attributes should be ignored or included in returned data-sets - - - boolean - - - - - __construct - \ArangoDBClient\Graph::__construct() - - Constructs an empty graph - - - array - - - array - - - - \ArangoDBClient\ClientException - - - - $name - null - array + $options + + \ArangoDBClient\ConnectionOptions - $options - array() - array + $connectionHeader + + string - - - addEdgeDefinition - \ArangoDBClient\Graph::addEdgeDefinition() - - Adds an edge definition to the graph. - - - \ArangoDBClient\EdgeDefinition - - - \ArangoDBClient\Graph - - - - $edgeDefinition + $method - \ArangoDBClient\EdgeDefinition + string + + + $url + + string + + + $body + + string + + + $customHeaders + array() + array - - getEdgeDefinitions - \ArangoDBClient\Graph::getEdgeDefinitions() - - Get the edge definitions of the graph. + + validateMethod + \ArangoDBClient\HttpHelper::validateMethod() + + Validate an HTTP request method name - - array<mixed,\ArangoDBClient\EdgeDefinition> + + \ArangoDBClient\ClientException - - - - - addOrphanCollection - \ArangoDBClient\Graph::addOrphanCollection() - - Adds an orphan collection to the graph. - - + string - - \ArangoDBClient\Graph + + boolean - - $orphanCollection + $method string - - getOrphanCollections - \ArangoDBClient\Graph::getOrphanCollections() - - Get the orphan collections of the graph. - - - array<mixed,string> + + transfer + \ArangoDBClient\HttpHelper::transfer() + + Execute an HTTP request on an opened socket + It is the caller's responsibility to close the socket + + resource - - - - - set - \ArangoDBClient\Graph::set() - - Set a graph attribute - The key (attribute name) must be a string. -This will validate the value of the attribute and might throw an -exception if the value is invalid. - - \ArangoDBClient\ClientException + + string - + string - - mixed + + \ArangoDBClient\ClientException - - void + + string - - $key + $socket + + resource + + + $request string - $value + $method - mixed + string - - getSingleUndirectedRelation - \ArangoDBClient\Graph::getSingleUndirectedRelation() - - returns (or creates) the edge definition for single-vertexcollection-undirected graphs, throw an exception for any other type of graph. + + parseHttpMessage + \ArangoDBClient\HttpHelper::parseHttpMessage() + + Splits an http message into its header and body. - - \ArangoDBClient\ClientException + + string - - \ArangoDBClient\EdgeDefinition + + string - - - - __construct - \ArangoDBClient\Document::__construct() - - Constructs an empty document - - + + string + + + \ArangoDBClient\ClientException + + array - $options + $httpMessage + + string + + + $originUrl null - array + string + + + $originMethod + null + string - \ArangoDBClient\Document - - createFromArray - \ArangoDBClient\Document::createFromArray() - - Factory method to construct a new document using the values passed to populate it + + parseHeaders + \ArangoDBClient\HttpHelper::parseHeaders() + + Process a string of HTTP headers into an array of header => values. - - \ArangoDBClient\ClientException - - - array + + string - + array - - \ArangoDBClient\Document - \ArangoDBClient\Edge - \ArangoDBClient\Graph - - $values + $headers - array - - - $options - array() - array + string - \ArangoDBClient\Document - - - __clone - \ArangoDBClient\Document::__clone() - - Clone a document - Returns the clone - - - void - - - \ArangoDBClient\Document - - __toString - \ArangoDBClient\Document::__toString() - - Get a string representation of the document. - It will not output hidden attributes. - -Returns the document as JSON-encoded string - - - string - - - \ArangoDBClient\Document - - - toJson - \ArangoDBClient\Document::toJson() - - Returns the document as JSON-encoded string + + eJytWvt32sgV/t1/xcTHXUQC+HH27La4pCZYid21wQdwumnscgYxgGohUc3INtvkf++989BbGO/WJyeANPPNfc2931zpr39bL9d7e4dv3+6Rt6QbUn8RnH8gNxc3xPFc5os2WQqxJkvmrVlIVkwsgxmHsTj8bE2dB7pghMQze3KSvEkjGBvCPfJ36pORYGxFfV/ecoL1JnQXS0F68beTo+OTBhGhC4A+J59W04sG3PaChc8a5BMLYfYGZh/u7fl0xTiszXLLnsaKXGTEJXOQ42I8viEh+0/EuDgMYX7gc0aW1J95rr/Ia1SiD3d9B1U9ap1IMRyPck4uwDpqtb3/7qGyUgL8e6uWvBmMxoSDXv6COLCmoIgnBxzKT3mRXNvji8H5RI7ukBp+1kCfUsTb1wDeKrzbSrhz+8oe27sj6vEAqr5V4X6yXyEmDgZE+KiCu7C757vjydEAiJ+VduyOexevsKQcjrbELyWgvWXkPxDu/saI5UerKQRgMCfTjWCcrMPAYZyzGXF9EviMTKlwlvWS1XoXt/1fJqPLf6KJ/3z8l5PiQrY/Q2SIW0ZWNHwgkQZGtUog7cEVYO3fhXf+fhFtxNY0pAK2yJSJJ8Z82Ox0BsLD1iDTYLYpQRzZN91hdzwYGtwKbGln0F0ETuCRRxZyN/CluA3YeuGs6QQzEF0E8b3j1nHJejfDwXjQk2rUEPMQhpV5IGRUMELRwk3hrpgSADB85giEn25IsGY+epwSHjgPTODqYskIZyEIoaEM4qUgLpe3Hep5LKxxonOHO3U9V2xwtuMFkEokhkTMYZyJZRg8cUhmUgz72WFrFCY/DN2wMqPg/kCO4uQg0F+aaU30xTxIyEQU+ihkEIWQr5pGyydXLLWOKZgGXPc8IiUkT0twvh+kV3EgdU8ZgZxJp57Ll2yW8c46gqsO7CEq4GMe+XqW9EOiiVWtlNoCKnXi3wHzZ+vA9QW42oxpvl8w0YvCEFKxrW9b9dNkDggs2DNOgd3M6GqiL0yUIDg2HuzOiWVA2m0AHm/WzIqXrZNOp0OSAeMvN/ZkNLqqp2SUUXcIxhSgcgh+DwmMMB6R1QaDwUBm5uUEBIyJmmcZLRqkxrlXgw9wlTvfTNYM4q4RW+NrwZjt9uBmfDnoTz7bw8uPXyY9ezi+T9kH/85+58ITLLavXn3S717beRFeIwFstuAJhnjzCXeBAcx2E6F7dTX4x2RkX32EDPqpb5/nZcj8wFBw+URVAOtsB/xed/Lx8go0y4fDa/Vz6Nz1drRrvGhWle97BWV2Abu8ubCHo3vyBsLcjzyvTBMIbgxox11DbPM/pqjC2FFTLVxB0xKdD+Zr2O8mrFWSmyjOamVmJ3vZD4BEelCfU9u9kRl7wMKwH+SuAdnkwAlzV1/WZnx5bQ9ux/fZiaPx0O5eT3pXl3Z/POkN+n27N85hayvGF/P56w0on/ebSuE+eyrUGavgQAg/3w+ESfRYw+K0e1erkVZhRpKWW6R2V2sTGJRYRtstMyvlw5TXjLvAV1ifg0hYoMtOwWHMmTaGrnYAoVb7XqAEH4LIn9FwY3geJmfJvcxZgEDZFaaMZmgfrDf5MLjtn3eHX5B4/Prrrzya4nD4VklTFXfCZVb0QfIMrNUMGBZWRso3vgOe8oOobM3u6Eu/J8mrPZRLNtVBpNnFedsYj9FGq2nlOJxhmruTjfhvC+swMHrRdLwkc7RFmsADWROOTGw19YDzaQFTbkmmvAyvTnapK01lfnX95flR6GXi28y/HV69PBkNmpus7EI9aWzcT+uAixwSDUOanXfgRFwEK2UhrpDglKtHYhagruSq2ljMYyvIb1WkT4sKGLGV06defb9AS2XOrGClW2neNHK92VCBb6F4jWI0NIwHG9IVDWXThlY8Z5YO+Xqfp4kyCya1W04vFOVUSszqaNUu/UeoBDMC/0dMJQVAaBH7eY1yghUVcoMsIE9isgOmKCRTVEuVZrcDj/kLoNmSh8J3PTiXvXfIdR/wiHkvqagII5ZXTBUIX1JXTBM99bOJv9tkFXnCxTR1CHqtmjMq6Cmop/JgB3VBXtVuZxOcuQqHxZRuEHJwtNm+eu20hIloS7wnR+SHH3ZJ71JlOFWOldpzCgtXcBNYQG4zOJlBIYEjDBy8lkHkzSQlp0TL10R/6a1TLGhbTUjXawh4mbIP/80Dv1ZuHuX+skBIR7C2kbkHTmEU6o+VC3MKO0YJ+wvbkM578+szhmgxAtILtDrpqVChdX1OAVT4NxEZ7Dp3IYN5mzh9yFOMTh6JaiabQJCvYYuIuVX7EyfyX62wr9Wa5vhezzGLYpVoKUmAnIAXxBI8jM0SSDxQo9URFsopqLDNGNXBmr0Vi298fyVjtq0VURFcTxsu+z27DkZkCTPR1qqiJ58xC8kK7mdztS5wePqqaidsy9u56mXqZXMbrhZ5GgQe1hDviW64TD+ZJgFsPpDV1fkzBSe3Y4QbZ7cmwaNW/VpCWFrEskRvpMe8oFNXqlv67VuerlcMvt19rO5x7jocu5e7jpWdyZ1lxqSYHANySUA7DF1UuqV3qH+5cJPkPxZHUv1avSp27WfmRCWhizRXcl44tpd3xP4vXTUV4HGj60D3ubJ8VV+0VpAhsJGFUtXL90gqtSHEau0xwbKaQYqmeRaVxzDMNENIVYfWYq1Fi+xjBOwXCPnWXV2keFou/RhDX6ay0fzoYk91uil2NbfuRwEnDT5noaUt2YjtEWf1KhZmnGCm/h4mpj2FhqqVsyssS6FIdWyMfPU0wzqbP4WuYEUtUqBn87kX8WUs7mm6cqtioGoBXlFtklS3kUmOyGbxkMIIEQjqDaEcmSsdcpRvV5olbgKubqcrLAcKl6MNB3M3hBAkHb3f4xtPSxdKtaXvf/tG3sxZMK90BaCDXB2wAX5JzKTyTvL0IdeDkXlYTTXsDNdKLkGiKGFrU7j/sLVvlTLWu4Q3I2y9jFdKLctWSqwmJ58WB8QGlNLnhCojumnYViluWQ8uG0Cd7W02Z8mcB5xnOKvmzfrA5+KGZhwfQZbNPj4BbVZwRFxFKxLM50h/LbfFWsaO++ZhCXl+ft6vk2YZCp0Lhh1rKpBJO5pIM7Kflam9XzTOWgYvbkf4ZmlbYdcvO5MAnzo+yfszthiivNnG+eVaJRvTkg17Hk1BgmR1ifeOHP8Eix7VT6WhfkrOZHm1iMnFWxdU29RA/6xQf4ZLAA0XJE2duQu3xFGxnqkqrx5MVumqHRM/tpacQacxOE4neV0RM1UGZtugJHXGeVAf8Ml4lvKqY3ADDvRCIm5D6g/GMfEAPHlsrhyf3wzpNJj++164+v2V+8y0s+VpM5eht+1BydtHeL5QEZKJ4+TRZqMYDvWiKlKuBPDlmE7GQu77UQbVj6lIjZeviNC8nhnAnMRFaV82cQ4/Y+Mkbb/v5CXZuRKULJ4cnNAHVdxzBMcMOBECz5Svp+hGNBxLgDjijVz7s7X9dIQY1xqCjCGqM6BqVKtibhDCrvdvVT8R56oL1MNeoj5Ba5YG2Rx4pWx3hsFqK546FEm8NI1USRponuST8nktFIcZTsQ2j3mUrTBSzcxXskzZhtuFM4LonF0k1rPSpmykjaMip5HTT+/LHK3UUkBMecGMWYqZxK8cNEh2kZPKA8qNeuki5uz40oS05lK3XGS4UK0v3tVh03mvMiJ/KW40TlNa3fzKHBD+oGkVpGVWKjwtR0v0wEglJFQTF1JyK3kbBXurqbIc96aM7ZPXm2TToxHrXJf9KnwFpa9edcGGFf7M733VDUyNgyRyVMGGFEOT77WAM7QC2FaA5OLSYllCbOBHi8kKn+hY+4f/QvfeHd7N3t218D/+zoKP+iHmb4TFkwwOZbz0CW7WpIZfmClfj+9fSqJpw3fUkjvyTNA+kG8S4Bxuev/kgW3aMhSbnvsQh1jZbIzAeYCPzTE0XYx68Bp2gCm+t4YN2JX7m3oKBVG/AKoYuvgeURWYeArwdbwVJxYcMSAoaMhwTzI4pT8ydD+M2uirshMAaI866eKXOil1mCmyyh/Yqqy/XCk9lwvrAKwBHnxUDdFOnCBqkmBqwJOSulxp9R2gX0Au4cRmc30FTUUADsEzNeDX7zEm5BK718GvcTw2SIrhmjXuTe6DmfKFxAkcpinP7Ft5HSx9Z16uvNNvN07vkmF45v4fBozSrQ== + + + + ArangoDB PHP client: view handler + + + + + + + + \ArangoDBClient\Handler + ViewHandler + \ArangoDBClient\ViewHandler + + A handler that manages views. + + + + + + + OPTION_RENAME + \ArangoDBClient\ViewHandler::OPTION_RENAME + 'rename' + + rename option - - array + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection - + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + string - - $options - array() - array - - \ArangoDBClient\Document - - - toSerialized - \ArangoDBClient\Document::toSerialized() - - Returns the document as a serialized string + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - - array - - + string - - $options - array() - array - - \ArangoDBClient\Document - - - filterHiddenAttributes - \ArangoDBClient\Document::filterHiddenAttributes() - - Returns the attributes with the hidden ones removed - - - array + + + create + \ArangoDBClient\ViewHandler::create() + + Create a view + This will create a view using the given view object and return an array of the created view object's attributes.<br><br> + + \ArangoDBClient\Exception - - array + + \ArangoDBClient\View - + array + - $attributes + $view - array - - - $_hiddenAttributes - array() - array + \ArangoDBClient\View - \ArangoDBClient\Document - - set - \ArangoDBClient\Document::set() - - Set a document attribute - The key (attribute name) must be a string. -This will validate the value of the attribute and might throw an -exception if the value is invalid. - - \ArangoDBClient\ClientException - - - string + + get + \ArangoDBClient\ViewHandler::get() + + Get a view + This will get a view.<br><br> + + String - - mixed + + \ArangoDBClient\View + false - - void + + \ArangoDBClient\ClientException + - $key - - string - - - $value + $view - mixed + String - \ArangoDBClient\Document - - __set - \ArangoDBClient\Document::__set() - - Set a document attribute, magic method - This is a magic method that allows the object to be used without -declaring all document attributes first. -This function is mapped to set() internally. - - \ArangoDBClient\ClientException - - - - string + + properties + \ArangoDBClient\ViewHandler::properties() + + Get a view's properties<br><br> + + + \ArangoDBClient\Exception - + mixed - - void + + array + - $key - - string - - - $value + $view mixed - \ArangoDBClient\Document - - get - \ArangoDBClient\Document::get() - - Get a document attribute + + setProperties + \ArangoDBClient\ViewHandler::setProperties() + + Set a view's properties<br><br> - - string + + \ArangoDBClient\Exception - + mixed + + array + + + array + + - $key + $view - string + mixed + + + $properties + + array - \ArangoDBClient\Document - - __get - \ArangoDBClient\Document::__get() - - Get a document attribute, magic method - This function is mapped to get() internally. - - - string + + drop + \ArangoDBClient\ViewHandler::drop() + + Drop a view<br><br> + + + \ArangoDBClient\Exception - + mixed + + boolean + + - $key + $view - string + mixed - \ArangoDBClient\Document - - __isset - \ArangoDBClient\Document::__isset() - - Is triggered by calling isset() or empty() on inaccessible properties. + + rename + \ArangoDBClient\ViewHandler::rename() + + Rename a view - + + \ArangoDBClient\Exception + + + mixed + + string - + boolean - $key + $view - string + mixed - \ArangoDBClient\Document - - - __unset - \ArangoDBClient\Document::__unset() - - Magic method to unset an attribute. - Caution!!! This works only on the first array level. -The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. - - - - $key + $name - + string - \ArangoDBClient\Document - - getAll - \ArangoDBClient\Document::getAll() - - Get all document attributes + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler - - mixed - - - array + + \ArangoDBClient\Connection - $options - array() - mixed + $connection + + \ArangoDBClient\Connection - \ArangoDBClient\Document + \ArangoDBClient\Handler - - getAllForInsertUpdate - \ArangoDBClient\Document::getAllForInsertUpdate() - - Get all document attributes for insertion/update + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object - - mixed + + \ArangoDBClient\Connection - \ArangoDBClient\Document + \ArangoDBClient\Handler - - getAllAsObject - \ArangoDBClient\Document::getAllAsObject() - - Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection - + + mixed - - mixed + + \ArangoDBClient\ClientException - $options - array() - mixed + $optionName + + - \ArangoDBClient\Document + \ArangoDBClient\Handler - - setHiddenAttributes - \ArangoDBClient\Document::setHiddenAttributes() - - Set the hidden attributes -$cursor - - - array - - - void + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + + string + + + \ArangoDBClient\ClientException - $attributes + $body array - \ArangoDBClient\Document + \ArangoDBClient\Handler - - getHiddenAttributes - \ArangoDBClient\Document::getHiddenAttributes() - - Get the hidden attributes - - + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + array - - \ArangoDBClient\Document - - - isIgnoreHiddenAttributes - \ArangoDBClient\Document::isIgnoreHiddenAttributes() - - - - - boolean + + array - - \ArangoDBClient\Document - - - setIgnoreHiddenAttributes - \ArangoDBClient\Document::setIgnoreHiddenAttributes() - - - - - boolean + + array + + + array - $ignoreHiddenAttributes + $options - boolean + array - \ArangoDBClient\Document - - - setChanged - \ArangoDBClient\Document::setChanged() - - Set the changed flag - - - boolean - - - boolean - - - $value + $body - boolean + array - \ArangoDBClient\Document - - - getChanged - \ArangoDBClient\Document::getChanged() - - Get the changed flag - - - boolean - - - \ArangoDBClient\Document - - - setIsNew - \ArangoDBClient\Document::setIsNew() - - Set the isNew flag - - - boolean - - - void - - - $isNew - - boolean + $includeArray + array() + array - \ArangoDBClient\Document + \ArangoDBClient\Handler - - getIsNew - \ArangoDBClient\Document::getIsNew() - - Get the isNew flag + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name - - boolean - - - \ArangoDBClient\Document - - - setInternalId - \ArangoDBClient\Document::setInternalId() - - Set the internal document id - This will throw if the id of an existing document gets updated to some other id - + \ArangoDBClient\ClientException - - string + + mixed - - void + + string - $id + $value - string + mixed - \ArangoDBClient\Document + \ArangoDBClient\Handler - - setInternalKey - \ArangoDBClient\Document::setInternalKey() - - Set the internal document key - This will throw if the key of an existing document gets updated to some other key - - \ArangoDBClient\ClientException - - - string + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array - - void + + mixed + + $headers + + array + - $key + $collection - string + mixed - \ArangoDBClient\Document - - - getInternalId - \ArangoDBClient\Document::getInternalId() - - Get the internal document id (if already known) - Document ids are generated on the server only. Document ids consist of collection id and -document id, in the format collectionId/documentId - - string - - - \ArangoDBClient\Document + \ArangoDBClient\Handler - - getInternalKey - \ArangoDBClient\Document::getInternalKey() - - Get the internal document key (if already known) + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use - - string - - - \ArangoDBClient\Document - - - getHandle - \ArangoDBClient\Document::getHandle() - - Convenience function to get the document handle (if already known) - is an alias to getInternalId() - Document handles are generated on the server only. Document handles consist of collection id and -document id, in the format collectionId/documentId - + string - - \ArangoDBClient\Document - - - getId - \ArangoDBClient\Document::getId() - - Get the document id (or document handle) if already known. - It is a string and consists of the collection's name and the document key (_key attribute) separated by /. -Example: (collectionname/documentId) - -The document handle is stored in a document's _id attribute. - - mixed - - - \ArangoDBClient\Document - - - getKey - \ArangoDBClient\Document::getKey() - - Get the document key (if already known). - Alias function for getInternalKey() - - mixed - - - \ArangoDBClient\Document - - - getCollectionId - \ArangoDBClient\Document::getCollectionId() - - Get the collection id (if already known) - Collection ids are generated on the server only. Collection ids are numeric but might be -bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used - - mixed - - - \ArangoDBClient\Document - - - setRevision - \ArangoDBClient\Document::setRevision() - - Set the document revision - Revision ids are generated on the server only. - -Document ids are strings, even if they look "numeric" -To reliably store a document id elsewhere, a PHP string must be used - - mixed - - - void + + \ArangoDBClient\DocumentClassable - $rev + $class - mixed + string - \ArangoDBClient\Document - - - getRevision - \ArangoDBClient\Document::getRevision() - - Get the document revision (if already known) - - - mixed - - - \ArangoDBClient\Document + \ArangoDBClient\DocumentClassable - - jsonSerialize - \ArangoDBClient\Document::jsonSerialize() - - Get all document attributes -Alias function for getAll() - it's necessary for implementing JsonSerializable interface + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use - - mixed + + string - - array + + \ArangoDBClient\DocumentClassable - $options - array() - mixed + $class + + string - \ArangoDBClient\Document + \ArangoDBClient\DocumentClassable - eJzFWG1v2zYQ/u5fcQWMWg6cpin2yamztrGTtOjiIskKDElg0BJta5FFgaScGm3++44veqMk1yswzAgQm+TdPXd89Bypt78nq6TTOTo46MABvOckXrLxB/hy+QX8KKSxHIII42VEIWB+usYBXKeWvkuI/0iWFCC3OtMGepKkcsU4zsEnEsONpHRN4tiZOo8YD3H6A+GSRkLP+izZ8nC5knCWf3vz+vi3AUhcu6SxgIv1/HKA0xFbxnQAF5Sj720GC9H6ChTA8as3OHLU6cRkTQXCpQ7SkzzvryRKKbD539SXwGnCqcB5zBsILDlJVtb72zk/3Sv/Ogo/IgKxK2dAv0kaBwLGWUm/d9RSDUZ9DrJ1AfoP6CKMQxmyWNjZI/3fxwEJk6vb679mk/HFZDaenH+8+nj7cXp1AyPoKeNxYdvDbPcKAgvO1ug9irAYO6OeX0//UJGUwf7uJdvL+e1UuZZsf8f7eD2bfv48OVM1Ut4Li9YojCcrpOg+vqfXXy7fX5VC6G0wDs4K+4ZQtysKUYiO2KKelvmOVJS4SpPxlbXLzN9tCIdJZbvvHlodvqokkHAmERgNoDtzGIPo7x52g61XZwdcZSloZTHhFGImIRUIIIwBn2MXrwqzO3PCOdnugNSecG1vspTdnM/UNvPUlwg5BrpO5DbThSqehHCytoi6SnfU+CGwRLkn0QB0ViQCPbdAHSy7ceyNlWi0z+ZcF7knR4Gqk3LF2ZOA+6py3Zt/k28+1d6rdUvnUejDIo11qWA287OieCbTEcRphBAd9Kqkfe3iu6mrru0RbgTdYDSYo44+ER6oB3idEBnOwyjE+s45JY/wtKLIEUWARchxh3WBqKQcQqGH8zg6bB4gXID3IhQzPWoA9uHlS7spL0YGbB++5xbq05WrUByeCiq93uyRbnsDY9A/yZc9V5NQol6BgfKmfiNOlVxeI9wmnAnMJPFlinv4xPhj7swYDIeVulqnNvxznZjvg8BQ0nloLIrmh8aQrCoY0K0+/Ug65UD7LUZrrjiVKY+NVjZQ701OvWYSkSCowvB2o8p45OyXq1yofiPX9KTYNwtaG+eVdQp7QWVRgLIc75Qj69nV4l+ozJLKqhfhucmX06jX4KeUqQnlPqRBYipt77rKaelS8/kfEGbqhPZqYNpYUpN7wxN3+BeZ0tAL9+GKqeivcsQtxk9ZUqtBK09uMC97+gUiEeU8ldRJQp0FUCbByxeAUdp1ilo9R6Wz+ZXOAKjbT2EUwYZEYUCkEfeNOYCbehXOSBzAWt8BdMfC35kfmjUppfSFB3Qextpzrd625zX3uBaaq9xU/66m5yxeh9/wNAFdg+DQIlGNua1s2d5vWBjs3GHViBSIgfXubq7qchrkCBuaoNFiOGy+ELiNThtaSgTsq90Kd5X66KuRXcD4cJhtm2cRnVQsSt1RfRwN/kAEnZpLFvZf+uQIpdc/qZpjDSnxV2BjARHKYxNKt3uN8PbKYtoOwIlUjUaDu3Ix1T3nQQdXN52m8A0QDk9Rq85xfVmptP1Jzfx5fyy3U4NEsn+D45aVUaDtPhhqjpCN1zQixomDq7j1PDQ4t1Srt3u3v7tsyr8BjfDu0Mr3+t3rf2J8E2Ubt6ooSUND+1kdqu6yo2NNLcqn1hLWksgbIRLgoVr5iFxS0W8692g5My+CDjeUS5TfHO9hGgchN3cq3S7EIJfrkk5rQcT7HUP3eBjeJlrvm3vjTq1uOWY5t7xwo3pLuVfeaPh/5mBzLtfOC5jIKNugpoNYUVfFKp+lsfS0MJ3C69qVgpiz6N3rh+qmdudqgugIVZ2oRNBL/WJp+VGuLHxuB3UMP35UHHo1OpbWq2frWN2V6qtKK1uAN4ZrNHUS2WnYnWP59K2t6+O3unb3O82/3N0wvFStx+GW19MnE5ZQTsxrhzjagkiThHG89Rte48FFrkD1lRLl7evR0jmaW2L19tkdXe0aaei4qQxtTGq+AdiXGTmCJulQgdpacQG9dpik4/zYiH/61eYMVZIITx/sh0M9NIDeffbWNnvVML/XK1Rp/gGsVV+5 + eJzVl1tvGjkUgN/5FecBiSGCZC992UmTbTZBSardFBGaqkoQMoNhpmvske0pQdv89x7bcwcWstutspYSwD5X+/OZOa9/jcO40Tg6OGjAAZxJwufi4jfoX/UhYBHl2ofPEV1CSPiUUYlCRu5NTII/yZwC5CrnVtoukkSHQuIavCUcbjWlC8K5XQpEvJLRPNRwnn/76Ycff+kUri8Xk6sOLjMx57QDl1Si9ipzrCIeGLcAPx++wpmjRoOTBVUYEK3FclyklYUPOiQa0B7Grmxi6rCe0oaEMqeZy4ARpeAO1a9Su/RRUz5VkP5u/NUwIVr3ZhyApCZMELGOBE8nj+xnILjS8K4/vH53Mx70bs7+6MEJtJxCC5OoWTqXlGgKxIafTmZrwzBSsIwYg6AsBQlmMMfkKcyjz5S7STH5RAMNGDFGpxPJ8SsQKckKxMwKOyPTsnhLAdFaRpNEU3X4eiJPzV8tjDc6lGKpoPcY0HLC+XpMJFnYDYSmNd7F0GklrGUYBSGEguGumlgiPhNIgrGWhWfFtYBJHmndT5aXSSqfrJxm6SDiZMKiAGYJD6wXZ9MromxbMXe0ZjRtGgq/ncB9PmuG0fH93s1w8HFsD9SNk1NnqHs6p/oGj9drd7bqDT/2N+oNV3FFb3RcBJRIlmrAe8mU778f/D6+u+59KMlIvCyIHEWZpkZerNFzwTm1aXvt7mkslPaMsU4m8kkJPqY8EFM6XkoSx1R6afrtdsm4kUsDyB1ZB2+VMV2SdPkoqq+nnlW7Lyd/fTFqp+ibkZ5jsQlnjGXWntZuyCXVu67HPBfZyrBj9BZZx6vjKMXhQHV3uaBwC3cmoy8zwhSt34yHapV5cB/1+7I/q5iPt5lRg4Sl4YoyPDXfnyQRm+Jvr0pIB+6tgcq+7wOLdY1eyoc7JZpsRaBiPWEaBTlurtksz2re16/PqAPrC+Z+jNrHdWs5U2sKW5hyartZwsoXS4FbqCOq/l3hW0SPWFWzymc/LFEEiysoRxw+QCN8MBBz/kja3XbKXMnuwsD+VJUqXqrV8MGAbwOEyKIrsapacSqlkDXmdhFX7MVm8NCFW8jTSLNol4TsuVmhk7XKWJzsU+Of49yBVhFpawMv+5G9hZq10vZk/9chuv2vIXLj+ShlthwvzSI0tOXmlpEOndli8UVxiLe9X0Oxs57P/5LOnY/pZK+ndLEJz3pSryFvNPIyWUf8Ar2kjL+k2jgRghmW2ZKs8D1SJthRLL8pf1NMPK2A8DIhq2C1BaUpZRTfdbdUO7Nvf1ffBq652fjO9V2OPbOSCjatqhtd+3JhJ7CBwG6LMZf2NydmMx+uj8sKk43sOxWjtDvB3mStHTENhYlktJsMU2QqQTynuinKZr5f6W1HtZZnjwYjl9+BJiZvO/MxYRFRXqk/9327gOX2AQnBLp+r7A188lCSa6GHr/G26dU= - + - ArangoDB PHP client: single document + ArangoDB PHP client: result set cursor - - - + + - EdgeDefinition - \ArangoDBClient\EdgeDefinition + \Iterator + Cursor + \ArangoDBClient\Cursor - Value object representing an edge Definition. - An edge definition contains a collection called 'relation' to store the edges and -multiple vertices collection defined in 'fromCollections' and 'toCollections'. + Provides access to the results of an AQL query or another statement + The cursor might not contain all results in the beginning.<br> -<br> +If the result set is too big to be transferred in one go, the +cursor might issue additional HTTP requests to fetch the +remaining results from the server. - + - - $_relation - \ArangoDBClient\EdgeDefinition::_relation + + ENTRY_ID + \ArangoDBClient\Cursor::ENTRY_ID + 'id' + + result entry for cursor id + + + + + ENTRY_HASMORE + \ArangoDBClient\Cursor::ENTRY_HASMORE + 'hasMore' + + result entry for "hasMore" flag + + + + + ENTRY_RESULT + \ArangoDBClient\Cursor::ENTRY_RESULT + 'result' + + result entry for result documents + + + + + ENTRY_EXTRA + \ArangoDBClient\Cursor::ENTRY_EXTRA + 'extra' + + result entry for extra data + + + + + ENTRY_STATS + \ArangoDBClient\Cursor::ENTRY_STATS + 'stats' + + result entry for stats + + + + + FULL_COUNT + \ArangoDBClient\Cursor::FULL_COUNT + 'fullCount' + + result entry for the full count (ignoring the outermost LIMIT) + + + + + ENTRY_CACHE + \ArangoDBClient\Cursor::ENTRY_CACHE + 'cache' + + cache option entry + + + + + ENTRY_CACHED + \ArangoDBClient\Cursor::ENTRY_CACHED + 'cached' + + cached result attribute - whether or not the result was served from the AQL query cache + + + + + ENTRY_SANITIZE + \ArangoDBClient\Cursor::ENTRY_SANITIZE + '_sanitize' + + sanitize option entry + + + + + ENTRY_FLAT + \ArangoDBClient\Cursor::ENTRY_FLAT + '_flat' + + "flat" option entry (will treat the results as a simple array, not documents) + + + + + ENTRY_TYPE + \ArangoDBClient\Cursor::ENTRY_TYPE + 'objectType' + + "objectType" option entry. + + + + + ENTRY_BASEURL + \ArangoDBClient\Cursor::ENTRY_BASEURL + 'baseurl' + + "baseurl" option entry. + + + + + $_connection + \ArangoDBClient\Cursor::_connection - - The name of the edge collection for this relation. + + The connection object - - string + + \ArangoDBClient\Connection - - $_fromCollections - \ArangoDBClient\EdgeDefinition::_fromCollections - array() - - An array containing the names of the vertices collections holding the start vertices. + + $_options + \ArangoDBClient\Cursor::_options + + + Cursor options - + array - - $_toCollections - \ArangoDBClient\EdgeDefinition::_toCollections - array() - - An array containing the names of the vertices collections holding the end vertices. + + $data + \ArangoDBClient\Cursor::data + + + Result Data - + array - - __construct - \ArangoDBClient\EdgeDefinition::__construct() - - Constructs an new edge definition + + $_result + \ArangoDBClient\Cursor::_result + + + The result set - - string - - - array - string - - + array - string - - - $relation - null - string - - - $fromCollections - array() - array|string - - - $toCollections - array() - array|string - - - - setRelation - \ArangoDBClient\EdgeDefinition::setRelation() - - Set the relation of the edge definition + + + $_hasMore + \ArangoDBClient\Cursor::_hasMore + + + "has more" indicator - if true, the server has more results - - string + + boolean - - - $relation - - string - - - - getRelation - \ArangoDBClient\EdgeDefinition::getRelation() - - Get the relation of the edge definition. + + + $_id + \ArangoDBClient\Cursor::_id + + + cursor id - might be NULL if cursor does not have an id - - string + + mixed - - - - getToCollections - \ArangoDBClient\EdgeDefinition::getToCollections() - - Get the 'to' collections of the graph. + + + $_position + \ArangoDBClient\Cursor::_position + + + current position in result set iteration (zero-based) - - array + + integer - - - - getFromCollections - \ArangoDBClient\EdgeDefinition::getFromCollections() - - Get the 'from' collections of the graph. + + + $_length + \ArangoDBClient\Cursor::_length + + + total length of result set (in number of documents) - - array + + integer - - - - addToCollection - \ArangoDBClient\EdgeDefinition::addToCollection() - - Add a 'to' collections of the graph. + + + $_fullCount + \ArangoDBClient\Cursor::_fullCount + + + full count of the result set (ignoring the outermost LIMIT) - - string + + integer - - - $toCollection - - string - - - - addFromCollection - \ArangoDBClient\EdgeDefinition::addFromCollection() - - Add a 'from' collections of the graph. + + + $_extra + \ArangoDBClient\Cursor::_extra + + + extra data (statistics) returned from the statement - - string + + array - - - $fromCollection - - string - - - - clearToCollection - \ArangoDBClient\EdgeDefinition::clearToCollection() - - Resets the 'to' collections of the graph. + + + $_fetches + \ArangoDBClient\Cursor::_fetches + 1 + + number of HTTP calls that were made to build the cursor result - - - - clearFromCollection - \ArangoDBClient\EdgeDefinition::clearFromCollection() - - Resets the 'from' collections of the graph. + + + $_cached + \ArangoDBClient\Cursor::_cached + + + whether or not the query result was served from the AQL query result cache - - - - transformToArray - \ArangoDBClient\EdgeDefinition::transformToArray() - - Transforms an edge definition to an array. + + + $_count + \ArangoDBClient\Cursor::_count + + + precalculated number of documents in the cursor, as returned by the server - - array + + integer - - - - createUndirectedRelation - \ArangoDBClient\EdgeDefinition::createUndirectedRelation() - - Constructs an undirected relation. This relation is an edge definition where the edges can start and end -in any vertex from the collection list. + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + - + string - - array - - - \ArangoDBClient\EdgeDefinition - - - - $relation - - string - - - $vertexCollections - - array - - - - createDirectedRelation - \ArangoDBClient\EdgeDefinition::createDirectedRelation() - - Constructs a directed relation. This relation is an edge definition where the edges can start only in the -vertices defined in 'fromCollections' and end in vertices defined in 'toCollections'. + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - + string - + + + + __construct + \ArangoDBClient\Cursor::__construct() + + Initialise the cursor with the first results and some metadata + + + \ArangoDBClient\Connection + + array - string - + array - string - - \ArangoDBClient\EdgeDefinition + + \ArangoDBClient\ClientException - - $relation + $connection - string + \ArangoDBClient\Connection - $fromCollections + $data - array|string + array - $toCollections + $options - array|string + array - - eJztWE1v4zYQvftXzCGAnMBx2qCn7Ec3m+xmj4tt2ksSGLRE22ppSqCobI1t/3uHFEWRlGRL2aS91AgQm0POzJs3M+Lo9c/5Jp9Mzk5OJnACl4LwdXb9Hj5/+gwxSymXF1CkfM0oJFlcbnEB96mt73IS/0HWFMCeutIHtJCUcpMJlMFHlomUcHhPhKSs0NI4y3ciXW8kXNlv5z/8+NMMJO5dU17AzXb5aYZilq05ncENFVvCd7VtdClWlgHO5+e4cjaZcLKlBfpEA3deWXC/EVZSyJa/01iCoLmgBcoRHKB7NEEo13SV8lSmGZ/raJjlxC5DnHFJUvSP4FfGUJNeJfg1gUhQRtRCBDKDQmaCgtxQrQRP8EQp3ZZMpjnG85EKmcYocBRpS6gp5RCtRLa9sqIiUgogkpm7NjcBeb0Ubwfx0g5czEhRwAd0sUE/+TZRW3Tc1OcEbhGGijBkKwvJdXyFZMtNWkAdgrk5WSt490gEhkSocO9RZLaf6f+5yCQuYzyOFrVepDNwDVkiQpBdzY2yII27RW2mI9gFbDKW1LsLiflpt3V6X1nx1PqnhuAIWIU3cPfwUpgoJsxYRO6ZIXi8fOxBc4UiKcpYqiIATr+GZRX6lhNBtnW2VJ+jOgHMbzj10shKp+pXyRMq2E6dDvLreB4Y0SH4y5g6Ctk5xTpnaSGVGTfKGIHHtImzru8gF7AgSA2hJoXUvdSpHIViv1N+iGGUUx6dT3HJehZ0DldosqJcsjSGVckrLYtFXPM+bdh7A7xkbNYOtUqdWQhWLR5r7VVH0pmg+szp24Wj8ijoDnpb28BUx/W4JXrl6A5i7RzyRK4h40/b3j471Zm2udCM2v13q6J+odJPe7ebDqyrhpNT21vCchqUBd30F1R+MVoa+sdx2Y39Zhj2luuCylJwg/4JgNYOoBCH0R3CsRD6MODjPPJq2GBZC5Jv+hDohHwagFs3uQ6hGJSJFonK9X8Vy0e/uA6h6azFNp7LJMGeOI4Xv6zcsHWUFkkSfHA2ur+jxFCVS+jUM91Xah6rdw9hyzkQl5Es+5HxKXjx2PgJMg3M98UnyJMqQv5iX4y+4ECBd5zxhT0cVswoER7pg3g2F7PDbo/kd6TjASPjKnYvhlscdQocQraFHeacqQ2nMWJ6zXM3Ilkbvs0ulYoOPuodNPmQgP9pILW33kUNDVFVpzou3nOo/7Bm8sHaaQ63+ma/DkziB8fXRkfwHHFuQ5ZDV1Pvc9CfDPDanopqsLAXEJw8nakS0k5+v26oN2rHhJvruJqZqRq8K3s4VxO+0zdi+ieoEOlTzt1XXawPtLFwEnneWQRZqNz7vjnEAO+f/wxRweA/uADQivTqW1Ai6a+Wwfbdb9YBrKcDqBHRd2y/mk7Vg5IOnj3jMs52Ks9QVhu0A9jB1zuKMRR2Hmi9+dmTo6ac/5+Z/9uZ+UVq7HpfhQVkhAP10+rtkFJbafinXycuCEtJMfVVXlxo2Qyi+/ot7715Q7m897dGqPIfNEzqrA== - - - - ArangoDB PHP client: single vertex document - - - - - - - - - \ArangoDBClient\Document - Vertex - \ArangoDBClient\Vertex - - Value object representing a single vertex document - <br> - - - - - - ENTRY_ID - \ArangoDBClient\Document::ENTRY_ID - '_id' - - Document id index - + + delete + \ArangoDBClient\Cursor::delete() + + Explicitly delete the cursor + This might issue an HTTP DELETE request to inform the server about +the deletion. + + \ArangoDBClient\Exception + + + boolean + - - - ENTRY_KEY - \ArangoDBClient\Document::ENTRY_KEY - '_key' - - Document key index - + + + getCount + \ArangoDBClient\Cursor::getCount() + + Get the total number of results in the cursor + This might issue additional HTTP requests to fetch any outstanding +results from the server + + \ArangoDBClient\Exception + + + integer + - - - ENTRY_REV - \ArangoDBClient\Document::ENTRY_REV - '_rev' - - Revision id index + + + getFullCount + \ArangoDBClient\Cursor::getFullCount() + + Get the full count of the cursor (ignoring the outermost LIMIT) + + integer + - - - ENTRY_ISNEW - \ArangoDBClient\Document::ENTRY_ISNEW - '_isNew' - - isNew id index + + + getCached + \ArangoDBClient\Cursor::getCached() + + Get the cached attribute for the result set + + boolean + - - - ENTRY_HIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES - '_hiddenAttributes' - - hidden attribute index - - - - - ENTRY_IGNOREHIDDENATTRIBUTES - \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES - '_ignoreHiddenAttributes' - - hidden attribute index - - - - - OPTION_WAIT_FOR_SYNC - \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC - 'waitForSync' - - waitForSync option index - - - - - OPTION_POLICY - \ArangoDBClient\Document::OPTION_POLICY - 'policy' - - policy option index - - - - - OPTION_KEEPNULL - \ArangoDBClient\Document::OPTION_KEEPNULL - 'keepNull' - - keepNull option index - - - - - $_id - \ArangoDBClient\Document::_id - - - The document id (might be NULL for new documents) - - - string + + + getAll + \ArangoDBClient\Cursor::getAll() + + Get all results as an array + This might issue additional HTTP requests to fetch any outstanding +results from the server + + \ArangoDBClient\Exception - - - - $_key - \ArangoDBClient\Document::_key - - - The document key (might be NULL for new documents) - - - string + + array - - - $_rev - \ArangoDBClient\Document::_rev - - - The document revision (might be NULL for new documents) + + + rewind + \ArangoDBClient\Cursor::rewind() + + Rewind the cursor, necessary for Iterator - - mixed + + void - - - $_values - \ArangoDBClient\Document::_values - array() - - The document attributes (names/values) + + + current + \ArangoDBClient\Cursor::current() + + Return the current result row, necessary for Iterator - + array - - - $_changed - \ArangoDBClient\Document::_changed - false - - Flag to indicate whether document was changed locally + + + key + \ArangoDBClient\Cursor::key() + + Return the index of the current result row, necessary for Iterator - - boolean + + integer - - - $_isNew - \ArangoDBClient\Document::_isNew - true - - Flag to indicate whether document is a new document (never been saved to the server) + + + next + \ArangoDBClient\Cursor::next() + + Advance the cursor, necessary for Iterator - - boolean + + void - - - $_doValidate - \ArangoDBClient\Document::_doValidate - false - - Flag to indicate whether validation of document values should be performed -This can be turned on, but has a performance penalty - - + + + valid + \ArangoDBClient\Cursor::valid() + + Check if cursor can be advanced further, necessary for Iterator + This might issue additional HTTP requests to fetch any outstanding +results from the server + + \ArangoDBClient\Exception + + boolean - - - $_hiddenAttributes - \ArangoDBClient\Document::_hiddenAttributes - array() - - An array, that defines which attributes should be treated as hidden. + + + add + \ArangoDBClient\Cursor::add() + + Create an array of results from the input array - + array - - - - $_ignoreHiddenAttributes - \ArangoDBClient\Document::_ignoreHiddenAttributes - false - - Flag to indicate whether hidden attributes should be ignored or included in returned data-sets - - - boolean + + void - - - - __construct - \ArangoDBClient\Document::__construct() - - Constructs an empty document - - - array + + \ArangoDBClient\ClientException - $options - null + $data + array - \ArangoDBClient\Document - - createFromArray - \ArangoDBClient\Document::createFromArray() - - Factory method to construct a new document using the values passed to populate it + + addFlatFromArray + \ArangoDBClient\Cursor::addFlatFromArray() + + Create an array of results from the input array - - \ArangoDBClient\ClientException - - + array - - array - - - \ArangoDBClient\Document - \ArangoDBClient\Edge - \ArangoDBClient\Graph + + void - $values + $data array - - $options - array() - array - - \ArangoDBClient\Document - - __clone - \ArangoDBClient\Document::__clone() - - Clone a document - Returns the clone - - + + addDocumentsFromArray + \ArangoDBClient\Cursor::addDocumentsFromArray() + + Create an array of documents from the input array + + + array + + void - - \ArangoDBClient\Document - - - __toString - \ArangoDBClient\Document::__toString() - - Get a string representation of the document. - It will not output hidden attributes. - -Returns the document as JSON-encoded string - - - string + + \ArangoDBClient\ClientException - \ArangoDBClient\Document + + $data + + array + - - toJson - \ArangoDBClient\Document::toJson() - - Returns the document as JSON-encoded string + + addPathsFromArray + \ArangoDBClient\Cursor::addPathsFromArray() + + Create an array of paths from the input array - + array - - string + + void + + + \ArangoDBClient\ClientException - $options - array() + $data + array - \ArangoDBClient\Document - - toSerialized - \ArangoDBClient\Document::toSerialized() - - Returns the document as a serialized string + + addShortestPathFromArray + \ArangoDBClient\Cursor::addShortestPathFromArray() + + Create an array of shortest paths from the input array - + array - - string + + void + + + \ArangoDBClient\ClientException - $options - array() + $data + array - \ArangoDBClient\Document - - filterHiddenAttributes - \ArangoDBClient\Document::filterHiddenAttributes() - - Returns the attributes with the hidden ones removed + + addDistanceToFromArray + \ArangoDBClient\Cursor::addDistanceToFromArray() + + Create an array of distances from the input array - - array - - + array - - array + + void - $attributes + $data array - - $_hiddenAttributes - array() - array - - \ArangoDBClient\Document - - set - \ArangoDBClient\Document::set() - - Set a document attribute - The key (attribute name) must be a string. -This will validate the value of the attribute and might throw an -exception if the value is invalid. - - \ArangoDBClient\ClientException - - - string - - - mixed + + addCommonNeighborsFromArray + \ArangoDBClient\Cursor::addCommonNeighborsFromArray() + + Create an array of common neighbors from the input array + + + array - + void + + \ArangoDBClient\ClientException + - $key - - string - - - $value + $data - mixed + array - \ArangoDBClient\Document - - __set - \ArangoDBClient\Document::__set() - - Set a document attribute, magic method - This is a magic method that allows the object to be used without -declaring all document attributes first. -This function is mapped to set() internally. - - \ArangoDBClient\ClientException - - - - string - - - mixed + + addCommonPropertiesFromArray + \ArangoDBClient\Cursor::addCommonPropertiesFromArray() + + Create an array of common properties from the input array + + + array - + void - $key - - string - - - $value + $data - mixed + array - \ArangoDBClient\Document - - get - \ArangoDBClient\Document::get() - - Get a document attribute + + addFigureFromArray + \ArangoDBClient\Cursor::addFigureFromArray() + + Create an array of figuresfrom the input array - - string + + array - - mixed + + void - $key + $data - string + array - \ArangoDBClient\Document - - __get - \ArangoDBClient\Document::__get() - - Get a document attribute, magic method - This function is mapped to get() internally. - - - string + + addEdgesFromArray + \ArangoDBClient\Cursor::addEdgesFromArray() + + Create an array of Edges from the input array + + + array - - mixed + + void + + + \ArangoDBClient\ClientException - $key + $data - string + array - \ArangoDBClient\Document - - __isset - \ArangoDBClient\Document::__isset() - - Is triggered by calling isset() or empty() on inaccessible properties. + + addVerticesFromArray + \ArangoDBClient\Cursor::addVerticesFromArray() + + Create an array of Vertex from the input array - - string + + array - - boolean + + void + + + \ArangoDBClient\ClientException - $key + $data - string + array - \ArangoDBClient\Document - - __unset - \ArangoDBClient\Document::__unset() - - Magic method to unset an attribute. - Caution!!! This works only on the first array level. -The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. - - + + sanitize + \ArangoDBClient\Cursor::sanitize() + + Sanitize the result set rows + This will remove the _id and _rev attributes from the results if the +"sanitize" option is set + + array + + + array + - $key + $rows - + array - \ArangoDBClient\Document - - getAll - \ArangoDBClient\Document::getAll() - - Get all document attributes + + fetchOutstanding + \ArangoDBClient\Cursor::fetchOutstanding() + + Fetch outstanding results from the server - - mixed + + \ArangoDBClient\Exception - - array + + void - - $options - array() - mixed - - \ArangoDBClient\Document - - getAllForInsertUpdate - \ArangoDBClient\Document::getAllForInsertUpdate() - - Get all document attributes for insertion/update + + updateLength + \ArangoDBClient\Cursor::updateLength() + + Set the length of the (fetched) result set - - mixed + + void - \ArangoDBClient\Document - - getAllAsObject - \ArangoDBClient\Document::getAllAsObject() - - Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class + + url + \ArangoDBClient\Cursor::url() + + Return the base URL for the cursor - - mixed - - - mixed + + string - - $options - array() - mixed - - \ArangoDBClient\Document - - setHiddenAttributes - \ArangoDBClient\Document::setHiddenAttributes() - - Set the hidden attributes -$cursor + + getStatValue + \ArangoDBClient\Cursor::getStatValue() + + Get a statistical figure value from the query result - - array + + string - - void + + integer - $attributes + $name - array + string - \ArangoDBClient\Document - - getHiddenAttributes - \ArangoDBClient\Document::getHiddenAttributes() - - Get the hidden attributes + + getMetadata + \ArangoDBClient\Cursor::getMetadata() + + Get MetaData of the current cursor - + array - \ArangoDBClient\Document - - isIgnoreHiddenAttributes - \ArangoDBClient\Document::isIgnoreHiddenAttributes() - - + + getExtra + \ArangoDBClient\Cursor::getExtra() + + Return the extra data of the query (statistics etc.). Contents of the result array +depend on the type of query executed - - boolean + + array - \ArangoDBClient\Document - - setIgnoreHiddenAttributes - \ArangoDBClient\Document::setIgnoreHiddenAttributes() - - + + getWarnings + \ArangoDBClient\Cursor::getWarnings() + + Return the warnings issued during query execution - - boolean + + array - - $ignoreHiddenAttributes - - boolean - - \ArangoDBClient\Document - - setChanged - \ArangoDBClient\Document::setChanged() - - Set the changed flag + + getWritesExecuted + \ArangoDBClient\Cursor::getWritesExecuted() + + Return the number of writes executed by the query - - boolean - - - boolean + + integer - - $value - - boolean - - \ArangoDBClient\Document - - getChanged - \ArangoDBClient\Document::getChanged() - - Get the changed flag + + getWritesIgnored + \ArangoDBClient\Cursor::getWritesIgnored() + + Return the number of ignored write operations from the query - - boolean + + integer - \ArangoDBClient\Document - - setIsNew - \ArangoDBClient\Document::setIsNew() - - Set the isNew flag + + getScannedFull + \ArangoDBClient\Cursor::getScannedFull() + + Return the number of documents iterated over in full scans - - boolean - - - void + + integer - - $isNew - - boolean - - \ArangoDBClient\Document - - getIsNew - \ArangoDBClient\Document::getIsNew() - - Get the isNew flag + + getScannedIndex + \ArangoDBClient\Cursor::getScannedIndex() + + Return the number of documents iterated over in index scans - - boolean - - - \ArangoDBClient\Document - - - setInternalId - \ArangoDBClient\Document::setInternalId() - - Set the internal document id - This will throw if the id of an existing document gets updated to some other id - - \ArangoDBClient\ClientException - - - string - - - void + + integer - - $id - - string - - \ArangoDBClient\Document - - setInternalKey - \ArangoDBClient\Document::setInternalKey() - - Set the internal document key - This will throw if the key of an existing document gets updated to some other key - - \ArangoDBClient\ClientException - - - string - - - void + + getFiltered + \ArangoDBClient\Cursor::getFiltered() + + Return the number of documents filtered by the query + + + integer - - $key - - string - - \ArangoDBClient\Document - - getInternalId - \ArangoDBClient\Document::getInternalId() - - Get the internal document id (if already known) - Document ids are generated on the server only. Document ids consist of collection id and -document id, in the format collectionId/documentId - - string + + getFetches + \ArangoDBClient\Cursor::getFetches() + + Return the number of HTTP calls that were made to build the cursor result + + + integer - \ArangoDBClient\Document - - getInternalKey - \ArangoDBClient\Document::getInternalKey() - - Get the internal document key (if already known) + + getId + \ArangoDBClient\Cursor::getId() + + Return the cursor id, if any - + string - \ArangoDBClient\Document - - getHandle - \ArangoDBClient\Document::getHandle() - - Convenience function to get the document handle (if already known) - is an alias to getInternalId() - Document handles are generated on the server only. Document handles consist of collection id and -document id, in the format collectionId/documentId - + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + string - - \ArangoDBClient\Document - - - getId - \ArangoDBClient\Document::getId() - - Get the document id (or document handle) if already known. - It is a string and consists of the collection's name and the document key (_key attribute) separated by /. -Example: (collectionname/documentId) - -The document handle is stored in a document's _id attribute. - - mixed - - - \ArangoDBClient\Document - - - getKey - \ArangoDBClient\Document::getKey() - - Get the document key (if already known). - Alias function for getInternalKey() - - mixed - - - \ArangoDBClient\Document - - - getCollectionId - \ArangoDBClient\Document::getCollectionId() - - Get the collection id (if already known) - Collection ids are generated on the server only. Collection ids are numeric but might be -bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used - - mixed - - - \ArangoDBClient\Document - - - setRevision - \ArangoDBClient\Document::setRevision() - - Set the document revision - Revision ids are generated on the server only. - -Document ids are strings, even if they look "numeric" -To reliably store a document id elsewhere, a PHP string must be used - - mixed - - - void + + \ArangoDBClient\DocumentClassable - $rev + $class - mixed + string - \ArangoDBClient\Document - - - getRevision - \ArangoDBClient\Document::getRevision() - - Get the document revision (if already known) - - - mixed - - - \ArangoDBClient\Document + \ArangoDBClient\DocumentClassable - - jsonSerialize - \ArangoDBClient\Document::jsonSerialize() - - Get all document attributes -Alias function for getAll() - it's necessary for implementing JsonSerializable interface + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use - - mixed + + string - - array + + \ArangoDBClient\DocumentClassable - $options - array() - mixed + $class + + string - \ArangoDBClient\Document + \ArangoDBClient\DocumentClassable - eJylUMtKw0AU3c9XnF01BGuzTAUfLbYIQkHoKiA300sSm8yEmYk0iP/ubWK7qEt3w3ndc+buvi1bpaZRpBDh0ZEp7PIJm/UGuq7YhBS+MkXN+GQX+ICd1V0juMiPjoeW9J4KBs7mxeAbSOpCaZ1weCGDt8DckDEX1LP49nilnt3AaNv2rirKgMX5ldzOkhjBVXLKeKyafB0LXdvCcIwVO8ntB7e01cc2wOwmEWSqlKGGvfTki4rz8+4t1R3D5h+sAxy3jr3wshv0n/l/u+iavMd2zOJDYLPzWJ4yv5T6VqPmneqK/NWoTNMBizHJTl+Q/Z7Ls1EyuZ6rH7e+kY0= + eJzdXFt32zYSfvevQH1yKrlV7LSPTp2t15Yb9ziJ11ay23V0fCASkrimSC0JSna3+e87gwsJguBFttLkVA+JJQKDbwaDuQHgT39bzpc7OwfffbdDviPHCY1m8enfyeXrS+KFAYv4IUlYmoWcpIwTL0vSOIGW2PjnJfXu6IwRkvc7EV3EQ5rxeZzAM/Irjcg1Z2xBo0g88uLlQxLM5pyc5H/9+OKHHweEJwEQjFLyy2LyegCPw3gWsQH5hSXQ+wF6H+zsRHTBUhibWcO+zNm4TOJV4LOUUM9jaUp4TPicKUZSEk8JQDr+xwX5b8aSBwIwaRRDi4SknHK2kDwgpRF0k0yThcAJ7YgXR5wGEaFhmNOErzjEhM2CKAqi2f5Pk+SVInI+NYYXcgwQU0wmwQyxTRgwTqN0ypKE+UgqjhiZxQPshgRKCII0zRihvh/wII5oSF6PRpdAHHhJueB1yrg3130TkHuAiHKo0yReCEApS1Ys2e80nWkQefiIkBf7P4p58EIKoj2R0ILFMhRyS8nHc84SykFN/reD7cWc4AcEsVjGCSfPbv3Yy7D1iaAxzSJP8hLwB9X2QPyfpYycmm3pJGQwzxZdMUtxFDFBhsST/8Bf6qFu8/OKJqBQulFpmGUSrGDeAVhB5aU9iOI0XuLT1EWdJgl9qCGsulWxX0mtOKWcbkjThy5uWRSatilM2bNKdXdOU7KIE7YL6ukHHs4veU4C0OwkYwNDnYhuqfXNBWESx2ENAuj+BnpXIahFEPgwrlwJsG7evr+4QBTqoR/DosclOqcrhos88F3DL4J75teMH/jOoRPQQLKMU7HocImaq1koPP7e/50l8fMJTZm/5xo4iHjNsJp0dXAec1jkIYtmfI6myxi4DziibDEBqcMDvajSDYeWpKsDTzOwb16cAeNxxYL1g1kUJ2hW8EGcgQgWccrJxfmb89GGAHCgExynioHdg2UkqOmkj7Y5SHngpXuAhGdJBMayMGaF5d5M5cUQ1ZELuQr76oGxB+M6p5ysGSj3gvpM2O4sCH0BQKmglFEdp2iZQUWPyA/VEddzJnwQEEEVRprSPymxr2FhiTVmcF04MdXIox7afefo4pkvDZs9+DJhwKKXhdDUdymV9nCSzQEBMPkkTB4MA7DZ3HvueVfcwMDA2hQkkq/+Eh0w16Bzw7ejq99uz09BrL3A73WgtquszC6ZhnRWS/L18fWbd1dDpKs6dCGufsglV0v+anj9/mKE1GWXLsSLBVFLdviv0dUxUhVtuxDFtVMP83p0PLpGeqJZF3qoDIb16GQrzHHPwKrfnrx7/1YIJzcPjqGFSiufLAHUsnFyfPJaTKXoU0fL19xQDsHoBLCCu3GszE5rsroYK4BOc0QuxU1pBF7h944cXh+/PR+d/1sweau7OqjugtLz3RJN0l8HMF88YZSXYmXgj5JUhHfSig6ECCq+porm7OJYTN8tjuZCIcO00cOSlbHs15Ic/XYpmCt6uuii+82SsCvRvx9fD99fXSBd1dNB9ByFCfEpxKOGrV8HfC6VPUiAXi6zyCdpvAAnwTj1HYHdkiZ0YQSj5JkRvT43Q1mZHUAY7FudxVyIn2QgKP/EkEwiza0QPmuz1S6iKmCVRL3G2JfPk3gNgX85bfgo/xvee2xZjbizSRh4eeRPbm/FlCSZx/tuuQwUOsFt/kUhkloo8w2Bns+D9PkrI5yH6X1mB/dGS0OE2FKG1jY1CD2LNhFYpWoTafAam0gLrprcjB00pB2SDaY0THUwjB+IdfuQATLeFyBvUhZODw+1Bxzv7RlSsLArvuwuBYBP+V+1w13rKEsTEFa6flgpDz1yTW8TQSdGhYerH1RK2MWu7GiI0xrJJFDqKHzgWP1UuKcqBhNH7rgQy8akX5boftpURtK7NMyM1DKXlFRX57QcHBiecZGlIgtD58jyJpCms4TXAlNBFSCrqr6KsgBVH1PEPQc43d29JpQ9uOmVSwy9WjlAr1KBoYmEUyBG+yB9y9a9cbFqbfYMm3qUd6w2U6ZbNnNYCOr7/b4wgC4ByahyXJVutoS27EJke/09Q37qecLWkNv3VUdg0XaCw/slGO2Ahw/EZyHjpi+0fMIIKJbrVZHMo06HF8PRUJer0L8FEYSMZkGK0AnEiJoS/i5GA1ntW6Noz2P7GPKzdHeizgDuC2sUolZhjOHdRfE6ZP6M+aUxNLSBnEQi6oJrcPyN/kvKo2/7IdTMwgLbKohxV731KLwVuCdJXk9kEvb3yD7pHfTg34L+AJRlzzJu+FHCQClYRgUiVCwV9nMBkmfMRum0PIqkoecOffmFyVhSVjCKnNKqmXZUoNaCJ40eMLmALCXyIdkoZyeVsuemqgQpLGqSm5VG3ZgxLrxAo3ZIR/nNkYwa7DlQGEqNndZoPQ8gUO9b9rTG9gmxvSsk1ndbOGtwXS4yWjnmvFo8UjHkZoWjbQj/TLvhygRYnBl1qBaNVs6z8IQ6662vvJYt0tNqPY4ij0PnBMY2ns2aUA3D5jYHpoNRqZz21S5YmSE8z/GKbZ+ClTbxHYdhRXZ/wurSBfia+bgSPrpUiAMnwdKUqtJLvvniVr9VbFXQbM51EFCTUOUV8CPyogGk9DcSpKicK7WGGdsQsJ5FNzGtj2kae64ir8WcItC2JiT9G5vncReGQXjs3jB5T+Ne2T0372KoRn7v2EMbr8W+Qw1vx/6K4tbf51O5CHKiCszvv++M8GTOvDtjE8gDjZig/RHAwYBmCdrajrC/OjvmiGHbGJWRayER4IhifbZ5HlY0DKor3wxS8tX/05EVDgDAH2w7CKnimsmdOHM/EDdRysah2FZLXVFPOW610t9v7NTxjz/IN/Uht8Tkx1GPV5ENCPhyU8AgN3Y/p5Dl6vpbGZmV5pXT5IhhZpHrSKFFjXpBGv2HvYq7zkz92sGCLyv5yAq8IFqCWFw+v1Q2lGVILEB68aI4b9BuFR5XQFQ7SLn2YlJsALHVGFY8o5jq6LxflcdlgWIPHckzAGHri1CxIL0VlPuyBWiYVS/SJQAzDcfy93iPfPutnf07WjUUkYCts5DyM5iM4wKDncYxXO9VGgq9C6pZQ3cDKIPQRZK0EUkjGvyk64Abs1ADp6YzfjwKtHuYtvfIYW2rMvYhtG7HbX4moCx39U0kCFiznN13h/EB2gfe50CypHzeHccltP4MINJ5DPJI+eVGYK6NXtvH5AdoPT02irsjOs37bB8PWMZFHL1lEF5M4iTtDuqk3PFzIbtM4iVqKdsYWtFz+9imwSxLNljvZ6L9NnH4bEox7O6sQ52tZUcQn6pmdsf97dOf6OpzQpbPr+wQ1qYCDi9uuTuXM7cStXF5y64b78XBlu1xv6uJ7sqHHeSwteDHoXIN4ZB9BLOIGku/VzcJSjIvNz489ISYrckb2AFQEY22zxJ6tq3OkCD4BabHcrrbmJqiA4ZDduP8N3MO5VmPI3JTMh4iksHIpIffjl6Rm/Gg3ACJyac1DdI4SzzWyxt0U40b3W9cVRJrAB9ihCASpyx7mwxg9mscxdhmK3IFSSMXz1ikCatKwU+I1WzXcXms6taGXB91eORstIBRjRSSXBsej8JlAMRYGyxnHSP+dda1O379MsvbTPdsza2keFIm7i1t3Q2/6AMCBi0DG4TKCf8gEiFsqdvcvDAbGWuw1EhsD/Xz73tYqhh3MFdirrdrjQw+2k2RShC0tdSWRv9so3mE6Sp6tJisQlYolCbL3mzWxVMn4Y2NIQKp2sLV0w2bJLx9u6YMptQqRRi/tAQ/ZdvXJeJUCvIl7V5D/OhIe5vMmFybxaeiepVFqDx+sdKqK+WpK6tQUaTu8u3b8GIyVyaRzsb/Cn6stsCw3SQiZFNu+BT8WvIn8jJg/lx87dlnvaySpt6uQ2L1591KraxzVZ86k7+RCDsOo1tXhqu1gLlOKSuov280XMfoM6dtC2KTRbDM6z5fpVWrL0416fUdsT9HEsvtHXtIVU3iZXP7Z3flIMiasDtbKSxNwAaoAF5l5uVJXg/PG/o965RoFgnN1Q+telMVww1QE8riPUoHZGEu/Ron3q4BNk13+dilXUtqF4PYX9im+mNU8wV8gLVP0mj5O5ccXGWjpqitpWTUYTpUOrLF+ZABxReYkeqW0Vdf07Mn6FpfYbIukKJ8LEmKoxfiHlLCFvFKdsGbC3ihBkCuigN3xnLLT5NO5ZV3SWtXb/Dm14CC1HUsr6QBYs4MDRDf5RUcTa5yn9g6p5S3MxmsmeB8D9oY/umTWr3O4Np41nfF2reojZZlT1R4LCEn9FbgHkUcvqJhJs7FlToU6PR+umoHCBRi8cNNRQnr77foj/J8iOQGYYybiDg2rbeL9Gr4YQtQBRUXVvc3x6FCHKN2ZZ6JgynGwaVtnVhqd9DVsy2W2h8ciLdsBFFGixEIJggsXYKGMmMhmAflwdK3n5Lv9dRJeU21OGymLmibNlK4haNi5OevZoz/msaR6w7FZjdYrM54hKXpPkc5S2k5hWqcvpJMqVOjMV7l5CVTjOYVz5IJxZQu0ydRvHYGjyL8LN9s+1QRg33VpEYDr9VwxcsN8Ftf4d1rP03drmllJDWRnxr/iKiKZMkt1sM3jn3izVGCt0j1QXDnpQYNO+VJcU6wDnhSPX/czbSrC611Jd9GY6/71h1qw67i7TV4xJ+G4YR6d7bVeZ+EYMKAyu3J+6vrd1dNVwUoyd/qQEOVTxBhWgsjZB6Md7tvKU/IlukCr2uL//L0BB24RFYzG3UvJzBPg+PNxQ8Iqy8GaZ+Y2nt+on/r3LR0bzpJ/qJJ3m8Yp/iqGfuEcqO6th+sBgm9UXedWw4cN6VWxnoy3vuhkEotMF4CQsBK7O/t4zVqLvbxyy8pMUETny0ZGLlYEucPS6EfkiS7Z17GmwO7NuaHCLftqLV60Ugr72ua4PuaUnn+2Cd+JrTbRFs43UfB/acaoYOBkYrY05hqN5JIbYcmXb0Zd5BHceFnnQQY+usZ03fZhWS6Lm6HNATVoSLaMoslW9Bbl7r2ak82OLkRF6GAC0GEYIWKyuuhZcv3VMbO5TCP4Ev13JAt440x4oQ9cBjjjcsgkpfCUgg16nLoDkxdQ/eI+XipayOW0qLf9hiStz22w9E50noMS6Ljo3maBiFwtbXFdKbIbcSIxrAhE094MdNjOJOpQeslQp1BtDKSv9JogHZXvN7Qic0VLVbhnbde9Qvya34AS7y975aGAU378s12h4fiN0iPPurXMOry1eSjbILz8392+EmX - + - ArangoDB PHP client: single collection + ArangoDB PHP client: transaction base - - + + - + - Collection - \ArangoDBClient\Collection - - Value object representing a collection - <br> - - + TransactionBase + \ArangoDBClient\TransactionBase + + Transaction base class, used by Transaction and StreamingTransaction + + + - - ENTRY_ID - \ArangoDBClient\Collection::ENTRY_ID - 'id' - - Collection id index + + ENTRY_COLLECTIONS + \ArangoDBClient\TransactionBase::ENTRY_COLLECTIONS + 'collections' + + Collections index - - ENTRY_NAME - \ArangoDBClient\Collection::ENTRY_NAME - 'name' - - Collection name index + + ENTRY_WAIT_FOR_SYNC + \ArangoDBClient\TransactionBase::ENTRY_WAIT_FOR_SYNC + 'waitForSync' + + WaitForSync index - - ENTRY_TYPE - \ArangoDBClient\Collection::ENTRY_TYPE - 'type' - - Collection type index + + ENTRY_LOCK_TIMEOUT + \ArangoDBClient\TransactionBase::ENTRY_LOCK_TIMEOUT + 'lockTimeout' + + Lock timeout index - - ENTRY_WAIT_SYNC - \ArangoDBClient\Collection::ENTRY_WAIT_SYNC - 'waitForSync' - - Collection 'waitForSync' index + + ENTRY_READ + \ArangoDBClient\TransactionBase::ENTRY_READ + 'read' + + Read index - - ENTRY_JOURNAL_SIZE - \ArangoDBClient\Collection::ENTRY_JOURNAL_SIZE - 'journalSize' - - Collection 'journalSize' index - - - - - ENTRY_STATUS - \ArangoDBClient\Collection::ENTRY_STATUS - 'status' - - Collection 'status' index + + ENTRY_WRITE + \ArangoDBClient\TransactionBase::ENTRY_WRITE + 'write' + + WRITE index - - ENTRY_KEY_OPTIONS - \ArangoDBClient\Collection::ENTRY_KEY_OPTIONS - 'keyOptions' - - Collection 'keyOptions' index + + ENTRY_EXCLUSIVE + \ArangoDBClient\TransactionBase::ENTRY_EXCLUSIVE + 'exclusive' + + EXCLUSIVE index - - ENTRY_IS_SYSTEM - \ArangoDBClient\Collection::ENTRY_IS_SYSTEM - 'isSystem' - - Collection 'isSystem' index + + $_connection + \ArangoDBClient\TransactionBase::_connection + + + The connection object + + \ArangoDBClient\Connection + - - - ENTRY_IS_VOLATILE - \ArangoDBClient\Collection::ENTRY_IS_VOLATILE - 'isVolatile' - - Collection 'isVolatile' index + + + $attributes + \ArangoDBClient\TransactionBase::attributes + array() + + The transaction's attributes. + + array + - - - ENTRY_NUMBER_OF_SHARDS - \ArangoDBClient\Collection::ENTRY_NUMBER_OF_SHARDS - 'numberOfShards' - - Collection 'numberOfShards' index + + + __construct + \ArangoDBClient\TransactionBase::__construct() + + Initialise the transaction object + + \ArangoDBClient\Connection + + + \ArangoDBClient\ClientException + - - - ENTRY_SHARD_KEYS - \ArangoDBClient\Collection::ENTRY_SHARD_KEYS - 'shardKeys' - - Collection 'shardKeys' index + + $connection + + \ArangoDBClient\Connection + + + + getConnection + \ArangoDBClient\TransactionBase::getConnection() + + Return the connection object + + \ArangoDBClient\Connection + - - - OPTION_PROPERTIES - \ArangoDBClient\Collection::OPTION_PROPERTIES - 'properties' - - properties option - + + + setCollections + \ArangoDBClient\TransactionBase::setCollections() + + Set the collections array. + The array should have 2 sub-arrays, namely 'read' and 'write' which should hold the respective collections +for the transaction + + array + - - - TYPE_DOCUMENT - \ArangoDBClient\Collection::TYPE_DOCUMENT - 2 - - document collection type - + + $value + + array + + + + getCollections + \ArangoDBClient\TransactionBase::getCollections() + + Get collections array + This holds the read and write collections of the transaction + + array + - - - TYPE_EDGE - \ArangoDBClient\Collection::TYPE_EDGE - 3 - - edge collection type + + + setWaitForSync + \ArangoDBClient\TransactionBase::setWaitForSync() + + set waitForSync value + + boolean + + + \ArangoDBClient\ClientException + - - - STATUS_NEW_BORN - \ArangoDBClient\Collection::STATUS_NEW_BORN - 1 - - New born collection + + $value + + boolean + + + + getWaitForSync + \ArangoDBClient\TransactionBase::getWaitForSync() + + get waitForSync value + + boolean + - - - STATUS_UNLOADED - \ArangoDBClient\Collection::STATUS_UNLOADED - 2 - - Unloaded collection + + + setLockTimeout + \ArangoDBClient\TransactionBase::setLockTimeout() + + Set lockTimeout value + + integer + + + \ArangoDBClient\ClientException + - - - STATUS_LOADED - \ArangoDBClient\Collection::STATUS_LOADED - 3 - - Loaded collection + + $value + + integer + + + + getLockTimeout + \ArangoDBClient\TransactionBase::getLockTimeout() + + Get lockTimeout value + + integer + - - - STATUS_BEING_UNLOADED - \ArangoDBClient\Collection::STATUS_BEING_UNLOADED - 4 - - Collection being unloaded + + + setReadCollections + \ArangoDBClient\TransactionBase::setReadCollections() + + Convenience function to directly set read-collections without having to access +them from the collections attribute. + + array + - - - STATUS_DELETED - \ArangoDBClient\Collection::STATUS_DELETED - 5 - - Deleted collection + + $value + + array + + + + getReadCollections + \ArangoDBClient\TransactionBase::getReadCollections() + + Convenience function to directly get read-collections without having to access +them from the collections attribute. + + array + - - - $_id - \ArangoDBClient\Collection::_id - - - The collection id (might be NULL for new collections) + + + setWriteCollections + \ArangoDBClient\TransactionBase::setWriteCollections() + + Convenience function to directly set write-collections without having to access +them from the collections attribute. - - mixed + + array - - - $_name - \ArangoDBClient\Collection::_name - - - The collection name (might be NULL for new collections) - - - string - - - - - $_type - \ArangoDBClient\Collection::_type - - - The collection type (might be NULL for new collections) - - - integer - - - - - $_waitForSync - \ArangoDBClient\Collection::_waitForSync - - - The collection waitForSync value (might be NULL for new collections) - - - boolean - - - - - $_journalSize - \ArangoDBClient\Collection::_journalSize - - - The collection journalSize value (might be NULL for new collections) - - - integer - - - - - $_isSystem - \ArangoDBClient\Collection::_isSystem - - - The collection isSystem value (might be NULL for new collections) - - - boolean - - - - - $_isVolatile - \ArangoDBClient\Collection::_isVolatile - - - The collection isVolatile value (might be NULL for new collections) - - - boolean - - - - - $_numberOfShards - \ArangoDBClient\Collection::_numberOfShards - - - The collection numberOfShards value (might be NULL for new collections) - - - integer - - - - - $_shardKeys - \ArangoDBClient\Collection::_shardKeys - - - The collection shardKeys value (might be NULL for new collections) - - - array - - - - - $_status - \ArangoDBClient\Collection::_status - - - The collection status value - - - integer - - - - - $_keyOptions - \ArangoDBClient\Collection::_keyOptions - - - The collection keyOptions value + + $value + + array + + + + getWriteCollections + \ArangoDBClient\TransactionBase::getWriteCollections() + + Convenience function to directly get write-collections without having to access +them from the collections attribute. - + array - - - __construct - \ArangoDBClient\Collection::__construct() - - Constructs an empty collection - - - string - - - \ArangoDBClient\ClientException - - - - $name - null - string - - - createFromArray - \ArangoDBClient\Collection::createFromArray() - - Factory method to construct a new collection + + setExclusiveCollections + \ArangoDBClient\TransactionBase::setExclusiveCollections() + + Convenience function to directly set exclusive-collections without having to access +them from the collections attribute. - - \ArangoDBClient\ClientException - - + array - - \ArangoDBClient\Collection - - $values + $value array - - getDefaultType - \ArangoDBClient\Collection::getDefaultType() - - Get the default collection type - - - string - - - - - __clone - \ArangoDBClient\Collection::__clone() - - Clone a collection - Returns the clone - - - void - - - - - __toString - \ArangoDBClient\Collection::__toString() - - Get a string representation of the collection - Returns the collection as JSON-encoded string - - - string - - - - - toJson - \ArangoDBClient\Collection::toJson() - - Returns the collection as JSON-encoded string - - - string - - - - - toSerialized - \ArangoDBClient\Collection::toSerialized() - - Returns the collection as a serialized string + + getExclusiveCollections + \ArangoDBClient\TransactionBase::getExclusiveCollections() + + Convenience function to directly get exclusive-collections without having to access +them from the collections attribute. - - string + + array - - getAll - \ArangoDBClient\Collection::getAll() - - Get all collection attributes + + set + \ArangoDBClient\TransactionBase::set() + + Sets an attribute - - array + + + + \ArangoDBClient\ClientException + + $key + + + + + $value + + + - - set - \ArangoDBClient\Collection::set() - - Set a collection attribute - The key (attribute name) must be a string. - -This will validate the value of the attribute and might throw an -exception if the value is invalid. - + + __set + \ArangoDBClient\TransactionBase::__set() + + Set an attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. + \ArangoDBClient\ClientException - + + string - + mixed - + void @@ -15432,2301 +15466,2423 @@ exception if the value is invalid. mixed - - setId - \ArangoDBClient\Collection::setId() - - Set the collection id - This will throw if the id of an existing collection gets updated to some other id - - \ArangoDBClient\ClientException + + get + \ArangoDBClient\TransactionBase::get() + + Get an attribute + + + string - + mixed - - boolean - - $id + $key - mixed + string - - getId - \ArangoDBClient\Collection::getId() - - Get the collection id (if already known) - Collection ids are generated on the server only. - -Collection ids are numeric but might be bigger than PHP_INT_MAX. -To reliably store a collection id elsewhere, a PHP string should be used - + + __get + \ArangoDBClient\TransactionBase::__get() + + Get an attribute, magic method + This function is mapped to get() internally. + + + string + + mixed + + $key + + string + - - setName - \ArangoDBClient\Collection::setName() - - Set the collection name + + __isset + \ArangoDBClient\TransactionBase::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. - - \ArangoDBClient\ClientException - - + string - - void + + boolean - $name + $key string - - getName - \ArangoDBClient\Collection::getName() - - Get the collection name (if already known) + + buildTransactionAttributesFromArray + \ArangoDBClient\TransactionBase::buildTransactionAttributesFromArray() + + Build the object's attributes from a given array - - string - - - - - setType - \ArangoDBClient\Collection::setType() - - Set the collection type. - This is useful before a collection is create() 'ed in order to set a different type than the normal one. -For example this must be set to 3 in order to create an edge-collection. - + + \ArangoDBClient\ClientException - - integer - - - void - - $type + $options - integer + - - getType - \ArangoDBClient\Collection::getType() - - Get the collection type (if already known) + + eJzNWltv2kgUfs+vmJWQgIq02/Yt3e02pSRFpUmV0O1WSWQNZoDZGBt5xiRo1f++58z4MrbHNrC0WxQFsM+c63cuM+a3P1aL1dHRsydPjsgTchpSfx68e0s+vf9EXI8zX54QCRcFdSUPfDKhggEh0r5ZUfeezhkh6bK+WqFu0kgughDukTO4eU8+0g0L1R03WG1CPl9I0k8/vfj1+cseCOLAzxfkfDl534PbXjD3WY+cs3BJ/Q2sfnZ05NMlEyCaFaS+So0YF/QFQ6gQPRIJNiWTTe4+9afkWoaMLrk/N24UbbRYKLjvovHPn75UmikpJvO36Kt/jtAHSjN8gXYLUCjwfaYVCCZ/w6f4ZkLzZk1DMD8hii8/U++rkK+pZKTlZFzAdosUI25tQagE904iycRTmzQahnSTFxRNPO6SVraQ/E5u7sqyIE6e1kMQ7k/ZY44NaCkkGVyMr746/cvRaNAfDy8vroFX280Wtstsv1Auz4LweuO7DWy/nA7HztnllXP99aKPjB+ypRbGo8C9J5IvWRDJBs6jy/4HZzz8OLj8PEbGHiwd65UWxleMThsYXg1O3yEjQNzUZvPVcDxoslbRoJUhlwyYIEGR0eCv/ujz9fDPJmYZHTBkj64XCb5mFs2GPpecehzSSeaxVQHhFQ3p0gAxaRmo169jxcq4LAMyYSpPi9zkIgweBLnN5+Gtfhs8umxVThSN31nka+aOowwPI1d27Gp11TqdsfhqyQUXx6+NRAMvtcy0SyiLS7KcuRHMm52clPB/h8mULsOXSahh8hrSrVdJE+OgnsiILxKmdHda929HFhDLKPSLkbHHONS0hjdLIc0tTCpYIOEaFOM0NnMmMyadYhxiMeVwVBpxzWSsSFaaVIUr1j6sk+oGEYsg8qZkQdeMvCAimhyr69A3sON4mzhnVceIU488LLi7SFcG8A+FhtCfUOg6Jz+ROIOuWMgge+potVpr6kWsFtgCnZfK6Zjrip7kM6LvO/ds47BHLqToaMN6yZKuQW9AGqRgfTMl6QU3ev1dN0uHbw0Ctfu2kPgFCW0iNYddZGbFbQu5g4TYJjvjVJZvweI5YLGEwxIMuVAAEjGCoJEg0JSZudXBrAk9cbZsDZ95Hj71yQfEnYqK1q3MRnAoMVoyMXUqgH4SBF5e6UO2AERUpkfHniMZCnKW5oaMHumgpt0ESZWmz7cxPXaxst0gboqaacpuUcvZUq08VlFj4qmLG/fldw3bKFNjt7CZExxEDfRsDtr5NnbHHkbDDdqmmJl27BYz05Bq1aGLrpkProWtSSoXxqopDyHBoYthLmJ5OTaLygOHzRoYCs0PtkFIT12XibRnQcVZklkYLMtNNRl0SpuK3ZuYvb1UxHmLCeumOFHhzKU7Q4KB/f04/1F+zJVz5VTRBLKiI+uBtpcnE8fhf+sGZCsgqvb2EyKxYuw4EBTV4H5oLP4YV+4BxpIvD4tG7czUd3tDMR3qfkI41kyjB4Jkuk08NCx/nFv3gKbVr4eFZ+bYuikL7PIz0+yAacFmpnipbuDaccDqIP9ezbbxFy4cARr6c0Va2jwpscRnD0XJnfbQB658SqaBGy3hVmYqAU7t3CaqBskoFvHZgEucWk139siSzsHaJQPQFQ+W1MYL/miOCIyhwMTz0JEIQX2KYZxPJRBO+EyZ61F0Dq6yGCrIjIdCllBbG6yUSulmh4UOiUIHwRO1zLV4bFEgXvJHUD12IBDrdzyRqARfDP91wKe1EHKcJhAJcJm7IBo9BfC4eExfkVDkJEdqYKNw8JEb683XBAa1+1dlgfoUwWDRrpVVNRXsIDDMT2b18irm4R3EMUuBq5dZ12q2F1y516z3b3lrvp/I3Kl9nUTLrnIriVM2o5En61jnU6GRa+3pUXNzMKvAscp8PChqSmpdDpIyYC7okYvPoxHW/ayeQJX0A4m9oqmv6hTfNf23SY7SFrm01Tlw9pcElsfZ75CPJan2SWULVOVaOBcKmPbGWmrolYOPIrcKiZf4kefVHq7s1p5TaMHnJV2tALPQiBFnXTx+YaEPPbd0sr9t0/yf08VxqhKmfBykqCodOxT4AH0+Z6F+zO2CV9BKHfUugS7Pliu5wY94bqVHbj7xGD6RWbFQcsuz4f/iMDzQZBBr/RXVQ7+FZEY9yIYObrvgW+ylboObYvBaHLU3tFGfOhwrPSv9/Tbi8QMfPR3mnrHr3Qslc8hZ33rkn8zwwcp8PFQcDHc6Ni0/V5ugjsZPEk5TBc9Av1NUq5NoUOPWmKJyy1PzJCU3RzTyaSpdNga5AaNOldx8sQWnfZQxR486XXKTRzOj8qAAKqkfnDiws6KiU/jZyclJ/JuX9m3yo5oESZPbAi3uv/4FJWtlpQ== + + + + ArangoDB PHP client: single document + + + + + + + + + \ArangoDBClient\Document + Graph + \ArangoDBClient\Graph + + Value object representing a graph + <br> + + + + + + ENTRY_EDGE_DEFINITIONS + \ArangoDBClient\Graph::ENTRY_EDGE_DEFINITIONS + 'edgeDefinitions' + + Graph edge definitions - - string - - - - - setStatus - \ArangoDBClient\Collection::setStatus() - - Set the collection status. - This is useful before a collection is create()'ed in order to set a status. - - \ArangoDBClient\ClientException - - - integer - - - void - - - $status - - integer - - - - getStatus - \ArangoDBClient\Collection::getStatus() - - Get the collection status (if already known) + + + ENTRY_FROM + \ArangoDBClient\Graph::ENTRY_FROM + 'from' + + Graph edge definitions from collections - - integer - - - - setKeyOptions - \ArangoDBClient\Collection::setKeyOptions() - - Set the collection key options. + + + ENTRY_TO + \ArangoDBClient\Graph::ENTRY_TO + 'to' + + Graph edge definitions to collections - - \ArangoDBClient\ClientException - - - array - - - void - - - $keyOptions - - array - - - - getKeyOptions - \ArangoDBClient\Collection::getKeyOptions() - - Get the collection key options (if already known) + + + ENTRY_COLLECTION + \ArangoDBClient\Graph::ENTRY_COLLECTION + 'collection' + + Graph edge definitions collections - - array - - - - setWaitForSync - \ArangoDBClient\Collection::setWaitForSync() - - Set the waitForSync value + + + ENTRY_ORPHAN_COLLECTIONS + \ArangoDBClient\Graph::ENTRY_ORPHAN_COLLECTIONS + 'orphanCollections' + + Graph orphan collections - - boolean - - - void - - - $value - - boolean - - - - getWaitForSync - \ArangoDBClient\Collection::getWaitForSync() - - Get the waitForSync value (if already known) + + + ENTRY_ID + \ArangoDBClient\Document::ENTRY_ID + '_id' + + Document id index - - boolean - - - - setJournalSize - \ArangoDBClient\Collection::setJournalSize() - - Set the journalSize value + + + ENTRY_KEY + \ArangoDBClient\Document::ENTRY_KEY + '_key' + + Document key index - - integer - - - void - - - $value - - integer - - - - getJournalSize - \ArangoDBClient\Collection::getJournalSize() - - Get the journalSize value (if already known) + + + ENTRY_REV + \ArangoDBClient\Document::ENTRY_REV + '_rev' + + Revision id index - - integer - - - - setIsSystem - \ArangoDBClient\Collection::setIsSystem() - - Set the isSystem value + + + ENTRY_ISNEW + \ArangoDBClient\Document::ENTRY_ISNEW + '_isNew' + + isNew id index - - boolean - - - void - - - $value - - boolean - - - - getIsSystem - \ArangoDBClient\Collection::getIsSystem() - - Get the isSystem value (if already known) + + + ENTRY_HIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES + '_hiddenAttributes' + + hidden attribute index - - boolean - - - - setIsVolatile - \ArangoDBClient\Collection::setIsVolatile() - - Set the isVolatile value + + + ENTRY_IGNOREHIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES + '_ignoreHiddenAttributes' + + hidden attribute index - - boolean - - - void - - - $value - - boolean - - - - getIsVolatile - \ArangoDBClient\Collection::getIsVolatile() - - Get the isVolatile value (if already known) + + + OPTION_WAIT_FOR_SYNC + \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC + 'waitForSync' + + waitForSync option index - - boolean - - - - setNumberOfShards - \ArangoDBClient\Collection::setNumberOfShards() - - Set the numberOfShards value + + + OPTION_POLICY + \ArangoDBClient\Document::OPTION_POLICY + 'policy' + + policy option index - - integer - - - void - - - $value - - integer - - - - getNumberOfShards - \ArangoDBClient\Collection::getNumberOfShards() - - Get the numberOfShards value (if already known) + + + OPTION_KEEPNULL + \ArangoDBClient\Document::OPTION_KEEPNULL + 'keepNull' + + keepNull option index - - integer - - - - setShardKeys - \ArangoDBClient\Collection::setShardKeys() - - Set the shardKeys value + + + KEY_REGEX_PART + \ArangoDBClient\Document::KEY_REGEX_PART + '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' + + regular expression used for key validation - - array - - - void - - - $value - - array - - - - getShardKeys - \ArangoDBClient\Collection::getShardKeys() - - Get the shardKeys value (if already known) + + + $_edgeDefinitions + \ArangoDBClient\Graph::_edgeDefinitions + array() + + The list of edge definitions defining the graph. - - array + + array<mixed,\ArangoDBClient\EdgeDefinition> - - - eJy1G2tz2rj2e36FOpPZQAfabbv7Jd3kLk1oS5tCJpD29m47jMEC3BqbsU1S9vHf9xzJsiVbsuzAZTpLFp1zdB46Lz1++89mtTk6evr48RF5THqREyzDy1fk+u01mfseDZJTEnvB0qdkHvo+nSdeGAAkAv++cebfnSUlJMO7YChs0NkmqzCCMfLOCcg4oXTtBAEbmoebXeQtVwm5yP56/vOz5x2SRB4QDGLyZj1724FhP1wGtEPe0Aiwd4D99OgocNY0hrlpYdqXmRgfHX9LSTj7BvySiG4iGsM4iEGcshi/zaLzWhKBHuY4RMjPT54zVua+E8fIpaD41xEOMy7w85hMVrLiiOeS1prJO6NkeHt1RRago4DeS0BxO0UWNH6/cyKy9n5Ql3RVYinEU/a9ibw7J6HkeOq5oIpqRlCHD2UlBiuBKrtFegZucMjKT7LbPJgfL0hUZpCYgRkcsjJz73jJ6zAa74I5uWNL6YGczcLQB9ZK9AzMSXBWHr+F2yhw/LH3J92PR669EjkDixKclUUvHu/ihK4PokOVmGnhp0A1WPsY+k7i+XsqL2NOJWdkT4DZ/XO7ntFotBivnMiND2FhHUWTxyqgVl5jBHtPd3uy6USRswNGC+QMPGZQdvYSJ9mqxDTq0UCVpmQg1vm+091ow8Q0zylkNcAWZ87ByrNfKNnFC1z6Q6EyB6yE9IeTm8/TwSU5Iyeee1JJhuWGakLD3oc+kkLQamIssFcTm3y+ZsQQtJrYiRQhTyxUP/UGk+n48/ACSct41TNIAc42w7vR7c2wdzUdD/7H+JdRqyfhK8lGfzzpTW7HSDmFryaaLxIb4ff9z9PR9WQwGjLqEmL1DCK82ugPxqD48aT/ga02gWSjLWJjDeofR1e9yeCqz+lniNUzqFHNNsvw9sOr/s109Ho6ftu7uWSKKlCw2FgEKKuZkT7ahJs6QyuT30ThhkaJR2MSbngFW6LJ7Tq9vhld928mgz4jmiNqqLrhfLuGGreyguLE0VOnl6OL2w/AOhB+XqZG3WWpsDNR6l++QRO+KFMZQr6YhVGgVOslItxBpsP+p+mr0c0QSD0rk7oN/NBxoXauQ+p2eDXqXfYv9bJd1SeUkdEIJ62SGcVKepuyaCb3qj8YvpG5+6VM9pL6NKnJ3mX/qj9hhH7V8QeQ0XaexAQ6N7reJLsy0SydbZzIWYue4Jjlji5PIZj4kxWtwE1WUXgfky9qs/WFf/V/zGl5lW+2M9+bk8U24BqcTueC3Raf/QxKHd/nJQbvx/DjLUg6/ugshZBG8XOcrLy4ex7TZAhgHLj9MgP554j/t6it1848CaMdWVPod12ShCRjCLpNtfAxyK+Xt6BhXjIcszIhxpoz8BLP8Un6AyrbPFFEE8hNcqeq0SlmGVm184hC+fE6Ctc9nLulcFDU77Hk82dM7Jj6i1Y7XV74ARapM1+BHVKenZgcQ/IhZ+cp1ZJJcqLMMC0E7whg2TbZn6mkEuZLg+He0IQtT5cunK1vCn9FFWbNb7nj1WtxSZNLPsMEqLaKehNkQVmnp0p8NfF94YcBLWxkKKzeMJIx9z0ELoqydpbe3CDfXVjcVig7HNIsCZK6zxSKUPnDfe1lCYy5oh1Mbp0rwOT2tQIsayKrJ5XauUoR1I7KBJb3MyVq+kXpiEWW7Vw5TPPhojqcKnbPFzN42bvxaNilwTzE9MWJN1kT2ZpX6BjyTHm9JOGYETCt/VRRSfguDoNW26SavcQ7hCSCQb0U32Bsyim2UonA9Xu+32o/QCRYAzSC8A4Luq5IuGUrIdUWapzhmINTClFbMLaMfV8RKgFGZ9uExgZBRE/Mv2Gx2wjoBRK8FcMTeBJG+TPyh5JieODN2uP8g0kpC2kdIw7rhDU4GN/MWHlzqmJJ4c6MrPad57ogaEbOe7OCjGlorMTM+i4VU0RLMy5r8TVawkRrxkob4BIWb4fNeHJ/K+PljW6G+lWqT7BExNjMKkR9kC8VKHxV/aGsiELn+JWYqGkLGOTCi6fMC1qlHNKuw0HeUcpzSztmmmlFLObkTH49ZulJ55QFp8Y9MSztWhkAK5jaZL2N2dagSHJPSoheTO49nxW2nov7Xxgd+c5imgFzmk7gEr7byEpp+H9Bh4pqGhWaUwDiXsAoFyduVIyLdgdFJBizFCkLwPzoJq1aAZh/Y8Fu0l7tYqxUE2u6nkewmji/DLS0grjmsGIviN46GXBVaQ3OiuQTfRHOmi1W2YMnqRHW3HUN3FZW2CsgXBnNJsKwbGvwDjZZFs3NM37KA/sBJ5YzgXnud3leOODcWSKpsGiaUw47q0hCVfOKjHTAmTGFmadkvd3hJuOZzzzdmGXAA04opUzzrO+z/HlITy2kywqvVZLnIbWd5csKjYvsWXte8dfTp2QbfA/Ceyl4dniKgzzoLYMwSrf+9Pk2KV4hMGZMHsnTfAdhG2voADKhF7O7DxIRKJJjst1gemVbVnEI3XgIaFGZfqPEyHPdsWe6qlDMcHiAastwmBg8V7uhl+85iF098tNPpPAzItfPeeNVuPVdEoRJqiCrNg1JUO1ukZkz0uKJuI082falCtdGPGyIIuq4O8IWU/EMVTkHhAYyomDlgEbMxNjoAUlo5O7AxGHg74rljwYdilVo/OYEFizJjnRn3nJJcV8XdAEd53QwnEw/9P77JFuNIQjue87M30GVBEtbrRdBEurH9B5WGjiBw5tWXkzFXPEwxzampvWivQbTIeqJM6hKGndDGjNz7kCxK+cOq8bS3ZlyEzkwtsO5RavK5KR84eYQFae0wb5H0SjtcBdkdGJYJElLqhkZVLvQJynbeDrfywY4/r7+x8g19UCFF9n5+JWk2u7HL0vZHLD2DrG8ypghLOusilvNSsO6XNtVwT/wrMUW886i7JlxuuHfapMTijcJSBi56OohrhgAdr3FAtw2SPihPgsBzDZhtHZ8iCrZtARKXbCTs974CAekRduHlIDgC4U8n5fZ1l3Sbs7UXj0a3us4Zpx2OcNn5Dnpngt281k6YvgFDhdY2MPJeE2ItM1OBkymIGUPY0yBB52IE9qTcnnCGTeeHrBFwyJukSaKWYcentGaqylpG0cbBbIBLuO+UYCRaxoFcsEfnWlVxRnWAKDsD+iWGSnMYYVDOUuUSnV/zK8oSkDVwYnfnPy/BKeqAyuZ6wbBiW/d7Ree9NFJT7l5xEgvgokbYRQPdp6xuJHeSeiIu2JpPBGn99LvLJCUfv0Ff1VP/KXRX3HU5Wf4ewQd0RlyupbAkwKZknvKm86xpSFBZV/nTkk+xL0feUG6YaqGM91Gsbr9jx/u8YXLJJ1qMHEVwwJWC0i93GEBTm9uKEBf8eK8uDwIn3b+V/PolZqhefzKVvKxuCgpAVbHsBS1dhSTr2zagljqEJYwVs2yJpDhPgK/hLVfzEkvVUgXQbukh0eAcTj3nMTDdoWBzMMgcbwAfYLPCzUMYMWnLAN08LQsvL8F98ZNig6oCMIlFg0d8KgFBIYSlw2Cirzxk3NqDi7p4YUEKoeY8nEMLhr5jmvthSNZof7qKV++ta0hSX7LOrJLIdaS6VFAYX2wG+bZ0YEVqYFRNVvSeoOy2I9FY8rG339DNp4iYwJPCgy6ixsC02ZYzbuLujat99KibFlZCRbTKq8zqm1rek2hqzeEaa04DUyr2fE3+mq6y1NhSpmzuqbUPE9pFtwtD1LKlpRltlhSecRSbUnts5NKFxUYp2ThQN/VPYdMGqndJuTq7nnM6R6k0ywetBzQjzMF1LV88dVPQw+ueuej2aQTgtu26rKHQTZzax/yWAxejdPIjsWDq4NaMuOzvi2Lz6QaW7PqYZTOnpkCrBbN31JV27Ti4VNVPK6D1mTHVXt41cS89kBdupBYz8r6t2bNwrX9dZlm71NViW0XVHN1xmx0/SMyfe0tLG7BadKEFw8Lm9g5LZ6NVs7ZrGvg0gO9ppVy5ZM8TcuViW/rutQrSf8cgQzsTfUUWlEnbuWHUqen7PcOOfki3oiLVwOzLxdKi/ovCj6ryQ== - - - - ArangoDB PHP client: HTTP response - - - - - - - - HttpResponse - \ArangoDBClient\HttpResponse - - Container class for HTTP responses - <br> - - - - - HEADER_LOCATION - \ArangoDBClient\HttpResponse::HEADER_LOCATION - 'location' - - HTTP location header - + + + $_orphanCollections + \ArangoDBClient\Graph::_orphanCollections + array() + + The list of orphan collections defining the graph. + These collections are not used in any edge definition of the graph. + + array + - - - HEADER_LEADER_ENDPOINT - \ArangoDBClient\HttpResponse::HEADER_LEADER_ENDPOINT - 'x-arango-endpoint' - - HTTP leader endpoint header, used in failover + + + $_id + \ArangoDBClient\Document::_id + + + The document id (might be NULL for new documents) + + string + - - - $_header - \ArangoDBClient\HttpResponse::_header - '' - - The header retrieved + + + $_key + \ArangoDBClient\Document::_key + + + The document key (might be NULL for new documents) - + string - - $_body - \ArangoDBClient\HttpResponse::_body - '' - - The body retrieved + + $_rev + \ArangoDBClient\Document::_rev + + + The document revision (might be NULL for new documents) - - string + + mixed - - $_headers - \ArangoDBClient\HttpResponse::_headers + + $_values + \ArangoDBClient\Document::_values array() - - All headers retrieved as an assoc array + + The document attributes (names/values) - + array - - $_result - \ArangoDBClient\HttpResponse::_result - '' - - The result status-line (first line of HTTP response header) + + $_changed + \ArangoDBClient\Document::_changed + false + + Flag to indicate whether document was changed locally - - string + + boolean - - $_httpCode - \ArangoDBClient\HttpResponse::_httpCode - - - The HTTP status code of the response + + $_isNew + \ArangoDBClient\Document::_isNew + true + + Flag to indicate whether document is a new document (never been saved to the server) - - integer + + boolean - - $_wasAsync - \ArangoDBClient\HttpResponse::_wasAsync + + $_doValidate + \ArangoDBClient\Document::_doValidate false - - Whether or not the response is for an async request without a response body + + Flag to indicate whether validation of document values should be performed +This can be turned on, but has a performance penalty - + boolean - - $batchPart - \ArangoDBClient\HttpResponse::batchPart - - - Whether or not the response is for an async request without a response body + + $_hiddenAttributes + \ArangoDBClient\Document::_hiddenAttributes + array() + + An array, that defines which attributes should be treated as hidden. - - \ArangoDBClient\Batchpart + + array - - __construct - \ArangoDBClient\HttpResponse::__construct() - - Set up the response + + $_ignoreHiddenAttributes + \ArangoDBClient\Document::_ignoreHiddenAttributes + false + + Flag to indicate whether hidden attributes should be ignored or included in returned data-sets - - string - - - string + + boolean - - string + + + + __construct + \ArangoDBClient\Graph::__construct() + + Constructs an empty graph + + + array - - boolean + + array - + + \ArangoDBClient\ClientException + - $responseString - - string - - - $originUrl + $name null - string + array - $originMethod - null - string + $options + array() + array + + + addEdgeDefinition + \ArangoDBClient\Graph::addEdgeDefinition() + + Adds an edge definition to the graph. + + + \ArangoDBClient\EdgeDefinition + + + \ArangoDBClient\Graph + + + - $wasAsync - false - boolean + $edgeDefinition + + \ArangoDBClient\EdgeDefinition - - getHttpCode - \ArangoDBClient\HttpResponse::getHttpCode() - - Return the HTTP status code of the response + + getEdgeDefinitions + \ArangoDBClient\Graph::getEdgeDefinitions() + + Get the edge definitions of the graph. - - integer + + array<mixed,\ArangoDBClient\EdgeDefinition> + - - getHeader - \ArangoDBClient\HttpResponse::getHeader() - - Return an individual HTTP headers of the response + + addOrphanCollection + \ArangoDBClient\Graph::addOrphanCollection() + + Adds an orphan collection to the graph. - + string - - string + + \ArangoDBClient\Graph + - $name + $orphanCollection string - - getHeaders - \ArangoDBClient\HttpResponse::getHeaders() - - Return the HTTP headers of the response + + getOrphanCollections + \ArangoDBClient\Graph::getOrphanCollections() + + Get the orphan collections of the graph. - - array + + array<mixed,string> + - - getLocationHeader - \ArangoDBClient\HttpResponse::getLocationHeader() - - Return the location HTTP header of the response - - - string + + set + \ArangoDBClient\Graph::set() + + Set a graph attribute + The key (attribute name) must be a string. +This will validate the value of the attribute and might throw an +exception if the value is invalid. + + \ArangoDBClient\ClientException - - - - getLeaderEndpointHeader - \ArangoDBClient\HttpResponse::getLeaderEndpointHeader() - - Return the leader location HTTP header of the response - - + string + + mixed + + + void + + + + $key + + string + + + $value + + mixed + - - getBody - \ArangoDBClient\HttpResponse::getBody() - - Return the body of the response + + getSingleUndirectedRelation + \ArangoDBClient\Graph::getSingleUndirectedRelation() + + returns (or creates) the edge definition for single-vertexcollection-undirected graphs, throw an exception for any other type of graph. - - string + + \ArangoDBClient\ClientException + + + \ArangoDBClient\EdgeDefinition - - getResult - \ArangoDBClient\HttpResponse::getResult() - - Return the result line (first header line) of the response + + __construct + \ArangoDBClient\Document::__construct() + + Constructs an empty document - - string + + array + + $options + null + array + + \ArangoDBClient\Document - - getJson - \ArangoDBClient\HttpResponse::getJson() - - Return the data from the JSON-encoded body + + createFromArray + \ArangoDBClient\Document::createFromArray() + + Factory method to construct a new document using the values passed to populate it - + \ArangoDBClient\ClientException - + array - - - - setBatchPart - \ArangoDBClient\HttpResponse::setBatchPart() - - - - - \ArangoDBClient\Batchpart + + array - - \ArangoDBClient\HttpResponse + + \ArangoDBClient\Document + \ArangoDBClient\Edge + \ArangoDBClient\Graph - $batchPart + $values - \ArangoDBClient\Batchpart + array + + + $options + array() + array + \ArangoDBClient\Document - - getBatchPart - \ArangoDBClient\HttpResponse::getBatchPart() - - - - - \ArangoDBClient\Batchpart + + __clone + \ArangoDBClient\Document::__clone() + + Clone a document + Returns the clone + + + void + \ArangoDBClient\Document - - - No summary for method setBatchPart() - No summary for method getBatchPart() - - eJzNWFtv2zYUfvevOAGC2g7spMv25NRdkzSoG6RJkKTYQ1sYtETb2mRSI6m4xtD/vsOLZIm6xFmAYmoRyeS5n4+Hh3zze7JMOp2jg4MOHMCpIGzB35/B7eQWgjiiTI1g8vBwC4LKhDNJkUoTvktI8BdZUICc59yQm0mSqiUXOAeXhMG9onRFGDNTAU82IlosFZznX8evfzkegBIRCmQSPqxmkwFOx3zB6AA+UIHcG+Q+6nQYWaEhJKCe2pPchXPOFIkYFWg/kRLmaEjJA+lceDMTb31vanyREQu0m68Pj40JVupEqeQuC8k/He2q0a+fA3hYUlhSEqIRgqJf9JGGbi4jefdIBEicYws3dGTeiYgeiaKwP3UCxtDtonc1GmY83LxAvmGvl34ax85+uVUARAJmE73nARAhyKZOZXGi3iOJSr98q3cJc5TGCu0mKpXDGNMIvXkkpALzzeflVDoj+8/23elpjq1RY82AgIdGtbIGumVQ1RhpxNQ7jmg5RylVXX8sKYoVgCBlXJVUQGTBa2K+YQFO/J1SDMU6wtWVKiBbUp3LOpNmnMcNNq2JPDVixzAnsfz5tp0RFSwTIhqCNtPTtzhdNcwkJ+YBURFnDgMlIQEqVjC5OH1/cTe9ujk/ffh4c62znTFh1jVdvWC77igLE44pdfIHkEpcAxHDaEUxf2zVaF8X1+9vbz5eP2jF34fElJZhJrYGd/dUQZq0wCwPH0aNrBzCYT8jvre/h0ZCwFdJTBX1FgyuYZkmCZa3EGYbQymp2Hrjy+ZYoSP2WcRm2iwNO0Ri+Hx3VQEFqtV8c8FXrRI/IbR46CQaE1d2RC0JogjNNOFeLylDA1moWUOiCChudFop2oT62Gjg4+/9DOU+lVoKvpZg6/zF94AmGhZlJKazOApgnrLA4Gw6NUkWaaB6XswHxUCNgaVxPPA8zUf9dWeLl91C9LOvlpEcvi2uz5znJKeK5tAr6NwbW/nw6pWnN5vpF1TkAjzkjMe6IPqU+jHhAkbXfsR6FVL9dD9gvWB8iwyNhwLYgMyV2Rtt0cCcdmvlHHrOHEIX/x0Wo62HhnDNFR2BjhysyAZmCHRQ0YrqUhRJmdKq/P5JaehHZ/uVf8aRxFy7hGR1IPut61ofs6NbgQmNEypGIwSfpHrgE5USG4o2oHgIKdhTVuv2jq1iu3ltf7tttd4WO+c50T/plJFUcMmgwGGpFKGKRQZbx69/M6Crm/vVzu3l+O3nAn2QHR3BwsOMNmavitmXgF4//wXKuM1F7JHEUfgTIL07Utvd2dXybkG+lf2jsjXdUZUKZpie2xkJy6p30mEts8dYX3wXVE0ctHp+xXQafAietPtiIhNGj1GY4l5mDMv60yc8Ku9n+kSCnpkXMpa6ET8IMtuhXW+PiUlxYV9/vrrS4HajuFpYF5tgbAdwi9s5PIa5Z+zxI4Q9OxWqF8mptcBRFcuA9WOsTVR48lrnorxSgdWU+jVRfjGk3/r+evMzU6Iuos7PpV68T+Qvx+KOWXOSzfkEM2DfyEMKZx3dvdqkyN3CLZ8EoyXbwZe8ny04taNPrbCSL4PVlTPLwavd3S0MJY3no5HXgfezMOi/baGwBv9fI2KYL1wf/6K4lM8J/R1QYnboZ8aghafRyTPkeQrbWu4OJruzdvEw7+Kvh/rP9aZBZHY/UL4RaPTvzkh4ykOrZwcfzdEk31cv72+u8aCnN7iw9vjbevpoLlW2MjXoqTtvN7p/KbFBqJw83I3QFrQWBdtCvf8n8iGFfk1DqhX3DJe+vUsre8UebjjG+J5hrGwPxdYzbxFrWjYXjy/f/EbIbyHlkqdxaNp/F76BOa4D1xcZ6yhDl3ue6p3wLBHPuVjZ6GrEtbZOFRRpp5vA47qI/BKkcOHRsAJKV45t+cV6dpbJ6m3FNhw083mdef/SpeiNJm/0xhE13OnU1JfcwPYlWDDIacb/5gp2ik0tkb1iVEYjMzOA7tfsMvmru9GdfS0S6rz9C8rpmwY= - - - - ArangoDB PHP client: http helper methods - - - - - - - - HttpHelper - \ArangoDBClient\HttpHelper - - Helper methods for HTTP request/response handling - - - - - - METHOD_POST - \ArangoDBClient\HttpHelper::METHOD_POST - 'POST' - - HTTP POST string constant - - - - - METHOD_PUT - \ArangoDBClient\HttpHelper::METHOD_PUT - 'PUT' - - HTTP PUT string constant - - - - - METHOD_DELETE - \ArangoDBClient\HttpHelper::METHOD_DELETE - 'DELETE' - - HTTP DELETE string constant - - - - - METHOD_GET - \ArangoDBClient\HttpHelper::METHOD_GET - 'GET' - - HTTP GET string constant - - - - - METHOD_HEAD - \ArangoDBClient\HttpHelper::METHOD_HEAD - 'HEAD' - - HTTP HEAD string constant - - - - - METHOD_PATCH - \ArangoDBClient\HttpHelper::METHOD_PATCH - 'PATCH' - - HTTP PATCH string constant - - - - - CHUNK_SIZE - \ArangoDBClient\HttpHelper::CHUNK_SIZE - 8192 - - Chunk size (number of bytes processed in one batch) - - - - - EOL - \ArangoDBClient\HttpHelper::EOL - "\r\n" - - End of line mark used in HTTP - - - - - SEPARATOR - \ArangoDBClient\HttpHelper::SEPARATOR - "\r\n\r\n" - - Separator between header and body - - - - - PROTOCOL - \ArangoDBClient\HttpHelper::PROTOCOL - 'HTTP/1.1' - - HTTP protocol version used, hard-coded to version 1.1 - - - - - MIME_BOUNDARY - \ArangoDBClient\HttpHelper::MIME_BOUNDARY - 'XXXsubpartXXX' - - Boundary string for batch request parts - + + __toString + \ArangoDBClient\Document::__toString() + + Get a string representation of the document. + It will not output hidden attributes. + +Returns the document as JSON-encoded string + + + string + - - - ASYNC_HEADER - \ArangoDBClient\HttpHelper::ASYNC_HEADER - 'X-Arango-Async' - - HTTP Header for making an operation asynchronous + \ArangoDBClient\Document + + + toJson + \ArangoDBClient\Document::toJson() + + Returns the document as JSON-encoded string - - - - createConnection - \ArangoDBClient\HttpHelper::createConnection() - - Create a one-time HTTP connection by opening a socket to the server - It is the caller's responsibility to close the socket - - \ArangoDBClient\ConnectException - - - \ArangoDBClient\ConnectionOptions + + array - - resource + + string $options - - \ArangoDBClient\ConnectionOptions + array() + array + \ArangoDBClient\Document - - buildRequest - \ArangoDBClient\HttpHelper::buildRequest() - - Create a request string (header and body) + + toSerialized + \ArangoDBClient\Document::toSerialized() + + Returns the document as a serialized string - - \ArangoDBClient\ConnectionOptions - - - string - - - string - - - string - - - string - - + array - + string - - \ArangoDBClient\ClientException - $options - - \ArangoDBClient\ConnectionOptions - - - $connectionHeader - - string - - - $method - - string - - - $url - - string - - - $body - - string - - - $customHeaders array() array + \ArangoDBClient\Document - - validateMethod - \ArangoDBClient\HttpHelper::validateMethod() - - Validate an HTTP request method name + + filterHiddenAttributes + \ArangoDBClient\Document::filterHiddenAttributes() + + Returns the attributes with the hidden ones removed - - \ArangoDBClient\ClientException + + array - - string + + array - - boolean + + array - $method + $attributes - string + array + + + $_hiddenAttributes + array() + array + \ArangoDBClient\Document - - transfer - \ArangoDBClient\HttpHelper::transfer() - - Execute an HTTP request on an opened socket - It is the caller's responsibility to close the socket - - resource - - - string + + set + \ArangoDBClient\Document::set() + + Set a document attribute + The key (attribute name) must be a string. +This will validate the value of the attribute and might throw an +exception if the value is invalid. + + \ArangoDBClient\ClientException - + string - - \ArangoDBClient\ClientException + + mixed - - string + + void - $socket - - resource - - - $request + $key string - $method + $value - string + mixed + \ArangoDBClient\Document - - parseHttpMessage - \ArangoDBClient\HttpHelper::parseHttpMessage() - - Splits an http message into its header and body. - - - string - - - string + + __set + \ArangoDBClient\Document::__set() + + Set a document attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. +This function is mapped to set() internally. + + \ArangoDBClient\ClientException - + + string - - \ArangoDBClient\ClientException + + mixed - - array + + void - $httpMessage + $key string - $originUrl - null - string + $value + + mixed + \ArangoDBClient\Document + + + get + \ArangoDBClient\Document::get() + + Get a document attribute + + + string + + + mixed + + - $originMethod - null + $key + string + \ArangoDBClient\Document - - parseHeaders - \ArangoDBClient\HttpHelper::parseHeaders() - - Process a string of HTTP headers into an array of header => values. - - + + __get + \ArangoDBClient\Document::__get() + + Get a document attribute, magic method + This function is mapped to get() internally. + + string - - array + + mixed - $headers + $key string + \ArangoDBClient\Document - - eJytWvtzGskR/l1/xVilHIsN6FFXdwkOjmW0ZykngQqQY8dSqGEZYE/7IDuzkrjY/3u657HvRegSymXQ7sw3/Zrub3r3r39br9Z7e4evX++R1+Q0osEyPPtArs+vieO5LBBdshJiTVbMW7OI+EyswjmHsTj8/Zo693TJCElm9uUkeZPGMDaCe+TvNCBjwZhPg0DecsL1JnKXK0H6ya+To+OTFhGRC4ABJx/92XkLbnvhMmAt8pFFMHsDsw/39gLqMw5rs8KybxNFznPikgXIcT6ZXJOI/TtmXBxGMD8MOCMrGsw9N1gWNarQh7uBg6oedU6kGI5HOSfnYB212t5/9lBZKQF+Xqslr4fjCeGgV7AkDqwpKOLJAYfyW14kV/bkfHg2laN7pIHfDdCnEvHmJYA3Cu+mFu7MvrQn9u6IejyAql91uB/tF4iJgwERvurgzu3Ts93x5GgAxO9aO55O+ucvsKQcjrbEHxWg/VUc3BPu/s6IFcT+DAIwXJDZRjBO1lHoMM7ZnLgBCQNGZlQ4q2bFav3zm8Gv0/HFP9HEfz7+y0l5ITuYIzLELSM+je5JrIFRrQpIe3gJWPu30W2wX0YbszWNqIAtMmPikbEANjudg/CwNcgsnG8qEMf29enodDIcGdwabGln0F2ETuiRBxZxNwykuC3YetG87YRzEF2Eyb3jznHFetej4WTYl2o0EPMQhlV5IGJUMELRwm3h+kwJABgBcwTCzzYkXLMAPU4JD517JnB1sWKEswiE0FAG8UIQl8vbDvU8FjU40bnDnbmeKzY42/FCSCUSQyIWMN6LVRQ+ckhmUgz7yWFrFKY4DN3gm1FwfyhHcXIQ6h/trCb6YhEkYiKOAhQyjCPIV22j5aMrVlrHDEwLrnsekRKSxxU4PwizqziQumeMQM6kM8/lKzbPeWcdw1UH9hAV8LWIAz1L+iHVxKpXSm0BlTrxc8CC+Tp0AwGuNmPa75ZM9OMoglRs69tW8206BwQW7AmnwG5m1J/qC1MlCI5NBrsLYhmQbheAJ5s1s5Jlm6TX65F0wOTLtT0djy+bGRll1B2CMQWoHIHfIwIjjEdktcFgMJC5eQUBAWOq5llGixZpcO414Atc5S420zWDuGsl1vhaMma3O7yeXAwH00/26OKXL9O+PZrcZeyDn/d/cOEpFtsXrz4dnF7ZRRFeIgFstvARhniLKXeBAcx3E+H08nL4j+nYvvwFMujHgX12l3W9cf8OQP2L63N7NL4jryAagtjziv7XMYB+d9w1hAAv3X6JvhpjNy2NcAX7ft9Lf6V7Y7GGbWG8r3LBVFE7Kzc7DfkgBK7lQRnL7IpWbuwBi6JBWLgGnIwDdSpcfV6bycWVPbyZ3OUnjicj+/Rq2r+8sAeTaX84GNj9SQFbWzG5WNzmr0D5ot9UpgvYYykdWyUHNiD7BaEw+RBTfZKdbhsN0inNSLNXhzRuG10Cg1LLaLvlZmV8mPGacRf4CstYGAsLdNkpOIw5s8bQRQEg1GrfS5XzQxgHcxptDB3CHCYpiqHMBKqTMNUmx45gvemH4c3g7HT0Bevz58+feTzD4fCrls0pioHL+PRelmMsaQyICBYQyjeBA54KwrhqzdPxl0Ffcjx7JJdsK77ePsV524iB0UaraRWojiFku9fk5LOlOBsYvWg2XtI52iJtoEusDScL5s88oEZawIxb0inPw6sDUOZKW5lfXX9+fhx5ufg2829Gl89PRoMWJiu7UE8aG/fTOuSigESjiObnHTgxF6GvLMQVEhwG9UjMAtSVlE4bi3nMh/xWx420qICRWDl7ONT3S+xN5swa8raVDc1i15uPFPgWJtQqR0PLeLAlXdFSNm1pxQtm6ZGvd0U2JbOgy6dKJUtOb25JiXkdrcZF8ACVYE7g/5ippAAIHWI/rVFOsKJCbpEl5ElMdkCohCRUaqnK7HbgsWAJbFTSNfitBxey9w657gOexO4kYxNRzIqKqQIRSIaHaaKv/mzj313ix55wMU0dgl5+e04FfQvqqTzYQ12QfnS7+QRnrsKZKqMbhBycALav3qhiItoS78gR+eGHXdK7VBkOXxOl9oLCwjXcBBaQ2wwOMFBIgOnD+WQVxt5cMldKtHxt9JfeOuWCttWEdL2GgJcp+/A3HgaNavMo91cFQjaCtY3MPXAKo1B/rEKYU9gxSthf2Yb03pm/PmGIliMgu0Cnl50KFVrX5wxAjX9TkcGuCxcymLdJ0ock+zp5pKqZbAJBvoYtIhZW40+cyH+N0r5Wa5pTbrPALMpVoqMkAXICXhAr8DD2FCDxQI1WJz0op6DCNmPUB2v+ViK+8f2ljNmuVkRFcDNruPzv/DoYkRXMRFurjp58wiwkK3iQz9W6wOEhpe7UvS1vF6qXqZftbbha5FkYelhDvEe64TL95M7SsPlAVlfnzwyc3I4xbpzdztIPWvUrCWFpEasSvZEe84JOXZmm4rdvRbpeM/hm97G6FbjrcGzy7TpWNvB2lhmTYnoMKCQB7TB0UeWW3qH+FcJNkv9EHEn1G8262LWfmBNXhC7SXMl54XRb3Tj6vzSfVIAn/aAD3Q7K81V90fIhQ2C/B6VqVu+RTGpDCH/tMcHymkGKpkUWVcQwzDRHSFUj02KdZYfsYwTslwj51l1dpnhaLt3t15ep7Mc+uNh6nG3Kzb+t+1HASYMvWGRpS7YSeyRZvY6FGSeYqX+EiWlPoaEa1ewKy1IkrAzr0/I1swzr/eIxcgUra5EBfb9YeDFfJeK+zVZuVQxULcArqk2SacoxyRHZPBlSGiFCQb0RlCNzpUeOil09s8R1yNXtbIXlQOEKtOFg4UYQgqSn93ty43HlQqm29P1v38irBQsXta4AdJCrBzbAH6mZVN5Jm/SFHozMw2qqYWe4VnoJEkUFW5vB/fsiYcrLkxrrTcqbEbaywyW1rFoptZqc/LY8IDGglL4gVBXRzcJ2KnG/V0iYD6De9jabs2LOPc4znFXzZn3gc3FDM45P6qpmH5+ANj4cEf3YJ+FigfTXcjusY+y4b54pkKenp/0maVeh0IVg2NilApm0o4k0I/t5mbr7ZeOsZfDidoRflrYVdv3yMwnwqeOToj8TiyHKq22cX65VsTEt2dfm8QwkSFeXeG/I8U+w6FHzrTTUT+mZrKgWMbl464JqmxronxXqz3AJoOGCpKlzd+lWOCrRM1Pl1fO7Ol21Y5Knu5Iz6DQGx+k0rytipsrAfBuUpM44D+oDPkDOU151DG7BgV5IxG1Ig+EkIR6AJ4/NteOLmyGbBrOf76Wr31+4z0w7W542Cxl62x6UvH2M5wsVIbk4Tp8Atsrh0CyrIuVKAZ+P6XQs5L4fZVD9mInUZPmaCC3qmQMsSFyW9nkTF/BzNk7T9rteUZKdK0HF4unBCX1Qxz3HcMyAEyHwTPkWh25Ew7EEiCPeKLQ/O9tPR4hxpSHIBKI6B6pGdWrmhhHs+uBG9RNxrrpAPewl6hO0ZmmQzYFXynZnFPpb8dShSOJlaaRK0kDzJJ+UjzWhOMxxIrZ5zBNfhZFpZr6QZco23C6cEUTn7Dy1npU1ZStrHBU5rYJ+el8WaKWWAmLKC+fMUswkeTLfIvlFTmoPKNfq3YSEs+O7BdKaK91ykeFCtb54V4dN753KiPy5uNE4bWl181fugPA/mlZBWmal0kNltEQfjFRBQjVxIRW30pc2sLeaKctJb8rYPn0LSDY9WonOTdmvwjc1BuqNEGxY4Z/Fva+6gZlxkESOatiQYmjy9Q9whlYA2wqQXFxaLkuIDfxoOfXxiY61f/gvdO/t4e38zW0H/+NvLPhqHmL+Rlg8yeBQxku8uGxSwy/MlK/Hd88l0azhe2rJHXkmaB/KB+44h5veP7lnm64Mxbbn3ichVjUbI3AR4tNlDE0Xox68hh1giq93YQPWd39XT6Eg6pdAFSMXX7epAxOPIb615nNiwREDgoJGDPckg1P6A0P3w6iNvio7AYD2oJMu/miSSoeZIqv8ga3K5vOV0nO5sA7AGuDBB9UQ7SUJoiEJpgY8qajLtVbfAfoZ5ApObDbXV9BUhOAQPFMDfvMOY0IusXsd/JrEY4tkGK5Z487kPpgp39ubwmGa8ty+ldfB0rfmHcRb/RLg7DYdhmfu/wIci5Km - - - - ArangoDB PHP client: update policies - - - - - - - - UpdatePolicy - \ArangoDBClient\UpdatePolicy - - Document update policies - - - - - - LAST - \ArangoDBClient\UpdatePolicy::LAST - 'last' - - last update will win in case of conflicting versions - - - - - ERROR - \ArangoDBClient\UpdatePolicy::ERROR - 'error' - - an error will be returned in case of conflicting versions - - - - - validate - \ArangoDBClient\UpdatePolicy::validate() - - Check if the supplied policy value is valid + + __isset + \ArangoDBClient\Document::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. - - \ArangoDBClient\ClientException - - + string - - void + + boolean - $value + $key string + \ArangoDBClient\Document - - eJydU2Fr2zAQ/e5fcYNRJyFdunx0G9ouLe3GYCFdvwWKopxtUVsSkpwslP73nSTHpF6hMGFko7v33t07+eJSlzpJJqNRAiO4NkwW6uYbLO4XwCuB0mXQ6A1zCFpVggu0lOdTrzTjz6xAgA41D4AQZI0rlaEY/GASHhxizaQMIa703oiidDDvvqZnX6djcEYQobRwV6/vxxSuVCFxDHdoCL0n9CRJJKvRkjb2ZM+7Jm4Ub2o6+ajwd8q2QnLf0dmXaVDjFbMWHgPPwtPsk5fEdxWk/BoBpXRSO1FVtEmghzOLoHLgSuaEdEIWsEVjhZK2xU7CmxKI4ef1w2+YQerpUmqmp0IuojFkaZBYIxh0jZG4+Q+p2+Xy19JrBcZ3xOYl8mcQObgSwTZak0Ob6OMetqxqEIT1H2LTQg7IK1catbMQPb39w1E7qqKfpZlhNVgaOFX6OTKevplXq9MHxq5hqzrl2Jhu1gQiRubolTeSe9lYInEOosYw5MYJ+kXDReMGwj7FUg5pw9YSv8iF9hg+zWZgscqzLAzr5AT+CQRrh0cSfgVPQOKub8sg/S5DiW9bT0n/gH1N4v6axMv4ROnMDo6vZJaFyBjS1eEPWrV3e706TvS8fwH05C35 - - - - ArangoDB PHP client: exception base class - - - - - - - \Exception - Exception - \ArangoDBClient\Exception - - Exception base class used to throw Arango specific exceptions - <br> - - - - - $enableLogging - \ArangoDBClient\Exception::enableLogging - false - - - + + __unset + \ArangoDBClient\Document::__unset() + + Magic method to unset an attribute. + Caution!!! This works only on the first array level. +The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. + + - - - __construct - \ArangoDBClient\Exception::__construct() - - Exception constructor. + + $key + + + + \ArangoDBClient\Document + + + getAll + \ArangoDBClient\Document::getAll() + + Get all document attributes - - string - - - integer + + mixed - - \Exception + + array - $message - '' - string + $options + array() + mixed + \ArangoDBClient\Document + + + getAllForInsertUpdate + \ArangoDBClient\Document::getAllForInsertUpdate() + + Get all document attributes for insertion/update + + + mixed + + + \ArangoDBClient\Document + + + getAllAsObject + \ArangoDBClient\Document::getAllAsObject() + + Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class + + + mixed + + + mixed + + - $code - 0 - integer + $options + array() + mixed + \ArangoDBClient\Document + + + setHiddenAttributes + \ArangoDBClient\Document::setHiddenAttributes() + + Set the hidden attributes +$cursor + + + array + + + void + + - $previous - null - \Exception + $attributes + + array + \ArangoDBClient\Document - - enableLogging - \ArangoDBClient\Exception::enableLogging() - - Turn on exception logging + + getHiddenAttributes + \ArangoDBClient\Document::getHiddenAttributes() + + Get the hidden attributes + + array + + \ArangoDBClient\Document - - disableLogging - \ArangoDBClient\Exception::disableLogging() - - Turn off exception logging + + isIgnoreHiddenAttributes + \ArangoDBClient\Document::isIgnoreHiddenAttributes() + + + + boolean + + \ArangoDBClient\Document - - - No summary for property $enableLogging - - eJydVF1vmzAUfedX3AckoGJJlkfaZu26qtVUaZXSx0jIOBewRmxkmy7VtP++i8NHgtJpql9sfM+599wPfPWlLmvPm19ceHABt5rJQn37Cs+Pz8ArgdImgHuOtRVKQsYM0jUzhsAt/qZm/CcrEGCg3jmWM7LGlkqTDb4zCWuLuGNSOhNX9ZsWRWnhbjgtF5+XMVgtyKE08LDLHmMyV6qQGMMDamK/EXvueZLt0FBsnIS9HDK5PyMaGoNbsApsqdWvjgqmRi5ywcc8++yuMr36r0SNkLw1ASxmS6fwEG8UgXuLcmtgM1x5v72W4OS261gyJw1WN9wqPeusPYiEaLYDMgtZuDufSmFI2gQhpIVu+Vxtp+ZRCPi1xlehGtNB5m6vm6yiouSN5A6VpoOqsA8J1xAE8cE/nRfxWbdkkU1VRc7tIet2iRxCg1WeJD5KllX4pIqCkoqOMO26Qa2VTmkMwgJt6iob+rYUJoIZBAkEtPWKosv3uMHaUgtpvGhqkmCCy5VGxksIcV9XlExI85/e/3ii3NpAn1YU+aVl3pq1q3wYRcAM+AKuV+BXQuJU9jQ8fTqhDnsa/Y83noYjtan9+5Jzde9KHo817jx2/KOhemm0BDeAfV+qQ5nPNdtYZo97ftKXcNrAc82jXpNU/LeaPP+YnK0wH9CTs8qcCqq1eGUWe//vMQjthi1llWAmHCY7Sdx1DMGmf6w23aOQjfPfjthfI0+USQ== - - - - ArangoDB PHP client: endpoint - - - - - - - - Endpoint - \ArangoDBClient\Endpoint - - Endpoint specification - An endpoint contains the server location the client connects to -the following endpoint types are currently supported (more to be added later): -<ul> -<li> tcp://host:port for tcp connections -<li> unix://socket for UNIX sockets (provided the server supports this) -<li> ssl://host:port for SSL connections (provided the server supports this) -</ul> - -Note: SSL support is added in ArangoDB server 1.1<br> - -<br> - - - - - TYPE_TCP - \ArangoDBClient\Endpoint::TYPE_TCP - 'tcp' - - TCP endpoint type - - - - - TYPE_SSL - \ArangoDBClient\Endpoint::TYPE_SSL - 'ssl' - - SSL endpoint type - - - - - TYPE_UNIX - \ArangoDBClient\Endpoint::TYPE_UNIX - 'unix' - - UNIX socket endpoint type - - - - - REGEXP_TCP - \ArangoDBClient\Endpoint::REGEXP_TCP - '/^(tcp|http):\/\/(.+?):(\d+)\/?$/' - - Regexp for TCP endpoints - - - - - REGEXP_SSL - \ArangoDBClient\Endpoint::REGEXP_SSL - '/^(ssl|https):\/\/(.+?):(\d+)\/?$/' - - Regexp for SSL endpoints - - - - - REGEXP_UNIX - \ArangoDBClient\Endpoint::REGEXP_UNIX - '/^unix:\/\/(.+)$/' - - Regexp for UNIX socket endpoints - - - - - ENTRY_ENDPOINT - \ArangoDBClient\Endpoint::ENTRY_ENDPOINT - 'endpoint' - - Endpoint index - - - - - ENTRY_DATABASES - \ArangoDBClient\Endpoint::ENTRY_DATABASES - 'databases' - - Databases index - - - - - $_value - \ArangoDBClient\Endpoint::_value - - - Current endpoint value + + setIgnoreHiddenAttributes + \ArangoDBClient\Document::setIgnoreHiddenAttributes() + + - - string + + boolean - - - __construct - \ArangoDBClient\Endpoint::__construct() - - Create a new endpoint + + $ignoreHiddenAttributes + + boolean + + \ArangoDBClient\Document + + + setChanged + \ArangoDBClient\Document::setChanged() + + Set the changed flag - - string + + boolean - - \ArangoDBClient\ClientException + + boolean $value - string + boolean + \ArangoDBClient\Document - - __toString - \ArangoDBClient\Endpoint::__toString() - - Return a string representation of the endpoint + + getChanged + \ArangoDBClient\Document::getChanged() + + Get the changed flag - - - string + + boolean + \ArangoDBClient\Document - - getType - \ArangoDBClient\Endpoint::getType() - - Return the type of an endpoint + + setIsNew + \ArangoDBClient\Document::setIsNew() + + Set the isNew flag - - string + + boolean - - string + + void - $value + $isNew - string + boolean + \ArangoDBClient\Document - - normalize - \ArangoDBClient\Endpoint::normalize() - - Return normalize an endpoint string - will convert http: into tcp:, and https: into ssl: + + getIsNew + \ArangoDBClient\Document::getIsNew() + + Get the isNew flag - - string + + boolean - + + \ArangoDBClient\Document + + + setInternalId + \ArangoDBClient\Document::setInternalId() + + Set the internal document id + This will throw if the id of an existing document gets updated to some other id + + \ArangoDBClient\ClientException + + string + + void + - $value + $id string + \ArangoDBClient\Document - - getHost - \ArangoDBClient\Endpoint::getHost() - - Return the host name of an endpoint - - - string + + setInternalKey + \ArangoDBClient\Document::setInternalKey() + + Set the internal document key + This will throw if the key of an existing document gets updated to some other key + + \ArangoDBClient\ClientException - + string + + void + - $value + $key string + \ArangoDBClient\Document - - isValid - \ArangoDBClient\Endpoint::isValid() - - check whether an endpoint specification is valid + + getInternalId + \ArangoDBClient\Document::getInternalId() + + Get the internal document id (if already known) + Document ids are generated on the server only. Document ids consist of collection id and +document id, in the format collectionId/documentId + + string + + + \ArangoDBClient\Document + + + getInternalKey + \ArangoDBClient\Document::getInternalKey() + + Get the internal document key (if already known) - + string - - boolean + + \ArangoDBClient\Document + + + getHandle + \ArangoDBClient\Document::getHandle() + + Convenience function to get the document handle (if already known) - is an alias to getInternalId() + Document handles are generated on the server only. Document handles consist of collection id and +document id, in the format collectionId/documentId + + string - - $value - - - + \ArangoDBClient\Document - - listEndpoints - \ArangoDBClient\Endpoint::listEndpoints() - - List endpoints - This will list the endpoints that are configured on the server - - \ArangoDBClient\Connection + + getId + \ArangoDBClient\Document::getId() + + Get the document id (or document handle) if already known. + It is a string and consists of the collection's name and the document key (_key attribute) separated by /. +Example: (collectionname/documentId) + +The document handle is stored in a document's _id attribute. + + mixed - - - array + + \ArangoDBClient\Document + + + getKey + \ArangoDBClient\Document::getKey() + + Get the document key (if already known). + Alias function for getInternalKey() + + mixed - - \ArangoDBClient\Exception + + \ArangoDBClient\Document + + + getCollectionId + \ArangoDBClient\Document::getCollectionId() + + Get the collection id (if already known) + Collection ids are generated on the server only. Collection ids are numeric but might be +bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used + + mixed + + + \ArangoDBClient\Document + + + setRevision + \ArangoDBClient\Document::setRevision() + + Set the document revision + Revision ids are generated on the server only. + +Document ids are strings, even if they look "numeric" +To reliably store a document id elsewhere, a PHP string must be used + + mixed + + + void - $connection + $rev - \ArangoDBClient\Connection + mixed + \ArangoDBClient\Document - - normalizeHostname - \ArangoDBClient\Endpoint::normalizeHostname() - - Replaces "localhost" in hostname with "[::1]" in order to make these values the same -for later comparisons + + getRevision + \ArangoDBClient\Document::getRevision() + + Get the document revision (if already known) - - string + + mixed - - string + + \ArangoDBClient\Document + + + jsonSerialize + \ArangoDBClient\Document::jsonSerialize() + + Get all document attributes +Alias function for getAll() - it's necessary for implementing JsonSerializable interface + + + mixed + + + array - $hostname - - string + $options + array() + mixed + \ArangoDBClient\Document - - Name of argument $value does not match with the DocBlock's name $mixed in isValid() - Parameter $mixed could not be found in isValid() - - eJy9WG1v2zYQ/u5fcTM8RE4dK8mXAWqTNEuNpkWRBYk7tIhTg5Zpm4hMCiSdly397ztSpCzJsut0w4wglsnjcy987njUm5N0ljYa4e5uA3bhVBI+Fe9+h8vzS4gTRrmOgPJxKhjXKGBk3qYkviNTCpCLn1lJO0kWeiYkzsFHwuFaUzonnNupWKRPkk1nGs7yp8P9g8MOaMkQkCt4Px+dd3A6EVNOO/CeSlz9hKvDRoOTOVWom1bUvs6t7zlDQaU0ZhMWE80Ed2af8twRiAXXhKE+PaOgqLynEhKRiduxzHUjx2msUU4YCDMzEUkiHhifLtH0U0oVEInLFlLiuuQJ1CJNhdR0DMFc4IwWMKJAxmMcSYimsh0ZxDeL5Nh+J+wYdJxGYTgTSkdmLaqSZsxbgbapXHbB2SMKKxHf0Uzy88WHL5D9VhCkUtwzo6zgobPJeM1UO4dSKllRe339qah2a7ww88c8XwhNIwvk5IApFwDGl0RzWAfdgzcj6dcWHjezTTEemymA/e6hpUmcEKVyJjT+bphJyw/z2YWzbIuWu3dPkgV1s17o7T1B95CVfOqGQvudSnaPmwetoV2FzKug988uy7woLceIKg39r5e9oRE8gh3c3p1VFBO0rVCMIKLgDtagFAixHZpdgHCGWzV4V3RKH1NLj6Kbqgbuqve+9+XSOxl+C9DP55nWaTsahIMw6L46aUfBYPyqPQhPWuFmZcVobFDmYoHKMBxWmfoZbXVR26DVxyz8ZjPS6WvXasnLE+Nj+liD2bvoX30d9i7eXf7x4aJvYL0FNWjviCYjorDybIZ7d9o//f30undt8MZ+kQFcSQ1JDbkJcPpQKPrlzEiJJHOXG9CyaQB7S35VKm95rZ5J8aAgy9/eY0zTVSmXaItRwmKYLLgtQDAcWpfkItZBprRt5bL0Nh82geAXRZNJFDH1J0nY2Au2C1LmY62wPlYMCRTmN9eToMn4vUFY4xbs/Kp2mh3w+K9z+O+N/LFliuLecVYoMPQtVzEKYiUC6oXkGHoXWElTSRUalykUE1t31+3JnExZXB2UGaQD3HsR8rpN0OLaogTV6DtlJad/4KtRa6qRMYHw/4Rv9bW8Goj1tdA5rExsCn5Pqe6j6AbiYUinwznR8SzIKLgsgEuaVGjozbLy/kyopdImDVj1XqABpV+swVS4F6gw4rU6nChfJIlnhvm//LdKES6w/UvYX7RIkOVGPrAkMaUO+wcNpuBHWAqx0TJ9VAeXjO2gcqOmzXkpuYodwFo+5VaO16zcSK589Rp6OW12dzB3E+x/gxtohtbfEKtQ9qjwGW47gFPGfTNuHLZjDniLfDRNIJg++39Pylzzlgl5jvL/LiHx2wpQtY7VpZg3w2/LkLsQe4Cbw9v6Q2DLzP05U1Rmi93mLWypyb8qE3B9fAcPM4pckOWcK+0oNvL2fNxMizl7xJTYTAsIYlRjbkZ+mbCKiZTkyZAwG1XtNfwZCZGgCmwMqAn2D+ztwIQkCslt/HtgaiuyVbqJGrIxNczMXNdxtHwTcOMfb4tb5J/KvQyi2ih4UHh+xmK34Dnt4ejoCPbXEMY6WssDbHIpiWfgYIAoaNG0CuNN8I6hRFVkvbayWzYC9qQ/cgdFfqAi6uvGil4njN4Zsv6s2u9V5huS5MyvUv8TU6v9vp/sY1eTnTaJESs2TObyS3R2+Rd8wqYLiaR3bxGyu219lpzlt2toLW/ahsszWrh6uxcHC0VXsi1h/M6dcGE4FrHqEntBHo+6sZiH5/3+ZeivHCq0l4TuTM+Tag5ludbCrjDFHpue2p976DQFP5bJdKuN/KB8Ix9UW/qNeWVCmZsX1Iejmm25kaahXortHSOjgs8yUVH0+epTfoMqkst3qB7BrvmosOtvr7QjpcPR1lwFTfN+KDHHVNO8vzAP9qB8YHoGzZsoOri1E0KOsXbirs3JHTWbicbaRHMvm5ZHnL1u2ndBuN9zZAVT9g1PHVt8Tc3V7i0teEF/4te8qDE5d4uCXHsxJcMQ3LlUCpENi42KKTCOmDAWVG3sbJruXUF+hT9xd/gc+vng8LdBd9/+HbSzI3AwOMAUsNrMUbgMU3lrMe3t26EhukVU4MkXRXa0AzsD/x7SE3s08EI7CPUPvDch/w== + eJzFWG1v2zYQ/u5fcQWMWg6cpin2yamztrGTtOjiIskKDElg0BJta5FFgaScGm3++44veqMk1yswzAgQm+TdPXd89Bypt78nq6TTOTo46MABvOckXrLxB/hy+QX8KKSxHIII42VEIWB+usYBXKeWvkuI/0iWFCC3OtMGepKkcsU4zsEnEsONpHRN4tiZOo8YD3H6A+GSRkLP+izZ8nC5knCWf3vz+vi3AUhcu6SxgIv1/HKA0xFbxnQAF5Sj720GC9H6ChTA8as3OHLU6cRkTQXCpQ7SkzzvryRKKbD539SXwGnCqcB5zBsILDlJVtb72zk/3Sv/Ogo/IgKxK2dAv0kaBwLGWUm/d9RSDUZ9DrJ1AfoP6CKMQxmyWNjZI/3fxwEJk6vb679mk/HFZDaenH+8+nj7cXp1AyPoKeNxYdvDbPcKAgvO1ug9irAYO6OeX0//UJGUwf7uJdvL+e1UuZZsf8f7eD2bfv48OVM1Ut4Li9YojCcrpOg+vqfXXy7fX5VC6G0wDs4K+4ZQtysKUYiO2KKelvmOVJS4SpPxlbXLzN9tCIdJZbvvHlodvqokkHAmERgNoDtzGIPo7x52g61XZwdcZSloZTHhFGImIRUIIIwBn2MXrwqzO3PCOdnugNSecG1vspTdnM/UNvPUlwg5BrpO5DbThSqehHCytoi6SnfU+CGwRLkn0QB0ViQCPbdAHSy7ceyNlWi0z+ZcF7knR4Gqk3LF2ZOA+6py3Zt/k28+1d6rdUvnUejDIo11qWA287OieCbTEcRphBAd9Kqkfe3iu6mrru0RbgTdYDSYo44+ER6oB3idEBnOwyjE+s45JY/wtKLIEUWARchxh3WBqKQcQqGH8zg6bB4gXID3IhQzPWoA9uHlS7spL0YGbB++5xbq05WrUByeCiq93uyRbnsDY9A/yZc9V5NQol6BgfKmfiNOlVxeI9wmnAnMJPFlinv4xPhj7swYDIeVulqnNvxznZjvg8BQ0nloLIrmh8aQrCoY0K0+/Ug65UD7LUZrrjiVKY+NVjZQ701OvWYSkSCowvB2o8p45OyXq1yofiPX9KTYNwtaG+eVdQp7QWVRgLIc75Qj69nV4l+ozJLKqhfhucmX06jX4KeUqQnlPqRBYipt77rKaelS8/kfEGbqhPZqYNpYUpN7wxN3+BeZ0tAL9+GKqeivcsQtxk9ZUqtBK09uMC97+gUiEeU8ldRJQp0FUCbByxeAUdp1ilo9R6Wz+ZXOAKjbT2EUwYZEYUCkEfeNOYCbehXOSBzAWt8BdMfC35kfmjUppfSFB3Qextpzrd625zX3uBaaq9xU/66m5yxeh9/wNAFdg+DQIlGNua1s2d5vWBjs3GHViBSIgfXubq7qchrkCBuaoNFiOGy+ELiNThtaSgTsq90Kd5X66KuRXcD4cJhtm2cRnVQsSt1RfRwN/kAEnZpLFvZf+uQIpdc/qZpjDSnxV2BjARHKYxNKt3uN8PbKYtoOwIlUjUaDu3Ix1T3nQQdXN52m8A0QDk9Rq85xfVmptP1Jzfx5fyy3U4NEsn+D45aVUaDtPhhqjpCN1zQixomDq7j1PDQ4t1Srt3u3v7tsyr8BjfDu0Mr3+t3rf2J8E2Ubt6ooSUND+1kdqu6yo2NNLcqn1hLWksgbIRLgoVr5iFxS0W8692g5My+CDjeUS5TfHO9hGgchN3cq3S7EIJfrkk5rQcT7HUP3eBjeJlrvm3vjTq1uOWY5t7xwo3pLuVfeaPh/5mBzLtfOC5jIKNugpoNYUVfFKp+lsfS0MJ3C69qVgpiz6N3rh+qmdudqgugIVZ2oRNBL/WJp+VGuLHxuB3UMP35UHHo1OpbWq2frWN2V6qtKK1uAN4ZrNHUS2WnYnWP59K2t6+O3unb3O82/3N0wvFStx+GW19MnE5ZQTsxrhzjagkiThHG89Rte48FFrkD1lRLl7evR0jmaW2L19tkdXe0aaei4qQxtTGq+AdiXGTmCJulQgdpacQG9dpik4/zYiH/61eYMVZIITx/sh0M9NIDeffbWNnvVML/XK1Rp/gGsVV+5 - + - ArangoDB PHP client: query handling + ArangoDB PHP client: single document - + + - - \ArangoDBClient\Handler - QueryHandler - \ArangoDBClient\QueryHandler - - A base class for REST-based handlers - - - + + + \JsonSerializable + Document + \ArangoDBClient\Document + + Value object representing a single collection-based document + <br> + + - - $_connection - \ArangoDBClient\Handler::_connection + + ENTRY_ID + \ArangoDBClient\Document::ENTRY_ID + '_id' + + Document id index + + + + + ENTRY_KEY + \ArangoDBClient\Document::ENTRY_KEY + '_key' + + Document key index + + + + + ENTRY_REV + \ArangoDBClient\Document::ENTRY_REV + '_rev' + + Revision id index + + + + + ENTRY_ISNEW + \ArangoDBClient\Document::ENTRY_ISNEW + '_isNew' + + isNew id index + + + + + ENTRY_HIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES + '_hiddenAttributes' + + hidden attribute index + + + + + ENTRY_IGNOREHIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES + '_ignoreHiddenAttributes' + + hidden attribute index + + + + + OPTION_WAIT_FOR_SYNC + \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC + 'waitForSync' + + waitForSync option index + + + + + OPTION_POLICY + \ArangoDBClient\Document::OPTION_POLICY + 'policy' + + policy option index + + + + + OPTION_KEEPNULL + \ArangoDBClient\Document::OPTION_KEEPNULL + 'keepNull' + + keepNull option index + + + + + KEY_REGEX_PART + \ArangoDBClient\Document::KEY_REGEX_PART + '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' + + regular expression used for key validation + + + + + $_id + \ArangoDBClient\Document::_id - - Connection object + + The document id (might be NULL for new documents) - - \ArangoDBClient\Connection + + string - - $_documentClass - \ArangoDBClient\Handler::_documentClass - '\ArangoDBClient\Document' - - + + $_key + \ArangoDBClient\Document::_key + + + The document key (might be NULL for new documents) - + string - - clearSlow - \ArangoDBClient\QueryHandler::clearSlow() - - Clears the list of slow queries + + $_rev + \ArangoDBClient\Document::_rev + + + The document revision (might be NULL for new documents) - - \ArangoDBClient\Exception + + mixed - - - getSlow - \ArangoDBClient\QueryHandler::getSlow() - - Returns the list of slow queries + + + $_values + \ArangoDBClient\Document::_values + array() + + The document attributes (names/values) - - \ArangoDBClient\Exception - - + array - - - getCurrent - \ArangoDBClient\QueryHandler::getCurrent() - - Returns the list of currently executing queries + + + $_changed + \ArangoDBClient\Document::_changed + false + + Flag to indicate whether document was changed locally - - \ArangoDBClient\Exception + + boolean - - array + + + + $_isNew + \ArangoDBClient\Document::_isNew + true + + Flag to indicate whether document is a new document (never been saved to the server) + + + boolean - - - kill - \ArangoDBClient\QueryHandler::kill() - - Kills a specific query - This will send an HTTP DELETE command to the server to terminate the specified query - - string + + + $_doValidate + \ArangoDBClient\Document::_doValidate + false + + Flag to indicate whether validation of document values should be performed +This can be turned on, but has a performance penalty + + + boolean - - \ArangoDBClient\Exception + + + + $_hiddenAttributes + \ArangoDBClient\Document::_hiddenAttributes + array() + + An array, that defines which attributes should be treated as hidden. + + + array - + + + + $_ignoreHiddenAttributes + \ArangoDBClient\Document::_ignoreHiddenAttributes + false + + Flag to indicate whether hidden attributes should be ignored or included in returned data-sets + + boolean + + + __construct + \ArangoDBClient\Document::__construct() + + Constructs an empty document + + + array + + - $id - - string + $options + null + array - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler + + createFromArray + \ArangoDBClient\Document::createFromArray() + + Factory method to construct a new document using the values passed to populate it - - \ArangoDBClient\Connection + + \ArangoDBClient\ClientException + + + array + + + array + + + \ArangoDBClient\Document + \ArangoDBClient\Edge + \ArangoDBClient\Graph - $connection + $values - \ArangoDBClient\Connection + array + + + $options + array() + array - \ArangoDBClient\Handler - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object - - - \ArangoDBClient\Connection + + __clone + \ArangoDBClient\Document::__clone() + + Clone a document + Returns the clone + + + void - \ArangoDBClient\Handler - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection + + __toString + \ArangoDBClient\Document::__toString() + + Get a string representation of the document. + It will not output hidden attributes. + +Returns the document as JSON-encoded string + + + string + + + + + toJson + \ArangoDBClient\Document::toJson() + + Returns the document as JSON-encoded string - - - mixed + + array - - \ArangoDBClient\ClientException + + string - $optionName - - + $options + array() + array - \ArangoDBClient\Handler - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - + + toSerialized + \ArangoDBClient\Document::toSerialized() + + Returns the document as a serialized string + + array - + string - - \ArangoDBClient\ClientException - - $body - + $options + array() array - \ArangoDBClient\Handler - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - - array - - + + filterHiddenAttributes + \ArangoDBClient\Document::filterHiddenAttributes() + + Returns the attributes with the hidden ones removed + + array - + array - + array - $options - - array - - - $body + $attributes array - $includeArray + $_hiddenAttributes array() array - \ArangoDBClient\Handler - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name - - + + set + \ArangoDBClient\Document::set() + + Set a document attribute + The key (attribute name) must be a string. +This will validate the value of the attribute and might throw an +exception if the value is invalid. + \ArangoDBClient\ClientException - + + string + + mixed - - string + + void + + $key + + string + $value mixed - \ArangoDBClient\Handler - - setDocumentClass - \ArangoDBClient\Handler::setDocumentClass() - - Sets the document class to use - - + + __set + \ArangoDBClient\Document::__set() + + Set a document attribute, magic method + This is a magic method that allows the object to be used without +declaring all document attributes first. +This function is mapped to set() internally. + + \ArangoDBClient\ClientException + + + string - - \ArangoDBClient\Handler + + mixed + + + void - $class + $key string - \ArangoDBClient\Handler - - - - No summary for class \ArangoDBClient\QueryHandler - - eJzFVN9v2jAQfs9fcQ+VCAjENmkv6dZ1o6io6wOl8DCNqTLJkVg1dnZ2RlHV/31nE7IKrZU6ps1SlDj33a/v7O/dh7Ioo6jf6UTQgY8kdG7OPsF4NIZUSdQuge8V0gYKoTMldc4wjzwtRXorcgRonAYBH4yicoUhtsGF0HDtEFdC62BKTbkhmRcOBs3Xm1ev33bBkeSA2sL5ajHqslmZXGMXzpHYe8Pe/SjSYoWWc+Ne2uMoSpWwFq58tSNfLBLgnUOdWaj30X3kawrN+tWBgUJBFlyBoKR1YJZglVmHniXaGrZDn7qCzNrC8C7F0kmja0M/vMtqoWQKy0qn3sb8cexrjha3g32b3K+jihS8hxmpEaoSKUkWlVQZ72N+bJLMJpc3V7Ph5EsXvrZ8Qa1v7eNf7q6QtneSoxsYrTFki9u9kwwVOox99Br9EO03PEFXkT6448ZOIR4IIrF5lg2u9mkuwjqAEOIzYbRFjvEUOfxjx0zjVxffuAfUhfUOL+EvrYj4CKoNnzdMK8e35F/QOdim/RuM1h38L1I/S6UsCLAlpnLJbQbJ2eNmyiXAmpFg+U4D68poOh3D2fByOB1CalYsEhk4E0ZjkX7w/fc7Vg+phcPt/20GzH6bgkWNxAosKxGP8Ehm0KvVT2Z/OMmFMerZQd5yRzGnOkgj2P/lArE/MUcVNhN6qPX0RigpbPxYVZMkWLrQmu8ke16L8WL+GNjiJD8BgT/eng== - - - - ArangoDB PHP client: server exception - - - - - - - \ArangoDBClient\Exception - ServerException - \ArangoDBClient\ServerException - - Server-Exception - This exception type will be thrown by the client when the server returns an -error in response to a client request. - -The exception code is the HTTP status code as returned by -the server. -In case the server provides additional details -about the error, these details can be queried using the -getDetails() function.<br> -<br> - - - - - - ENTRY_CODE - \ArangoDBClient\ServerException::ENTRY_CODE - 'errorNum' - - Error number index + + $value + + mixed + + + + get + \ArangoDBClient\Document::get() + + Get a document attribute + + string + + + mixed + - - - ENTRY_MESSAGE - \ArangoDBClient\ServerException::ENTRY_MESSAGE - 'errorMessage' - - Error message index + + $key + + string + + + + __get + \ArangoDBClient\Document::__get() + + Get a document attribute, magic method + This function is mapped to get() internally. + + + string + + + mixed + + + + $key + + string + + + + __isset + \ArangoDBClient\Document::__isset() + + Is triggered by calling isset() or empty() on inaccessible properties. + + string + + + boolean + - - - $_details - \ArangoDBClient\ServerException::_details - array() - - Optional details for the exception + + $key + + string + + + + __unset + \ArangoDBClient\Document::__unset() + + Magic method to unset an attribute. + Caution!!! This works only on the first array level. +The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. + + + + + $key + + + + + + getAll + \ArangoDBClient\Document::getAll() + + Get all document attributes - + + mixed + + array - - - $enableLogging - \ArangoDBClient\Exception::enableLogging - false - - + + $options + array() + mixed + + + + getAllForInsertUpdate + \ArangoDBClient\Document::getAllForInsertUpdate() + + Get all document attributes for insertion/update + + mixed + - - - __toString - \ArangoDBClient\ServerException::__toString() - - Return a string representation of the exception + + + getAllAsObject + \ArangoDBClient\Document::getAllAsObject() + + Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class - - string + + mixed + + + mixed + + $options + array() + mixed + - - setDetails - \ArangoDBClient\ServerException::setDetails() - - Set exception details - If the server provides additional details about the error -that occurred, they will be put here. - + + setHiddenAttributes + \ArangoDBClient\Document::setHiddenAttributes() + + Set the hidden attributes +$cursor + + array - + void - $details + $attributes array - - getDetails - \ArangoDBClient\ServerException::getDetails() - - Get exception details - If the server has provided additional details about the error -that occurred, they can be queries using the method - + + getHiddenAttributes + \ArangoDBClient\Document::getHiddenAttributes() + + Get the hidden attributes + + array - - getServerCode - \ArangoDBClient\ServerException::getServerCode() - - Get server error code - If the server has provided additional details about the error -that occurred, this will return the server error code - - integer + + isIgnoreHiddenAttributes + \ArangoDBClient\Document::isIgnoreHiddenAttributes() + + + + + boolean - - getServerMessage - \ArangoDBClient\ServerException::getServerMessage() - - Get server error message - If the server has provided additional details about the error -that occurred, this will return the server error string - - string + + setIgnoreHiddenAttributes + \ArangoDBClient\Document::setIgnoreHiddenAttributes() + + + + + boolean + + $ignoreHiddenAttributes + + boolean + - - __construct - \ArangoDBClient\Exception::__construct() - - Exception constructor. + + setChanged + \ArangoDBClient\Document::setChanged() + + Set the changed flag - - string - - - integer + + boolean - - \Exception + + boolean - $message - '' - string - - - $code - 0 - integer - - - $previous - null - \Exception + $value + + boolean - \ArangoDBClient\Exception - - enableLogging - \ArangoDBClient\Exception::enableLogging() - - Turn on exception logging - - - \ArangoDBClient\Exception - - - disableLogging - \ArangoDBClient\Exception::disableLogging() - - Turn off exception logging - - - \ArangoDBClient\Exception - - - eJzNVk1v2kAQvfMr5hAJiICkOZI0bUoQadV8KOZSJZG12ANe1azd3TUJqvrfO7teG+MASVOpKhcb78yb2ffejn3yIY3SRuNgf78B+3AmmZgl55/g5uIGgpij0H1QKBcoAZ8CTDVPBAWa2I8pC76zGQKUaQObYRdZpqNE0hp8YQI8jThnQtilIEmXks8iDYPy7ujw3VEHtOQEKBSM5pOLDi3HyUxgB0YoKXtJ2QeNhmBzVFQba2WPy114tuHusNbwOOJqtQvQyxThkccxTBB0JJNHAZMl3aHbOTxGKOx/x4BEnUnqjtl9oJS0QS7osUoToQgkAVbkSvyRodK9sjZWSgdJiEDNGOyL8fgGlGY6U/lzplwhDKkfk7xqwcDBZwJgptyqs1QmCx4itRaG3JRgMYSoGY+VyWCTJNM23jbdMbcE4CIITRgOqGHJqWimuJiZEJM6Q32eh7XaMM1EYNB7JxN5albddc0OG8xAgIHxyWHvyGoYxEwpJ1OpEvGjUYQKVrr9bBgDWVXNbx+u0/XNwZQk0FVuXWSRQF1JNgcmJVu6Zwf2mkq+YBphzy+g3sPdA3moVnFoVRbZfIJG7BCf1mACEl7D8Gp8+80fXJ8PCaVpOb7K5s1taORfZZjaDXc59Lyz0QrxMs/agHpr7ULeU3SASDqJKXmSyGeW12S6m6LcbUVydzPKOnnZJOZBaQfwfZ14NqvVtgG5cObnwH1/8PXM83wfetDsQ5Mue5rOY/eUDJYbYUDmJ4/Rem3ZbbzVPraov57t30NdOVyl79d2+Xn6yvNSPywFgI6YhiQIMikxtCdoWU6PlBIilNjb4T7YKwp03QPS5aWuC20WCQ93KqBWx3S9Wl0PR2vF9UXkNnZHf8xuRCPMMRz+JcNro0mtRhOdIXq/hFvoyimo8Lze9WYKq5Nus4lr3O0irHhn2vNuxvo/IYxeKdaSrt9Kha2NFJRxemd1t0ZvZax6dGuk8Sm0uCJjtmq83SmMp/3+amg+tNuVvO2EP088LrOcDM+Tqcm8vVfL5cbzf6FYPotfnNjb239BuXK2vkk894p6k35F7i4JRRbHhWy0aj8bfBZzplq1j4d+3y52oHlffETeuw+RyX0ttklW+A1ZRFRS - - - - ArangoDB PHP client: base handler - - - - - - - - Handler - \ArangoDBClient\Handler - - A base class for REST-based handlers - - - - - - $_connection - \ArangoDBClient\Handler::_connection - - - Connection object + + getChanged + \ArangoDBClient\Document::getChanged() + + Get the changed flag - - \ArangoDBClient\Connection + + boolean - - - $_documentClass - \ArangoDBClient\Handler::_documentClass - '\ArangoDBClient\Document' - - + + + setIsNew + \ArangoDBClient\Document::setIsNew() + + Set the isNew flag - - string + + boolean - - - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler - - - \ArangoDBClient\Connection + + void - $connection + $isNew - \ArangoDBClient\Connection + boolean - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object + + getIsNew + \ArangoDBClient\Document::getIsNew() + + Get the isNew flag - - \ArangoDBClient\Connection + + boolean - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection - - - - mixed - - + + setInternalId + \ArangoDBClient\Document::setInternalId() + + Set the internal document id + This will throw if the id of an existing document gets updated to some other id + \ArangoDBClient\ClientException + + string + + + void + - $optionName + $id - + string - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - - array + + setInternalKey + \ArangoDBClient\Document::setInternalKey() + + Set the internal document key + This will throw if the key of an existing document gets updated to some other key + + \ArangoDBClient\ClientException - + string - - \ArangoDBClient\ClientException + + void - $body + $key - array + string - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - - array + + getInternalId + \ArangoDBClient\Document::getInternalId() + + Get the internal document id (if already known) + Document ids are generated on the server only. Document ids consist of collection id and +document id, in the format collectionId/documentId + + string - - array + + + + getInternalKey + \ArangoDBClient\Document::getInternalKey() + + Get the internal document key (if already known) + + + string - - array + + + + getHandle + \ArangoDBClient\Document::getHandle() + + Convenience function to get the document handle (if already known) - is an alias to getInternalId() + Document handles are generated on the server only. Document handles consist of collection id and +document id, in the format collectionId/documentId + + string - - array + + + + getId + \ArangoDBClient\Document::getId() + + Get the document id (or document handle) if already known. + It is a string and consists of the collection's name and the document key (_key attribute) separated by /. +Example: (collectionname/documentId) + +The document handle is stored in a document's _id attribute. + + mixed - - $options - - array - - - $body - - array - - - $includeArray - array() - array - - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name - - - \ArangoDBClient\ClientException + + getKey + \ArangoDBClient\Document::getKey() + + Get the document key (if already known). + Alias function for getInternalKey() + + mixed + + + + + getCollectionId + \ArangoDBClient\Document::getCollectionId() + + Get the collection id (if already known) + Collection ids are generated on the server only. Collection ids are numeric but might be +bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used + + mixed - + + + + setRevision + \ArangoDBClient\Document::setRevision() + + Set the document revision + Revision ids are generated on the server only. + +Document ids are strings, even if they look "numeric" +To reliably store a document id elsewhere, a PHP string must be used + mixed - - string + + void - $value + $rev mixed - - setDocumentClass - \ArangoDBClient\Handler::setDocumentClass() - - Sets the document class to use + + getRevision + \ArangoDBClient\Document::getRevision() + + Get the document revision (if already known) - - string + + mixed + + + + + jsonSerialize + \ArangoDBClient\Document::jsonSerialize() + + Get all document attributes +Alias function for getAll() - it's necessary for implementing JsonSerializable interface + + + mixed - - \ArangoDBClient\Handler + + array - $class - - string + $options + array() + mixed - eJztWG1v2zYQ/p5fcQOM2gkcp8tHZ8mSOl2TYUiMxv0wNIVBS7TFmqIEkopjDPnvO75I1pvttuiKAZtgwBJ1L889dzyS+uXXNEoPDk6Ojg7gCK4kEYvk+g2Mb8YQcEaFHsKMKAoRESGnEoWM3GVKgiVZUIBCZWSl7UuS6SiR+A5+JwIeNKUxEcK+CpJ0Ldki0jAq7k5f/3zaBy0ZGhQK3sWzmz6+5slC0D68oxK116h9cnAgSEwV+qY1t2ebCBzcgBOlYI4o3r99mBybsTCPQdWDaAlBMRGY6F4PTq1nMlNakkB7wzeejb8OTJTWtbmOELYQNNAsEZDMPuOdf5G/R5+SxCUx/+LE/qeSPRFNoTMNCgEMrcUJoskQDQFBV5vc7HYFnY1VOIbSg05gRiFDjqo2PKpsxlkA80w46alB5wD02q0fWj1Hjrk6OmLq+KIUFZyX5c+s5Esj0PdUZxLhRbSMtp1Y6WRH5RB3KeaMJxrHsDiK8BZUb4z06qF4N82Iihi2BEEqSNJS7mGCtgB/VuSJCqxCLL4CkI4I1h3hXMFnlYgpvk1COl1JkqZUQlInqL0OOs7nHc4gZGaCGm7AJF/mEJ8Iz6iZNlvYjdkzUuWIdepd5ZQKSR3JZKXgsTqpHt3f2+eApi1lvzsJ91alV4pgd1ZqGbQDLTb2Z8zQDY7uELDimVjYnmLCJ1KSNaTYDWg4+KGZdJ47syRc+0zaW8yjswdM4L1xsCWLPpJjF59/SubWuTNlcK6I8uF959y2hN6z0XxlVrfbqWX2RCdhMoTe5RxxL2OypvIQgogGS2Bz9DLHxp5YEgjMmIY4kRRisqQKFK5IdDAY1EvkhnKTsWpmZYbLl+EoW0SlKaJgwbAWALs0pibgWUiNGI1dooygTSzVuDb57FqNoqzuBV8XxqwrgggV1WgBOt7mlVVcMc5NM/eDzdJMjC1TxA17bhXAiDV4WMV2QFH5hOGiN9SMTa1kkpdR9zhbUuiuCNO/JfJhLYJuH7pLStO7jHO8pzpAGg9hsLOmc0z2KnepnBcLNkp4qCoEI14fsMFYZbTdU4U056nkIaRzJjBLq4gFUQkCCnGerLCaHVk5y32b3JVRRedMGgMk49o3VKYGlnL6TOKU02GVqPMLXEvplrnq4VrsCoG6Z0xAiXxjGhdvEzoxifm2+QqXWI5UCuIT23A9qRaqLV5HUDkV2wpwazvwgq5Bq1sxtv7yTq36rRk7h4+fGrsMj9S8OytGkRxKEGNhELCvdZYUbVxAx+bnsGTEXNgUetbpFMWm9JkpjXjwvl9FcVhXzJWd+fNzqK9haji8H09u7++mH8bXV5O30/H9H7ejP9vsmOtDGuJ2cJzg9ms9HCJWZp57HvVZQ+elMeI5+WgQfTKbLqva1LSoXbEa3AIn7TZQDZNlStzoPmSbJ7/nM1fe7Z35/1v4P9bC/b7GrJS+bXMWM20atlqy9F/YrO2mJL/Kzfore9B/bw344q77xlTDpudayr+89f7oJmvhfUtTg1ev2hoW/LSv6VUdfueWZ4xvOwNPyiczW+/mcMG5P0maLyL1svHLfvsyX5sK7kTnWTqGMAmyGLX6ZR9YWu6QsO880Y5raw2a/jwqVPJlrVZapSQyoTTBAxVW/katnrGcU6tiTw3msNcrrZYve2xfew72W96guA2rHhopLpVoM8eXTySnuPDuvzRhvnFab2GyM83zNbLC59Ct7/Vyc92zhtcHql1jDne4rJWLB9lxkruwFtVxU/k61f5JCdfB63IkPedg23eketRO+qxBuhEvOMefFZviNoqonoc1HNpBXPse8y+QOYWzRy/TxdT+Datad3E= + + No summary for method isIgnoreHiddenAttributes() + No summary for method setIgnoreHiddenAttributes() + + eJztHGtz2zbyu38F3PFVUk6y00zvZs6O0ri24qhp7Yztps3ZPg1EwRIbitQQlB218X+/XQAkQQIgKduZ3nWiL5ZFYLEvLPYFPv9uMVtsbOw8ebJBnpD9mIbT6PB78vb1W+IFPguTXcL9cBowMom85Rx+gHE49OWCeh/olBGSzToQE8RDukxmUQzPyA80JGcJY3MahqVHr2DeB/ITXbFYPPGixSr2p7OEHGTfnj395lmXJLEPS4WcHM3Hr7vwOIimIeuSIxYD3BXM3tnYCOmcccCKlRDay8h7R4MlI9H4N+YlJGaLmHF4DuQRmlLpRUEAT/0o7I0pZ5My2c/H8YtGHAB4Hj4i5On2M4GgF1DOyaGCR/z5ImD4jZPLH3gUnjEgMvB/p+OAbfyxgTMF2vh5Qs5nuQSIPyHtuWDPmJHjn3/8kVwDR0N2mw3hHTUxnf/yhsaEAx+B2J4OSQ3YEX8XcZQA9UD21sifAOOqsPjAVo+FBoBy4gHPahCJ2Y3PQWL3w2buf2RuLgDsmtVpAuSMlwnjpC1UcOcG1cy+GI1j6iZVTiR9cnFlLvoqoFOSRMQPJ75HE0ZuZyyZsTjH5JZy4s1AEwFYEHk0CFY2HMZRFDhRSOf3yTUNOLsPGj6H7aTzHfjCbmDEmLGQcHoD4AEATCKcxfDAyqlKLH1+DPD7YBeW66AI/PUnFDc3ia5z9BTb+SxaBhPUngWLQXfmmVqAwIEoDywZPEyWcQhIRGGXgNTJjCK5agbFPb9gIQ2S9Vk/id5J/Jib+/uhVCEwiTOakAm79kNA/XbmezNdE3NakphRhA9ozvzJhIXb6+ulnLifg19TQ+V8O37+NIxi5GcM87xgOYHvfgh7WvEZ+EF7nCV8fSURkF+buDt4e6iZVyCBfSxA9qKQJ2RwfH76fjQ8BCgtsJCtCihoHqvBvBm8F3BgpAXQaWrVatE5HbwTcMBWWeDIvVJP09nx4BdJFk6wACpLsQbg6+Hh4eB4//z8dPj9z+eDMwG7rEkPX2Z4dHxyOrAuZlcAy5K31E9eRfHZKvRItBD2wbXoydvz4cnx6Jf94fno1cnp6Oz98QEupoGwLLCIAt9bNYT99uTH4YHQDDnNAu8DY4vjZRA0hPhmMHgrTkSAmU4FqDiuDDlm02UAO4t9RO9I6N8S3SA8S1GjcxNqWQ4UGpTxaPDr6O3+6TmudkF7v+/3/v2096/R7vbLy8teu/P3bn9va/PJZetvV3980332j2/vLAQeILx46YFzBFaXzRfJSvPEioZgQWM6lxaMbEmGcJJ/eopJNOgCn/wEnKx8GJJVgkvqPs8XL07UdBozsitdwoZzA/+FZRcAkmcsQVIlGXA6mTYTcfWUNc9cmu31VnZsCVgfj1I03mCZb83Ft8khu6bLAOQBY4QBfb4DENfgWVFsylwvx6Dh5HoZCpebjEZeKvh2SaB9EoLWSldBesf48a9J2+cjMbadju10tBH42dkROwadTvQ6QnDul7BjYu6JowdcEKHoyOAx+PS3NJ7wnhfNF6DoYz/w08O8sCicSdmKFy1DpFcGFvjZSsCT6L2AuWUZVMPaK0C6q0OHs+B6d9duh++PWDXUB6Bot+F1iA6turzeCg9BGg/MWhzxLK2cvyYGrZGywKxaw4repHW6a2X57c5076iXRPGKzMGpi4QLn23WssO/5OleU771AkJf6fYvogUcMHisG4Y8mcXRLScyiB589NhCO2fs5l6BB/uVmnb1i82w208K2/lQcTxkwKSHmvl7nwaTKft0FNPFzGbieAK2RLN00pC/iqP5vrRdEu9uGTv0tMtGbyvjc1+wXcLOzV8uWMCfUYgMUvAYBWzhMd5/oXhXVqEMtlDfNg7upkP3NBUxkRETDmT42MbTpLOXj1LMygbvOXTsIIhCBtrkYPqpAMOFZnk4tCyUOZ36nkNSN1E522GePgizbfBbbSnwodUxtGc8E0x1PAO/3HgGR9IkgpMoURG7ICmLvq8xkoLIiTnYdITOQppHyRJZWWSbaPmJcrg3TMitD54jLh0tkwWGsMZpX8H2PO/ByQ9nJ8c9FnoRBm0Sm3UEkuWBCnBKoneJKonOxHRDWqmqSeYnEebW2h2Xwj2AtFprkvly6UMRswvuY5IhM4m49pQl+/B7SmC1X1X2QGtGS89PBtfDMGExYFfw+dQzgYivBjzY+fszHM7nO2U/8zGUTelQA8us1voNho/kEm2lh1K+mou6rkJSTJaJBPEXhfxrKSTWWjTZNlTJs2zGGoqZLfMgtdRi0ls/mYnfFL8izEbGbB7dZMlTu3pqMHo6QD0RaZ9pRM8O/srhTuB2vl77AWibGVPkQLpOPOy+mmWUZepmXzoI5Dvb012Si8vATXezMGDwomUIjlsZSIe8IE/L3l7uHxproqdY+vGYzg1/MV1VhSk5ny5ss+0hC36WYbP5e8bsYsikhzHZVwGcFKDXxbKGO5HPdW0RkcGx1IVK+onFI1E6yzOcoWDsfMlF7Sp17LbzGT6XVjoN3vLQKnX3cmA0nBBZBxPxFPyfwmFpSIUSyyEAcD8UkI3SwDoRmbJnIrwg+r4T5JUGi6IbUYEFDJZ/Mdxysa2xF2+ELaUdidpqBsmWlJGF2fKILAwUNWUFJYp3d9NZ7aqgSeAAOF48vSL9PuaqW2UE0iHieSFvcFiTclDn5XBiolBU6nICoNn6bwbvmyHwhq0+Dwang3fVGKSlk8+zvEjcNEr7rLe6BQ/EYTNVVhUc2hRlU5lfNVIG+xeI/VWHfPpEbA/EmWNPAuAHNgAaTT0idRGsFY1lQbaWLgCOZorDjtG2lxE4F9BNkV3X/HaJiEFV2sowxmj90LvWB0m/mAYBGj9ET7WMgOMH9lnUQ9DxgfA5hTNhXkCF/YNZ1t6Aaz/mSdGkZyYLvs/pYiGdbxRkJ/N6g9U9jbI18P7fstSjUZ2tzneULRPlyovUHsEWPvQE7Xia1pElGdLLj19N00SRzb/Wi5dcZFqAgkpWTBWF9vqGc2+XN24x91EYaz2H1Pg8NdWcpfXbyq7e0zr1bqi4f7LARiOXyIoyyEZl/C0zeMixvW06ZViKGq8I9u0glVLsHWyMEPVP/IqVXup5WJgdBwy7HRYsTnwzY/cghmFXBaNpDwaXgTGgIYJe0sZjATurJJc6NWxS2vtoul08YUxdVs0ddmX+qWDkIxUYUC3Ozyz0AV0iBZubm8r/juIPHCQQrFAMeCgIi66iwYDdsECz7igbds1ilKmxXH4o+BIS9rhgt2EXtU8eAfB7xEU6QoSFeFpOIsR0uRDeZScPvWXsvquV9jG9L/iwzubaMprwDFmqIM0iS/XEJsdKw2I/LO0Iyn3cLLGF55Mli9Ul6vdUxfPTbKucj0pXt3++ZLxca7ozXllGJpWWQ/yqgbLuwMTEVYPUF/iaYgOLIkl8A7uuUNnPVCUKJqQsISI0j8F/27lPYgySn75ueuRAVwOa2id/1Feo7zRwZl5IrWsDZwFUjCrquyZMQvNCsmaBCcNT4bM2XNgwEchj2W3EPvo84W0jOmkZ+61rRjCKnsKDDmbhsoq5AeUK83HlXzX2PgBj00TcC2UTTBOcH11oLvVvIjq7zbqfAO2wJEuszwxh3p+S+i1+H5oatLY0p86WyF6PsMcmyUqMgaajHQF8qWyFfikU0qwpqLe+OWHTqCxGq0taajh8rUSrZFMtm74vUyLuvDuiV9+Vka1QzBmSr78mT0UeBxz9RcRVkNwaYToRnm36YWrkZfSsE92VmLkS8oKR1tSL/mmQfJecceygvjo1zTYUFGMmPldZBkd1LarhzroKb1pkvvLGDeviF7Iv+4oUhlZFHmLaPbxdYVF9cKBj3Ak70sGviWUp55Hng+G9YY/oTr2K4qHA42cVZJRcqVQqF1o2oajK2U6r1+lCflU004tMZf4LtrPbtNOL8M6WmWesgo6ixB2h0lh9VW5zJD5Vo/OSiSB3xbR0QAM89P+qd9FdcZNorUSbDgQfRTXX0M2uiDxT/z3txFbpUL/YaSRTPBC8QJyatcX9EuPPMRGX377EdX/JuO4BRkkILtOrs2RyIC5JljTLhdkkYjJbN6O4ZFidv5A6s89PhPY2CR23IGQEPuX7rNwusVfYwKryLid1hJExKu5pxpXdkkuuyG3bj6t070p4VWUPrQHDSKKQLW8Z8yi27z1rN0YmuroWiya1WOPQNpZ0JP2rw1mUSX1J/qiGOfYMRVN2ONXM7NEokVjMEdcF7nbaStnaSpx87miWXwOxygSFBT2pYKlBdniAddrj6vG3Q2uiSQ4yQJ/aiGvHHTVV7z+zUGpjRV5HU22/tuGaYOv4k/Zb28tnpXJQXqZNSa0sqB41oExDNT13fO1mrXYjuavKBxHeCL31OaskbZqT1oyoOvHIW5B1wpGjemKcOIXQTmMBBoNgTIwAZQ+whaotQKzibDJXV5szbcT/60Tkpk4X0DrkOcUiaagRSiXSmUhSd8h8G0E6NO98kr1Myi/wJ8IehwXEJQjAkKsaiaymR3Olcyb0e7U3+RNx2aQW9bX0QmvZ8SdVDUuwetYqiOFM8WecXPI3JN9QziUq260zeQcb/SfJsBretopuSgG/zUXMpqM5TbxZu7XzH+3aZw9vef7z27vLnRbZVumU0j3RbdLa2ml1Bfpr4D+UTWtEXLxPCnd1gIqW47pKzjHYY1KouMvqDYgh8rxeVqOuGNDdQ19N+Pfux7NprAX8PVRWNHk5iru2gFbX2vT3LUsOZm29rWCyQxUseluvoojqI+koxvDVSiovFeVamkX5FSeBxTKRNnY4BDGjkxX5EEa3YfmNG9qrD2TcO2Uhi4VOqmK3fFOHqH9vF4fjJUBgODI/f3kOrkrD7P0ZGjLdtOitWJLPGU520nFDlzXNmuZtdHZJ8f0vuieShYqYzVHhovH2G8tpl1vmuiPPaUHcohFtwHWyaUC6SO6uRbv5xh037bjFa4ivUMyDKLxhIWwLj+nXF3CB4h0X8OMmAbPwA0kWrwGAnUS5mmsIxqLMEuJaCp1O+Usr9WtBZI1MSzyuU+6CudGtnORoh5TFarmXKPowFTMw7aiEwNMe95yrLS6bmXBUYXWxo4TdzKL1DogaT8REtlftZF06g48UX8G1i4mbFDBC1QRWVq1zi8IC1qKPVby2Ju+UAxTRyTAai8rCT5NnDxP5du1mfgQDVmO3Msbui32a36kBdbCakwbM+DyWrd6ilfGtjZELRqLWph/ow5sYKMuEEFgQA2H4EqqUQyn8segnxDbmEK+XjYbH56Of9n/dJucREAriGQcr1X1NS7hjN8ctXj3uwiNxNU1uyPyNTUtu3u0qya8A8jNYsAPNvhqSfBmA0Whv6Ta4A24U+7gI8EJmS/hxmdJ3yTPbdR99dl1oYLyIrsQd7U1ODWRd55pJefAuYXCuqhBjRYIo+kC+UjrxVWavLOLWLbVL2OlVJJuoC0UbvNrey1/A96AoOL+1AfBc6RF5lz53icX7+Rqarfw9gU19rlSfNQI/gzZnhNdY6Bpaq5spHVYZyxnCw8IDK2TYWkxj2RSXvaASNaL8hkrpq1xTz9Fb/6Wo939e1HvMZs3fNOVha1xXrqy63W3ANhBl5ZEIDNqppdzdFb92SesyUe+NvVQvaB1fpoMw8v4vAesctg== - + - ArangoDB PHP client: Traversal + ArangoDB PHP client: single vertex document + + - - + + - - - Traversal - \ArangoDBClient\Traversal - - Provides graph traversal - A Traversal object is used to execute a graph traversal on the server side.<br> -<br> - -The object requires the connection object, the startVertex, the edgeCollection and the optional parameters.<br> -<br> - - - + + \ArangoDBClient\Document + Vertex + \ArangoDBClient\Vertex + + Value object representing a single vertex document + <br> + + + - - OPTION_FIELDS - \ArangoDBClient\Traversal::OPTION_FIELDS - 'fields' - - count fields + + ENTRY_ID + \ArangoDBClient\Document::ENTRY_ID + '_id' + + Document id index - - ENTRY_STARTVERTEX - \ArangoDBClient\Traversal::ENTRY_STARTVERTEX - 'startVertex' - - Collections index + + ENTRY_KEY + \ArangoDBClient\Document::ENTRY_KEY + '_key' + + Document key index - - ENTRY_EDGECOLLECTION - \ArangoDBClient\Traversal::ENTRY_EDGECOLLECTION - 'edgeCollection' - - Action index + + ENTRY_REV + \ArangoDBClient\Document::ENTRY_REV + '_rev' + + Revision id index - - $_connection - \ArangoDBClient\Traversal::_connection + + ENTRY_ISNEW + \ArangoDBClient\Document::ENTRY_ISNEW + '_isNew' + + isNew id index + + + + + ENTRY_HIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_HIDDENATTRIBUTES + '_hiddenAttributes' + + hidden attribute index + + + + + ENTRY_IGNOREHIDDENATTRIBUTES + \ArangoDBClient\Document::ENTRY_IGNOREHIDDENATTRIBUTES + '_ignoreHiddenAttributes' + + hidden attribute index + + + + + OPTION_WAIT_FOR_SYNC + \ArangoDBClient\Document::OPTION_WAIT_FOR_SYNC + 'waitForSync' + + waitForSync option index + + + + + OPTION_POLICY + \ArangoDBClient\Document::OPTION_POLICY + 'policy' + + policy option index + + + + + OPTION_KEEPNULL + \ArangoDBClient\Document::OPTION_KEEPNULL + 'keepNull' + + keepNull option index + + + + + KEY_REGEX_PART + \ArangoDBClient\Document::KEY_REGEX_PART + '[a-zA-Z0-9_:.@\\-()+,=;$!*\'%]{1,254}' + + regular expression used for key validation + + + + + $_id + \ArangoDBClient\Document::_id - - The connection object + + The document id (might be NULL for new documents) - - \ArangoDBClient\Connection + + string - - $attributes - \ArangoDBClient\Traversal::attributes + + $_key + \ArangoDBClient\Document::_key + + + The document key (might be NULL for new documents) + + + string + + + + + $_rev + \ArangoDBClient\Document::_rev + + + The document revision (might be NULL for new documents) + + + mixed + + + + + $_values + \ArangoDBClient\Document::_values array() - - The traversal's attributes. + + The document attributes (names/values) - + array - - $_action - \ArangoDBClient\Traversal::_action - - - + + $_changed + \ArangoDBClient\Document::_changed + false + + Flag to indicate whether document was changed locally - + + boolean + - - __construct - \ArangoDBClient\Traversal::__construct() + + $_isNew + \ArangoDBClient\Document::_isNew + true + + Flag to indicate whether document is a new document (never been saved to the server) + + + boolean + + + + + $_doValidate + \ArangoDBClient\Document::_doValidate + false - Initialise the Traversal object + Flag to indicate whether validation of document values should be performed +This can be turned on, but has a performance penalty - - \ArangoDBClient\Connection + + boolean - - string + + + + $_hiddenAttributes + \ArangoDBClient\Document::_hiddenAttributes + array() + + An array, that defines which attributes should be treated as hidden. + + + array - - string + + + + $_ignoreHiddenAttributes + \ArangoDBClient\Document::_ignoreHiddenAttributes + false + + Flag to indicate whether hidden attributes should be ignored or included in returned data-sets + + + boolean - + + + + __construct + \ArangoDBClient\Document::__construct() + + Constructs an empty document + + array - - \ArangoDBClient\ClientException - - - $connection - - \ArangoDBClient\Connection - - - $startVertex - - string - - - $edgeCollection - - string - $options null array + \ArangoDBClient\Document - - getResult - \ArangoDBClient\Traversal::getResult() - - Execute and get the traversal result + + createFromArray + \ArangoDBClient\Document::createFromArray() + + Factory method to construct a new document using the values passed to populate it - + + \ArangoDBClient\ClientException + + array - - \ArangoDBClient\Exception + + array - - \ArangoDBClient\ClientException + + \ArangoDBClient\Document + \ArangoDBClient\Edge + \ArangoDBClient\Graph + + $values + + array + + + $options + array() + array + + \ArangoDBClient\Document - - getConnection - \ArangoDBClient\Traversal::getConnection() - - Return the connection object - - - \ArangoDBClient\Connection + + __clone + \ArangoDBClient\Document::__clone() + + Clone a document + Returns the clone + + + void + \ArangoDBClient\Document - - setStartVertex - \ArangoDBClient\Traversal::setStartVertex() - - Set name of the user function. It must have at least one namespace, but also can have sub-namespaces. - correct: -'myNamespace:myFunction' -'myRootNamespace:mySubNamespace:myFunction' + + __toString + \ArangoDBClient\Document::__toString() + + Get a string representation of the document. + It will not output hidden attributes. -wrong: -'myFunction' - +Returns the document as JSON-encoded string + + string - - \ArangoDBClient\ClientException - - - $value - - string - + \ArangoDBClient\Document - - getStartVertex - \ArangoDBClient\Traversal::getStartVertex() - - Get name value + + toJson + \ArangoDBClient\Document::toJson() + + Returns the document as JSON-encoded string - + + array + + string + + $options + array() + array + + \ArangoDBClient\Document - - setEdgeCollection - \ArangoDBClient\Traversal::setEdgeCollection() - - Set user function code + + toSerialized + \ArangoDBClient\Document::toSerialized() + + Returns the document as a serialized string - - string + + array - - \ArangoDBClient\ClientException + + string - $value - - string + $options + array() + array + \ArangoDBClient\Document - - getEdgeCollection - \ArangoDBClient\Traversal::getEdgeCollection() - - Get user function code + + filterHiddenAttributes + \ArangoDBClient\Document::filterHiddenAttributes() + + Returns the attributes with the hidden ones removed - - string + + array + + + array + + + array + + $attributes + + array + + + $_hiddenAttributes + array() + array + + \ArangoDBClient\Document - + set - \ArangoDBClient\Traversal::set() - - Set an attribute - - - - + \ArangoDBClient\Document::set() + + Set a document attribute + The key (attribute name) must be a string. +This will validate the value of the attribute and might throw an +exception if the value is invalid. + \ArangoDBClient\ClientException + + string + + + mixed + + + void + $key - + string $value - + mixed + \ArangoDBClient\Document - + __set - \ArangoDBClient\Traversal::__set() - - Set an attribute, magic method + \ArangoDBClient\Document::__set() + + Set a document attribute, magic method This is a magic method that allows the object to be used without -declaring all attributes first. - +declaring all document attributes first. +This function is mapped to set() internally. + \ArangoDBClient\ClientException - + + string - + mixed - - + void @@ -17740,18 +17896,18 @@ declaring all attributes first. mixed + \ArangoDBClient\Document - + get - \ArangoDBClient\Traversal::get() - - Get an attribute + \ArangoDBClient\Document::get() + + Get a document attribute - - + string - + mixed @@ -17760,18 +17916,19 @@ declaring all attributes first. string + \ArangoDBClient\Document - + __get - \ArangoDBClient\Traversal::__get() - - Get an attribute, magic method + \ArangoDBClient\Document::__get() + + Get a document attribute, magic method This function is mapped to get() internally. - - + + string - + mixed @@ -17780,17 +17937,18 @@ declaring all attributes first. string + \ArangoDBClient\Document - + __isset - \ArangoDBClient\Traversal::__isset() - + \ArangoDBClient\Document::__isset() + Is triggered by calling isset() or empty() on inaccessible properties. - + string - + boolean @@ -17799,730 +17957,508 @@ declaring all attributes first. string + \ArangoDBClient\Document - - __toString - \ArangoDBClient\Traversal::__toString() - - Returns the action string + + __unset + \ArangoDBClient\Document::__unset() + + Magic method to unset an attribute. + Caution!!! This works only on the first array level. +The preferred method to unset attributes in the database, is to set those to null and do an update() with the option: 'keepNull' => false. + + + + + $key + + + + \ArangoDBClient\Document + + + getAll + \ArangoDBClient\Document::getAll() + + Get all document attributes - - - string + + mixed + + + array + + $options + array() + mixed + + \ArangoDBClient\Document - - eJzVWG1v2zYQ/u5fwQEGLAeKvW775HRZvdRNPHhpYLvFhqYQKImW1cikSlJJvGH/fUfqnZLsGuswTB8sSzrey3MPj0e+/Cnexr3e+Oysh87QlGMasNc/o7ubO+RFIaFygtYcPxIucAQSSugVTuSWcQTXG5B/QL/iPeH6i8fiPQ+DrURXxb/vvn3xvY0kD3FAqEDXO/fGhs8RCyix0TXhO0z3MHrc61G8IyLGHikcudI+XBQO3nH2GPpEoIDjeAta665NS2cRcz8RT6JQoEQQH0mGyDPxEkkQNkcjRpHcEiQIhxdIgIXRS5dfKpXZXf1dg0imlZPPScjBDzXMY5TCyxC0pJ/tVJvEXL4nXJLn9AXxAwKBR5kspr5+zWL1CF7EmAMAElxqs/4qCgFrfW2ljMVkPPaZJ0ZYQ+W7I4/txjfr9d24wGAcUp88j7ZyV+QO0H2ARICSOsT6owipR7SFF6MfdEq8CAtRYcCfPfVVJ0NdKSaN+LOPucyrR8wh47lQ9nqs7zEPHzHkpO+UWiDdLVaKbA0EwhL45EIuxajNFuYc7w0zTIJy4EG/HIt+RB8+No15LKESbUIS+aKmBDwUEr29W8/f3jpv5rPF6xWoGKSSg6aiMtcC6Uy0aJvdrpe/O6v1dLl+P1uuZ78pjRXmtKidplAf1jh7fT27ertYzK6Ut0ppnX0tejV0fQen6gWgRAONfPYGMIzBpz1iG83bIiGjLqgzXU1TcxrKEEehIFqTOWnNnOqJUWEQ6lcop65zcx7CbHeJnviGkiwsdfUrMKdKQJ6jTUJzgFMn/8D60ccSH1BmTO7TlWnSpvO7n5YEYeIgt5w9CXRfn7r36W327JG4Ob8SNwq90g/H0SzhiSetdkDtGjC2GZmdOZr7CNSiSRQNtbW0POgQ5DYU55eVWQ2C/eocNyQFkavSrFX1YdgmPKt5ZRleDjPOqSvcICsUjnbbyt0eDivOVjTXqoMe4uwID4jV+G4XEFT8+6uX/jYYP8vXHij6AZH1CQTLiUiiBu05kQmnOd4gE4MxMq0Ut05KmGT4KtwBv5faUWvYM9PtMn9/p3iscGtgddEr01EEUgpWWHJ+GTMhrVpq3vFITCbvlgtnvZxClVxNF3Zb7sC/ktLW8Pzyk2DUIdRjPnGeYMmH8mVVPB0WSqp0yVAv3NR6fxFK40VXdpfpmNZmoCOrlcnXqF61gWZVraajGq6RkTyMBsKdQayAlqoDy+t7rYCN0FyiXQLryxZICwswigiGJ0YJKto2G0G2EY4EQx6mqaRI3PNCoFiuIVrOwZ9J/jzY7W9zqclu/yYzO6h8XzImqzKrxD00JB/5xBkNqnY6BNtre/8RRwn5FwqxWe+0nY4qCrKWINFmMmm0CzayUk+HmavdJL3O89saUsaXLGwld6wWVN0/zL6g2//S3RY21pdQNY3/s1yZy80p6ar3Yidm7DgGp2fOCOa05NWj6XZeJRCKQLEItKeu/0D25qtDaTwxbZbSb6P2dKnG4BvoDFLktGijLdBmESVPpmVrMKegNfTLCBEoGNSaAZMZ5Yr4QVn7qJZA7doXo2ijHQ4gSNgnbplvgLQGI2rDi2tCEANWVTlS+MlyD1v2yOgpBMEkX3GQT2Dfp9kEoyqbLdgUcSEbW66DqemYqhA9Ui13CV6FuLnwLnwG5zKIQDi9bxjvZpUOvGOGPLLQP0gYxzlGGQFIeVuUcsWgioeFOkJoLXNoUhOtUKJ9HbhoiLuc4IeLwwaNTd8hm+317IvM+mSDoQk8pL2O4VGtRdesbkb9O1RCWpPd5Nl50dZ0asoYkhIuJ1p1gI1u3y0WqmSUjIWZRplUZeZYwU350lJ+QqHRaq8OjWJUL8ymeGvhyYaoLVrXSmuifLzElLtaAbLQVuvjNRXnEDa6knAKdWPfqBP/j3Q5TlfCmuuiluqs3XOhjj2DgHDw0t3DfI0iFWWa9CGCOkZ2sdyrv+qEAHvQIYvQjUh+1hK2HHD9E8BcxqBtp1kkyj2FG/QX0LMT6EuACfCUoTQ8AlPG3a/JbOXPIRprP4/swtI1rnaKdcoikQGb7ckS2KVQ2aqtCxbJVmk/cWRHhmu7MQhHn7U60FJgYRUnYpOJfm2jwX1+hJ53su59IaW6jr8BeLzhcA== - - - - ArangoDB PHP client: vertex document handler - - - - - - - - - \ArangoDBClient\DocumentHandler - VertexHandler - \ArangoDBClient\VertexHandler - - A handler that manages vertices. - A vertex-document handler that fetches vertices from the server and -persists them on the server. It does so by issuing the -appropriate HTTP requests to the server. - - - - - - ENTRY_DOCUMENTS - \ArangoDBClient\DocumentHandler::ENTRY_DOCUMENTS - 'documents' - - documents array index + + getAllForInsertUpdate + \ArangoDBClient\Document::getAllForInsertUpdate() + + Get all document attributes for insertion/update + + mixed + - - - OPTION_COLLECTION - \ArangoDBClient\DocumentHandler::OPTION_COLLECTION - 'collection' - - collection parameter + \ArangoDBClient\Document + + + getAllAsObject + \ArangoDBClient\Document::getAllAsObject() + + Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class + + mixed + + + mixed + - - - OPTION_EXAMPLE - \ArangoDBClient\DocumentHandler::OPTION_EXAMPLE - 'example' - - example parameter + + $options + array() + mixed + + \ArangoDBClient\Document + + + setHiddenAttributes + \ArangoDBClient\Document::setHiddenAttributes() + + Set the hidden attributes +$cursor + + array + + + void + - - - $_connection - \ArangoDBClient\Handler::_connection - - - Connection object + + $attributes + + array + + \ArangoDBClient\Document + + + getHiddenAttributes + \ArangoDBClient\Document::getHiddenAttributes() + + Get the hidden attributes - - \ArangoDBClient\Connection + + array - - - $_documentClass - \ArangoDBClient\Handler::_documentClass - '\ArangoDBClient\Document' - + \ArangoDBClient\Document + + + isIgnoreHiddenAttributes + \ArangoDBClient\Document::isIgnoreHiddenAttributes() + - - string + + boolean - - - createFromArrayWithContext - \ArangoDBClient\VertexHandler::createFromArrayWithContext() - - Intermediate function to call the createFromArray function from the right context + \ArangoDBClient\Document + + + setIgnoreHiddenAttributes + \ArangoDBClient\Document::setIgnoreHiddenAttributes() + + - - - - \ArangoDBClient\Document - - - \ArangoDBClient\ClientException + + boolean - - $data + $ignoreHiddenAttributes - + boolean + \ArangoDBClient\Document + + + setChanged + \ArangoDBClient\Document::setChanged() + + Set the changed flag + + + boolean + + + boolean + + - $options + $value - + boolean + \ArangoDBClient\Document - - get - \ArangoDBClient\DocumentHandler::get() - - Get a single document from a collection - Alias method for getById() - - \ArangoDBClient\Exception - - - string - - - mixed + + getChanged + \ArangoDBClient\Document::getChanged() + + Get the changed flag + + + boolean - - array + + \ArangoDBClient\Document + + + setIsNew + \ArangoDBClient\Document::setIsNew() + + Set the isNew flag + + + boolean - - \ArangoDBClient\Document + + void - $collection - - string - - - $documentId + $isNew - mixed - - - $options - array() - array + boolean - \ArangoDBClient\DocumentHandler + \ArangoDBClient\Document - - has - \ArangoDBClient\DocumentHandler::has() - - Check if a document exists - This will call self::get() internally and checks if there -was an exception thrown which represents an 404 request. - - \ArangoDBClient\Exception + + getIsNew + \ArangoDBClient\Document::getIsNew() + + Get the isNew flag + + + boolean - - string + + \ArangoDBClient\Document + + + setInternalId + \ArangoDBClient\Document::setInternalId() + + Set the internal document id + This will throw if the id of an existing document gets updated to some other id + + \ArangoDBClient\ClientException - - mixed + + string - - boolean + + void - $collection + $id string - - $documentId - - mixed - - \ArangoDBClient\DocumentHandler + \ArangoDBClient\Document - - getById - \ArangoDBClient\DocumentHandler::getById() - - Get a single document from a collection - This will throw if the document cannot be fetched from the server. - - \ArangoDBClient\Exception + + setInternalKey + \ArangoDBClient\Document::setInternalKey() + + Set the internal document key + This will throw if the key of an existing document gets updated to some other key + + \ArangoDBClient\ClientException - + string - - mixed - - - array - - - \ArangoDBClient\Document + + void - $collection + $key string - - $documentId - - mixed - - - $options - array() - array - - \ArangoDBClient\DocumentHandler + \ArangoDBClient\Document - - getHead - \ArangoDBClient\DocumentHandler::getHead() - - Gets information about a single documents from a collection - This will throw if the document cannot be fetched from the server - - \ArangoDBClient\Exception - - - string - - - mixed - - - boolean - - + + getInternalId + \ArangoDBClient\Document::getInternalId() + + Get the internal document id (if already known) + Document ids are generated on the server only. Document ids consist of collection id and +document id, in the format collectionId/documentId + string - - array - - - $collection - - string - - - $documentId - - mixed - - - $revision - null - string - - - $ifMatch - null - boolean - - \ArangoDBClient\DocumentHandler + \ArangoDBClient\Document - - createFromArrayWithContext - \ArangoDBClient\DocumentHandler::createFromArrayWithContext() - - Intermediate function to call the createFromArray function from the right context + + getInternalKey + \ArangoDBClient\Document::getInternalKey() + + Get the internal document key (if already known) - - - - \ArangoDBClient\Document + + string - - \ArangoDBClient\ClientException + + \ArangoDBClient\Document + + + getHandle + \ArangoDBClient\Document::getHandle() + + Convenience function to get the document handle (if already known) - is an alias to getInternalId() + Document handles are generated on the server only. Document handles consist of collection id and +document id, in the format collectionId/documentId + + string - - $data - - - - - $options - - - - \ArangoDBClient\DocumentHandler + \ArangoDBClient\Document - - store - \ArangoDBClient\DocumentHandler::store() - - Store a document to a collection - This is an alias/shortcut to save() and replace(). Instead of having to determine which of the 3 functions to use, -simply pass the document to store() and it will figure out which one to call. + + getId + \ArangoDBClient\Document::getId() + + Get the document id (or document handle) if already known. + It is a string and consists of the collection's name and the document key (_key attribute) separated by /. +Example: (collectionname/documentId) -This will throw if the document cannot be saved or replaced. - - \ArangoDBClient\Exception - - - \ArangoDBClient\Document - - +The document handle is stored in a document's _id attribute. + mixed - - array + + \ArangoDBClient\Document + + + getKey + \ArangoDBClient\Document::getKey() + + Get the document key (if already known). + Alias function for getInternalKey() + + mixed - + + \ArangoDBClient\Document + + + getCollectionId + \ArangoDBClient\Document::getCollectionId() + + Get the collection id (if already known) + Collection ids are generated on the server only. Collection ids are numeric but might be +bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used + mixed - - - $document - - \ArangoDBClient\Document - - - $collection - null - mixed - - - $options - array() - array - - \ArangoDBClient\DocumentHandler + \ArangoDBClient\Document - - save - \ArangoDBClient\DocumentHandler::save() - - save a document to a collection - This will add the document to the collection and return the document's id + + setRevision + \ArangoDBClient\Document::setRevision() + + Set the document revision + Revision ids are generated on the server only. -This will throw if the document cannot be saved - - \ArangoDBClient\Exception - - +Document ids are strings, even if they look "numeric" +To reliably store a document id elsewhere, a PHP string must be used + mixed - - \ArangoDBClient\Document - array - - - array - - - mixed + + void - - $collection + $rev mixed - - $document - - \ArangoDBClient\Document|array - - - $options - array() - array - - \ArangoDBClient\DocumentHandler + \ArangoDBClient\Document - - update - \ArangoDBClient\DocumentHandler::update() - - Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document. - Attention - The behavior of this method has changed since version 1.1 - -This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the document to-be-replaced is the same as the one given. - - \ArangoDBClient\Exception + + getRevision + \ArangoDBClient\Document::getRevision() + + Get the document revision (if already known) + + + mixed - - \ArangoDBClient\Document + + \ArangoDBClient\Document + + + jsonSerialize + \ArangoDBClient\Document::jsonSerialize() + + Get all document attributes +Alias function for getAll() - it's necessary for implementing JsonSerializable interface + + + mixed - + array - - boolean - - - $document - - \ArangoDBClient\Document - $options array() - array + mixed - \ArangoDBClient\DocumentHandler + \ArangoDBClient\Document - - updateById - \ArangoDBClient\DocumentHandler::updateById() - - Update an existing document in a collection, identified by collection id and document id -Attention - The behavior of this method has changed since version 1.1 - This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the document to-be-updated is the same as the one given. - - \ArangoDBClient\Exception + + eJylUMtKw0AU3c9XnF01BGuzTAUfLbYIQkHoKiA300sSm8yEmYk0iP/ubWK7qEt3w3ndc+buvi1bpaZRpBDh0ZEp7PIJm/UGuq7YhBS+MkXN+GQX+ICd1V0juMiPjoeW9J4KBs7mxeAbSOpCaZ1weCGDt8DckDEX1LP49nilnt3AaNv2rirKgMX5ldzOkhjBVXLKeKyafB0LXdvCcIwVO8ntB7e01cc2wOwmEWSqlKGGvfTki4rz8+4t1R3D5h+sAxy3jr3wshv0n/l/u+iavMd2zOJDYLPzWJ4yv5T6VqPmneqK/NWoTNMBizHJTl+Q/Z7Ls1EyuZ6rH7e+kY0= + + + + ArangoDB PHP client: query handling + + + + + + + \ArangoDBClient\Handler + QueryHandler + \ArangoDBClient\QueryHandler + + A base class for REST-based handlers + + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection - + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + string - - mixed - - - \ArangoDBClient\Document - - - array - - - boolean - - - $collection - - string - - - $documentId - - mixed - - - $document - - \ArangoDBClient\Document - - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - - replace - \ArangoDBClient\DocumentHandler::replace() - - Replace an existing document in a collection, identified by the document itself - This will update the document on the server - -This will throw if the document cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given. - - \ArangoDBClient\Exception - - - \ArangoDBClient\Document - - - array - - - boolean + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string - - $document - - \ArangoDBClient\Document - - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - - replaceById - \ArangoDBClient\DocumentHandler::replaceById() - - Replace an existing document in a collection, identified by collection id and document id - This will update the document on the server - -This will throw if the document cannot be Replaced - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given. - + + + clearSlow + \ArangoDBClient\QueryHandler::clearSlow() + + Clears the list of slow queries + + \ArangoDBClient\Exception - - mixed - - - mixed - - - \ArangoDBClient\Document - - - array - - - boolean - - - $collection - - mixed - - - $documentId - - mixed - - - $document - - \ArangoDBClient\Document - - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - remove - \ArangoDBClient\DocumentHandler::remove() - - Remove a document from a collection, identified by the document itself + + getSlow + \ArangoDBClient\QueryHandler::getSlow() + + Returns the list of slow queries - + \ArangoDBClient\Exception - - \ArangoDBClient\Document - - + array - - boolean - - - $document - - \ArangoDBClient\Document - - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - removeById - \ArangoDBClient\DocumentHandler::removeById() - - Remove a document from a collection, identified by the collection id and document id + + getCurrent + \ArangoDBClient\QueryHandler::getCurrent() + + Returns the list of currently executing queries - + \ArangoDBClient\Exception - - mixed - - - mixed - - - mixed - - + array - - boolean - - - - $collection - - mixed - - - $documentId - - mixed - - - $revision - null - mixed - - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - - getDocumentId - \ArangoDBClient\DocumentHandler::getDocumentId() - - Helper function to get a document id from a document or a document id value - - - \ArangoDBClient\ClientException - - - mixed - - - mixed - - - $document - - mixed - - \ArangoDBClient\DocumentHandler - - getRevision - \ArangoDBClient\DocumentHandler::getRevision() - - Helper function to get a document id from a document or a document id value - - - \ArangoDBClient\ClientException - - - mixed + + kill + \ArangoDBClient\QueryHandler::kill() + + Kills a specific query + This will send an HTTP DELETE command to the server to terminate the specified query + + string - - mixed + + \ArangoDBClient\Exception - - - $document - - mixed - - \ArangoDBClient\DocumentHandler - - - createCollectionIfOptions - \ArangoDBClient\DocumentHandler::createCollectionIfOptions() - - - - - - array + + boolean - $collection - - - - - $options + $id - array + string - \ArangoDBClient\DocumentHandler - + __construct \ArangoDBClient\Handler::__construct() - + Construct a new handler - + \ArangoDBClient\Connection @@ -18533,30 +18469,30 @@ that the revision of the to-be-replaced document is the same as the one given. \ArangoDBClient\Handler - + getConnection \ArangoDBClient\Handler::getConnection() - + Return the connection object - + \ArangoDBClient\Connection \ArangoDBClient\Handler - + getConnectionOption \ArangoDBClient\Handler::getConnectionOption() - + Return a connection option This is a convenience function that calls json_encode_wrapper on the connection - - + + mixed - + \ArangoDBClient\ClientException @@ -18567,19 +18503,19 @@ This is a convenience function that calls json_encode_wrapper on the connection< \ArangoDBClient\Handler - + json_encode_wrapper \ArangoDBClient\Handler::json_encode_wrapper() - + Return a json encoded string for the array passed. This is a convenience function that calls json_encode_wrapper on the connection - + array - + string - + \ArangoDBClient\ClientException @@ -18590,23 +18526,23 @@ This is a convenience function that calls json_encode_wrapper on the connection< \ArangoDBClient\Handler - + includeOptionsInBody \ArangoDBClient\Handler::includeOptionsInBody() - + Helper function that runs through the options given and includes them into the parameters array given. Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - + array - + array - + array - + array @@ -18627,19 +18563,19 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\Handler - + makeCollection \ArangoDBClient\Handler::makeCollection() - + Turn a value into a collection name - + \ArangoDBClient\ClientException - + mixed - + string @@ -18650,1727 +18586,2021 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\Handler - - setDocumentClass - \ArangoDBClient\Handler::setDocumentClass() - - Sets the document class to use + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation - - string + + array - - \ArangoDBClient\Handler + + mixed + + $headers + + array + - $class + $collection - string + mixed \ArangoDBClient\Handler + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + - eJyNU8Fu2zAMvfsreBjQLvCSNcd0wNqla9MBAwKs2C4BBkVmbKG2pEn0FmPov4+SHCdxL9NFBsn39N4j/OGjrWyWzSaTDCZw64Quzd0nWK/WIGuFmhbwGx3hHgoj24YLUAld1Oh4PkBurJDPokSAAb2MwNgULVXGcQ++CA3fCLERWo9a94x7hq+ii6RwI43tnCorguXwNX9/Nc+BnOKntIeHZrvKuV2bUmMOD+iYt4tor7QMagCupnOuzLJMiwY968SRxOuj8YMroEoQMBm/46N1JdFP00xK4t04iYTZIcnqBAM7ZxpuIXh0XAQeDjQWnVeefGg1YPTJyBQeiXNmrDew7UB53ypdhomAFNY6YzkCQlg9Pa3B4a8WI5U5ZfmvzbyOSdbCe/gePa56Z7gn1IWHu95yX8/+ZgEZwwtnAo+aeAdYRHG7VktSwZoBKeo6ipMOuXfPodw6J7rj0JBT2rQ0TLWnnvjAz2acaOBNIUiMa8YGHj9GOKTW6UH6UKfKmT8eNuehbNL1eS8x0vXjs3jbdlsreZQ88vJDUbVMsi+jwnwQ9TbiU1zh9KJSyovFiOgV+joCX7KXLK3np6iV8JdnS2KW0MrhYnP4Pw7etpuzyQvm+werwkRL + + No summary for class \ArangoDBClient\QueryHandler + + eJzFVN9v2jAQfs9fcQ+VCAjENmkv6dZ1o6io6wOl8DCNqTLJkVg1dnZ2RlHV/31nE7IKrZU6ps1SlDj33a/v7O/dh7Ioo6jf6UTQgY8kdG7OPsF4NIZUSdQuge8V0gYKoTMldc4wjzwtRXorcgRonAYBH4yicoUhtsGF0HDtEFdC62BKTbkhmRcOBs3Xm1ev33bBkeSA2sL5ajHqslmZXGMXzpHYe8Pe/SjSYoWWc+Ne2uMoSpWwFq58tSNfLBLgnUOdWaj30X3kawrN+tWBgUJBFlyBoKR1YJZglVmHniXaGrZDn7qCzNrC8C7F0kmja0M/vMtqoWQKy0qn3sb8cexrjha3g32b3K+jihS8hxmpEaoSKUkWlVQZ72N+bJLMJpc3V7Ph5EsXvrZ8Qa1v7eNf7q6QtneSoxsYrTFki9u9kwwVOox99Br9EO03PEFXkT6448ZOIR4IIrF5lg2u9mkuwjqAEOIzYbRFjvEUOfxjx0zjVxffuAfUhfUOL+EvrYj4CKoNnzdMK8e35F/QOdim/RuM1h38L1I/S6UsCLAlpnLJbQbJ2eNmyiXAmpFg+U4D68poOh3D2fByOB1CalYsEhk4E0ZjkX7w/fc7Vg+phcPt/20GzH6bgkWNxAosKxGP8Ehm0KvVT2Z/OMmFMerZQd5yRzGnOkgj2P/lArE/MUcVNhN6qPX0RigpbPxYVZMkWLrQmu8ke16L8WL+GNjiJD8BgT/eng== - + - ArangoDB PHP client: statement + ArangoDB PHP client: document handler + - - - Statement - \ArangoDBClient\Statement - - Container for an AQL query - Optional bind parameters can be used when issuing the AQL query to separate -the query from the values. -Executing a query will result in a cursor being created. - -There is an important distinction between two different types of statements: -<ul> -<li> statements that produce an array of documents as their result AND<br /> -<li> statements that do not produce documents -</ul> + + \ArangoDBClient\Handler + DocumentHandler + \ArangoDBClient\DocumentHandler + + A handler that manages documents + A document handler that fetches documents from the server and +persists them on the server. It does so by issuing the +appropriate HTTP requests to the server.<br> -For example, a statement such as "FOR e IN example RETURN e" will produce -an array of documents as its result. The result can be treated as an array of -documents, and each document can be updated and sent back to the server by -the client.<br /> -<br /> -However, the query "RETURN 1 + 1" will not produce an array of documents as -its result, but an array with a single scalar value (the number 2). -"2" is not a valid document so creating a document from it will fail.<br /> -<br /> -To turn the results of this query into a document, the following needs to -be done: -<ul> -<li> modify the query to "RETURN { value: 1 + 1 }". The result will then be a - an array of documents with a "value" attribute<br /> -<li> use the "_flat" option for the statement to indicate that you don't want - to treat the statement result as an array of documents, but as a flat array -</ul> - - +<br> + + + - - ENTRY_QUERY - \ArangoDBClient\Statement::ENTRY_QUERY - 'query' - - Query string index - - - - - ENTRY_COUNT - \ArangoDBClient\Statement::ENTRY_COUNT - 'count' - - Count option index - - - - - ENTRY_BATCHSIZE - \ArangoDBClient\Statement::ENTRY_BATCHSIZE - 'batchSize' - - Batch size index - - - - - ENTRY_RETRIES - \ArangoDBClient\Statement::ENTRY_RETRIES - 'retries' - - Retries index - - - - - ENTRY_BINDVARS - \ArangoDBClient\Statement::ENTRY_BINDVARS - 'bindVars' - - Bind variables index + + ENTRY_DOCUMENTS + \ArangoDBClient\DocumentHandler::ENTRY_DOCUMENTS + 'documents' + + documents array index - - ENTRY_FAIL_ON_WARNING - \ArangoDBClient\Statement::ENTRY_FAIL_ON_WARNING - 'failOnWarning' - - Fail on warning flag + + OPTION_COLLECTION + \ArangoDBClient\DocumentHandler::OPTION_COLLECTION + 'collection' + + collection parameter - - ENTRY_MEMORY_LIMIT - \ArangoDBClient\Statement::ENTRY_MEMORY_LIMIT - 'memoryLimit' - - Memory limit threshold for query + + OPTION_EXAMPLE + \ArangoDBClient\DocumentHandler::OPTION_EXAMPLE + 'example' + + example parameter - - FULL_COUNT - \ArangoDBClient\Statement::FULL_COUNT - 'fullCount' - - Full count option index + + OPTION_OVERWRITE + \ArangoDBClient\DocumentHandler::OPTION_OVERWRITE + 'overwrite' + + overwrite option - - ENTRY_STREAM - \ArangoDBClient\Statement::ENTRY_STREAM - 'stream' - - Stream attribute + + OPTION_RETURN_OLD + \ArangoDBClient\DocumentHandler::OPTION_RETURN_OLD + 'returnOld' + + option for returning the old document - - ENTRY_TTL - \ArangoDBClient\Statement::ENTRY_TTL - 'ttl' - - TTL attribute + + OPTION_RETURN_NEW + \ArangoDBClient\DocumentHandler::OPTION_RETURN_NEW + 'returnNew' + + option for returning the new document - + $_connection - \ArangoDBClient\Statement::_connection + \ArangoDBClient\Handler::_connection - - The connection object + + Connection object - + \ArangoDBClient\Connection - - $_bindVars - \ArangoDBClient\Statement::_bindVars - - - The bind variables and values used for the statement - - - \ArangoDBClient\BindVars - - - - - $_batchSize - \ArangoDBClient\Statement::_batchSize - - - The current batch size (number of result documents retrieved per round-trip) + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + - - mixed + + string - - $_doCount - \ArangoDBClient\Statement::_doCount - false - - The count flag (should server return total number of results) + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - - boolean + + string - - $_fullCount - \ArangoDBClient\Statement::_fullCount - false - - The count flag (should server return total number of results ignoring the limit) -Be careful! This option also prevents ArangoDB from using some server side optimizations! - - - boolean + + get + \ArangoDBClient\DocumentHandler::get() + + Get a single document from a collection + Alias method for getById() + + \ArangoDBClient\Exception - - - - $_query - \ArangoDBClient\Statement::_query - - - The query string - - + string + + mixed + + + array + + + \ArangoDBClient\Document + - - - $_flat - \ArangoDBClient\Statement::_flat - false - - "flat" flag (if set, the query results will be treated as a simple array, not documents) - - - boolean - - - - - $_sanitize - \ArangoDBClient\Statement::_sanitize - false - - Sanitation flag (if set, the _id and _rev attributes will be removed from the results) - - - boolean - - - - - $_retries - \ArangoDBClient\Statement::_retries - 0 - - Number of retries in case a deadlock occurs - - - boolean - - - - - $_cache - \ArangoDBClient\Statement::_cache - - - Whether or not the query cache should be consulted - - - boolean + + $collection + + string + + + $documentId + + mixed + + + $options + array() + array + + + + has + \ArangoDBClient\DocumentHandler::has() + + Check if a document exists + This will call self::get() internally and checks if there +was an exception thrown which represents an 404 request. + + \ArangoDBClient\Exception - - - - $_stream - \ArangoDBClient\Statement::_stream - - - Whether or not the query results should be build up dynamically and streamed to the -client application whenever available, or build up entirely on the server first and -then streamed incrementally (false) - - - boolean + + string - - - - $_ttl - \ArangoDBClient\Statement::_ttl - - - Number of seconds the cursor will be kept on the server if the statement result -is bigger than the initial batch size. The default value is a server-defined -value - - - double + + mixed - - - - $_failOnWarning - \ArangoDBClient\Statement::_failOnWarning - false - - Whether or not the cache should abort when it encounters a warning - - + boolean - - - $_memoryLimit - \ArangoDBClient\Statement::_memoryLimit - 0 - - Approximate memory limit value (in bytes) that a query can use on the server-side -(a value of 0 or less will mean the memory is not limited) - - - integer + + $collection + + string + + + $documentId + + mixed + + + + getById + \ArangoDBClient\DocumentHandler::getById() + + Get a single document from a collection + This will throw if the document cannot be fetched from the server. + + \ArangoDBClient\Exception - - - - $resultType - \ArangoDBClient\Statement::resultType - - - resultType - - + string - - - - $_documentClass - \ArangoDBClient\Statement::_documentClass - - - - - - - - __construct - \ArangoDBClient\Statement::__construct() - - Initialise the statement - The $data property can be used to specify the query text and further -options for the query. - -An important consideration when creating a statement is whether the -statement will produce a list of documents as its result or any other -non-document value. When a statement is created, by default it is -assumed that the statement will produce documents. If this is not the -case, executing a statement that returns non-documents will fail. - -To explicitly mark the statement as returning non-documents, the '_flat' -option should be specified in $data. - - \ArangoDBClient\Exception - - - \ArangoDBClient\Connection + + mixed - + array + + \ArangoDBClient\Document + - $connection + $collection - \ArangoDBClient\Connection + string - $data + $documentId + mixed + + + $options + array() array - - getConnection - \ArangoDBClient\Statement::getConnection() - - Return the connection object - - - \ArangoDBClient\Connection - - - - - execute - \ArangoDBClient\Statement::execute() - - Execute the statement - This will post the query to the server and return the results as -a Cursor. The cursor can then be used to iterate the results. - + + getHead + \ArangoDBClient\DocumentHandler::getHead() + + Gets information about a single documents from a collection + This will throw if the document cannot be fetched from the server + \ArangoDBClient\Exception - - \ArangoDBClient\Cursor + + string - - - - explain - \ArangoDBClient\Statement::explain() - - Explain the statement's execution plan - This will post the query to the server and return the execution plan as an array. - - \ArangoDBClient\Exception + + mixed - - array + + boolean - - - - validate - \ArangoDBClient\Statement::validate() - - Validates the statement - This will post the query to the server for validation and return the validation result as an array. - - \ArangoDBClient\Exception + + string - + array - - - __invoke - \ArangoDBClient\Statement::__invoke() - - Invoke the statement - This will simply call execute(). Arguments are ignored. - - \ArangoDBClient\Exception - - - mixed - - - \ArangoDBClient\Cursor - - - $args + $collection + + string + + + $documentId mixed - - - __toString - \ArangoDBClient\Statement::__toString() - - Return a string representation of the statement - - - string + + $revision + null + string + + + $ifMatch + null + boolean + + + + createFromArrayWithContext + \ArangoDBClient\DocumentHandler::createFromArrayWithContext() + + Intermediate function to call the createFromArray function from the right context + + + + + \ArangoDBClient\Document + + + \ArangoDBClient\ClientException + + $data + + + + + $options + + + - - bind - \ArangoDBClient\Statement::bind() - - Bind a parameter to the statement - This method can either be called with a string $key and a -separate value in $value, or with an array of all bind -bind parameters in $key, with $value being NULL. + + store + \ArangoDBClient\DocumentHandler::store() + + Store a document to a collection + This is an alias/shortcut to save() and replace(). Instead of having to determine which of the 3 functions to use, +simply pass the document to store() and it will figure out which one to call. -Allowed value types for bind parameters are string, int, -double, bool and array. Arrays must not contain any other -than these types. - +This will throw if the document cannot be saved or replaced. + \ArangoDBClient\Exception - - mixed + + \ArangoDBClient\Document - + mixed - - void + + array + + + mixed + - $key + $document - mixed + \ArangoDBClient\Document - $value + $collection null mixed + + $options + array() + array + - - getBindVars - \ArangoDBClient\Statement::getBindVars() - - Get all bind parameters as an array - - - array + + insert + \ArangoDBClient\DocumentHandler::insert() + + insert a document into a collection + This will add the document to the collection and return the document's id + +This will throw if the document cannot be saved + + \ArangoDBClient\Exception - - - - setQuery - \ArangoDBClient\Statement::setQuery() - - Set the query string - - - \ArangoDBClient\ClientException + + mixed - - string + + \ArangoDBClient\Document + array - - void + + array + + + mixed + - $query + $collection - string + mixed - - - getQuery - \ArangoDBClient\Statement::getQuery() - - Get the query string - - - string - - - - - setResultType - \ArangoDBClient\Statement::setResultType() - - setResultType - - - - string - - - $resultType + $document - + \ArangoDBClient\Document|array + + + $options + array() + array - - setCount - \ArangoDBClient\Statement::setCount() - - Set the count option for the statement - - - boolean - - - void - + + save + \ArangoDBClient\DocumentHandler::save() + + Insert a document into a collection + This is an alias for insert(). - $value + $collection - boolean + - - - getCount - \ArangoDBClient\Statement::getCount() - - Get the count option value of the statement - - - boolean - - - - - setFullCount - \ArangoDBClient\Statement::setFullCount() - - Set the full count option for the statement - - - boolean - - - void - - - $value + $document - boolean + + + + $options + array() + array - - getFullCount - \ArangoDBClient\Statement::getFullCount() - - Get the full count option value of the statement - - - boolean + + update + \ArangoDBClient\DocumentHandler::update() + + Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document. + Attention - The behavior of this method has changed since version 1.1 + +This will update the document on the server + +This will throw if the document cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the document to-be-replaced is the same as the one given. + + \ArangoDBClient\Exception - - - - setTtl - \ArangoDBClient\Statement::setTtl() - - Set the ttl option for the statement - - - double + + \ArangoDBClient\Document - - void + + array + + + boolean - $value + $document - double + \ArangoDBClient\Document + + + $options + array() + array - - getTtl - \ArangoDBClient\Statement::getTtl() - - Get the ttl option value of the statement - - - double + + updateById + \ArangoDBClient\DocumentHandler::updateById() + + Update an existing document in a collection, identified by collection id and document id +Attention - The behavior of this method has changed since version 1.1 + This will update the document on the server + +This will throw if the document cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the document to-be-updated is the same as the one given. + + \ArangoDBClient\Exception - - - - setStream - \ArangoDBClient\Statement::setStream() - - Set the streaming option for the statement - - - boolean + + string - - void + + mixed - - - $value - - boolean - - - - getStream - \ArangoDBClient\Statement::getStream() - - Get the streaming option value of the statement - - - boolean + + \ArangoDBClient\Document - - - - setCache - \ArangoDBClient\Statement::setCache() - - Set the caching option for the statement - - - boolean + + array - - void + + boolean - $value + $collection - boolean + string + + + $documentId + + mixed + + + $document + + \ArangoDBClient\Document + + + $options + array() + array - - getCache - \ArangoDBClient\Statement::getCache() - - Get the caching option value of the statement - - + + replace + \ArangoDBClient\DocumentHandler::replace() + + Replace an existing document in a collection, identified by the document itself + This will replace the document on the server + +This will throw if the document cannot be replaced + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given. + + \ArangoDBClient\Exception + + + \ArangoDBClient\Document + + + array + + boolean + + $document + + \ArangoDBClient\Document + + + $options + array() + array + - - setFailOnWarning - \ArangoDBClient\Statement::setFailOnWarning() - - Set whether or not the cache should abort when it encounters a warning - - - boolean + + replaceById + \ArangoDBClient\DocumentHandler::replaceById() + + Replace an existing document in a collection, identified by collection id and document id + This will update the document on the server + +This will throw if the document cannot be Replaced + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given. + + \ArangoDBClient\Exception - - void + + mixed + + + mixed + + + \ArangoDBClient\Document + + + array + + + boolean - $value - true - boolean + $collection + + mixed + + + $documentId + + mixed + + + $document + + \ArangoDBClient\Document + + + $options + array() + array - - getFailOnWarning - \ArangoDBClient\Statement::getFailOnWarning() - - Get the configured value for fail-on-warning + + remove + \ArangoDBClient\DocumentHandler::remove() + + Remove a document from a collection, identified by the document itself - + + \ArangoDBClient\Exception + + + \ArangoDBClient\Document + + + array + + boolean + + $document + + \ArangoDBClient\Document + + + $options + array() + array + - - setMemoryLimit - \ArangoDBClient\Statement::setMemoryLimit() - - Set the approximate memory limit threshold to be used by the query on the server-side -(a value of 0 or less will mean the memory is not limited) + + removeById + \ArangoDBClient\DocumentHandler::removeById() + + Remove a document from a collection, identified by the collection id and document id - - integer + + \ArangoDBClient\Exception - - void + + mixed + + + mixed + + + mixed + + + array + + + boolean - $value + $collection - integer + mixed + + + $documentId + + mixed + + + $revision + null + mixed + + + $options + array() + array - - getMemoryLimit - \ArangoDBClient\Statement::getMemoryLimit() - - Get the configured memory limit for the statement + + getDocumentId + \ArangoDBClient\DocumentHandler::getDocumentId() + + Helper function to get a document id from a document or a document id value - - integer + + \ArangoDBClient\ClientException + + + mixed + + + mixed + + $document + + mixed + - - setBatchSize - \ArangoDBClient\Statement::setBatchSize() - - Set the batch size for the statement - The batch size is the number of results to be transferred -in one server round-trip. If a query produces more results -than the batch size, it creates a server-side cursor that -provides the additional results. - -The server-side cursor can be accessed by the client with subsequent HTTP requests. - + + getRevision + \ArangoDBClient\DocumentHandler::getRevision() + + Helper function to get a document id from a document or a document id value + + \ArangoDBClient\ClientException - - integer + + mixed - - void + + mixed - $value + $document - integer + mixed - - getBatchSize - \ArangoDBClient\Statement::getBatchSize() - - Get the batch size for the statement + + lazyCreateCollection + \ArangoDBClient\DocumentHandler::lazyCreateCollection() + + - - integer + + mixed + + + array + + $collection + + mixed + + + $options + + array + - - buildData - \ArangoDBClient\Statement::buildData() - - Build an array of data to be posted to the server when issuing the statement + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler - - array + + \ArangoDBClient\Connection + + $connection + + \ArangoDBClient\Connection + + \ArangoDBClient\Handler - - getCursorOptions - \ArangoDBClient\Statement::getCursorOptions() - - Return an array of cursor options + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object - - array + + \ArangoDBClient\Connection + \ArangoDBClient\Handler - - setDocumentClass - \ArangoDBClient\Statement::setDocumentClass() - - Sets the document class to use + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection - - string + + + mixed - - \ArangoDBClient\Statement + + \ArangoDBClient\ClientException - $class + $optionName - string + + \ArangoDBClient\Handler - + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + + string + + + \ArangoDBClient\ClientException + + + + $body + + array + + \ArangoDBClient\Handler + + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array + + + array + + + array + + + array + + + + $options + + array + + + $body + + array + + + $includeArray + array() + array + + \ArangoDBClient\Handler + + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name + + + \ArangoDBClient\ClientException + + + mixed + + + string + + + + $value + + mixed + + \ArangoDBClient\Handler + + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler + + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + - No summary for property $_documentClass + Name of argument $revision does not match with the DocBlock's name $ifMatch in getHead() + The type hint of the argument is incorrect for the type definition of the @param tag with argument $revision in getHead() + Name of argument $ifMatch does not match with the DocBlock's name $revision in getHead() + The type hint of the argument is incorrect for the type definition of the @param tag with argument $ifMatch in getHead() + Argument $collection is missing from the Docblock of save + Argument $document is missing from the Docblock of save + Argument $options is missing from the Docblock of save + No summary for method lazyCreateCollection() - eJzFHNtWG0fy3V/R5nAikUjg+G2xYSMw2ORgcIRINuv46LSkFup4NKOdGYFJ4n/fqurrXHokAdnlwYiZ7rrfurrk1/9czBbPnu19++0z9i3rpTy+Sd4csQ/vPrBxJEWc77Ms57mYw0dYgYt+WPDxZ34jGLPrj2kpveTLfJak8I79yGN2lQsx53FMr8bJ4j6VN7OcHdtPL198/7LD8lQCwDhjb+ejdx14HSU3seiwtyKF3fewe+/Zs5jPRQa4RQntK0v+cRLnXMYiZVMgAdD3fjpn/1mK9F6TfrnIZRLziI1kPGELngLIXKQZG8PikWDLTEzY3UzETGbZUsY3LJ8JB4XlCcsEbssFgsOX6sU0Teb05y2PliLbxbcnX8R4mSMQrlfdyShiqciWUc5kDI/HyzQDSkcCV41TAXAnu5rWwUykAuhAPuR8kaQ5j3M2kRmAHCMbsC2/E0BrfpfA8+kU1sOK/H4hMpZMnd6yfYT3ehkd0u9IHnrvgGqes0WaTJYgWcDF05Tf4/5JMl6qJRxXCZka2nsXb16PUrYXhjdJWJw4sBYUbdhTlODnU+BefOHzRQTa5g4My5bjGeLdOr3sM8HOLswy1j8ZXPfhzy0lTo0CgQWJl/BLkb6LYjVsaKXnSu640IOAAC0QoA3sRXCgyTyzJrOYqN2wIMPnI/AONBS0hkykt2CNo3tjLcqndj3p2U/vkjsBizueVW1pXr9n37HvNb++WEMMIzjHc4eNlrlbeyfzGYoaTA6kmY15xFNltqyNqOPlfAQ0v9whI956uYU2iFg5rpITJ4EsUTarTNw+Jl+QuSJ3ymVUy+4AJLRMY+JW0UlGm88Am+JexiBFB1cJZppEUXKHGGMhJmBtCQIboYnFomrn8wQc494TKYA0Uv1Tcb2vxMu+bhWMg6jPMRQAcI4AWUDeWqBbBG2L8RyiGUhclFwEYgvRsTWcRjzfYgnFIopUZCrW9IFEiE5yDH8rZ7pPlsheC4jiKsoyMjCUfWmvJr5oyr4dkynAW4ZEqBVln7TxvSa6g9WMMfC/2H1JQXkc8SyDKG8yxJ/PMPJTOMYfimJsnMSxUCErGf0On/RLs+aHW7DAY7tIP96j34tU3qIgtocOCgT8GiwU0gGS5KNIZOSPKhirqF6Rcx0RRwDjZ55mARJG+nU9ARDMUxUAcogTmfwDHEo7E+hAa8aZTSrATsDjIQ/BijRZxpMuPFns1BE2l1/EJEQV4rsCdAGyAHKO6r5h7WyWLKOJCUtAAXlgkkNGLFOa1dIxSpIoQMYkOSZMB+DzUfbExDB5EyepSciRnMvc0MeOACxPxXQZPQccED60ZwEVCdAHIkZx29KGwtMSwx8EsLmN0ZmcCNo5l39w3J8931AAQEC0hghUHMpy5KYOQ+FNGQdtrsLdUiFFyVVC6he5n0eMECmmlTIeME5plUJBhwK9tdFNTYBiSpD5Kx7LnKugVyF0KFUKHYK+XAh1JKdinqCv2ELrgVaaIRHomkEyLzzbQw/NsFQbc4jekIsEn0QJ5PdkjKXbhrgNvAP2oor2l5kAtgBvSjpwyhtD1QFWqpxlRNEUObfhYF3sBGcDvMZoHObRUsKH5YJN7qEWhwQVRfeq7kGDmoN2VNljQKtih/HFIsJshorH2hqrHMZvoTDASN1BzBYyrJepALBJ7BdQU5lmOaEysCkzW7yQlVIK6kRSmzS7sWUQsFf0NGwTmQD5TzJVzKnq3ZjoZ7HIS3TLaW1+NmAhVo3kzY3AzMTVRonmiQcUm0RUVTIRU475QxVqkhyXcHThDRx5jDWoBXWsT5IliDvAfJ5H9ZzXmEfBIPkIDib6yJSD+ijA44mKQ7GSxoEY1xRDwC4u41/U3rCX9hZQBH+Rc9w0h9gABktZwVSy4LOjewggO6qE4taZYirECmrqYuw3gNtcgwBlv0C2oZjQYWgutJI0Ql0XE14xqbU3aeuMMp8KxjnRXBsQlKkM4DS3aZZwOwFqGexPXvrBOlN8KQDB6JKzk4tB/9fhT9cn/V+BuBbJrlUlUWU7nW6bYR1fXl8MEBYZSA2sI1c1NUM66g2O312d/fsEodnapwZi34bvJnBwGOifnVwhMB2f64gr1pYrCDy7ePNzr08gTcXYqveuUzB2tEXtKpQXg3BPe2fnw8uL4S+9/sXZxVsEX3CWAI73vnfkMzCOWRKpeli3RgL43p+8v4Rf52fvz0hznsXWiOgUqh9d3q0wiNPr83NnD7ZqCpB/RWHZlQRBcq8G/ZPeewSpInkA3mBwvgYwXAWQICzWsHqmYrTUB7rQiQLD9vaE5xzP61Dj5/eFNhP2khZiXDqeii8qz02XKcZdA0uJNLOnGFq9W0LY8xtFyA2EtdTlXf+w7jISBLE7HeO91O3e+00W2Ahc5w39FUZ9N0jfPvFxEndtd4CC6y7mlbhMh26AwSH13uY7iW8MIDhrLqnMmFUOvgUyLXG77Ey3FHSs9qsTKOk6THhNOu8IjgjUiSQrkJ95XY2yuhMAhpWOzKEGmfP0c4lEnmmQ1L3wgaoSuEX1c6uocq/8UtYiqdxRhlUm4Qdw7+QuYydfxmLhHaXte+p4ekdttu2dzbsqu7sHYKHaWEsAVGOBfpSBq5+ur07tI+osxXBVMVlBMSLHYOa6lzkckvuly3Herqevo9ESRpVsVbeByEAldw+9JgG477bfMiivNJEZHh2wWNzZs397R3s8/kAB15YZnFLahPZjJqLp/r6XHj/t7HhkeAhgD6Xa8EZH01f7aS3EKtI1YVZBs2Grj3stnBSvm1BSDA9v3BihTfNNSI9M+m8G8GBJQxpoQj/Io9CmzfnVVUMQn7VYQt0IYQPkLhmHEfuNjTaW7jvKCT8e0wGoAGQjUZv92jZ7F2eDJoX7h/daOkpwHqx2XROGCXEneTho5IaMOhBrqaJI/+l5r0kZqsfSwD/tfwDe497xuwbhq2NfI2YF4cFiLxW4DTIonRELJDVBfDBpfi0cpqt4pguZRgFWmaKvdccYc0+yspGum6jHDUm9sNEcHJMcnmF3zaTjGwzoZk+7nG01mmrSfRXgQV2FriqXpa6uFknmN6KKd2lYHKeicnXEXZHIlFHumqY89mjG6uReqL7h0J5yTZQGs25B5SRN4BsrG1VhiooQ0dyey2yojuJtI0ziuWJhRAeVKeoyxhLUbukDvS0TuT7ct+rTgCrYDozyqPP2Bh4Vyp5tr1Fpnt3NZIRXhOlSVKgDAopPCAgIdQFFnXDYPFPpHqKa29dplO3vX/chf1z3ry77HbO0ZIHdw9+zJB5ig2kihncpX8CJSjnqTod9/ORTXzJTkhrpqV0lo+PIJJw/ZoitQAVtVZMDUBx6UiXJgmlh46J9ReZp9cK2K1IySlfC/e47dnhQTih1W5z6t8Wrytuv9SgUM4qmY5BYe4c9PzhgL/8RwrC3By/xlLRle9wToaLC1qNJAuBoIvyGy/hZ/VIb/aqhYxHBtmLoaGXm4AaShvflg87DYkkRpH+JunFc0Ber9DAUFoivSlhwB6p6H7XrNvOuk399OO+dXTyFe5noX+M3r0Ja/BknBzhe6DxBCsAmyK0CSPd8RS16b6q34X+DIjW+aoD/mzRJp8f/lx7P4tvk87p5nG4WsekFn20W3GW99Ma0jnDACS92aeppLcWUOhF0L862eXqTQanDLWQ0EQm0qmunjr2j0dhCdZMqFrpeSaALiEYLGA4liaVNdDQXS1YOoVJJl3smi8P2BVCCV1uqfJs2Ct9wojd3zT0VDSbU3DyHGMqTK1WWrCj99H10PSvUNeduzM66cZPlwMpZMqGCTUhqS+KdJ5gQTubp0SXF3PZnoa4fTWfJzuaZWzKgkz7RHaPa7E3FoFnimdrsLs8E4nZA0VE7FSQ9qncBB95K9xUHk4QeOtFTeGiGZbBo9IqDDl4Pdcx+dT/XobsxxRYFLHAX+AVyWUJExBbmWA05Vtus5g4x09gf51IoXGzp4dQlSqswXsMu+7WidHck9UCVbLpaRlY6ZlfAmG8TOWm0VwTSVrrSKA5YvIyiUJew1EnxNgbd8q3IHZe+Nl1uCVCvhNR1wioKak8NKTXyB3HZdSebHdKxBpvAJMOB5kr4GbZ+HkVbTOnMUW83xisVvG4j3HUV65qo6li04gj1t5+d/KiH2box/L1dQ8DlcF0XqgtX+kEDUXJ6TLgGYfeDd85Kx9vhS+kyJ26lyVnV28YadTsK2h6yZrY8VAfF2+9myy/cVq6cD1QSoOhcE8d8WI+wdt1FV7EoEL3coJ3pe9HyVWZY4NaOOKxTTBDPzjbt3hqeg+apGFthnpqzVXqbVq6aH6m8CsBHaPDUNMtXaLGuqV7QI/4b0mVVAk+i0JAcglp1zK7QrOW2iTuj3zyPNlSsqp3qVOtgPUKndM/TqE1EA3pUdKzrkR6fG6lPc1ujwAq3Qc0hSyt0ZmfCmrWlpi0w6D+NMyp4j1eauQNt1JtG9gAXrLD9JB5Yx3xQh5rDFWr05xobciEfz55Ohy26LGo9QT5EOCt0WL6YWi8bFvl9EuXVch3OiMTaqqsVNbTrzLHWDe+efEhzRb7kMuomcTeweZNs6d/kte3hjS4ZQokzcPm3tufCAXoqb5apPauvz1IwcRZ3r5s9C8yvyqD+4nXiMg9NyLoZQDfggyNX7qzyv5iOVRYmQYo1BubT+wjreu/uY1fEkNqb24dYVEHSK6Oo5gWlUGNVBVjrmZTP8QqD8lhelRy8bzStYmlQXC5Vw7/6fR5lennK42wqUteSxa5bEttWv/taFI3ymTFuPeiXMWDBXt4aCHaW3tHRwbinxgu9yXn6yo++IMaJPwMAoN/CK0U6n0yk/tJw4JJ4UHQV/8oZWwpjoNPzMP2lCOopZstRJoAj+PvdYPABEMAfWfgaeq0+TMGlPFXUfjFgA2fyZq1qXck0Y6Q7+rC//ir4Ent9wF5s0J7xZsL9Hs0iyUAlt9jgzcWNSFd0a+yMeMCzQ169gdXXO3JA+OEen5Xwqiaf+8afZqHMwxF9oabwHVC8jFJehxdK9ss6xtMq33pfxWulr+lhyPT3WBXsIt/6WwqueevuxMrBWY8qfCzYS2WSkh0cFhtcneB6PXV+WO44FHe09LR1yz6BHUUiHGB/mv2wet7tBLYFRvoP6/N9Acgn+5c3PVRww9LpBm/+qR1eHlui0STL7ae6SVHvTtI/SOBPYITKPxI3Yy4PTXq47NlTIapFoErcZhR182n+Nasrr9fgyC8SDquBbMWkl4e2knrXQF5o7Ouey3pU2LlQj4LQNUGDuF0YXQ+rHb/10RYDVwmbiXIIa9X1qBfZdL7VZrxutCouD8Sm6vhPOUTpW+JykKqfSEX/NseV0khrp2E7DnTS4+p2nAZt2nrUuzq57p/T1vKoVV0YQYWjN5FbVdrrFa2rVyUvG/z6wVd6uR/fYGLmCxHH9L8KGM9m33zDwitarRBVreLqlm+IhTeNxqiAFczRzUtulwHVVNCqjHT/bQhRDrkRjl31BZy5SFMr3zRstNZ9VcrVwSLujU9uW6EI3zP4sj7QBL2qSAiXG/mAhGjVkEeSZ21L1/4+Pe6w1m/m//r5TX8jf/SbXYWF3H8Bkj0gYQ== + eJztXW1T40YS/s6vmEtRZ5MykE3uEwl7S8AJzhGgWPb2UoSiZGmMFWTJkWRY7pL/ft09L5oZSbZkDMtucKU2xprpeeu3ebpn9N0/p+Pp2tr2l1+usS/ZXurF18nB9+z08JT5UcjjfIcFiT+bwDc29uIg4ikUxLJvpp5/411zxnS1fapBD71ZPk5SeMZ+8mL2Nud84sWx8+gHqHfDfvbuiSh74yfT+zS8HudsX3/7+qtXX/dYnobQVJyxHyfDwx48jpLrmPfYjzwFuvdQe3ttLfYmPINecadD364VA1SDYPnYyxnUBbKZHmImx7ZXGrQoP+K5PzbLs1GaTOAZZxlPb6EYlEYCU55mYQbP4dGEJbFRZIsNciAAVLKEDe9ZmGWzML7GEljTm07TZArDzTk7PD8/ZSn/fcaJVGJS+W6Yvpa9Nb7OX5QsjH18xNhXW1/TnPmRl2XsQA7nUI6Vf8h5HGRM/r32vzWsQ1OIny+N8Xtp6sEY4oB/kA+36f9+Emc56x+fn/1ydXCy/+5n+PqW7bKOrtqBZXHI+kkUcT8PYb6mXgqrmSNjlKienJ4PTo6v9k+Ojvr7+BXpFnUrCPMP3mQa8SZU+//Z+/n0qI8kZS2gh6Vcmgmswl0awjIlU+pyPc2Tf/fP3p8NzomqrldHV1AbgYikPJ+lsWQOlkSBnvj6ts765+/OoMmjA2xMUDiJgraNxfyueWPH/fdFY8f8DlfAbelHnjOPAQdewzpo6SLx8YyFl8VVrb0o9DIGSzZOAurlNc+/vx8E3Q2n4Jt8nCZ3Get/8Pm0gtAbWnqWgSKBEa4bnMY2Tb4LAwYNeqogtBjPJkPNMIrOJPzAA8bW1UAGAdLRwwoD+DcchaV6QlzYupj3jB5uylXwop58nozkT5mqPufz3fT1iaTmpZztNKkSha87V6AMolnABzHIAzSedaAneTrjqGjkM2KFUBZgXg6TMpzlPNtiB3zkzSKhlUZQmX+3DUSbt30dJyk/DAOYqD1N1uxBNk7u2JgKrLDhlN+GGeoIbGnMDUWmnrQiF45+9sAiILVhkkQcTF04YtfhLXRaEcSRzEB0J1iSGCrJGzeyPX3tMrKQMq2znYFIExW4hsmS4elsGIU+G81iwfQgVF1DJHomXyue1Cy7yy4uhfQJs4Af2af1fBxmm6+VjNaTVMQ2hFb6s6wu9sfcv8HJ9Iqh8Q9oUp35OIcm2V0YRcz34J+MR6OdHRzQhmbc6B7NMvORZIY0YVpSrgjcobzHQFwqDkaaJGZ34xDWK+XTlGfC1MXsH1/9Q9njrUUKiL0fI+vGIM7YHuNpmpAbAT8SocT3Z6k7nHo9tSI1NU9LuTwmeXou74y9rHahXTbJ03vjL1rxbbF2NHnsLbFqMYOwVEAHKvkkQSA4bMiR2dKQ3/LAolTwXn13pGPgcC1qnG/1gz+Bj1BQu25n1vlGRec5KV3+YYrtwUqIpQXdZE+hUFVWbRhcd51Tj/eTgAO/7u7uYm23GaOrROVb6+mfa26ffpuBgYYKOKXWMzHJ6+Zg1+rkbzlzXQijaEvIWlHfhz2AWMQaNbVQql7M+pwqf1mz/uh22PUdzk2uDjMpn8A70GyYizZ4to3MLr/rfmw9P+O/wFo3cABQmYFsTRMwBmbVznZng/0N9BqtqavZ3kRg0M2GWc9U19ASKNYIlSPQcVW5IvKn/rYeeLlnz+GuYRfUpHXfpVG2s/Pu7EjvTHussa9CDcmfLoDjM9zvXLJdpZtrfCI/5bCj/wHWZQ9n832Yj/cTkMAPMH7sdhOfqFond7Ugi22SuzMinSx3UCEBEuwuSW/GSZpxe0sFKoFhbzXmgV4TlucBgiQa/rFZsp2GnqWRXpxNg0U3M1CuDNYEjAMWRGdOWfgXNW9XeVHzn7uaV4tWo/4Fny2j+9MkB1HBUob614oRpXOeKmxgCNbH3At4mqm/sYyhOIUy9ILgPPXizKNGDqlGV9W0OmC67JbYM0O3T7wbvq+fdeuqm6qHqoMdOOTRlKc7O8NZGAXwt5yCi7o5uDSsANo8mpGrG35/JTanXc2jhkJnf/87KxfUfGaUdA0k7RG0sVGkL2mngKJWtVVQ83jRGYw2dQXW+aLDtgzLpZu/hJ/hobOrYByEcxH14yTmyzfh7kKIPGy2p1CZW5YbLGUsF3dDbvEEp8rOmMtMU6aoUOHDPJ8aO6xvyjsssVlByFOA5dqWdTva04J9Lm1AfTCD1zzY6myUtlH4UVbf6sFPGfZ8nl3PQE+DLQYlgtztDZNZhanPHn//ZdNbzsa3Ry22HELSPi/GLdyKyiqsS1HBh5usnbFwaepR6UrsgZZhgVb31FcfHEQv1JC8n2A0IudMcL208uopqBY2lpyuWqh1+FHlzoPn9FB3YYUilDQ1oeKH+fgf9q+tk61aLJqa7weDQ+ttkr+PLuzjeMU0S0/hFVu2aVmveFVgYWO0sFTPEhDlFRcE1ONHlNkHOVCapRa5TMTfi3yl1jL0F/OcivlBeAAnBN0kPUfqx0qPSGmI1t6PbnPFLs9cuhVIRYW/Y81vnetjcl7h+7gdZQ4x2xsSZboV9S46yoDQ2Oq8qAqMQxKo1di0S53wgLIatBzBHpBiNmTcbHykKKQdFJEO4gvQpFqdrhvSq3+z9+J1SJqruH+10yd+dRzDRSqiBdzjqoErJTP7lJuhmcH+vWIR7AI7O04fmuNMb3PY3ZuBN1ioRU5nSPExD8P126Cg09yfUb3Mu0XHG21myqeR58NfW8APWQ4sg1DJ2LslFyZhASZmTMKYy9BbIpzXb/SsEmowy3hPtZyF4BHdsynOk6XKsWEchGwZHDJyikfh9QxGhs61bCLmigtdE9LclcYhBowyKGiAwZJBDL3V0FpTLvBmaXDQKlgCDmYGuoF/4RRwaeZ1QXSMpK2rMdkly1DhNyzwGiQm5qBi7MHAGH1cdExkOjWsi2COkIHCxCGoI36TLnUxWPLbKS8L1/Wey3hzYxynaPTOC/MfkvTtfexje0g647RuuGfvYcsoKhEwzCS5BRcpAUvqiWESx4UgHl6cA2sjewEZ4J84xAVGMQmzG7bNBiPhlYaiv9mU++icBZK8PbpOBtJFyBuRA7IodrCk1Bxy03QKCi5oOdj6AIVgsE1kIVj1Qmho6gsHViSkvdr6au6GRYhyWTwsf0e7WQ2jFZoKWbcBwvhdwl/K7obZSI1bgp85KMKeI1a0Yfx9FqZiSTOpcM2kKwtgwI8T6EXrjOup7QNp2mrvqzKIQUSKScjUJIhITXWoXDZaiXw4U9UCY9mLhaihmqnSrzg7AQLZiZwjg7HnozBiZpThqZ+PCiMIMsjT3FSnsgMNwBfQzSWV7agbYRBF/oFREgQ1DGrpNrJEyxkfbREkY8zfSy6wCUpU/5CyaNiz1dsybYBkzw0ztAoT9DAj9JHM0F/MEMnhFpm1VYMVEqQEToq3lGmpIYrxO5lnd+C/C1hGjY7wNi+CNQzuZWLaUn0ucmZrF0im48IiSPNp9kvMmkIfH9AFzBGe2wXl3da3DtXBOx/NgI9i6O0d1pxlpCh0rrSIW7Tu5xN5GoIraq1om/jXR4dvdO3WG8p1UqxGSRlPllpwEJ/S867tSshZ6bGLkmdkKyIxhtfCXSuXzcIIDaHxE5Qlp6SisCHyReEuYocb7I2ORImkUDcZ/7KCniELTekVCff1BEm+WxI87r93CF7qv9yAVzcEk5kbocKSwbmkKOT8An/8Ya9offxNcEK3+F2yhh7D/ll/77xfimdKkpH33/t9pwOO0AkWrPbuCI+0QEiwGjwOBFsiFlkOPiAyt01YXXUz1nSG2ZUnIRMpIuWRUOxht9AOZgZpBZBYKk/zuBdFIBYD0jrvplCEd2uG3CAuOk0yHRgVRX7LkviKx34S8Ku7FCcpFSjQRjV+iOUFj9YEMHXR7W0ZQQENBO4goip0QApm744D02PQZEhA7gQa72kEBj2E6wQUbko50SItO7nh6oiUzNEe8ii52zJb2/dmOM4dEzoyDPTgoKdyce1zLNQJWGXwIIe/wVzZI+BsECic6XsseYolpR+q84zxlBZCREgT94oYFEJjkVs9fE/jHnpZ6FPKedEPICcaZ5h33sO5SVKM4OFsoP/h+xRcoWpgQYuOM+q58LktvzkMLIZdH+rOu0unh9Ut8bDaJenKVUl16mO1t1gVgjJpoN/qeoSMWLvJbCCdJp2LEjAqTqX9q//LZbWsRYnvSUjBnssj+UAabiei8TddsU1+QSjy2kchiIJuWEd41bFC1Y2a/e46ULEUopHVMwgQAlZd7xadNC2+jQPI4Nm/OMzxoik09UclFUwtnUdkcFBP40zGVeZTOOv/+7KUAgIzgjEkB+YJylIwZ3F+hIXBEGQMe6Mw0IvgJk3ULUoTcEVxaqmbCpjAf11sYtAYm1CHEksgPcW4pbu7MT9fYC6wVOUSM8cnttGYBT52GZlxBi/spDiy44JGYWxNQq8IWpMSFxs/lTVxhXoVpE5hBKB8r1J+K+L9CEOgAtZwnGp+L8+RJOEiaED0DjaR+2CZVID5QjJXiInNxy2eCYZ6r7Ze1SI8MzE4S9dbp4eXxoYEZRcdgs37NIHVxmPIat8nDip1UU/gnGAuRJQM6Ts2MrsWW+GS86dSLHSChARyjKPUCOnQHINAzXBIeU/0F3wSsJxcHuRCJ0ARI7dC7D9ljDVxxpgnm0O+qbenMpsj8yZcmU0M81ASweoiM2LxbR4Rfa1dR+ArOjlWToGoiKE8DLpqn1VMSIBgBYQBZP8lbwiUbpYRCgs8BQsFvfGTeASPc9btEMt0eqwDahm2bsAyx++OjtgFOjMS77ncaLjnp57ccD49hv0hAWXCHZtJ2AkxqXQGzerLCih2SJlRWiMUOcdUHh1GYLZceoVhKhiQAoq4DbUTkymJuYtdMOkQnCFFhEIAbcbjIHHOkEAX+ya+JpwAl8/lmhQYlcLgOKbHqIXR8mI0yUaRdw3iB0qQQ1Go5A0jLg5UUyYTKLTUhOmaDq0elsEdLuayRXfefWYhcIaewn2COHyJ/DPXCInBVwaBWp9PFbTEoRfL7ha7UbTAvYqzI2aVjQV2a4WGywHg46C8E3ixTM/VMsnxPYZhUql/DkTYPmJTJASYZ2Ls9L8WgR8nhWHTNZQi+0Lmt4qpMDQtrlKhn0scsiDz4OFBnyXO5LDnZEF1bz4jK6rH9HlaUhreU1vTBcc+V2JrSfDbJoM/klVdmBTeWutaibGbyyRtv2juF81d0ZsXzf2pa+4FJxAerNHLOcdC1S46l7CkVn+Jay+Ma+++rgzNLYyVvt8bnF+9/eV4f6MiflwoAkahY+KUcjEraD4nXi5Obp/x26wzj5xShorcUuN6d3qwd96/Oj05Guz/UjU2K9i+yjj7qkLsVkRBhtgFD100HDaF3W1+akmAUk6Fk3NKq7Kz0z87OzkrOurmrJonj2x8Q4dTnDRQHB6dwKGIiapeebxG9t5kJOPyi1JxfbIkHG1O5KmZVRybKWUALHMMaXEegVSmpWSEgoSbhVuOyptaeV5YflFewPyY/a7qSunAMZVaPqpWGvJHjf+Wruyq2BGcyWS+ZSNERdkc+12La6mkwUeAxFQw4/PBxJwgjXl0+kmiNU7GsTPBzzcQo5jso0ViPk+v/QmxFnX6YCVwiiRmxy5WHah4iAJtEql4yuDC2YsmXV6T1hwTfH4glaPdX1Cn5VCnVeh6yZhChJ+PwqcxPrnSfxKEfdb6RsPHMgaPDrAveTPKi/6aLxcv+uvT0F9PcQciY49wDeIzAchni684fIHHPyl4/Dni3mf906O9/U8a+Fbf2+De9rCXAb4dCo2Qb7MFG8auuIby8RHtJe6+VN8MsLb5UTEby2YruJurklBTXLwBHD5bzRm1F7zb8NAnya11X1PpmtD2MPdKsVbs3/OHWj92zvtqvFfnIoeP77k+6a4bOW1VSCvSag+06gKF1jEfN9hvLyXNbXDXVuif44Uuu3e2N86td86SiHHDKLMuGZ2Tgo1CJNKjqlWQc2/ZQ7fTy2ymn48i+rxV0UdQRotehFa6Jba1ooLZzfgDrltehUZaMfC3GthvRaDfwyA/RcTSXKtRXCvGAV8U16emuJ4eQRO6pv3V188AQWt75/ULGLYSMOygf9R/iiTQh+NXVk+Xga9sAu3zNp97FqYNET2H7Mtm0Ezp6qaFIJWwuvUXrRMVAqLmw1D4WQjxLNuJJtCQmFnrxvVrbl8cEihvrki8SZ0ClLRS49BV34s+fwvoOFEnZ/Pjn65dUzf+GTTaGrbw1rqIvm4775oowxOsvPnLuldYXp7pc/AvFPXyLWKVFJ1LYByGobuG8BakEF/ZVVDAC9xgzFfCI616MooSr1wFik/sH1F1dTptbsrZFwlXXpTz1L04U7zLyFitBZf2Fj154esH83UFCuVyteOtuRcpteLnVkcPKl+bJYrVrvwcbMr4I8YkOLzgqAnk85He4OjewHh+P6WLa79Q8/YFjuBr2jsUiY2tdw7YVu3DL/AdRtTON9QO/rlkGxV3fOKtrJ/fjcPGTqx2n9Tggsu6138UhQ7l+6Z2hcp1f+9WOw7VmxjcUlliXX4fYSU/znk3oXZCcyxIL4ypvV2UaFXftlfdGZOZmvTBLG93xXpS2YPKt9J7ec4nU+Lcyou67W6UFk298HfhrabqbfML3jNv6LYJKChgYXnYFy9KF7dQG0OTA4T/fIxwXtGNbzosIru4s0MPe6zzK3gA3jWPM/XSm+GvTlm02P8HXsDLdQ== - + - ArangoDB PHP client: Base URLs + ArangoDB PHP client: statement - + - Urls - \ArangoDBClient\Urls - - Some basic URLs - - - + Statement + \ArangoDBClient\Statement + + Container for an AQL query + Optional bind parameters can be used when issuing the AQL query to separate +the query from the values. +Executing a query will result in a cursor being created. + +There is an important distinction between two different types of statements: +<ul> +<li> statements that produce an array of documents as their result AND<br /> +<li> statements that do not produce documents +</ul> + +For example, a statement such as "FOR e IN example RETURN e" will produce +an array of documents as its result. The result can be treated as an array of +documents, and each document can be updated and sent back to the server by +the client.<br /> +<br /> +However, the query "RETURN 1 + 1" will not produce an array of documents as +its result, but an array with a single scalar value (the number 2). +"2" is not a valid document so creating a document from it will fail.<br /> +<br /> +To turn the results of this query into a document, the following needs to +be done: +<ul> +<li> modify the query to "RETURN { value: 1 + 1 }". The result will then be a + an array of documents with a "value" attribute<br /> +<li> use the "_flat" option for the statement to indicate that you don't want + to treat the statement result as an array of documents, but as a flat array +</ul> + + - - URL_DOCUMENT - \ArangoDBClient\Urls::URL_DOCUMENT - '/_api/document' - - URL base part for document-related CRUD operations REST calls + + ENTRY_QUERY + \ArangoDBClient\Statement::ENTRY_QUERY + 'query' + + Query string index - - URL_EDGE - \ArangoDBClient\Urls::URL_EDGE - '/_api/document' - - URL base part for edge-related CRUD operations REST calls + + ENTRY_COUNT + \ArangoDBClient\Statement::ENTRY_COUNT + 'count' + + Count option index - - URL_EDGES - \ArangoDBClient\Urls::URL_EDGES - '/_api/edges' - - URL base part for all retrieving connected edges + + ENTRY_BATCHSIZE + \ArangoDBClient\Statement::ENTRY_BATCHSIZE + 'batchSize' + + Batch size index - - URL_GRAPH - \ArangoDBClient\Urls::URL_GRAPH - '/_api/gharial' - - URL base part for all graph-related REST calls + + ENTRY_RETRIES + \ArangoDBClient\Statement::ENTRY_RETRIES + 'retries' + + Retries index - - URLPART_VERTEX - \ArangoDBClient\Urls::URLPART_VERTEX - 'vertex' - - URL part vertex-related graph REST calls + + ENTRY_BINDVARS + \ArangoDBClient\Statement::ENTRY_BINDVARS + 'bindVars' + + Bind variables index - - URLPART_EDGE - \ArangoDBClient\Urls::URLPART_EDGE - 'edge' - - URL part for edge-related graph REST calls + + ENTRY_FAIL_ON_WARNING + \ArangoDBClient\Statement::ENTRY_FAIL_ON_WARNING + 'failOnWarning' + + Fail on warning flag - - URL_COLLECTION - \ArangoDBClient\Urls::URL_COLLECTION - '/_api/collection' - - URL base part for all collection-related REST calls + + ENTRY_MEMORY_LIMIT + \ArangoDBClient\Statement::ENTRY_MEMORY_LIMIT + 'memoryLimit' + + Memory limit threshold for query - - URL_INDEX - \ArangoDBClient\Urls::URL_INDEX - '/_api/index' - - URL base part for all index-related REST calls + + FULL_COUNT + \ArangoDBClient\Statement::FULL_COUNT + 'fullCount' + + Full count option index - - URL_CURSOR - \ArangoDBClient\Urls::URL_CURSOR - '/_api/cursor' - - base URL part for cursor related operations + + ENTRY_STREAM + \ArangoDBClient\Statement::ENTRY_STREAM + 'stream' + + Stream attribute - - URL_EXPORT - \ArangoDBClient\Urls::URL_EXPORT - '/_api/export' - - URL for export related operations + + ENTRY_TTL + \ArangoDBClient\Statement::ENTRY_TTL + 'ttl' + + TTL attribute - - URL_EXPLAIN - \ArangoDBClient\Urls::URL_EXPLAIN - '/_api/explain' - - URL for AQL explain-related operations + + ENTRY_TRANSACTION + \ArangoDBClient\Statement::ENTRY_TRANSACTION + 'transaction' + + transaction attribute (used internally) - - URL_QUERY - \ArangoDBClient\Urls::URL_QUERY - '/_api/query' - - URL for AQL query validation-related operations + + $_connection + \ArangoDBClient\Statement::_connection + + + The connection object + + \ArangoDBClient\Connection + - - - URL_EXAMPLE - \ArangoDBClient\Urls::URL_EXAMPLE - '/_api/simple/by-example' - - URL for select-by-example + + + $_bindVars + \ArangoDBClient\Statement::_bindVars + + + The bind variables and values used for the statement + + \ArangoDBClient\BindVars + - - - URL_FIRST_EXAMPLE - \ArangoDBClient\Urls::URL_FIRST_EXAMPLE - '/_api/simple/first-example' - - URL for first-example + + + $_batchSize + \ArangoDBClient\Statement::_batchSize + + + The current batch size (number of result documents retrieved per round-trip) + + mixed + - - - URL_ANY - \ArangoDBClient\Urls::URL_ANY - '/_api/simple/any' - - URL for any + + + $_doCount + \ArangoDBClient\Statement::_doCount + false + + The count flag (should server return total number of results) + + boolean + - - - URL_FULLTEXT - \ArangoDBClient\Urls::URL_FULLTEXT - '/_api/simple/fulltext' - - URL for fulltext + + + $_fullCount + \ArangoDBClient\Statement::_fullCount + false + + The count flag (should server return total number of results ignoring the limit) +Be careful! This option also prevents ArangoDB from using some server side optimizations! + + boolean + - - - URL_REMOVE_BY_EXAMPLE - \ArangoDBClient\Urls::URL_REMOVE_BY_EXAMPLE - '/_api/simple/remove-by-example' - - URL remove-by-example + + + $_query + \ArangoDBClient\Statement::_query + + + The query string + + string + - - - URL_REMOVE_BY_KEYS - \ArangoDBClient\Urls::URL_REMOVE_BY_KEYS - '/_api/simple/remove-by-keys' - - URL for remove-by-keys + + + $_flat + \ArangoDBClient\Statement::_flat + false + + "flat" flag (if set, the query results will be treated as a simple array, not documents) + + boolean + - - - URL_UPDATE_BY_EXAMPLE - \ArangoDBClient\Urls::URL_UPDATE_BY_EXAMPLE - '/_api/simple/update-by-example' - - URL for update-by-example + + + $_sanitize + \ArangoDBClient\Statement::_sanitize + false + + Sanitation flag (if set, the _id and _rev attributes will be removed from the results) + + boolean + - - - URL_REPLACE_BY_EXAMPLE - \ArangoDBClient\Urls::URL_REPLACE_BY_EXAMPLE - '/_api/simple/replace-by-example' - - URL for replace-by-example + + + $_retries + \ArangoDBClient\Statement::_retries + 0 + + Number of retries in case a deadlock occurs + + boolean + - - - URL_LOOKUP_BY_KEYS - \ArangoDBClient\Urls::URL_LOOKUP_BY_KEYS - '/_api/simple/lookup-by-keys' - - URL for lookup-by-keys + + + $_cache + \ArangoDBClient\Statement::_cache + + + Whether or not the query cache should be consulted + + boolean + - - - URL_RANGE - \ArangoDBClient\Urls::URL_RANGE - '/_api/simple/range' - - URL for select-range + + + $_stream + \ArangoDBClient\Statement::_stream + + + Whether or not the query results should be build up dynamically and streamed to the +client application whenever available, or build up entirely on the server first and +then streamed incrementally (false) + + boolean + - - - URL_ALL - \ArangoDBClient\Urls::URL_ALL - '/_api/simple/all' - - URL for select-all + + + $_ttl + \ArangoDBClient\Statement::_ttl + + + Number of seconds the cursor will be kept on the server if the statement result +is bigger than the initial batch size. The default value is a server-defined +value + + double + - - - URL_ALL_KEYS - \ArangoDBClient\Urls::URL_ALL_KEYS - '/_api/simple/all-keys' - - URL for select-all-keys + + + $_failOnWarning + \ArangoDBClient\Statement::_failOnWarning + false + + Whether or not the cache should abort when it encounters a warning + + boolean + - - - URL_NEAR - \ArangoDBClient\Urls::URL_NEAR - '/_api/simple/near' - - URL for select-range + + + $_memoryLimit + \ArangoDBClient\Statement::_memoryLimit + 0 + + Approximate memory limit value (in bytes) that a query can use on the server-side +(a value of 0 or less will mean the memory is not limited) + + integer + - - - URL_WITHIN - \ArangoDBClient\Urls::URL_WITHIN - '/_api/simple/within' - - URL for select-range + + + $_trxId + \ArangoDBClient\Statement::_trxId + null + + transaction id (used internally) + + string + - - - URL_IMPORT - \ArangoDBClient\Urls::URL_IMPORT - '/_api/import' - - URL for document import + + + $resultType + \ArangoDBClient\Statement::resultType + + + resultType + + string + - - - URL_BATCH - \ArangoDBClient\Urls::URL_BATCH - '/_api/batch' - - URL for batch processing + + + $_documentClass + \ArangoDBClient\Statement::_documentClass + + + - - - URL_TRANSACTION - \ArangoDBClient\Urls::URL_TRANSACTION - '/_api/transaction' - - URL for transactions - + + + __construct + \ArangoDBClient\Statement::__construct() + + Initialise the statement + The $data property can be used to specify the query text and further +options for the query. + +An important consideration when creating a statement is whether the +statement will produce a list of documents as its result or any other +non-document value. When a statement is created, by default it is +assumed that the statement will produce documents. If this is not the +case, executing a statement that returns non-documents will fail. + +To explicitly mark the statement as returning non-documents, the '_flat' +option should be specified in $data. + + \ArangoDBClient\Exception + + + \ArangoDBClient\Connection + + + array + - - - URL_ENGINE - \ArangoDBClient\Urls::URL_ENGINE - '/_api/engine' - - URL for storage engine + + $connection + + \ArangoDBClient\Connection + + + $data + + array + + + + getConnection + \ArangoDBClient\Statement::getConnection() + + Return the connection object + + \ArangoDBClient\Connection + - - - URL_ADMIN_VERSION - \ArangoDBClient\Urls::URL_ADMIN_VERSION - '/_api/version' - - URL for admin version - + + + execute + \ArangoDBClient\Statement::execute() + + Execute the statement + This will post the query to the server and return the results as +a Cursor. The cursor can then be used to iterate the results. + + \ArangoDBClient\Exception + + + \ArangoDBClient\Cursor + - - - URL_ADMIN_SERVER_ROLE - \ArangoDBClient\Urls::URL_ADMIN_SERVER_ROLE - '/_admin/server/role' - - URL for server role - + + + explain + \ArangoDBClient\Statement::explain() + + Explain the statement's execution plan + This will post the query to the server and return the execution plan as an array. + + \ArangoDBClient\Exception + + + array + - - - URL_ADMIN_TIME - \ArangoDBClient\Urls::URL_ADMIN_TIME - '/_admin/time' - - URL for admin time - + + + validate + \ArangoDBClient\Statement::validate() + + Validates the statement + This will post the query to the server for validation and return the validation result as an array. + + \ArangoDBClient\Exception + + + array + - - - URL_ADMIN_LOG - \ArangoDBClient\Urls::URL_ADMIN_LOG - '/_admin/log' - - URL for admin log - + + + __invoke + \ArangoDBClient\Statement::__invoke() + + Invoke the statement + This will simply call execute(). Arguments are ignored. + + \ArangoDBClient\Exception + + + mixed + + + \ArangoDBClient\Cursor + - - - URL_ADMIN_ROUTING_RELOAD - \ArangoDBClient\Urls::URL_ADMIN_ROUTING_RELOAD - '/_admin/routing/reload' - - base URL part for admin routing reload + + $args + + mixed + + + + __toString + \ArangoDBClient\Statement::__toString() + + Return a string representation of the statement + + string + - - - URL_ADMIN_STATISTICS - \ArangoDBClient\Urls::URL_ADMIN_STATISTICS - '/_admin/statistics' - - base URL part for admin statistics - + + + bind + \ArangoDBClient\Statement::bind() + + Bind a parameter to the statement + This method can either be called with a string $key and a +separate value in $value, or with an array of all bind +bind parameters in $key, with $value being NULL. + +Allowed value types for bind parameters are string, int, +double, bool and array. Arrays must not contain any other +than these types. + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + void + - - - URL_ADMIN_STATISTICS_DESCRIPTION - \ArangoDBClient\Urls::URL_ADMIN_STATISTICS_DESCRIPTION - '/_admin/statistics-description' - - base URL part for admin statistics-description + + $key + + mixed + + + $value + null + mixed + + + + getBindVars + \ArangoDBClient\Statement::getBindVars() + + Get all bind parameters as an array + + array + - - - URL_AQL_USER_FUNCTION - \ArangoDBClient\Urls::URL_AQL_USER_FUNCTION - '/_api/aqlfunction' - - base URL part for AQL user functions statistics + + + setQuery + \ArangoDBClient\Statement::setQuery() + + Set the query string - - - - URL_USER - \ArangoDBClient\Urls::URL_USER - '/_api/user' - - base URL part for user management - - - - - URL_TRAVERSAL - \ArangoDBClient\Urls::URL_TRAVERSAL - '/_api/traversal' - - base URL part for user management - - - - - URL_ENDPOINT - \ArangoDBClient\Urls::URL_ENDPOINT - '/_api/endpoint' - - base URL part for endpoint management - - - - - URL_DATABASE - \ArangoDBClient\Urls::URL_DATABASE - '/_api/database' - - base URL part for database management - - - - - URL_QUERY_CACHE - \ArangoDBClient\Urls::URL_QUERY_CACHE - '/_api/query-cache' - - URL for AQL query result cache - - - - - URL_UPLOAD - \ArangoDBClient\Urls::URL_UPLOAD - '/_api/upload' - - URL for file uploads - - - - - URL_FOXX_INSTALL - \ArangoDBClient\Urls::URL_FOXX_INSTALL - '/_admin/foxx/install' - - URL for foxx-app installations - - - - - URL_FOXX_UNINSTALL - \ArangoDBClient\Urls::URL_FOXX_UNINSTALL - '/_admin/foxx/uninstall' - - URL for foxx-app deinstallation - - - - - eJytmNtu4zYQhu/9FLxLG8T1NpfZFq0iax11ZUnRYZsAAQxa5tpCdFqSShMUffcOKduSD6S0aX1jw+L8H2fIGQ71y2/VphqNJpeXI3SJDIqLdTm9Rf6dj5IsJQW/QbeYERQHDoMRYtDvFU6e8ZogtB9vyqHyIa75pqTwDP2BCxRyQnJcFPJRUlZvNF1vODL3v64//Hx9hThNQbBgaJYv767gcVauC3KFZoSC9RtYT0ajAueEAZscYT/upx+WOUFLzNLk7HzPzJalRSIc+fDTtYTgJeMUJxycx4yhmGZs9PdIeCMR4nMptAWFoApTjr6Ct6syqXPQHFOSYU5WyAziKSorQjFPS/ArsMIIJTgDuUZkIr8TeMaF3mLqmfHcciP0K7qYLHCVTnaaF+Bf7wTIak3eD7emM+udYFBFlMD6kZe0WAvNgiRiEmJGOl7YAuXQwbQ1xdVm72uvb7PA8O9a1nqDYa9lCpoEvRDKyeueIHm9HN8IosUXK4isBwFrNHSUk1X7Ds5uvYT94LglZZbB0sCOGB4803Mcy4xsz20j2OoMRqfFqhPQXqrtTpsoNkBpfYa13NallpXUlMHXDtSmgMq9OAi9oOOatFe4JRfstSqBNRhgPfhe0Mnpxl4DMO4dAclw2q7SEIpj2O4BRij0cL7VhL6hF5ylK3ywLXqB97EVPLY4KaSBMSI2zHj5NiavOK8yovTDmPtOpxKxVIyetIYayNeUMt4D+GQHYaTEHChoSPJAOqtvuI8nqjBaN+s6y6BQcNWEY8eBihKdznVrp5CmJC9fSH/EA2vufbEWt4/KoJwoaZxpxz6TN9XeaZGfrcdQwxMaGlhdwa4d4GLsT41I6+KJktZFyKxkUGQhJ82e0B5racBZWT7XVU9sHc/7HPvK2B5q9CesaJeU/hnu7IxLwqJfGGq/KoMc5zSDMtVxfSipiwzono/Jzu6/RcO1jOBEuiBYd5YMkP3Tju66dX0r/FfKN9rqvuvgEIyH80Z1zM4PD6dmsEZ2iXmyQRUtE8KgcV4rdG+NyOx0XNJKowr9dsFwojtvIthtoXHUh3TsQF0YKCPNSyr6f1Ks00J5+Lgz2+3s6Gaw7hhY5WkhmkUGM1Btu+ncdkVbGB5MfWuk3RwUBiFaKgtMIx1aAagvAm9fX8SsJo35RJj3esDTXM+I7PmBuDDoVYULnFbU8WZdTRg+qMNrxGlZc3HbgIalxCstJ/DiyHZnUI8dz5h2kVuRSSPyHXTGoTliPE2UxaZZmsiI7DCyzfBgZfbG7yKOV4QlNK14355r6YupFZqB7Xey52gmXdFBsxLdYw17DNqXokncAUG5h7MYtiv0NO5RJuNv2U5oEF6ic1xATufyIn8WKGAtQ9j8j+JQkURWG85BPRJ5ffZueYohxaoqUyjRvSjLnfqe3X0zsLMdBILeBst/e0HQJxm3Rth9E7C1HXSRoITVGYeLXbJR1RN5b1iYhnlnHd0extJM295nBHo+kaqqHRb7nRQXS14pEnuvWb6+jnFVwf0Utm+Wae88n7yHB7iZQl7tWxSZRkJkshUYwlqRLk0Hi10Vri5a4D+jkXxXtYB7HGY/iDdWNzfynyt08bR7sfa0ffe1fBIDLn78OPoXdMSYIA== - - - - ArangoDB PHP client: connection - - - - - - - - - TraceResponse - \ArangoDBClient\TraceResponse - - Class TraceResponse - - - - - - - $_headers - \ArangoDBClient\TraceResponse::_headers - array() - - Stores each header as an array (key => value) element - - - array + + \ArangoDBClient\ClientException - - - - $_httpCode - \ArangoDBClient\TraceResponse::_httpCode - - - The http status code - - - integer + + string + + + void - - - $_body - \ArangoDBClient\TraceResponse::_body - - - The raw body of the response + + $query + + string + + + + getQuery + \ArangoDBClient\Statement::getQuery() + + Get the query string - + string - - - $_type - \ArangoDBClient\TraceResponse::_type - 'response' - - The type of http message + + + setResultType + \ArangoDBClient\Statement::setResultType() + + setResultType - + + string - - - $_timeTaken - \ArangoDBClient\TraceResponse::_timeTaken - - - The time taken to send and receive a response in seconds + + $resultType + + + + + + setCount + \ArangoDBClient\Statement::setCount() + + Set the count option for the statement - - float + + boolean + + + void - - - $_httpCodeDefinitions - \ArangoDBClient\TraceResponse::_httpCodeDefinitions - array(100 => 'Continue', 101 => 'Switching Protocols', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Timeout', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Requested Range Not Satisfiable', 417 => 'Expectation Failed', 418 => 'I\'m a teapot', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Timeout', 505 => 'HTTP Version Not Supported') - - Used to look up the definition for an http code + + $value + + boolean + + + + getCount + \ArangoDBClient\Statement::getCount() + + Get the count option value of the statement - - array + + boolean - - - __construct - \ArangoDBClient\TraceResponse::__construct() - - Set up the response trace + + + setFullCount + \ArangoDBClient\Statement::setFullCount() + + Set the full count option for the statement - - array - - - integer + + boolean - - string + + void - - $headers - - array - - - $httpCode - - integer - - - $body - - string - - - $timeTaken + $value - + boolean - - getHeaders - \ArangoDBClient\TraceResponse::getHeaders() - - Get an array of the response headers + + getFullCount + \ArangoDBClient\Statement::getFullCount() + + Get the full count option value of the statement - - array + + boolean - - getHttpCode - \ArangoDBClient\TraceResponse::getHttpCode() - - Get the http response code + + setTtl + \ArangoDBClient\Statement::setTtl() + + Set the ttl option for the statement - - integer + + double + + + void + + $value + + double + - - getHttpCodeDefinition - \ArangoDBClient\TraceResponse::getHttpCodeDefinition() - - Get the http code definition + + getTtl + \ArangoDBClient\Statement::getTtl() + + Get the ttl option value of the statement - - \ArangoDBClient\ClientException - - - string + + double - - getBody - \ArangoDBClient\TraceResponse::getBody() - - Get the response body + + setStream + \ArangoDBClient\Statement::setStream() + + Set the streaming option for the statement - - string + + boolean - - - - getType - \ArangoDBClient\TraceResponse::getType() - - Get the http message type - - - string + + void + + $value + + boolean + - - getTimeTaken - \ArangoDBClient\TraceResponse::getTimeTaken() - - Get the time taken for this request + + getStream + \ArangoDBClient\Statement::getStream() + + Get the streaming option value of the statement + + boolean + - - eJylV9ty2zYQfddXbGc8I9kjJ5FvbZ0mjaM4ttu40dhKX+KMByZXEsYUwACgHDXTf+/iQoqgaGva8sEX7sHu2YMFdvnLr/ks7zzf2enADpwoJqby3VsYnY8gyTgKcwyJFAITw6UgiEW9yVlyz6YIUC0YOqwzssLMpCIb/MYEXBvEOROiYXpP6xKuYTgryIEzJjJfKj6dGRhWf+29GOz1wShO0YSGs/ndeZ/MmZwK7MMZKnK9pNXPOx3B5qiJGDY4veyUyQ0zpjWMFWGuCCqFxjKhJ4k9ma3mIrEmgMGzfcckaQnzvWMRjod9dkgWqVADsmQGM2QpKmAaSC+mFFtC7x6X8Oo1LFhW4DZghnMX0C0ufbxZMOXx4c1z9ztXfMEMwtatd6zhFXz+QjI0KIxnCDNjctCGmULTNqfYFoFXgdf80+ohrWr3rdgD3Ml0CXICxv5fab4eQ9MWW7Vbw1gn7SHMMkfr3qVB269pm/61e+fkFXRLft1HYvE5/WD3KMBI0ChS2q6UskqQLxBYlR8JRmY6NKlu4zLJJHtMUBtjbEOsU/ikMbWBMynvocidoilOuOD2YMKEqpeqxwnx2EY+WSphK99VLl3ZeLQt7hcvbD12h1IYLgrs9mumgTNdP3CTzEhnGClpZCIzXUPtBQcff49e+qVDhUQjjSx7znKSJJg3TfvO9IcUuyfu3HIqYLsHF4JkmDPLPsIfBDxY9nSOIuOhM9JJRdNqP3L2EVOGs6wFsR8Suywyw/MM6eaQPEEdQXyal3JBmzhytxY5yZYRxif8XhYijd77bK8R4SNtuopsZWYGLmXKJxzjpT43Kh27Jd/icD862xjnuVRMLeEKU07FXE/tIKT2lqVk/lqgjq0+q0/C3578ryj6QUhoxJb27nIOKEAM2Q85qzuepigi2yq3piYHIbFLpLgpWMhJlsmHhvOjyoGvInaXYQTwEjhpwFYS0eSJK592tj+FUnFKwJgOqyxiRX4uD8kk47GUAy/lmRQRh4HX8AOKqZm1Rh0EGZW7Uvxpf8941kDtR9xOKROzhLGU8IGpaRzyoA7d/XR14XFSTCNYKB6hi5xKhM4gXFKJMBjTfRkBj+r+CHZFTRLdrlyTmHrCm8IPvPCn33KqN/ZYRl7ti5vunC5XgyyXdUEPQ21e0HlUgk7mNaoFddFTpaSKcIOqDC7muW+kUaTDUKi2ys/oGnpgy8hanj+1oGMNVO0L4tpI6TBUa1jfUhuHoWbPx+MR/Eld2WbtNCrlDeCWTn1NV1O48qsmY+x80bzlc6bYPIwQsFW2f9h1S/3rslsGY2Mp9Xr7/1bZDsLSZlsp4b6vwpZr8/bx8PC6DGWtjYXh2aoaXtyWijs6PjAphJs64faWSp+cFonplVn1VyT7nkC/5m7b+fneWQWacb37upqIgJpb6enlOqrM3qGqIacJq7K2MD+kNCEVIQupdXeL+Xttn89on6sRsDE1NTas0lOhKZRo6+0NEadozr2LXlOd4KMh0lMsq6Ko6LUNHcHv2gDZwiyIvJFatBkbuFlKtRmpyc7MlHygQd/N8qffbIdYoSrybaPj4/xX49NaJnwCvR+4pjGj18ymNnR9DrZIky/b2zVH9nHcQeBDk36PLkT6aOBpTYJcyQVPMX3W3V5VaNDuCY03stq0CVVt1C6A/ybvW3KwqTRWB3BDWYTvBPfx8L9Y2Ua4iZUNsolV7cvCjvF2Jblx3XQjhfJK2cijefcQHfehekvFwnQv+lw9PnamPnRvyk/vm/Dpe3cTIW1F/QNKpHLw - - - - ArangoDB PHP client: admin document handler - - - - - - - - - \ArangoDBClient\Handler - AdminHandler - \ArangoDBClient\AdminHandler - - Provides access to ArangoDB's administration interface - The admin handler utilizes ArangoDB's Admin API. - - - - - - OPTION_DETAILS - \ArangoDBClient\AdminHandler::OPTION_DETAILS - 'details' - - details for server version - - - - - $_connection - \ArangoDBClient\Handler::_connection - - - Connection object + + setCache + \ArangoDBClient\Statement::setCache() + + Set the caching option for the statement - - \ArangoDBClient\Connection + + boolean - - - - $_documentClass - \ArangoDBClient\Handler::_documentClass - '\ArangoDBClient\Document' - - - - - string + + void - - - getEngine - \ArangoDBClient\AdminHandler::getEngine() - - Get the server's storage engine - This will throw if the engine data cannot be retrieved - - \ArangoDBClient\Exception - - - mixed + + $value + + boolean + + + + getCache + \ArangoDBClient\Statement::getCache() + + Get the caching option value of the statement + + + boolean - - - getServerVersion - \ArangoDBClient\AdminHandler::getServerVersion() - - Get the server version - This will throw if the version cannot be retrieved - + + setFailOnWarning + \ArangoDBClient\Statement::setFailOnWarning() + + Set whether or not the cache should abort when it encounters a warning + + boolean - - \ArangoDBClient\Exception - - - string + + void - - $details - false + $value + true boolean - - getServerRole - \ArangoDBClient\AdminHandler::getServerRole() - - Get the server role - This will throw if the role cannot be retrieved - - \ArangoDBClient\Exception - - - string + + getFailOnWarning + \ArangoDBClient\Statement::getFailOnWarning() + + Get the configured value for fail-on-warning + + + boolean - - - getServerTime - \ArangoDBClient\AdminHandler::getServerTime() - - Get the server time - This will throw if the time cannot be retrieved - - \ArangoDBClient\Exception + + setMemoryLimit + \ArangoDBClient\Statement::setMemoryLimit() + + Set the approximate memory limit threshold to be used by the query on the server-side +(a value of 0 or less will mean the memory is not limited) + + + integer - - double + + void - + + $value + + integer + - - getServerLog - \ArangoDBClient\AdminHandler::getServerLog() - - Get the server log - This will throw if the log cannot be retrieved - - \ArangoDBClient\Exception + + getMemoryLimit + \ArangoDBClient\Statement::getMemoryLimit() + + Get the configured memory limit for the statement + + + integer - - array + + + + setBatchSize + \ArangoDBClient\Statement::setBatchSize() + + Set the batch size for the statement + The batch size is the number of results to be transferred +in one server round-trip. If a query produces more results +than the batch size, it creates a server-side cursor that +provides the additional results. + +The server-side cursor can be accessed by the client with subsequent HTTP requests. + + \ArangoDBClient\ClientException - - array + + integer + + + void - - $options - array() - array + $value + + integer - - reloadServerRouting - \ArangoDBClient\AdminHandler::reloadServerRouting() - - Reload the server's routing information -The call triggers a reload of the routing information from the _routing collection - This will throw if the routing cannot be reloaded - - \ArangoDBClient\Exception + + getBatchSize + \ArangoDBClient\Statement::getBatchSize() + + Get the batch size for the statement + + + integer - - boolean + + + + buildData + \ArangoDBClient\Statement::buildData() + + Build an array of data to be posted to the server when issuing the statement + + + array - - - getServerStatistics - \ArangoDBClient\AdminHandler::getServerStatistics() - - Get the server statistics -Returns the statistics information. The returned objects contains the statistics figures, grouped together -according to the description returned by _admin/statistics-description. - For instance, to access a figure userTime from the group system, you first select the sub-object -describing the group stored in system and in that sub-object the value for userTime is stored in the -attribute of the same name.In case of a distribution, the returned object contains the total count in count -and the distribution list in counts. -For more information on the statistics returned, please lookup the statistics interface description at - - - \ArangoDBClient\Exception - - + + getCursorOptions + \ArangoDBClient\Statement::getCursorOptions() + + Return an array of cursor options + + array - - - - getServerStatisticsDescription - \ArangoDBClient\AdminHandler::getServerStatisticsDescription() - - Returns a description of the statistics returned by getServerStatistics(). - The returned objects contains a list of statistics groups in the attribute groups -and a list of statistics figures in the attribute figures. -For more information on the statistics returned, please lookup the statistics interface description at - - - \ArangoDBClient\Exception + + setDocumentClass + \ArangoDBClient\Statement::setDocumentClass() + + Sets the document class to use + + + string - - array + + \ArangoDBClient\Statement - - array + + + $class + + string + + + + + No summary for property $_documentClass + + eJzFHNtWG0fy3V/R5nBWIpGw47dgw0ZgsJWDwREi2azjw2lJLdTxaEY7M+KSxP++VdXXufRIArLLgy003XW/dXUNb/65mC2ePXvxzTfP2Desl/L4Onl7yD6+/8jGkRRxvseynOdiDh9hBS76YcHHX/i1YMyuP6Kl9JAv81mSwjP2I4/ZRS7EnMcxPRoni/tUXs9ydmQ/vXr53asOy1MJAOOMvZuP3nfgcZRcx6LD3okUdt/D7hfPnsV8LjLALUpoX1vyj5I45zIWKZsCCYC+99Mp+89SpPea9PNFLpOYR2wk4wlb8BRA5iLN2BgWjwRbZmLCbmciZjLLljK+ZvlMOCgsT1gmcFsuEBw+VA+maTKnX294tBTZLj49vhPjZY5AuF51K6OIpSJbRjmTMXw9XqYZUDoSuGqcCoA72dW0DmciFUAH8iHniyTNeZyzicwA5BjZgG35rQBa89sEvp9OYT2syO8XImPJ1Okt20N4b5bRAf0fyQPvGVDNc7ZIk8kSJAu4eJrye9w/ScZLtYTjKiFTQ3vv7O2bUcpehOFNEhYnDqwFRRteKErw8wlwL+74fBGBtrkDw7LleIZ4t07OB0yw/plZxgbHw8sB/LqlxKlRILAg8RL+U6TvolgNG1rpuZI7LvQgIEALBGgDexEcaDLfWZNZTNRuWJDh9yPwDjQUtIZMpDdgjaN7Yy3Kp3Y96dlP75NbAYs7nlVtaV6/Y9+y7zS/vlhDDCM4x3OHjZa5W3sr8xmKGkwOpJmNecRTZbasjajj5XwENL/aISPeerWFNohYOa6SEyeBLFE2q0zcfk2+IHNF7pTLqJbdIUhomcbEraKTjDafATbFvYxBig6uEsw0iaLkFjHGQkzA2hIENkITi0XVzucJOMa9J1IAaaT6p+J6T4mXfd0qGAdRn2MoAOAcAbKAvLVAtwjaFuM5RDOQuCi5CMQWomPrahrxfIslFIsoUpGpWNMHEiE6yTH8rpzpPlkiey0giqsoy8jAUPalvZr4oin7dkymAE8ZEqFWlH3Sxvea6A5WM8bA/3L3FQXlccSzDKK8yRB/PsPIT+EYfyiKsXESx0KFrGT0O3zSD82aH27AAo/sIv31C/p/kcobFMT2lYMCAb8GC4V0gCT5KBIZ+aMKxiqqV+RcR8QhwPiZp1mAhJF+XE8ABPNUBYAc4kQm/wCH0s4EOtCacWaTCrAT8HjIQ7AiTZbxpAvfLHbqCJvLOzEJUYX4LgBdgCyAnKO6r1k7myXLaGLCElBAHpjkkBHLlGa1dIySJAqQMUmOCNM++HyUPTExTF7HSWoSciTnMjf0sUMAy1MxXUbPAQeED+1ZQEUC9IGIUdy2tKHwtMTwBwFsbmN0JieCds7lHxz3Z883FAAQEK0hAhWHshy5qcNQeFLGQZurcLdUSFFylZD6Re7nESNEimmljAeMU1qlUNChQG9tdFMToJgSZP6CxzLnKuhVCL2SKoVegb5cCHUkp2KeoK/YQuuBVpohEeiaQTLPPNtDD82wVBtziN6QiwSfRAnk92SMpduGuA28ffayivaXmQC2AG9KOnDKG0PVAVaqnGVE0RQ5t+FgXewEZwO8xmgc5tFSwoflgk3uoRaHBBVF96ruQYOag3ZU2WNAq2KH8cUiwmyGisfaGqscxm+gMMBI3UHMFjKsl6kAsEnsF1BTmWY5oTKwKTNbvJCVUgrqRFKbNLuxZRCw1/Rt2CYyAfKfZKqYU9W7MdEvYpGX6JbT2vxswEKsGsnra4GZiauNEs0TDyg2iaiqZCKmHPOHKtQkOS7h6MITOPIYa1AL6lifJEsQd4D5PI/qOa8xj4JB8hEcTPSRKQf1UYDHExWHYiWNAzGuKYaAXZzHv6i9YS/tLaAIvpNz3DSH2AAGS1nBVLLgs6N7CCA7qoTi1pliKsQKaupi7DeA21yDAGW/RLahmNBhaC60kjRCXRcTXjGptTdp64wynwrGKdFMAaFO+jkkrYyr0gkCZJsqGYkCjtHSa1E25o88vetPAF8MuaoqVGWdQzhAbgrY7axC/clLeFjZirsCDIxnOTs+Gw5+vfrp8njwK5DXIm21qrBUftUJvhnW0fnl2RBhkUnWwDp0dVozpMPe8Oj9Rf/fxwjNVls1EAc2YTSBg+PHoH98gcB0RqgjrljNriCwf/b2596AQJoatVVvUSfgXmj92jkpEwfhnvT6p1fnZ1e/9AZn/bN3CL7gngEcH3x/zGdgG7MkUhW4bsYE8H04/nAO/532P/RJc56P1IjoBGxYF5QrDOLk8vTU2YOt0wLkX1AicEVIkNyL4eC49wFBqtwRgDccnq4BDFcBJAjEHqsu3XmBwMIKxoMa6IPe2UXvaNg/PyMsDlyNYPsqB0l9YA2dmDAtbU94zrEfAWeY/L7QRsNe2UKMS8dvcafy+HSZYl4xsJQCM3tKo9W7JYQ9vxGG3EHYTl1d4TcjXMaFIH2rc5hXmrjnfhMJNgLXeUP/iFFfEcoTn/g4ibu2+0HJYxfzZlymQzf44BB+b/O5xCcGEJyll1RGzSoH+wKZlrhd1tctE52L/OoLStYOE14T0msxIAJ14soK5Gde16as7gSAYSUnc6ix5jz9UiKRZxokdWd8oKrEb9H5oFVUuVdeKmuRZNHKsMok/ADBJLnN2PHdWCy8VoF9Th1dr5XAtr3eQ1dVL+4LsFBtrCUAqnFCP8rA1U/XV6f2EXVWZLiqmBmh2JJjMHPdq726IndMl+O8XU9fR6MljMqTVTeFyEAldw+8Jgi48bbfEimvNHkAvoJ0L25tb6O9oz0ef6BAbcsMTmFtQvspE9F0b89Lxp93djwyPASwhxJ7eKOj6av9tBZiFVebMKsQ3bDVx70WTsoOTSgpY4Q3bozQFhVNSA9NsdEM4MGShqTThH6YR6FNm/Ora5QgPmuxhLoRwgbIXeoPI/YbN208muwoJ/x0RAe8ApCNRG32a9vsnfWHTQr3mxO1dJTgPFjtugINE+I6FXCQyg0ZdSDWUkWR/pPTXpMyVA+pgX/a/wC8R72j9w3CV8faRswKwoPFXiqnG2RQOgMXSGqC+GDS/Mo7TFfxzBoyjQKsjeOEV6l+3mH/+EcNAn8JJGJIyvFYQM2msgKIbOjK2xAr5iDcDL17cC3y/qRdibBf685+5jpr5X2H7nUfNdQmhY3msJ3k8B02QU1VcY15yexpl4sGjaZaO7wO8KBurFdV/VIXiYsk8/uFxStPrPFTUbnh467WZcq3ds3dCbbSxqrBUjhEyByLfOGDWbcudJIm8I0FmiqURUWIaKvPZXal+hdtI0ziueIoRAdVW+rOzBLUbukuiK12ue6ItOqzma07943+qEf6Fr4tFHDbM8En2G/bZ588Z0OqC6ZepvTFC/AcNLFSj6noLBr4p9Zdl9P9SReAdeWk9dnRpeDXM6GyCHMNLvy5nckI75rTpajID0RU/IbAgNoXUD0LD6kz5u4BGmL7Mo2yvb3LASTqy8HF+aBjlpZ8pHvwe5bEV9ipnIir25Qv4Oiq4tBOx3Lsi9j8aFsi7ZI9tavEdByxhPnHDHEWaKGtahAFanFP+yQ8cAHsSrUvyI2s/bDtiqycmlHI337LDvbL+btuC4mZzHRbvK48/VqPQjGjaDoCubV32PP9ffbq+xAGMK9X3+OhdMtemUyEil5bjyYJgKOh8Gsu42f1S22Uroa4RQTbiiGulZlzMkganpfPlQ+LeUWQ/p38xvFL39PTl6HwRXxVwpc7v9YHErtuMx87/tfH017/7GFO9umz714mS9X4zeuQFn/GQRSO94NPkKqw53SjAFJ7rahF70l1uOJvUKTGV01Ef5Mm6bD+/9JjP75Jvqxbb9BFNfYY4bPN1rusl16bTh3Oy+GcAA3RraUY+1w1fmjMgm3z9DqDkoxbyGgiEmhVt5gde+WnsYXqO1XUdL3SRRc6jRZwdSVJLG2io7mos3IIlXS6LDXVBmxfACV4U6rKzGmj8A0nenPXXHvSnEvNIEOIoTy5UOXTihJVjzfUs0JXItxNbVo3brIcWDlLJlRYCkldYLxCBxPCQU89CaeY2/4i1G22aeTZUU9z6Qp00ie6slabvSErNEtsYZjd5RFT3A4oOmqngqQnP88uT08rzW6ccxN6hkkPdaIZlsGi0SsOOngT0DH71XVvh65aFVsUsMBd4D+QyxIiInaMx2pmttrVNlfSmcb+OJdC4WIHFYd4UVqFaS12PqgVpbsAqweqZNPVMrLSMbsCxnyTyEmjvSKQttKVRqEuTENN2VLjytsYdMt3Indc+tp0uSVAvRJS1wmrKKgXauatkT+Iy64Z3OyQjjXYBCYZDjQXws+w9eNN2mJKZ6N6uzFeqeB1G+Guq1jXs1bHtxVHvb/9jOdHPczWjeHv3RoCLofrulBdmBAJGoiS02PCNQh7EJwnUDreDg8clDlxK03Oql4l16jbUdD2kDWz5aHaL042NFt+4Sp65bipkgBF55o45sN6hLXrSwsViwLRy81tmjYjLV9lhgVu7cTMOsUE8exs0+6t4TlonoqxFeapOVult2lljuCRyqsAfIQGT8zdxAot1t1hFPSI/4Z0WZXAkyg0JIegVh2zKzRruW3izug3z6MNFatqpzrVOliP0CldqzVqE9GAHhUd63qkx+dG6tPc1iiwwm1Qc8jSCp3ZEcNmbWWmif9EzqjgPV5p5sq5UW8a2QNcsML2k3hgHfNBHWoOV6jRH5NtyIV8PHs6Hbbobq71BPkQ4azQYfkecL1sWOT3SZRXy3U4IxJrq66A1Ay4M8daN7x98pnfFfmSy6ibxN3A5k2ypX9x2raHN7pqCCXOwF3r2p4LB+ipvF6m9qy+PkvBxFncvW72LDC/KoP6i9eJyzw0cO0GPN08FU64ubPK/2LYWlmYBCnWGJhP7yOs64O7/l4RQ2ovyh9iUQVJr4yimheUQo1VFWCtZ1I+xysMymN5VXLwXpBbxdKwuFyqhn/19TBlenSVORWpa8li1y2JbavfvWVHk5PmrQA9V5kxYMFeMhsI9tUMR0cH456a5vRexKA3yPRFNg5YGgAA/QYeKdL5ZCL1O+iBy+xh0VX8q3FsKYyBTs/D9Ds21FPMlqNMAEfw+/vh8CMggF+y8HX5Wn2Ygkt5qqh9z2QDZ/JG22pdyTRjpDv6sL/+KvgSe7PPXm7QnvEG/v0ezSLJQCU3ggapr0W6oltjXwAIeHbIqzew+npHDgg/3OOzEl7V5HMvkGoWyjwc0vtZhVeK8TJKeR1eKNl3v4ynVf6IwipeK31ND0OmX4tWsIt86zdQXPPW3YmVgzNB3GefCvZSGVxl+wfFBlcnuF6/UnBQ7jgUd7T0cHvLfgM7ikQ4wP6rCgfV824nsC3wvsZBfb4vAPlsf/PmRwpuWDrd4M0/tcPLo1U0SmW5/Vw3mOvdSfoHCfwJTKz5R+JmzOUZVX9ExZw9FaJaBKrEbUZRNw7oX7O68noNjvwi4aAayFYM1nloK6l3DeSFxr7uuaxHhR3D9SgIXRM0iNuF0fWw2mlnH20xcJWwmSiHsFZdj3qRTedbbcbrRqvi8kBsqo7/lEOUviUuB6n6AWD0b3NcKU0Qdxq24/wsfV3djsO3TVsPexfHl4NT2loeuKoLI6hw9CZyq0p7vaJ19ajkZcNfP/pKL/fjG0zMvH9yRH+kwng2zZQGV7RaIapaxdWFEbjCk0ZjVMAK5ujmOrfLgGoqaFVGur9CQ5RDboRjV30BZy7S1Mq3DRutdV+UcnWwiHvrk9tWKML3DL6s9zVBrysSwuVGPiAhWnXFI8mztqVrb4++7rDWb+ZPR/2m/8DD6De7Cgu5/wL9fMYY + + + + ArangoDB PHP client: exception base class + + + + + + + \Exception + Exception + \ArangoDBClient\Exception + + Exception base class used to throw Arango specific exceptions + <br> + + + + + $enableLogging + \ArangoDBClient\Exception::enableLogging + false + + + + + + + __construct + \ArangoDBClient\Exception::__construct() + + Exception constructor. + + + string + + + integer + + + \Exception - - - $options - array() - array + $message + '' + string + + + $code + 0 + integer + + + $previous + null + \Exception - + + enableLogging + \ArangoDBClient\Exception::enableLogging() + + Turn on exception logging + + + + + disableLogging + \ArangoDBClient\Exception::disableLogging() + + Turn off exception logging + + + + + + No summary for property $enableLogging + + eJydVF1vmzAUfedX3AckoGJJlkfaZu26qtVUaZXSx0jIOBewRmxkmy7VtP++i8NHgtJpql9sfM+599wPfPWlLmvPm19ceHABt5rJQn37Cs+Pz8ArgdImgHuOtRVKQsYM0jUzhsAt/qZm/CcrEGCg3jmWM7LGlkqTDb4zCWuLuGNSOhNX9ZsWRWnhbjgtF5+XMVgtyKE08LDLHmMyV6qQGMMDamK/EXvueZLt0FBsnIS9HDK5PyMaGoNbsApsqdWvjgqmRi5ywcc8++yuMr36r0SNkLw1ASxmS6fwEG8UgXuLcmtgM1x5v72W4OS261gyJw1WN9wqPeusPYiEaLYDMgtZuDufSmFI2gQhpIVu+Vxtp+ZRCPi1xlehGtNB5m6vm6yiouSN5A6VpoOqsA8J1xAE8cE/nRfxWbdkkU1VRc7tIet2iRxCg1WeJD5KllX4pIqCkoqOMO26Qa2VTmkMwgJt6iob+rYUJoIZBAkEtPWKosv3uMHaUgtpvGhqkmCCy5VGxksIcV9XlExI85/e/3ii3NpAn1YU+aVl3pq1q3wYRcAM+AKuV+BXQuJU9jQ8fTqhDnsa/Y83noYjtan9+5Jzde9KHo817jx2/KOhemm0BDeAfV+qQ5nPNdtYZo97ftKXcNrAc82jXpNU/LeaPP+YnK0wH9CTs8qcCqq1eGUWe//vMQjthi1llWAmHCY7Sdx1DMGmf6w23aOQjfPfjthfI0+USQ== + + + + ArangoDB PHP client: base handler + + + + + + + + Handler + \ArangoDBClient\Handler + + A base class for REST-based handlers + + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string + + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string + + + + __construct \ArangoDBClient\Handler::__construct() - + Construct a new handler - + \ArangoDBClient\Connection @@ -20379,32 +20609,30 @@ For more information on the statistics returned, please lookup the statistics in \ArangoDBClient\Connection - \ArangoDBClient\Handler - + getConnection \ArangoDBClient\Handler::getConnection() - + Return the connection object - + \ArangoDBClient\Connection - \ArangoDBClient\Handler - + getConnectionOption \ArangoDBClient\Handler::getConnectionOption() - + Return a connection option This is a convenience function that calls json_encode_wrapper on the connection - - + + mixed - + \ArangoDBClient\ClientException @@ -20413,21 +20641,20 @@ This is a convenience function that calls json_encode_wrapper on the connection< - \ArangoDBClient\Handler - + json_encode_wrapper \ArangoDBClient\Handler::json_encode_wrapper() - + Return a json encoded string for the array passed. This is a convenience function that calls json_encode_wrapper on the connection - + array - + string - + \ArangoDBClient\ClientException @@ -20436,25 +20663,24 @@ This is a convenience function that calls json_encode_wrapper on the connection< array - \ArangoDBClient\Handler - + includeOptionsInBody \ArangoDBClient\Handler::includeOptionsInBody() - + Helper function that runs through the options given and includes them into the parameters array given. Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - + array - + array - + array - + array @@ -20473,21 +20699,20 @@ This is only for options that are to be sent to the ArangoDB server in a json bo array() array - \ArangoDBClient\Handler - + makeCollection \ArangoDBClient\Handler::makeCollection() - + Turn a value into a collection name - + \ArangoDBClient\ClientException - + mixed - + string @@ -20496,19 +20721,42 @@ This is only for options that are to be sent to the ArangoDB server in a json bo mixed - \ArangoDBClient\Handler - + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + + + $collection + + mixed + + + setDocumentClass - \ArangoDBClient\Handler::setDocumentClass() - + \ArangoDBClient\DocumentClassable::setDocumentClass() + Sets the document class to use - + string - - \ArangoDBClient\Handler + + \ArangoDBClient\DocumentClassable @@ -20516,108 +20764,136 @@ This is only for options that are to be sent to the ArangoDB server in a json bo string - \ArangoDBClient\Handler + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable - eJzlWV9v2zgSf/enmIcAdgrHbtN9cppcvbGbeJHGge0ucGgLl5ZomxtJ1JJUGu+i331nSEqWZadxc7k9HNZAUUWc/7/hzJB68690mdZq7RcvavACuoolC9n7GW4ubyCIBE9MB1gYiwRCGWQx/g1LloQRV0hOHG9TFtyyBQcomM8tn11kmVlKhWvwC0tgbDiPWZJUlt4h3y28ZysrFN4GMl0psVgaOC+ejl++Om6CUQJVJRou4tllE5cjuUh4Ey64Qrkry61FEpA1AK9ax/imXaslLOYa7eQVE08Kv2+UvBMh18CCgGsNRhakde0CILRRzAiZgEgMV3MU50MwWXIfIx8ayIyIxB8oriSkaym6N4PWXpHb4UYQMe3lXHpF/N7wJNTg/679WSMO6xT9XkDIDRORhjmGWnN1hzz4T6MbnqJt/w9kog0MbyaD4fW01590B1djOIW6Z6+fWKqq8AtuwKDzTjD6qI1U5BFPFiLhniynniyFhq8iipBHya8g5pbZ0ULIDIMAk0MamHFQHLHmdzysCHlreTX07wOemrUbxToyZiqBWNzzEI4As07OfuOBAbcgkkVZq0gwMDErCcoj/5qiXopQms0iEcA8SwKbBAtu+lZG49DFxYWefgcKsw0DyjGCBwa9PjpD6nOZJNzyNg7ti8YHFelO58Poatq/vhhc9w9PChHei0KSZfhFE68j+lb7PhgVlB/BwBPvE/+UKRbDTMoIDvLkOoKJyjhtGrQSGMRScZ95CELuwxORxG1HoCGU+eNSRmGOY1GwNv3NUXz1OIpjG69fHXuj8OkU5izS/LCKbaYiXFtD1+29H1xPf+2Pxrh1TmoFIUa2EHZYErAp5JJHKVedDktT3Mc3FFuNrxtE0YSPxf6D0zMsfhn/XMqRb7UfzjgSW5JwYDcd/U4fSLW93MmTlaTtNK9M8LHukap/3jOTlYz2LCVE+Yw15PuZV7IOGry1aMGH617/He7jHnam4XDUG1x3J8NRE3o/j/sjzJDDSnIet17ul5wj1NHYmYkevGo6On3T0fCqf/I3JskmzhSZEsiPoGxEvCfKRPmMKIcSw84tyv6xjDIp04bF6VMLywQFbGP3wx3C4ToZvO8/BzTk1f7Q4JC1HzJI+BzAuBbDlGIrOJCWRLtW7t7JOeRvzZIZ7DRz6uW2AnCdReZIc9OpSH2Tng09E8Pu1HkzU2fFWiTO6llqZB3VuEghFXpHDuFAhm5oyFJqcIzeHUXoVtSCa2m4M6F4CXGmrfcSLZLzzps2yi7ZUFY5RywiaMPLTSJ85krhvNaGV1srX5mbYdpwvLVGwwwuvN5aCPksI5afNlfam+bUrQN1wBhAJGJhdAFqHgMMAL1C37SPeogjFGyF44t98wUhC+ELBfaLDXqcGTaLVji1BlGmxR1vbZlal/M5okdAgL4VqdU3FwqD6lZyW3awahy50fzCfsubZPEMcxhzxgGLFhNYJY+IbZc0w5Rx0Rg9kBI6C5bOYdQkVCF4BXiWSIyYC9SMO2WhODNkBA7sv2eIOWqNRLhLqbQ6SekYH3MACnO5wDcKmA5wXKA8wJ0XCuWqBqnClSbpwbNMiQRjIbR9RwccqVx5k7nZaEoJPKtTILBxKjUdiSDADZvQWUsEaDyyc7XLds5UsLTIDRNE2Zecqgt41MApohjEDR5hfHtttVoPJWi1aLtCUKoJ5Zp9x5SQGRpuUOwsM6gU4bc7t0OeNV3CNtfFvenMoHS1NknamCyWWUJpt4H5jM9puk0Zzv723NB6ame4kotGpcidwsfPj/T5hybGaqu4Gl40C8GHT54CfuhEUu0jIx5JFm4eEZXEwzFl5fbJi87RAe0xjPRigVMiYqacCJkPeFvMMFcytovTfDWQUeSc2Xds9Hyl1kVanzxS0OnoB7PCaczHPWvP9tTwAFy4TbdHhdHww2RwfTEd9a+GXZxI6/UdaNKRYt8pADeKEdqIQK/hdWXREhWrZXBaFtOi8LqTeFECtjjnYpFhfjWxYMosRQYj0dklXQs5jdXiZUuaEqkPoVczW8HU3se017KPSpTFjn2HhRLNMAwRatru7m5/mLcEMu0GuHWSWctAr7ThcRNWMvPNSXNKOedQNjtynuZ6nO5ZXp+8DIN1xLZPJ81WH5G4GryW4StahOdrusMpLBK6JAFpihDlRS/fM5ohNd2AtQZ0wNfcFcOQ7rOIEAPS9LPTBkybKLmSGNiKiArtQ6HSl82ySKyzek2pN0JurwfKW1gm1UzIbWlCGnGyOZLyNku3U83fxG0kAjPVfRmJ5BZgaUyqO+12KAPdYvbiIJy1Ahm3LyeTm3Z345avm4TvZSIwxAhbWyQhv28tTRztV1JKNj7fScU2i+qa5nRLWDSVcaG4t45I43CLyxel1/u1qrXUx46h+7an8aQ7GYwng/Nxk3re/6o/+bluI33kFoTlyrIzJq11Onyv3DG3K1BBSbitBtrv4tL2de/Le2wnu6+Z2/x+4Z+788ol///3WLrAaGURTrRmRaM11n/AYNmhlvoBgxIBmeAXmzgRZ8rR2KemTaGQrdw7enDdGc1kaBw1FM+7Y7b3yVS31yR5FhbtGoGMGXpHETIcDxM3UmtBVyl5dpJvlATrfYza/43dE3GxPtmxz98f42OevFULqzK2LY14sjD2FDKY2/78lSV0J21vjbB5CjKYMInZvYixpzmGYtdbCjxG2QzHIfS7ZrI7JiJGjm4MPWWOIFOKvpp5LnsawiDZ5ohbCDv7hhP/Wc1/xkJfbh//vVPKug1Me/3x+Whgv0D93QeXb/7b2pRFgulG+Qtbp2NXcH7+lH98/OS/Ocw+lQlpvP4LCNYG2Q== + eJztWG1v2zYQ/p5fcQWMxglsp+tHZ+maul2TYWiMxv0wNIVBS4zFmhIFkoptDP3vO75IpmTZTouuKLAJRSOTvLvn7jnekfr1tzzJj47OTk+P4BQuJcnm4vUrGF+NIeKMZnoIM6IoJCSLOZW4yKx7mZNoQeYUoBIZ2dV2khQ6ERLn4A+Swa2mNCVZZqcika8lmycaRtXb82e/PO+BlgwVZgreprOrHk5zMc9oD95SidJrlD47OspIShXapg2z5xsPHNyIE6XgHlG8f3M76ZuxuPRBNZ1ocUGxLDLePRs8t5bJTGlJIu0VX/lo/H1kvLSmzXMK12kupIbONBZRkaK2kQNSZJFmIiOc6bVfe2b/Fgj2dbiWzDhFdxp6RyLLqFUBYvYZ3/xEOY++SJIGy2pGcskeiKYIK6oWoI0WI+hlgV4SyOhyw/l+U9DZaIU+BD+0gBk1LsZ1HR5VMeMsqmIDU4POAei2az+xci7o5unohKn+i8AruAjXn9uVX7YcfU91IRFeQkO07YGVbu0odHGfYBlxoXEMk65yb071Rkm36Yo3s+1R5cMOJ0gNSR5wDxPUBfjPLnmgGWY3JnUFSCcE85lwruCzEtkUZ0VMp0tJ8pxKEM0AtedBx9l8hzsTIzNBCTdgyJclxAfCC2q2447opmyFoXKBdeLHyglVK3UixVLBXX2z3rk/b1YRzVvSfj8JN1akG3iwn5UGg3agRcdhxky4wYU7Bsx4ls1trTLuEynJGnKsBDQe/FAmneXOTMRrz6R9RR6dPmAZvhsDO1j0nvSdf/6XuLfGnSqDc0mUd+87c9vietd685Ws7tbTYPZMi1gMofvyHnEvUrKm8gSihEYLYPdo5R4bhrBBIDBjGlIhKaRkQRUo7HR0MBg0U+SKcsNYnVlZYFs0MSrmSbBFFMwZ5gJglUZqIl7E1CyjqSPKLLTEUo09z7NrJaq0usn4ulJmTRFEqKhGDdDxOi+t4JJxboq5H9xOTWF0mSTe0ue6AHqswcOqjhmKygd0F62hZGpypZA8RN3lbEHheEmY/l3I23UWHffgeEFp/q7gHN+pjjCMJzDYm9MlJvuEVaqMiwWbCB6rWoARr3fYYKxHtN1SLWjOUmAhpvcsQ5aWCYuSAAIu4lwsMZtdsMoo9yy5SyOKxpk0CkjBtS+oTA1syOmKpDmnw3qgLl5gL6U79qqHa7ErBOp+IwFB8I1qcz5hpmYhMd+2X+ElpiOVePaBWqQq05N6otrkdQEKqdiVgDvLgV/oCrS6zsbWXlmpVa+VsQv4+GnrlOGRmrnzahSDQwlirBQC1rXOgqKOF9Cx/JwESsyDRaFrjU5x2ZSumNKIB997dRQnTcFS2Km/uIBmD1PD4c14cn3zbvph/Ppy8mY6vvnzevRXmx7zfMhjPA6OBR6/1sMhYmXmd9ejPt+S+bI14mPy0SD6ZA5dVnRb0qJ2yWpwZ7hpd4HaUhmGxI0eQrb55c985tkQVWP6UWw92UWX5/wnZGofBU++loIdrD4i6mWPdRr/b5z/WuP0p0lzPvHNkrOUadMm1YLlP2GLtEfB8glb5FdW/v9e5310r3tlsmHT6WzIH9/wfnRrs/C+pZXA06dtbeJwnasb/E6Npix5RvmuLw+T8D5s891c6Tj393fzfauZNv6w1X64amwFd4/2UepD+RGqF9rA1HJXs0O3uHZcO3PQ1OdRJVK2qEZqBSSyTGmC11jM/I1Yk7EyplbE3tXMFbsbdL4vB3SXH9cOa96guI7rFrYoDlK05Z5/GcdIq8ZarYiLTUJJjOXaV/Fqx7thc+TF2ztud11d8wNhPDcLbG3EKtpbwkt1WFM47mCssnYjGjb9VHu6BESjaIYVc51Tgy+Y6EYkM/XxVqPmFFVONghHteQS6KI8OZQtJI4DDVcWnqsg8LR0pBdCa82kAGBA+X6MzUQorX08XvWJ7a99LVd9Fh9/cl8TS0GbJBO5amaH+x/zwH4bnuIZjaiu/0I8HNpBbMZ35Qfu8tY0u/NrjlHbP3VFJs0= - + - ArangoDB PHP client: document handler + ArangoDB PHP client: mixin for $_documentClass functionality - - + - - \ArangoDBClient\DocumentHandler - EdgeHandler - \ArangoDBClient\EdgeHandler - - A handler that manages edges - An edge-document handler that fetches edges from the server and -persists them on the server. It does so by issuing the -appropriate HTTP requests to the server. - - - + + DocumentClassable + \ArangoDBClient\DocumentClassable + + Add functionality for $_documentClass + + + - - ENTRY_DOCUMENTS - \ArangoDBClient\EdgeHandler::ENTRY_DOCUMENTS - 'edge' - - documents array index - - - - - - ENTRY_EDGES - \ArangoDBClient\EdgeHandler::ENTRY_EDGES - 'edges' - - edges array index + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + string + - - - OPTION_COLLECTION - \ArangoDBClient\EdgeHandler::OPTION_COLLECTION - 'collection' - - collection parameter + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + - + + string + - - - OPTION_EXAMPLE - \ArangoDBClient\EdgeHandler::OPTION_EXAMPLE - 'example' - - example parameter + + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use - + + string + + + \ArangoDBClient\DocumentClassable + - - - OPTION_FROM - \ArangoDBClient\EdgeHandler::OPTION_FROM - 'from' + + $class + + string + + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() - example parameter - - - - - OPTION_TO - \ArangoDBClient\EdgeHandler::OPTION_TO - 'to' - - example parameter - - - - - OPTION_VERTEX - \ArangoDBClient\EdgeHandler::OPTION_VERTEX - 'vertex' - - vertex parameter - - - - - OPTION_DIRECTION - \ArangoDBClient\EdgeHandler::OPTION_DIRECTION - 'direction' - - direction parameter + Sets the edge class to use + + string + + + \ArangoDBClient\DocumentClassable + - + + $class + + string + + + + eJydUU1PwkAQve+vmAMJSlD8OhjxAwWC8UTClcQs26Hd2O42u1MjMfx3t1uoFAoS59Jm5817897cP6VRylin1WLQgmfDVagHLzB+HYOIJSq6g0R+SQVzbaDxHmiRJe61H3NrYZ4pQVIrHktauPmcopdy8cFDBCjZ+p7IN3lGkSNy9cYVTAgx4Ur5ltDpwsgwIuiXf1cXl7dtICMdobIwSmavbdeOdaiwDSM0bjoX7jCmeILWaeOWbPfXXBBUN67ztO2ixoOVSuT2rs9vvDQZLgkGmyx8FiP7ZrlPL56Xm/zkBqxzo8IS7lLOkyQNmcUVsOO/qdGEgjDYif0BmtPqXtM1XbPrZw8pDwNn6yhVdMi9ijmNU9tWmiA53gghOGCwXCvlhifrxRoF8lAy0DNImVE1aVdMZLNYivLYYJEqAyeF1KkHF2fKq0GRtGePO2kX6G6JW+3g4cXrsjb1MgvcE/nBHPbd6f8ZDNf3/MP/5t2P8c6W7AdpWkd8 + + + + ArangoDB PHP client: vertex document handler + + + + + + + + + \ArangoDBClient\DocumentHandler + VertexHandler + \ArangoDBClient\VertexHandler + + A handler that manages vertices. + A vertex-document handler that fetches vertices from the server and +persists them on the server. It does so by issuing the +appropriate HTTP requests to the server. + + + + ENTRY_DOCUMENTS \ArangoDBClient\DocumentHandler::ENTRY_DOCUMENTS @@ -20645,42 +20921,81 @@ appropriate HTTP requests to the server. - + + OPTION_OVERWRITE + \ArangoDBClient\DocumentHandler::OPTION_OVERWRITE + 'overwrite' + + overwrite option + + + + + OPTION_RETURN_OLD + \ArangoDBClient\DocumentHandler::OPTION_RETURN_OLD + 'returnOld' + + option for returning the old document + + + + + OPTION_RETURN_NEW + \ArangoDBClient\DocumentHandler::OPTION_RETURN_NEW + 'returnNew' + + option for returning the new document + + + + $_connection \ArangoDBClient\Handler::_connection - + Connection object - + \ArangoDBClient\Connection - + $_documentClass - \ArangoDBClient\Handler::_documentClass + \ArangoDBClient\DocumentClassable::_documentClass '\ArangoDBClient\Document' - + - + string - + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string + + + + createFromArrayWithContext - \ArangoDBClient\EdgeHandler::createFromArrayWithContext() - + \ArangoDBClient\VertexHandler::createFromArrayWithContext() + Intermediate function to call the createFromArray function from the right context - - - - \ArangoDBClient\Edge + + + + \ArangoDBClient\Document - + \ArangoDBClient\ClientException @@ -20696,54 +21011,35 @@ appropriate HTTP requests to the server. - - saveEdge - \ArangoDBClient\EdgeHandler::saveEdge() - - save an edge to an edge-collection - This will save the edge to the collection and return the edges-document's id - -This will throw if the document cannot be saved - + + get + \ArangoDBClient\DocumentHandler::get() + + Get a single document from a collection + Alias method for getById() + \ArangoDBClient\Exception - - mixed - - - mixed - - - mixed + + string - + mixed - + array - - mixed + + \ArangoDBClient\Document - $collection - mixed - - - $from - - mixed - - - $to - - mixed + string - $document + $documentId mixed @@ -20752,237 +21048,69 @@ This will throw if the document cannot be saved array() array + \ArangoDBClient\DocumentHandler - - edges - \ArangoDBClient\EdgeHandler::edges() - - Get connected edges for a given vertex - - + + has + \ArangoDBClient\DocumentHandler::has() + + Check if a document exists + This will call self::get() internally and checks if there +was an exception thrown which represents an 404 request. + \ArangoDBClient\Exception - - mixed - - - mixed - - + string - - array + + mixed - - array + + boolean - $collection - mixed + string - $vertexHandle + $documentId mixed - - $direction - 'any' - string - - - $options - array() - array - + \ArangoDBClient\DocumentHandler - - inEdges - \ArangoDBClient\EdgeHandler::inEdges() - - Get connected inbound edges for a given vertex - - + + getById + \ArangoDBClient\DocumentHandler::getById() + + Get a single document from a collection + This will throw if the document cannot be fetched from the server. + \ArangoDBClient\Exception - - mixed + + string - + mixed - + array + + \ArangoDBClient\Document + $collection - mixed + string - $vertexHandle - - mixed - - - - outEdges - \ArangoDBClient\EdgeHandler::outEdges() - - Get connected outbound edges for a given vertex - - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - array - - - - $collection - - mixed - - - $vertexHandle - - mixed - - - - createCollectionIfOptions - \ArangoDBClient\EdgeHandler::createCollectionIfOptions() - - - - - - array - - - - - $collection - - - - - $options - - array - - - - get - \ArangoDBClient\DocumentHandler::get() - - Get a single document from a collection - Alias method for getById() - - \ArangoDBClient\Exception - - - string - - - mixed - - - array - - - \ArangoDBClient\Document - - - - $collection - - string - - - $documentId - - mixed - - - $options - array() - array - - \ArangoDBClient\DocumentHandler - - - has - \ArangoDBClient\DocumentHandler::has() - - Check if a document exists - This will call self::get() internally and checks if there -was an exception thrown which represents an 404 request. - - \ArangoDBClient\Exception - - - string - - - mixed - - - boolean - - - - $collection - - string - - - $documentId - - mixed - - \ArangoDBClient\DocumentHandler - - - getById - \ArangoDBClient\DocumentHandler::getById() - - Get a single document from a collection - This will throw if the document cannot be fetched from the server. - - \ArangoDBClient\Exception - - - string - - - mixed - - - array - - - \ArangoDBClient\Document - - - - $collection - - string - - - $documentId + $documentId mixed @@ -20993,28 +21121,28 @@ was an exception thrown which represents an 404 request. \ArangoDBClient\DocumentHandler - + getHead \ArangoDBClient\DocumentHandler::getHead() - + Gets information about a single documents from a collection This will throw if the document cannot be fetched from the server - + \ArangoDBClient\Exception - + string - + mixed - + boolean - + string - + array @@ -21040,18 +21168,18 @@ was an exception thrown which represents an 404 request. \ArangoDBClient\DocumentHandler - + createFromArrayWithContext \ArangoDBClient\DocumentHandler::createFromArrayWithContext() - + Intermediate function to call the createFromArray function from the right context - - - + + + \ArangoDBClient\Document - + \ArangoDBClient\ClientException @@ -21067,31 +21195,31 @@ was an exception thrown which represents an 404 request. \ArangoDBClient\DocumentHandler - + store \ArangoDBClient\DocumentHandler::store() - + Store a document to a collection This is an alias/shortcut to save() and replace(). Instead of having to determine which of the 3 functions to use, simply pass the document to store() and it will figure out which one to call. This will throw if the document cannot be saved or replaced. - + \ArangoDBClient\Exception - + \ArangoDBClient\Document - + mixed - + array - + mixed - + $document @@ -21110,31 +21238,31 @@ This will throw if the document cannot be saved or replaced. \ArangoDBClient\DocumentHandler - - save - \ArangoDBClient\DocumentHandler::save() - - save a document to a collection + + insert + \ArangoDBClient\DocumentHandler::insert() + + insert a document into a collection This will add the document to the collection and return the document's id This will throw if the document cannot be saved - + \ArangoDBClient\Exception - + mixed - + \ArangoDBClient\Document array - + array - + mixed - + $collection @@ -21153,10 +21281,34 @@ This will throw if the document cannot be saved \ArangoDBClient\DocumentHandler - + + save + \ArangoDBClient\DocumentHandler::save() + + Insert a document into a collection + This is an alias for insert(). + + + $collection + + + + + $document + + + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + update \ArangoDBClient\DocumentHandler::update() - + Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document. Attention - The behavior of this method has changed since version 1.1 @@ -21167,16 +21319,16 @@ This will throw if the document cannot be updated If policy is set to error (locally or globally through the ConnectionOptions) and the passed document has a _rev value set, the database will check that the revision of the document to-be-replaced is the same as the one given. - + \ArangoDBClient\Exception - + \ArangoDBClient\Document - + array - + boolean @@ -21192,10 +21344,10 @@ that the revision of the document to-be-replaced is the same as the one given. \ArangoDBClient\DocumentHandler - + updateById \ArangoDBClient\DocumentHandler::updateById() - + Update an existing document in a collection, identified by collection id and document id Attention - The behavior of this method has changed since version 1.1 This will update the document on the server @@ -21205,22 +21357,22 @@ This will throw if the document cannot be updated If policy is set to error (locally or globally through the ConnectionOptions) and the passed document has a _rev value set, the database will check that the revision of the document to-be-updated is the same as the one given. - + \ArangoDBClient\Exception - + string - + mixed - + \ArangoDBClient\Document - + array - + boolean @@ -21246,28 +21398,28 @@ that the revision of the document to-be-updated is the same as the one given. \ArangoDBClient\DocumentHandler - + replace \ArangoDBClient\DocumentHandler::replace() - + Replace an existing document in a collection, identified by the document itself - This will update the document on the server + This will replace the document on the server -This will throw if the document cannot be updated +This will throw if the document cannot be replaced If policy is set to error (locally or globally through the ConnectionOptions) and the passed document has a _rev value set, the database will check that the revision of the to-be-replaced document is the same as the one given. - + \ArangoDBClient\Exception - + \ArangoDBClient\Document - + array - + boolean @@ -21283,10 +21435,10 @@ that the revision of the to-be-replaced document is the same as the one given. \ArangoDBClient\DocumentHandler - + replaceById \ArangoDBClient\DocumentHandler::replaceById() - + Replace an existing document in a collection, identified by collection id and document id This will update the document on the server @@ -21295,22 +21447,22 @@ This will throw if the document cannot be Replaced If policy is set to error (locally or globally through the ConnectionOptions) and the passed document has a _rev value set, the database will check that the revision of the to-be-replaced document is the same as the one given. - + \ArangoDBClient\Exception - + mixed - + mixed - + \ArangoDBClient\Document - + array - + boolean @@ -21336,22 +21488,22 @@ that the revision of the to-be-replaced document is the same as the one given. \ArangoDBClient\DocumentHandler - + remove \ArangoDBClient\DocumentHandler::remove() - + Remove a document from a collection, identified by the document itself - + \ArangoDBClient\Exception - + \ArangoDBClient\Document - + array - + boolean @@ -21367,28 +21519,28 @@ that the revision of the to-be-replaced document is the same as the one given. \ArangoDBClient\DocumentHandler - + removeById \ArangoDBClient\DocumentHandler::removeById() - + Remove a document from a collection, identified by the collection id and document id - + \ArangoDBClient\Exception - + mixed - + mixed - + mixed - + array - + boolean @@ -21414,19 +21566,19 @@ that the revision of the to-be-replaced document is the same as the one given. \ArangoDBClient\DocumentHandler - + getDocumentId \ArangoDBClient\DocumentHandler::getDocumentId() - + Helper function to get a document id from a document or a document id value - + \ArangoDBClient\ClientException - + mixed - + mixed @@ -21437,19 +21589,19 @@ that the revision of the to-be-replaced document is the same as the one given. \ArangoDBClient\DocumentHandler - + getRevision \ArangoDBClient\DocumentHandler::getRevision() - + Helper function to get a document id from a document or a document id value - + \ArangoDBClient\ClientException - + mixed - + mixed @@ -21460,21 +21612,23 @@ that the revision of the to-be-replaced document is the same as the one given. \ArangoDBClient\DocumentHandler - - createCollectionIfOptions - \ArangoDBClient\DocumentHandler::createCollectionIfOptions() - + + lazyCreateCollection + \ArangoDBClient\DocumentHandler::lazyCreateCollection() + - - + + mixed + + array $collection - + mixed $options @@ -21483,13 +21637,13 @@ that the revision of the to-be-replaced document is the same as the one given. \ArangoDBClient\DocumentHandler - + __construct \ArangoDBClient\Handler::__construct() - + Construct a new handler - + \ArangoDBClient\Connection @@ -21500,30 +21654,30 @@ that the revision of the to-be-replaced document is the same as the one given. \ArangoDBClient\Handler - + getConnection \ArangoDBClient\Handler::getConnection() - + Return the connection object - + \ArangoDBClient\Connection \ArangoDBClient\Handler - + getConnectionOption \ArangoDBClient\Handler::getConnectionOption() - + Return a connection option This is a convenience function that calls json_encode_wrapper on the connection - - + + mixed - + \ArangoDBClient\ClientException @@ -21534,19 +21688,19 @@ This is a convenience function that calls json_encode_wrapper on the connection< \ArangoDBClient\Handler - + json_encode_wrapper \ArangoDBClient\Handler::json_encode_wrapper() - + Return a json encoded string for the array passed. This is a convenience function that calls json_encode_wrapper on the connection - + array - + string - + \ArangoDBClient\ClientException @@ -21557,23 +21711,23 @@ This is a convenience function that calls json_encode_wrapper on the connection< \ArangoDBClient\Handler - + includeOptionsInBody \ArangoDBClient\Handler::includeOptionsInBody() - + Helper function that runs through the options given and includes them into the parameters array given. Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - + array - + array - + array - + array @@ -21594,19 +21748,19 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\Handler - + makeCollection \ArangoDBClient\Handler::makeCollection() - + Turn a value into a collection name - + \ArangoDBClient\ClientException - + mixed - + string @@ -21617,17 +21771,42 @@ This is only for options that are to be sent to the ArangoDB server in a json bo \ArangoDBClient\Handler - + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler + + setDocumentClass - \ArangoDBClient\Handler::setDocumentClass() - + \ArangoDBClient\DocumentClassable::setDocumentClass() + Sets the document class to use - + string - - \ArangoDBClient\Handler + + \ArangoDBClient\DocumentClassable @@ -21635,1947 +21814,6803 @@ This is only for options that are to be sent to the ArangoDB server in a json bo string - \ArangoDBClient\Handler + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable - - No summary for method createCollectionIfOptions() - - eJztWVtT20YUfvev2DJMbWdsaNM3J7ihxgFnSGDASdohDLOW1ngbeaVqV4CnzX/vOXuRVrJEbNK8VTNge7Xn9p3rSi9/TRZJq7X/7FmLPCOHKRW38dFv5PzknAQRZ0INSBgH2RK+kQUVYcRS2Ih7XyU0+ExvGSE52UhT6Js0U4s4hXvkDRXkUjG2pEJUbr0Gus/kLV1ppuRVECerlN8uFBnl357/9PPzHlEpB1FCkuPl7KQHt6P4VrAeOWYp8F0B9X6rJeiSSdCKVRR6UdjnbCBqQRUBUuAqCQvhvzXrUOif/arVhmLOVLBwFGSexktYZ0Sy9A62wE5kkbBUcqkk3lqSWHhb9shEAaBAK2MyWxEuZcbFLe5ASpokaZyArYqRk+n0nKTsr4xpVrHPZSMXSC4CvEXIz3s/aYSCiEpJxqD7iTWKPSgmQkmOrLV2vfV3C+k0ang9y4NAEpqmFBQXIXuwN/f1ZxALqcj43fTij5ujs9H7t/D1khyQNmLVBh9UOBoIN+E2Pjoe55xkDasgjiIWKA5QJzSFKFAYUGvczs6nk7N3N6Oz09PxCL8iz4K2TscHukwitgnX8e+Hb89Px1pNQ/Vt/F5fnL1FZhhj38ZpeoZ8VFzDBWJJsYdNmHwYX0zHvyMjQ1PDLOTp5k44mlwUPsgpa7hOBPBZslDnxDwTRgKkQ0CjSOdEkDK49xpwOtTBlG/K09NUEpAPiivL2PF/pZUluyFVtLoWJ8hHVilSprJU6DzK19Qije8l+VTOw0/mY/wQMM2qhEeSzSIeFOpW7PjI1WJkVO5o7Xq5Ql1Nb3IUL0+hwaDCZo32hSb70lpD+k0G7tF2QCGDALM6Ez4nkt6xTheqlUadhVjUdDLuVbHh6C5Bo3qUl/wBiOHa9VK27+cvDwmF4gj1HqoidAmRLWd5HDk2rlqB19w3AmzQ1fkCRMiMERqGLKxQm5KDSjzuX63sP3cxD6tervdqvksyU3b9SjsYIIa40OmW99cHg0bcQ6lX2NqzFjj1IYOurqshYfwo2H1V2c7OWBfeELINm9sdgOT8Czm7iMM9ch4xKhnJ4K/Qeqc5cqTmYkICgbdf+4X6FYimCwilew4JrEnRcY5WZ3QRD4CeC2+3S+a9uS1J7px11gYCiN5SXAQwhsQKYwNFV6mdhxt968exH8T22j6WLStdq0pX39QvU27riQAuUiWCtcdIvIQpSCyw/brk6SFi+CuB2YFpi+B3PPsTjESj4IcOx9oky0PUF2fWaOTiOJ7bpbyaVK1au14mwzPLmaaMDF7O0uHGtBEftk2RHBW9Hz2n16oBCPHD7ciGcbNiCkojTHd7L/eB0VZC7ylXr+P0ciUClKcLK9NgqzSDYRYkA5gQuSlbxnc0AlhYSo2ZOqI5NFAqVLTS4QtsIFgFR68Aj5DLz3vbADHBzIBk4cYymbCAzzl6XCtSxgFSLWRzmkVKCwYFoHRw8L9WDIMlSaDQhFvCsp8MqxnmV19ACZIIAqRIX+2koiKbIVcPuHqluZrqKlauqJhgPUyjbaurn/kHwABg7A+X9LMXUb6orh1r8AKnd7i8obY3W6ndrsddS8gtPmjs6472RU75pbVG3x9CjCFVR5vrbS5vmcYdAMLXdFdnsiwMBKijLGQ28ybiXN/vlPW2sPXIVWkdr3IC6Otg6JjfMgXTjjCAGRGd6oIcDOz4+PFwMr25/OPdqNtbF7Oe3E8VM7oYH07H3ZKI6/xXCSzDvip6MrcsK5FnoC0xwDENsS68AroeRhEANhFw7lPvE9gCjdgnytLIAknep9EJixIcNSAX4VRn3APLHfgDm95fnOqjFNkj7f02/G9QKWeewmkaVGdFBJTQ63T7wySWMJ2CFj235U8ZixsmgjhkN/cpapKaEbRbUjyKA+rSx8nR/E/tjRNGQyD19MHM+SEnrCZM88DTPoIaghVuDsdMkgteaAFQU93p3anRLiVUoTJatqbuG4lAeKDxsOoN2OUG1kmImehM7BTGlALBT8uJnacnYUcrcGWKgTkYT46uG/P5gt1xqYWskV2MP1xXSxLq/cNBNfxA6lplegToYwAZ5gEuoHnxMAe0+pykCeCy4fIdu+/MaSSZr6vtDutqNg6nx0wf/TBooaHYBzc4uJBbfgd9rjQtPWkOXBsE+9Xxd5tRkOwajczBgbgBzR7VAds4uls701jOu8UZ3Crihi3XvfWTpDYVq/YeOQO+KYEUlnwGkj7QKANs2hwK5o+kHWeqXX9yqk51j410m00C1XluQyocqm5sV3KJInG0wnkKDbX3NIDuZEqoArBmmYLTKznyUNGxtsX4YsXfijhlJxxmZXGYc/aVkAvIl4Xe8N/Jbh6cjAf6hScqwb/l6KRpKt3LD9CeH3QHJrS+9wzlJhMstOUxQ7Jonndv+8yKmDGjpHQzkfdgauiZlhNcewX3Kd33Mm+/QG36ZMnMp3ZiWNCN2CMrF/gZVcECtFJrPew3d2e92LtymxPXV27r5ytIByzb7WuQoUPas0G3z9L11V5qinWZ5MpzAJRxRoMFsT3O+NF7ZnyNRdcMH9XxWrO+ui4A3eLpWy0GDinNeMNmxMUszsT3aUrlnvRNHanckB5rR0+sRfWVh4vxV2pPw3NQ69GvVy5sdcXg8KiroBv+76tmXwE8391ZOJA0esuCYLO7hKcBxlvC94QII69/Mlweb75xuHnCZNP4gMoNFBs9qNIPqTadKGpFTlcJQ7E7btbeQdCe69gvnsfk27eR1XhzB+NAy/lFy9FPhZ8goxiPbLymsTKxXHnd8vWjesM7l6Ln1eKGneWXolFAfOG79MG2Ql24Q8Drl7c3cLCislN6saBvQH58ci/J3Uuo2SdvH6bOv21kQP0= + eJyNU8tu2zAQvOsr9mAgqaHYjY9OH0mdJk6BAgYatBcDAU2tLSISyZKr1kKQf++SethWLtWFwu7OcGZW+vDZ5jZJpuNxAmO4cULvzO0XWC1XIAuFmubwBx3hHjIjq5ILkAudFeh4PkCurZDPYocAPXoRgbEpKsqN4x58Exp+EGIptB607hj3DN9FHUnhWhpbO7XLCRb92+z95SwFcoqv0h7uy80y5XZhdhpTuEfHvHVEe6VlUANwOZlxZZokWpToWScOJF4djHeugHJBwGR8j4/WlUQ/aWaaJC6GSTSYLZLMjzCwdabkFoJHx0Xg4UBj0XnlyYdWCUYfjUzggThnxnoDmxqU95XSuzARkMJaZyxHQAjLx8cVOPxdYaQyxyz/tZm3MclCeA8/o8dl6wz3hDrzcNtabuvJSxKQMbzwjOFBE+8AsyhuW2lJKlgzIEVRRHHSIffuOJQb50R9GOpzajYtDVPtqSXu+NmMEyWMMkFiWDM28PghwiFVTvfS+zrlzvz1sD4NZd0cX/cSI107Po2nrTaFkgfJAy+/FOWLRvZ5VJj2ot5FfBNXeEZP3deziHF/hBHlyl98Oq3zl9khWhsD4Hw+0PDm4qvI8Jq8Js1mn0ShhD8/2S+zhFYKZ+vu1+pi2axPJs+Y7x/mhFdE - + - ArangoDB PHP client: export + ArangoDB PHP client: HTTP response - + - + - Export - \ArangoDBClient\Export - - Collection export - - - + HttpResponse + \ArangoDBClient\HttpResponse + + Container class for HTTP responses + <br> + + - - ENTRY_COUNT - \ArangoDBClient\Export::ENTRY_COUNT - 'count' - - Count option index + + HEADER_LOCATION + \ArangoDBClient\HttpResponse::HEADER_LOCATION + 'location' + + HTTP location header - - ENTRY_BATCHSIZE - \ArangoDBClient\Export::ENTRY_BATCHSIZE - 'batchSize' - - Batch size option index - - - - - ENTRY_FLUSH - \ArangoDBClient\Export::ENTRY_FLUSH - 'flush' - - Flush option index - - - - - ENTRY_RESTRICT - \ArangoDBClient\Export::ENTRY_RESTRICT - 'restrict' - - Export restrictions - - - - - ENTRY_LIMIT - \ArangoDBClient\Export::ENTRY_LIMIT - 'limit' - - Optional limit for the number of documents + + HEADER_LEADER_ENDPOINT + \ArangoDBClient\HttpResponse::HEADER_LEADER_ENDPOINT + 'x-arango-endpoint' + + HTTP leader endpoint header, used in failover - - $_connection - \ArangoDBClient\Export::_connection - - - The connection object + + $_header + \ArangoDBClient\HttpResponse::_header + '' + + The header retrieved - - \ArangoDBClient\Connection + + string - - $_collection - \ArangoDBClient\Export::_collection - - - The collection name or collection object + + $_body + \ArangoDBClient\HttpResponse::_body + '' + + The body retrieved - - mixed + + string - - $_batchSize - \ArangoDBClient\Export::_batchSize - - - The current batch size (number of result documents retrieved per round-trip) + + $_headers + \ArangoDBClient\HttpResponse::_headers + array() + + All headers retrieved as an assoc array - - mixed + + array - - $_flat - \ArangoDBClient\Export::_flat - false - - "flat" flag (if set, the query results will be treated as a simple array, not documents) + + $_result + \ArangoDBClient\HttpResponse::_result + '' + + The result status-line (first line of HTTP response header) - - boolean + + string - - $_flush - \ArangoDBClient\Export::_flush - true - - Flush flag (if set, then all documents from the collection that are currently only -in the write-ahead log (WAL) will be moved to the collection's datafiles. This may cause -an initial delay in the export, but will lead to the documents in the WAL not being -excluded from the export run. If the flush flag is set to false, the documents still -in the WAL may be missing in the export result. + + $_httpCode + \ArangoDBClient\HttpResponse::_httpCode + + + The HTTP status code of the response - - boolean + + integer - $_type - \ArangoDBClient\Export::_type - + $_wasAsync + \ArangoDBClient\HttpResponse::_wasAsync + false - The underlying collection type + Whether or not the response is for an async request without a response body + + boolean + - $_restrictions - \ArangoDBClient\Export::_restrictions + $batchPart + \ArangoDBClient\HttpResponse::batchPart - export restrictions - either null for no restrictions or an array with a "type" and a "fields" index - - - mixed - - - - - $_limit - \ArangoDBClient\Export::_limit - 0 - - optional limit for export - if specified and positive, will cap the amount of documents in the cursor to -the specified value - - - integer - - - - - $_documentClass - \ArangoDBClient\Export::_documentClass - '\ArangoDBClient\Document' - - + Whether or not the response is for an async request without a response body - - string + + \ArangoDBClient\Batchpart - + __construct - \ArangoDBClient\Export::__construct() - - Initialize the export + \ArangoDBClient\HttpResponse::__construct() + + Set up the response - - \ArangoDBClient\Exception + + string - - \ArangoDBClient\Connection + + string - + string - - array + + boolean + + + \ArangoDBClient\ClientException - $connection + $responseString - \ArangoDBClient\Connection + string - $collection - + $originUrl + null string - $data - array() - array + $originMethod + null + string + + + $wasAsync + false + boolean - - getConnection - \ArangoDBClient\Export::getConnection() - - Return the connection object + + getHttpCode + \ArangoDBClient\HttpResponse::getHttpCode() + + Return the HTTP status code of the response - - \ArangoDBClient\Connection - - - - - execute - \ArangoDBClient\Export::execute() - - Execute the export - This will return the results as a Cursor. The cursor can then be used to iterate the results. - - \ArangoDBClient\Exception - - - \ArangoDBClient\ExportCursor + + integer - - setBatchSize - \ArangoDBClient\Export::setBatchSize() - - Set the batch size for the export - The batch size is the number of results to be transferred -in one server round-trip. If an export produces more documents -than the batch size, it creates a server-side cursor that -provides the additional results. - -The server-side cursor can be accessed by the client with subsequent HTTP requests. - - \ArangoDBClient\ClientException - - - integer + + getHeader + \ArangoDBClient\HttpResponse::getHeader() + + Return an individual HTTP headers of the response + + + string - - void + + string - $value + $name - integer + string - - getBatchSize - \ArangoDBClient\Export::getBatchSize() - - Get the batch size for the export + + getHeaders + \ArangoDBClient\HttpResponse::getHeaders() + + Return the HTTP headers of the response - - integer + + array - - getCursorOptions - \ArangoDBClient\Export::getCursorOptions() - - Return an array of cursor options + + getLocationHeader + \ArangoDBClient\HttpResponse::getLocationHeader() + + Return the location HTTP header of the response - - array + + string - - setDocumentClass - \ArangoDBClient\Export::setDocumentClass() - - Sets the document class to use + + getLeaderEndpointHeader + \ArangoDBClient\HttpResponse::getLeaderEndpointHeader() + + Return the leader location HTTP header of the response + + + string + + + + + getBody + \ArangoDBClient\HttpResponse::getBody() + + Return the body of the response + + + string + + + + + getResult + \ArangoDBClient\HttpResponse::getResult() + + Return the result line (first header line) of the response - + string - - \ArangoDBClient\Export + + + + getJson + \ArangoDBClient\HttpResponse::getJson() + + Return the data from the JSON-encoded body + + + \ArangoDBClient\ClientException + + + array + + + + + setBatchPart + \ArangoDBClient\HttpResponse::setBatchPart() + + + + + \ArangoDBClient\Batchpart + + + \ArangoDBClient\HttpResponse - $class + $batchPart - string + \ArangoDBClient\Batchpart + + getBatchPart + \ArangoDBClient\HttpResponse::getBatchPart() + + + + + \ArangoDBClient\Batchpart + + + - eJylWW1vGzcS/u5fMTGMSgokOy1w/WBHvtqKGrvIJYat4C5NDIHapaRtVtwtybWttvnvnSGXu9w32e4JaCPzZeaZ4cwzQ+r1v9N1urd39PLlHryEM8nEKnlzDlcXVxDEERf6GPhDmkiN07Tip5QFX9mKAxSLJ2admWSZXicS5+AXJuBGc75hQpipIEm3MlqtNUyKbz+8+v5fQ9AyQoFCwdvN4mKI03GyEnwIb7nE3VvcfbS3J9iGK9TNa2pPCuy4L+aBjhLRgbgFr4pEQKb8cPijURPETCmY2u1/7pEhRjp9XsJszSFIhMi1JIvf8Fs+6db8dMckQnGL8uEj828qozumORzMSymIv1VLYQsZDuhTb6hb8SZ64GGnTiegQ2cmJfoFFkwHa1DRHxz6ItssuIRkCZKrLNYQJkG2wVUKB/Dc+B0PIcUVMslEOMKRdPBcXEbfDaprwtpfxkzvA/5/Bf1oCYprDBfE+nvG5TbHpOA+imNYcAwkjiJDYAoYGrBJYw5MSrYdgkg87K0QF0kSdyAkFDCGJYtVC8if40ytmxgFMERV+mspk43B7h2kXqNgJgvfx1tIRLx1kiNhNtzLSPMRW3MWAqYG9P979m5QGL1J6Ax0UpPdUxAyzZZRzNUhnm+kYMO2ELBMcScfUzQSkY4Y4uQxzuYKbfoMYZFpqyYm1bmK0qJ8NaIx7l3wSKycaP4QxFmIwAqzrVCQmTiEy6UZWpaeQ3joONJhvDysqVIaYdTcQnrJJPJBpDCTV1X8eXgcPvuwCdQYgylrOWxKFIx0LuMtKfTPcpvyDpE01RRVosS0MTIUjIBHaIEEkaHbl5j2IqmuwCE8NhPVeDZ6jZG+T/L3cTikP5YRj0O1j74I+cNzc9FX1UScpDSB0RJHm0gbeLkRI6DIT3kQofrQQEkThaF1h0dpQihgqTkbtkGm0MQojUDCJFAoUidOHw2WQu9YnPE2gyKhO8yxOMfwqmnLxMIwFlV8ZWUgQSsN0/ez60/zyYeP72copRfQnl5T1nnJmE8SeH42m1zcXP46JaEF/bUIttTyJJk/v/t4c0HyTPy2yJo2w61T2PX0ZnZ9OTFGuw0tIj8044GOrCwaxRF3anp3+Z9Lo8aIaNFxaQmKfFumdj0K9Fom91S3A556VbeYT5lkG68qw4FXxkc5cxYDSELIKciTYU0AOQKTnj4HXuaPGrSeVHG6/TZr7X4iZ/uVkt6ejT3oqrPSbBFHASwzYWXP58Z9Mgt0v92goQ9umCu1+sbw+dYWP9vbGCQaa8Po1GtJcNlBo0GhD+Z4/0XfNz1CKAxbKDzrsv0aDDzxNWddIDXEGBxjEPze25OP95toBiddstzQuEXB6HTFtQ/VE/OtxfZCZkWYZ/vREQRrHnwlJ9xzzAq4T+RXCgfLwth0hqtKFBjy1g1dRNakpaHaQJ7hbH9Q8zlWNzKGjvCz4vHy+NjL+duGuxEq1VKGRX3JqGnzmLMGxhW7Ltm+054EqaC2JqxcJ+47d5S3W8CzlRsy6VRcVIM+FoxBi8l2+7O1OrK8HcB331UUR2pusm/npmJHA3al7redUSHEixeH9kUO1xfyuUfB10Ogf/1V2UCfF5FwaNv2DOFzDy9L1NT1htDL+zsap0ZpUBFXt4Q+GJQYhlFIhdmXf1j2Td7HELqlCHNZK5i937sURk61KzJJheFu2llsfmuk8e2p/rHNU6eHVLuHil3/3AtWxP/tByvm6Z5APHRLsZJak6YehNUOsUVsPVVs3zExvV1JLmc78jS/bvWpSXd52imlTuvfGh3ENdeZFPUi336HlnbtZEd3UNnoGs5E4xjddlyZRiovhfTrNTdX0yx2Jx02TB94kOkdLZC54JlGW5bmuvuxuQ9b3x26qz512gET9qaatzvUuOBVU7JcU76/cYPqaLcK9/mHtbOZ4dashn+KbqUSH43yBOPTaiUbdq7Pe/hTw1bFqttaoXXCip4cTuFVI0x31CyvsHvPGmWEtmqzdelJmmyJ8rSYvTvy0BFWSzY386+7wHgaHyWAg2o31ehzTqpOeLSb7G4mq82a6Z/es43pn9pwZTK238bwUcYXPE45cglLUy7CK2rQFQ738T91fPzx+t18+r+rD9czKnzes4qJufJvv0shbkzRK9X2zqX26BRvxEiKiGLopmssMTr9TSVizkWQhHx+LwmatDQ68HvCPM2oLPip1tI8D0tQRtsvivRU9Jut9ian+oNBFwPd0OsMcoL3Oujuex2EVFmL7FS9GjpuspctLZlQSy5leeeKkGoF3v+5vKu8L5rXI+beeIl7wyzgCjaJ5I0LJ72wiRruIXIcBOap0LwTGgUjFYXlC8SaFVc3lH+HUxY+C8Mov/J2cCOZ3SKRmBbNZAEiJaJdbG1ZMUXd3iBUtlD894z+vpjNrlAB/qG62bfWELRfebHThQPT/mMh846j9S0lD6u7JKo9D9VYu9rBG1F1As87rDnqdyuwo3KdtwX0etxkvB39jvfIotZJFofGocUzE5nKV1z2OpK/wezjCpqusH/7zLB3TiTHj9qe1H3Pt7t35bv3kc6hVmQ6m5/iyRAzLw/J6mNDHb9dPSp3tb5N5A9tla6nyif1wp7/jFAv7V3tHc0h4bpW0GsQh4/uPz+7mSKN0/4Gpz+6efbpapor9y/u1Y29ueObCf1u1PPnvI2VRaWE2yaj5+7pOkzz2pk/Qr3JhYL9yQpptHzYr3elB1UI9Nz2pfpj2BcnruUFDplfVZ7j21TWeCcHeWBX7sJaaxofI543viF9K7/rRatutF190ppLzuXodLNqjjcipvoW1PGxGcNr7xf3W6Xz3+KLXUK08zeWMY+8 + + No summary for method setBatchPart() + No summary for method getBatchPart() + + eJzNWFtv2zYUfvevOAGC2g7spMv25NRdkzSoG6RJkKTYQ1sYtETb2mRSI6m4xtD/vsOLZIm6xFmAYmoRyeS5n4+Hh3zze7JMOp2jg4MOHMCpIGzB35/B7eQWgjiiTI1g8vBwC4LKhDNJkUoTvktI8BdZUICc59yQm0mSqiUXOAeXhMG9onRFGDNTAU82IlosFZznX8evfzkegBIRCmQSPqxmkwFOx3zB6AA+UIHcG+Q+6nQYWaEhJKCe2pPchXPOFIkYFWg/kRLmaEjJA+lceDMTb31vanyREQu0m68Pj40JVupEqeQuC8k/He2q0a+fA3hYUlhSEqIRgqJf9JGGbi4jefdIBEicYws3dGTeiYgeiaKwP3UCxtDtonc1GmY83LxAvmGvl34ax85+uVUARAJmE73nARAhyKZOZXGi3iOJSr98q3cJc5TGCu0mKpXDGNMIvXkkpALzzeflVDoj+8/23elpjq1RY82AgIdGtbIGumVQ1RhpxNQ7jmg5RylVXX8sKYoVgCBlXJVUQGTBa2K+YQFO/J1SDMU6wtWVKiBbUp3LOpNmnMcNNq2JPDVixzAnsfz5tp0RFSwTIhqCNtPTtzhdNcwkJ+YBURFnDgMlIQEqVjC5OH1/cTe9ujk/ffh4c62znTFh1jVdvWC77igLE44pdfIHkEpcAxHDaEUxf2zVaF8X1+9vbz5eP2jF34fElJZhJrYGd/dUQZq0wCwPH0aNrBzCYT8jvre/h0ZCwFdJTBX1FgyuYZkmCZa3EGYbQymp2Hrjy+ZYoSP2WcRm2iwNO0Ri+Hx3VQEFqtV8c8FXrRI/IbR46CQaE1d2RC0JogjNNOFeLylDA1moWUOiCChudFop2oT62Gjg4+/9DOU+lVoKvpZg6/zF94AmGhZlJKazOApgnrLA4Gw6NUkWaaB6XswHxUCNgaVxPPA8zUf9dWeLl91C9LOvlpEcvi2uz5znJKeK5tAr6NwbW/nw6pWnN5vpF1TkAjzkjMe6IPqU+jHhAkbXfsR6FVL9dD9gvWB8iwyNhwLYgMyV2Rtt0cCcdmvlHHrOHEIX/x0Wo62HhnDNFR2BjhysyAZmCHRQ0YrqUhRJmdKq/P5JaehHZ/uVf8aRxFy7hGR1IPut61ofs6NbgQmNEypGIwSfpHrgE5USG4o2oHgIKdhTVuv2jq1iu3ltf7tttd4WO+c50T/plJFUcMmgwGGpFKGKRQZbx69/M6Crm/vVzu3l+O3nAn2QHR3BwsOMNmavitmXgF4//wXKuM1F7JHEUfgTIL07Utvd2dXybkG+lf2jsjXdUZUKZpie2xkJy6p30mEts8dYX3wXVE0ctHp+xXQafAietPtiIhNGj1GY4l5mDMv60yc8Ku9n+kSCnpkXMpa6ET8IMtuhXW+PiUlxYV9/vrrS4HajuFpYF5tgbAdwi9s5PIa5Z+zxI4Q9OxWqF8mptcBRFcuA9WOsTVR48lrnorxSgdWU+jVRfjGk3/r+evMzU6Iuos7PpV68T+Qvx+KOWXOSzfkEM2DfyEMKZx3dvdqkyN3CLZ8EoyXbwZe8ny04taNPrbCSL4PVlTPLwavd3S0MJY3no5HXgfezMOi/baGwBv9fI2KYL1wf/6K4lM8J/R1QYnboZ8aghafRyTPkeQrbWu4OJruzdvEw7+Kvh/rP9aZBZHY/UL4RaPTvzkh4ykOrZwcfzdEk31cv72+u8aCnN7iw9vjbevpoLlW2MjXoqTtvN7p/KbFBqJw83I3QFrQWBdtCvf8n8iGFfk1DqhX3DJe+vUsre8UebjjG+J5hrGwPxdYzbxFrWjYXjy/f/EbIbyHlkqdxaNp/F76BOa4D1xcZ6yhDl3ue6p3wLBHPuVjZ6GrEtbZOFRRpp5vA47qI/BKkcOHRsAJKV45t+cV6dpbJ6m3FNhw083mdef/SpeiNJm/0xhE13OnU1JfcwPYlWDDIacb/5gp2ik0tkb1iVEYjMzOA7tfsMvmru9GdfS0S6rz9C8rpmwY= - + - ArangoDB PHP client: graph handler + ArangoDB PHP client: bind variables - - - - + - - \ArangoDBClient\Handler - GraphHandler - \ArangoDBClient\GraphHandler - - A handler that manages graphs. - - - - + + + BindVars + \ArangoDBClient\BindVars + + A simple container for bind variables + This container also handles validation of the bind values.<br> +<br> + + - - ENTRY_GRAPH - \ArangoDBClient\GraphHandler::ENTRY_GRAPH - 'graph' - - documents array index - - - - - OPTION_REVISION - \ArangoDBClient\GraphHandler::OPTION_REVISION - 'revision' - - conditional update of edges or vertices - - - - - OPTION_VERTICES - \ArangoDBClient\GraphHandler::OPTION_VERTICES - 'vertices' - - vertex parameter + + $_values + \ArangoDBClient\BindVars::_values + array() + + Current bind values + + array + - - - OPTION_EDGES - \ArangoDBClient\GraphHandler::OPTION_EDGES - 'edges' - - direction parameter + + + getAll + \ArangoDBClient\BindVars::getAll() + + Get all registered bind variables + + array + - - - OPTION_KEY - \ArangoDBClient\GraphHandler::OPTION_KEY - '_key' - - direction parameter + + + getCount + \ArangoDBClient\BindVars::getCount() + + Get the number of bind variables registered + + integer + - - - OPTION_COLLECTION - \ArangoDBClient\GraphHandler::OPTION_COLLECTION - 'collection' - - collection parameter - + + + set + \ArangoDBClient\BindVars::set() + + Set the value of a single bind variable or set all bind variables at once + This will also validate the bind values. + +Allowed value types for bind parameters are string, int, +double, bool and array. Arrays must not contain any other +than these types. + + \ArangoDBClient\ClientException + + + string + integer + array + + + string + + + void + - - - OPTION_COLLECTIONS - \ArangoDBClient\GraphHandler::OPTION_COLLECTIONS - 'collections' - - collections parameter + + $name + + string|integer|array + + + $value + null + string + + + + get + \ArangoDBClient\BindVars::get() + + Get the value of a bind variable with a specific name + + string + + + mixed + - - - KEY_FROM - \ArangoDBClient\GraphHandler::KEY_FROM - '_from' - - example parameter + + $name + + string + + + + eJylVlFP2zAQfs+vuEmVaKsWGI8tMKCbQHsZGhMvgCo3vSYWrh3ZDqVa+993dhzapA1sml8CuTvf9919d+nplyzNouio242gC5eayUR9vYLbm1uIBUdpBzDhcgovTHM2EWjIzXleZCx+ZgkCvAWNvL83stymSpMNvjMJdxZxzqT0plhlS82T1MLo7a+T488nPbCUIUFp4Ho+uemRWahEYg+uUVP0kqKPokiyORrKjbW0ww0HMHyeCYRYScu4RA0zwrKXxa+Umy0/JoyClMkpeZCv4FNmuZKgZmBTLK8QOZrD04k+dzeE58clMVzGzgRwfHjiucSCGQNXdOk90yb6HTmjJ+FOF0a51hS9nTaYSo8L4gNMa7YMb478M9P8hVmE1riIgjN4eKIC1e6/RkuMBWhMuLGocbpTpGo2jTbXskgI/fCk2vzNJQFZPhE8hlkuY1/YBO2lEO2ONxYFcCckallqT/88sBh683ovDdcdmc8n1EPCUwWwBa2BEKci9/8hvpHLSOXSNrGJvbHKqdNE6i6Q8m6+xqRqmQisggMStgltrKFmFhQprkbZC37Byd1rPWgcd+RdC6MmqQUGK9hlRgnehipjmoaSCkRJNYKhOZZJz1W1V8ZPFRWLRnmiFGWmGK+dQ5oTehiY58aCVLYcRXIhYREmXV5gaSodSBOy1wFe2FSrhYFi4L69xpi5ptS9PNSAcEUAV4WGW26rgNOAe9YVAD9+EqAg9wW36Z5y780Am9MqKtcPFdxZSA3KfFH8fdFR89sefa9McUZCFqKuQT6DNjdjz6EI6HS2zO4QJmRxCoUZmAk31v3cuXeG+0I8Sg8GpY7aIWRYiVhX/qtOAOH1+TYRa0BBba4mDfi5DHQ7sFoBvSgK3cBoN9tDuwjoFEmfXHZvGf4vxX2g3fG6BImLujTbB1cVkfmim1TlgjZoOUVuvonzQWNB1x8sxa39UdV0oWMwGcZ8Ropy6d+bljAjDSPSIN85f6Wl0d+g2BfUuE1DV/co+ZPX8fgZl2N8pd1s3magul3rggiw3IBs6S16/7vzUEil3NTk7j/cY9IDM+3y8z0Y+Lc9OHgsf8c8hl8Bk8fSyfXxDz43w2I= + + + + ArangoDB PHP client: update policies + + + + + + + + UpdatePolicy + \ArangoDBClient\UpdatePolicy + + Document update policies + + + + + + LAST + \ArangoDBClient\UpdatePolicy::LAST + 'last' + + last update will win in case of conflicting versions - - KEY_TO - \ArangoDBClient\GraphHandler::KEY_TO - '_to' - - example parameter + + ERROR + \ArangoDBClient\UpdatePolicy::ERROR + 'error' + + an error will be returned in case of conflicting versions - - OPTION_NAME - \ArangoDBClient\GraphHandler::OPTION_NAME - 'name' - - name parameter + + validate + \ArangoDBClient\UpdatePolicy::validate() + + Check if the supplied policy value is valid + + + \ArangoDBClient\ClientException + + + string + + + void + + + + $value + + string + + + + eJydU2Fr2zAQ/e5fcYNRJyFdunx0G9ouLe3GYCFdvwWKopxtUVsSkpwslP73nSTHpF6hMGFko7v33t07+eJSlzpJJqNRAiO4NkwW6uYbLO4XwCuB0mXQ6A1zCFpVggu0lOdTrzTjz6xAgA41D4AQZI0rlaEY/GASHhxizaQMIa703oiidDDvvqZnX6djcEYQobRwV6/vxxSuVCFxDHdoCL0n9CRJJKvRkjb2ZM+7Jm4Ub2o6+ajwd8q2QnLf0dmXaVDjFbMWHgPPwtPsk5fEdxWk/BoBpXRSO1FVtEmghzOLoHLgSuaEdEIWsEVjhZK2xU7CmxKI4ef1w2+YQerpUmqmp0IuojFkaZBYIxh0jZG4+Q+p2+Xy19JrBcZ3xOYl8mcQObgSwTZak0Ob6OMetqxqEIT1H2LTQg7IK1catbMQPb39w1E7qqKfpZlhNVgaOFX6OTKevplXq9MHxq5hqzrl2Jhu1gQiRubolTeSe9lYInEOosYw5MYJ+kXDReMGwj7FUg5pw9YSv8iF9hg+zWZgscqzLAzr5AT+CQRrh0cSfgVPQOKub8sg/S5DiW9bT0n/gH1N4v6axMv4ROnMDo6vZJaFyBjS1eEPWrV3e706TvS8fwH05C35 + + + + ArangoDB PHP client: Base URLs + + + + + + + + Urls + \ArangoDBClient\Urls + + Some basic URLs + + + + + + URL_DOCUMENT + \ArangoDBClient\Urls::URL_DOCUMENT + '/_api/document' + + URL base part for document-related CRUD operations REST calls - - OPTION_EDGE_DEFINITION - \ArangoDBClient\GraphHandler::OPTION_EDGE_DEFINITION - 'edgeDefinition' - - edge definition parameter + + URL_EDGE + \ArangoDBClient\Urls::URL_EDGE + '/_api/document' + + URL base part for edge-related CRUD operations REST calls - - OPTION_EDGE_DEFINITIONS - \ArangoDBClient\GraphHandler::OPTION_EDGE_DEFINITIONS - 'edgeDefinitions' - - edge definitions parameter + + URL_EDGES + \ArangoDBClient\Urls::URL_EDGES + '/_api/edges' + + URL base part for all retrieving connected edges - - OPTION_ORPHAN_COLLECTIONS - \ArangoDBClient\GraphHandler::OPTION_ORPHAN_COLLECTIONS - 'orphanCollections' - - orphan collection parameter + + URL_GRAPH + \ArangoDBClient\Urls::URL_GRAPH + '/_api/gharial' + + URL base part for all graph-related REST calls - - OPTION_DROP_COLLECTION - \ArangoDBClient\GraphHandler::OPTION_DROP_COLLECTION - 'dropCollection' - - drop collection + + URL_VIEW + \ArangoDBClient\Urls::URL_VIEW + '/_api/view' + + URL base part for all view-related REST calls - - $cache - \ArangoDBClient\GraphHandler::cache - - - GraphHandler cache store + + URLPART_VERTEX + \ArangoDBClient\Urls::URLPART_VERTEX + 'vertex' + + URL part vertex-related graph REST calls - - - $cacheEnabled - \ArangoDBClient\GraphHandler::cacheEnabled - false - - + + + URLPART_EDGE + \ArangoDBClient\Urls::URLPART_EDGE + 'edge' + + URL part for edge-related graph REST calls - - - - $batchsize - \ArangoDBClient\GraphHandler::batchsize - - - batchsize + + + URL_COLLECTION + \ArangoDBClient\Urls::URL_COLLECTION + '/_api/collection' + + URL base part for all collection-related REST calls - - - $count - \ArangoDBClient\GraphHandler::count - - - count + + + URL_INDEX + \ArangoDBClient\Urls::URL_INDEX + '/_api/index' + + URL base part for all index-related REST calls - - - $limit - \ArangoDBClient\GraphHandler::limit - - - limit + + + URL_CURSOR + \ArangoDBClient\Urls::URL_CURSOR + '/_api/cursor' + + base URL part for cursor related operations - - - $_connection - \ArangoDBClient\Handler::_connection - - - Connection object + + + URL_EXPORT + \ArangoDBClient\Urls::URL_EXPORT + '/_api/export' + + URL for export related operations - - \ArangoDBClient\Connection - - - - $_documentClass - \ArangoDBClient\Handler::_documentClass - '\ArangoDBClient\Document' - - + + + URL_EXPLAIN + \ArangoDBClient\Urls::URL_EXPLAIN + '/_api/explain' + + URL for AQL explain-related operations - - string - - - - createGraph - \ArangoDBClient\GraphHandler::createGraph() - - Create a graph - This will create a graph using the given graph object and return an array of the created graph object's attributes.<br><br> - - \ArangoDBClient\Exception - - - \ArangoDBClient\Graph - - - array - - - - - $graph - - \ArangoDBClient\Graph - - - - getGraph - \ArangoDBClient\GraphHandler::getGraph() - - Get a graph - This will get a graph.<br><br> - - String - - - array - - - \ArangoDBClient\Graph - false - - - \ArangoDBClient\ClientException - - + + + URL_QUERY + \ArangoDBClient\Urls::URL_QUERY + '/_api/query' + + URL for AQL query validation-related operations + - - $graph - - String - - - $options - array() - array - - - - setBatchsize - \ArangoDBClient\GraphHandler::setBatchsize() - - Sets the batchsize for any method creating a cursor. - Will be reset after the cursor has been created. - - integer - + + + URL_EXAMPLE + \ArangoDBClient\Urls::URL_EXAMPLE + '/_api/simple/by-example' + + URL for select-by-example + - - $batchsize - - integer - - - - setCount - \ArangoDBClient\GraphHandler::setCount() - - Sets the count for any method creating a cursor. - Will be reset after the cursor has been created. - - integer - + + + URL_FIRST_EXAMPLE + \ArangoDBClient\Urls::URL_FIRST_EXAMPLE + '/_api/simple/first-example' + + URL for first-example + - - $count - - integer - - - - setLimit - \ArangoDBClient\GraphHandler::setLimit() - - Sets the limit for any method creating a cursor. - Will be reset after the cursor has been created. - - integer - + + + URL_ANY + \ArangoDBClient\Urls::URL_ANY + '/_api/simple/any' + + URL for any + - - $limit - - integer - - - - properties - \ArangoDBClient\GraphHandler::properties() - - Get a graph's properties<br><br> + + + URL_FULLTEXT + \ArangoDBClient\Urls::URL_FULLTEXT + '/_api/simple/fulltext' + + URL for fulltext - - \ArangoDBClient\Exception - - - mixed - - - boolean - - - - $graph - - mixed - - - - dropGraph - \ArangoDBClient\GraphHandler::dropGraph() - - Drop a graph and remove all its vertices and edges, also drops vertex and edge collections<br><br> + + + URL_REMOVE_BY_EXAMPLE + \ArangoDBClient\Urls::URL_REMOVE_BY_EXAMPLE + '/_api/simple/remove-by-example' + + URL remove-by-example - - \ArangoDBClient\Exception - - - mixed - - - boolean - - - boolean - - - - $graph - - mixed - - - $dropCollections - true - boolean - - - - addOrphanCollection - \ArangoDBClient\GraphHandler::addOrphanCollection() - - add an orphan collection to the graph. - This will add a further orphan collection to the graph.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - string - - - \ArangoDBClient\Graph - - + + + URL_REMOVE_BY_KEYS + \ArangoDBClient\Urls::URL_REMOVE_BY_KEYS + '/_api/simple/remove-by-keys' + + URL for remove-by-keys + - - $graph - - mixed - - - $orphanCollection - - string - - - - deleteOrphanCollection - \ArangoDBClient\GraphHandler::deleteOrphanCollection() - - deletes an orphan collection from the graph. - This will delete an orphan collection from the graph.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - string - - - boolean - - - \ArangoDBClient\Graph - - + + + URL_UPDATE_BY_EXAMPLE + \ArangoDBClient\Urls::URL_UPDATE_BY_EXAMPLE + '/_api/simple/update-by-example' + + URL for update-by-example + - - $graph - - mixed - - - $orphanCollection - - string - - - $dropCollection - false - boolean - - - - getVertexCollections - \ArangoDBClient\GraphHandler::getVertexCollections() - - gets all vertex collection from the graph. - This will get all vertex collection (orphans and used in edge definitions) from the graph.<br><br> - -If this method or any method that calls this method is used in batch mode and caching is off,<br> -then for each call, this method will make an out of batch API call to the db in order to get the appropriate collections.<br><br> - -If caching is on, then the GraphHandler will only call the DB API once for the chosen graph, and return data from cache for the following calls.<br> - - mixed - - - array - - - array - - - \ArangoDBClient\ClientException@since - + + + URL_REPLACE_BY_EXAMPLE + \ArangoDBClient\Urls::URL_REPLACE_BY_EXAMPLE + '/_api/simple/replace-by-example' + + URL for replace-by-example + - - $graph - - mixed - - - $options - array() - array - - - - addEdgeDefinition - \ArangoDBClient\GraphHandler::addEdgeDefinition() - - adds an edge definition to the graph. - This will add a further edge definition to the graph.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - \ArangoDBClient\EdgeDefinition - - - \ArangoDBClient\Graph - - + + + URL_LOOKUP_BY_KEYS + \ArangoDBClient\Urls::URL_LOOKUP_BY_KEYS + '/_api/simple/lookup-by-keys' + + URL for lookup-by-keys + - - $graph - - mixed - - - $edgeDefinition - - \ArangoDBClient\EdgeDefinition - - - - deleteEdgeDefinition - \ArangoDBClient\GraphHandler::deleteEdgeDefinition() - - deletes an edge definition from the graph. - This will delete an edge definition from the graph.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - string - - - boolean - - - \ArangoDBClient\Graph - - + + + URL_RANGE + \ArangoDBClient\Urls::URL_RANGE + '/_api/simple/range' + + URL for select-range + - - $graph - - mixed - - - $edgeDefinition - - string - - - $dropCollection - false - boolean - - - - getEdgeCollections - \ArangoDBClient\GraphHandler::getEdgeCollections() - - gets all edge collections from the graph. - This will get all edge collections from the graph.<br><br> - -If this method or any method that calls this method is used in batch mode and caching is off,<br> -then for each call, this method will make an out of batch API call to the db in order to get the appropriate collections.<br><br> - -If caching is on, then the GraphHandler will only call the DB API once for the chosen graph, and return data from cache for the following calls.<br> - - \ArangoDBClient\Exception - - - mixed - - - array - - + + + URL_ALL + \ArangoDBClient\Urls::URL_ALL + '/_api/simple/all' + + URL for select-all + - - $graph - - mixed - - - - replaceEdgeDefinition - \ArangoDBClient\GraphHandler::replaceEdgeDefinition() - - replaces an edge definition of the graph. - This will replace an edge definition in the graph.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - \ArangoDBClient\EdgeDefinition - - - \ArangoDBClient\Graph - - + + + URL_ALL_KEYS + \ArangoDBClient\Urls::URL_ALL_KEYS + '/_api/simple/all-keys' + + URL for select-all-keys + - - $graph - - mixed - - - $edgeDefinition - - \ArangoDBClient\EdgeDefinition - - - - saveVertex - \ArangoDBClient\GraphHandler::saveVertex() - - save a vertex to a graph - This will add the vertex-document to the graph and return the vertex id - -This will throw if the vertex cannot be saved<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - string - - - string - - + + + URL_NEAR + \ArangoDBClient\Urls::URL_NEAR + '/_api/simple/near' + + URL for select-range + - - $graph - - mixed - - - $document - - mixed - - - $collection - null - string - - - - getVertex - \ArangoDBClient\GraphHandler::getVertex() - - Get a single vertex from a graph - This will throw if the vertex cannot be fetched from the server<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - array - - - string - - - \ArangoDBClient\Document - - + + + URL_WITHIN + \ArangoDBClient\Urls::URL_WITHIN + '/_api/simple/within' + + URL for select-range + - - $graph - - mixed - - - $vertexId - - mixed - - - $options - array() - array - - - $collection - null - string - - - - hasVertex - \ArangoDBClient\GraphHandler::hasVertex() - - Check if a vertex exists - This will call self::getVertex() internally and checks if there -was an exception thrown which represents an 404 request. - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - boolean - + + + URL_IMPORT + \ArangoDBClient\Urls::URL_IMPORT + '/_api/import' + + URL for document import + - - $graph - - mixed - - - $vertexId - - mixed - - - - replaceVertex - \ArangoDBClient\GraphHandler::replaceVertex() - - Replace an existing vertex in a graph, identified graph name and vertex id - This will update the vertex on the server - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced vertex is the same as the one given.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - \ArangoDBClient\Document - - - mixed - - - string - - - boolean - - + + + URL_BATCH + \ArangoDBClient\Urls::URL_BATCH + '/_api/batch' + + URL for batch processing + - - $graph - - mixed - - - $vertexId - - mixed - - - $document - - \ArangoDBClient\Document - - - $options - array() - mixed - - - $collection - null - string - - - - updateVertex - \ArangoDBClient\GraphHandler::updateVertex() - - Update an existing vertex in a graph, identified by graph name and vertex id - This will update the vertex on the server - -This will throw if the vertex cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed vertex-document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - \ArangoDBClient\Document - - - mixed - - - string - - - boolean - - + + + URL_TRANSACTION + \ArangoDBClient\Urls::URL_TRANSACTION + '/_api/transaction' + + URL for transactions + - - $graph - - mixed - - - $vertexId - - mixed - - - $document - - \ArangoDBClient\Document - - - $options - array() - mixed - - - $collection - null - string - - - - removeVertex - \ArangoDBClient\GraphHandler::removeVertex() - - Remove a vertex from a graph, identified by the graph name and vertex id<br><br> + + + URL_ENGINE + \ArangoDBClient\Urls::URL_ENGINE + '/_api/engine' + + URL for storage engine - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed - - - mixed - - - string - - - boolean - - - - $graph - - mixed - - - $vertexId - - mixed - - - $revision - null - mixed - - - $options - array() - mixed - - - $collection - null - string - - - - saveEdge - \ArangoDBClient\GraphHandler::saveEdge() - - save an edge to a graph - This will save the edge to the graph and return the edges-document's id - -This will throw if the edge cannot be saved<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed + + + URL_ADMIN_VERSION + \ArangoDBClient\Urls::URL_ADMIN_VERSION + '/_api/version' + + URL for admin version + + + + + URL_ADMIN_SERVER_ROLE + \ArangoDBClient\Urls::URL_ADMIN_SERVER_ROLE + '/_admin/server/role' + + URL for server role + + + + + URL_ADMIN_TIME + \ArangoDBClient\Urls::URL_ADMIN_TIME + '/_admin/time' + + URL for admin time + + + + + URL_ADMIN_LOG + \ArangoDBClient\Urls::URL_ADMIN_LOG + '/_admin/log' + + URL for admin log + + + + + URL_ADMIN_ROUTING_RELOAD + \ArangoDBClient\Urls::URL_ADMIN_ROUTING_RELOAD + '/_admin/routing/reload' + + base URL part for admin routing reload + + + + + URL_ADMIN_STATISTICS + \ArangoDBClient\Urls::URL_ADMIN_STATISTICS + '/_admin/statistics' + + base URL part for admin statistics + + + + + URL_ADMIN_STATISTICS_DESCRIPTION + \ArangoDBClient\Urls::URL_ADMIN_STATISTICS_DESCRIPTION + '/_admin/statistics-description' + + base URL part for admin statistics-description + + + + + URL_AQL_USER_FUNCTION + \ArangoDBClient\Urls::URL_AQL_USER_FUNCTION + '/_api/aqlfunction' + + base URL part for AQL user functions statistics + + + + + URL_USER + \ArangoDBClient\Urls::URL_USER + '/_api/user' + + base URL part for user management + + + + + URL_TRAVERSAL + \ArangoDBClient\Urls::URL_TRAVERSAL + '/_api/traversal' + + base URL part for user management + + + + + URL_ENDPOINT + \ArangoDBClient\Urls::URL_ENDPOINT + '/_api/endpoint' + + base URL part for endpoint management + + + + + URL_DATABASE + \ArangoDBClient\Urls::URL_DATABASE + '/_api/database' + + base URL part for database management + + + + + URL_QUERY_CACHE + \ArangoDBClient\Urls::URL_QUERY_CACHE + '/_api/query-cache' + + URL for AQL query result cache + + + + + URL_UPLOAD + \ArangoDBClient\Urls::URL_UPLOAD + '/_api/upload' + + URL for file uploads + + + + + URL_FOXX_INSTALL + \ArangoDBClient\Urls::URL_FOXX_INSTALL + '/_admin/foxx/install' + + URL for foxx-app installations + + + + + URL_FOXX_UNINSTALL + \ArangoDBClient\Urls::URL_FOXX_UNINSTALL + '/_admin/foxx/uninstall' + + URL for foxx-app deinstallation + + + + + eJytmG1zozYQx9/7U+hd2kxcX/My105LMOfQw0B4yCUzmfHIWGczwcBJwpdMp9+9K2Eb/CDBpc2bZIL2/9Muu6sVv/1RrsrBYHR5OUCXyKA4XxbjW+Tf+SjJUpLzG3SLGUFx4DBYIRb9WeLkBS8JQvv1plwqH+KKrwoKz9BfOEchJ2SN81w+SoryjabLFUfm/q/rD79eXyFOUxDMGZqs53dX8Dgrljm5QhNCwfoNrEeDQY7XhAGbHGE/7rcfFmuC5pilydn9ntktS/NEOPLhl2sJwXPGKU44OI8ZQzHN2ODvgfBGIsTPpdAWFIJKTDn6Ct4uiqRag+aQkgxzskBmEI9RURKKeVqAX4EVRijBGcjVIiP5O4FnXOjNxp4ZTy03Qr+ji9EMl+lop3kB/nVugCyW5P1wazyx3gkGVUQJvD+ySfOl0MxJIjYhdqTjhQ1QLu1NW1Jcrva+dvo2CQz/rmEtVxhyLQOaWNaPuEnJ9/7AB9v60vCErcI1ydgQysnrXl0618nwjSCaPVhBZD0KUq2ho5ykyA9wdskh7Hu/pKTIMsgDSL/+gTM9x7HMyPbcJnyNTm90mi9aAe2k2u64jmINlNZnWPNtE2xYSUUZ/NqBmnpTuRcHoRe0XJP2CrfkC3stC2D1BliPvhe0GkhtrwEY946AZDht3lIfimPY7gFGKHRwvlWEvqENztIFPkiLTuB9bAVPDU4KaWCMiIQZzt+G5BWvy4wo/TCmvtNqeywVq0eNoQbyNaWMdwA+2UEYKTEHChqSPP3O6hvu04kqrNbtusoyaBRcteHYcaCjRKd73doppClZFxvSHfHAmnoP1uz2SRmUEyWNM83aF/Kmyp0G+dl6CjU8oaGBVSVkbQ8XY39sRFoXT5S0LkJlJb0iCzVpdoT2WEsDzoripSo7Yut43ufYV8b2UKO7YMVspvTPcCdnXBIW3cLQ+1UV5DinFZRlvSR1kQHd8zHZ2f23aLiWEZxI5wTrzpIesl/s6K7d17fC31O+0nb33biIYD2cN6pjdnp4ONWLNbJzzJMVKmmREAZT+lKhe2tEZmu8k1YaVRjuc4YT3XkTQbaFxtEc0rLTjI4y0ryg4rJB8mWaKw8fd2K7rYyuF+uOgcU6zcWwyGAHqrQbT21XjIXhwda3RtrkoLAI0ULZYGrp0ApAfRZ4+/4idjWqzUfCvNMDnq71jMieHogLg05VuC1qRR1v0taE5b0mvFqcFhUXVxsYWAq80HICL45sdwL92PGMcRu5FRnVIj9AZxyGI8bTRNls6lcTGZEdRrYZHryZvfG7iMMFYQlNS96Vcw19NrZCM7D9VvUc7aQt2mtXYnqsIMdgfMnrwu0RlHs4iyFdYaZxjyoZf8t2Qr3wEr3GOdT0Wn41OAsUsIYhbP5HcehIoqoN56AfibrG5w6rUwzJF2WRQovuRFnu2Pfs9meInW0vEMw2WP63EwRzknFrhO3PDlvbXhcJSliVcbjYJStVP5H3hplpmHfW0e1hKM20431GYOYTparKsNhvlbh45aWisPeaxevrEJcl3E8hfbNMe+f55D0+ws0U6mo/osgyEiKjrUAf1oK0aTpY7KpwVd4A/xkM5IexGdzjMPtJfB67uZH/uUIXz7uveM/bD23zZ7Hg4uePg38BaMq1fw== + + + + ArangoDB PHP client: single document + + + + + + + + + EdgeDefinition + \ArangoDBClient\EdgeDefinition + + Value object representing an edge Definition. + An edge definition contains a collection called 'relation' to store the edges and +multiple vertices collection defined in 'fromCollections' and 'toCollections'. + +<br> + + + + + $_relation + \ArangoDBClient\EdgeDefinition::_relation + + + The name of the edge collection for this relation. + + + string - - mixed + + + + $_fromCollections + \ArangoDBClient\EdgeDefinition::_fromCollections + array() + + An array containing the names of the vertices collections holding the start vertices. + + + array - - mixed + + + + $_toCollections + \ArangoDBClient\EdgeDefinition::_toCollections + array() + + An array containing the names of the vertices collections holding the end vertices. + + + array - - mixed + + + + __construct + \ArangoDBClient\EdgeDefinition::__construct() + + Constructs an new edge definition + + + string - + + array string - - mixed + + array + string - + - $graph - - mixed - - - $from - - mixed - - - $to - - mixed - - - $label + $relation null - mixed + string - $document - - mixed + $fromCollections + array() + array|string - $collection - null - string + $toCollections + array() + array|string - - getEdge - \ArangoDBClient\GraphHandler::getEdge() - - Get a single edge from a graph - This will throw if the edge cannot be fetched from the server<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - array - - + + setRelation + \ArangoDBClient\EdgeDefinition::setRelation() + + Set the relation of the edge definition + + string - - \ArangoDBClient\Document - - + - $graph - - mixed - - - $edgeId + $relation - mixed - - - $options - array() - array - - - $collection - null string - - hasEdge - \ArangoDBClient\GraphHandler::hasEdge() - - Check if an edge exists - This will call self::getEdge() internally and checks if there -was an exception thrown which represents an 404 request. - - \ArangoDBClient\Exception + + getRelation + \ArangoDBClient\EdgeDefinition::getRelation() + + Get the relation of the edge definition. + + + string - - mixed + + + + + getToCollections + \ArangoDBClient\EdgeDefinition::getToCollections() + + Get the 'to' collections of the graph. + + + array - - mixed + + + + + getFromCollections + \ArangoDBClient\EdgeDefinition::getFromCollections() + + Get the 'from' collections of the graph. + + + array - - boolean + + + + + addToCollection + \ArangoDBClient\EdgeDefinition::addToCollection() + + Add a 'to' collections of the graph. + + + string + - $graph + $toCollection - mixed + string + + + addFromCollection + \ArangoDBClient\EdgeDefinition::addFromCollection() + + Add a 'from' collections of the graph. + + + string + + + - $edgeId + $fromCollection - mixed + string - - replaceEdge - \ArangoDBClient\GraphHandler::replaceEdge() - - Replace an existing edge in a graph, identified graph name and edge id - This will replace the edge on the server - -This will throw if the edge cannot be Replaced - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed document has a _rev value set, the database will check -that the revision of the to-be-replaced edge is the same as the one given.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed - - - \ArangoDBClient\Edge - - - mixed + + clearToCollection + \ArangoDBClient\EdgeDefinition::clearToCollection() + + Resets the 'to' collections of the graph. + + + + + + clearFromCollection + \ArangoDBClient\EdgeDefinition::clearFromCollection() + + Resets the 'from' collections of the graph. + + + + + + transformToArray + \ArangoDBClient\EdgeDefinition::transformToArray() + + Transforms an edge definition to an array. + + + array - + + + + + createUndirectedRelation + \ArangoDBClient\EdgeDefinition::createUndirectedRelation() + + Constructs an undirected relation. This relation is an edge definition where the edges can start and end +in any vertex from the collection list. + + string - - boolean + + array + + + \ArangoDBClient\EdgeDefinition - + - $graph - - mixed - - - $edgeId - - mixed - - - $label + $relation - mixed + string - $document + $vertexCollections - \ArangoDBClient\Edge - - - $options - array() - mixed - - - $collection - null - string + array - - updateEdge - \ArangoDBClient\GraphHandler::updateEdge() - - Update an existing edge in a graph, identified by graph name and edge id - This will update the edge on the server - -This will throw if the edge cannot be updated - -If policy is set to error (locally or globally through the ConnectionOptions) -and the passed edge-document has a _rev value set, the database will check -that the revision of the to-be-replaced document is the same as the one given.<br><br> - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed - - - \ArangoDBClient\Edge + + createDirectedRelation + \ArangoDBClient\EdgeDefinition::createDirectedRelation() + + Constructs a directed relation. This relation is an edge definition where the edges can start only in the +vertices defined in 'fromCollections' and end in vertices defined in 'toCollections'. + + + string - - mixed + + array + string - + + array string - - boolean + + \ArangoDBClient\EdgeDefinition - + - $graph - - mixed - - - $edgeId + $relation - mixed + string - $label + $fromCollections - mixed + array|string - $document + $toCollections - \ArangoDBClient\Edge + array|string - - $options - array() - mixed + + + eJztWE1v4zYQvftXzCGAnMBx2qCn7Ec3m+xmj4tt2ksSGLRE22ppSqCobI1t/3uHFEWRlGRL2aS91AgQm0POzJs3M+Lo9c/5Jp9Mzk5OJnACl4LwdXb9Hj5/+gwxSymXF1CkfM0oJFlcbnEB96mt73IS/0HWFMCeutIHtJCUcpMJlMFHlomUcHhPhKSs0NI4y3ciXW8kXNlv5z/8+NMMJO5dU17AzXb5aYZilq05ncENFVvCd7VtdClWlgHO5+e4cjaZcLKlBfpEA3deWXC/EVZSyJa/01iCoLmgBcoRHKB7NEEo13SV8lSmGZ/raJjlxC5DnHFJUvSP4FfGUJNeJfg1gUhQRtRCBDKDQmaCgtxQrQRP8EQp3ZZMpjnG85EKmcYocBRpS6gp5RCtRLa9sqIiUgogkpm7NjcBeb0Ubwfx0g5czEhRwAd0sUE/+TZRW3Tc1OcEbhGGijBkKwvJdXyFZMtNWkAdgrk5WSt490gEhkSocO9RZLaf6f+5yCQuYzyOFrVepDNwDVkiQpBdzY2yII27RW2mI9gFbDKW1LsLiflpt3V6X1nx1PqnhuAIWIU3cPfwUpgoJsxYRO6ZIXi8fOxBc4UiKcpYqiIATr+GZRX6lhNBtnW2VJ+jOgHMbzj10shKp+pXyRMq2E6dDvLreB4Y0SH4y5g6Ctk5xTpnaSGVGTfKGIHHtImzru8gF7AgSA2hJoXUvdSpHIViv1N+iGGUUx6dT3HJehZ0DldosqJcsjSGVckrLYtFXPM+bdh7A7xkbNYOtUqdWQhWLR5r7VVH0pmg+szp24Wj8ijoDnpb28BUx/W4JXrl6A5i7RzyRK4h40/b3j471Zm2udCM2v13q6J+odJPe7ebDqyrhpNT21vCchqUBd30F1R+MVoa+sdx2Y39Zhj2luuCylJwg/4JgNYOoBCH0R3CsRD6MODjPPJq2GBZC5Jv+hDohHwagFs3uQ6hGJSJFonK9X8Vy0e/uA6h6azFNp7LJMGeOI4Xv6zcsHWUFkkSfHA2ur+jxFCVS+jUM91Xah6rdw9hyzkQl5Es+5HxKXjx2PgJMg3M98UnyJMqQv5iX4y+4ECBd5zxhT0cVswoER7pg3g2F7PDbo/kd6TjASPjKnYvhlscdQocQraFHeacqQ2nMWJ6zXM3Ilkbvs0ulYoOPuodNPmQgP9pILW33kUNDVFVpzou3nOo/7Bm8sHaaQ63+ma/DkziB8fXRkfwHHFuQ5ZDV1Pvc9CfDPDanopqsLAXEJw8nakS0k5+v26oN2rHhJvruJqZqRq8K3s4VxO+0zdi+ieoEOlTzt1XXawPtLFwEnneWQRZqNz7vjnEAO+f/wxRweA/uADQivTqW1Ai6a+Wwfbdb9YBrKcDqBHRd2y/mk7Vg5IOnj3jMs52Ks9QVhu0A9jB1zuKMRR2Hmi9+dmTo6ac/5+Z/9uZ+UVq7HpfhQVkhAP10+rtkFJbafinXycuCEtJMfVVXlxo2Qyi+/ot7715Q7m897dGqPIfNEzqrA== + + + + ArangoDB PHP client: client exception + + + + + + + \ArangoDBClient\Exception + ClientException + \ArangoDBClient\ClientException + + Client-Exception + This exception type will be thrown by the client when there is an error +on the client side, i.e. something the server is not involved in.<br> +<br> + + + + + + $enableLogging + \ArangoDBClient\Exception::enableLogging + false + + + + + + + __toString + \ArangoDBClient\ClientException::__toString() + + Return a string representation of the exception + + + + string + + + + + __construct + \ArangoDBClient\Exception::__construct() + + Exception constructor. + + + string + + + integer + + + \Exception + + + + $message + '' + string - $collection + $code + 0 + integer + + + $previous null - string + \Exception + \ArangoDBClient\Exception - - removeEdge - \ArangoDBClient\GraphHandler::removeEdge() - - Remove a edge from a graph, identified by the graph name and edge id<br><br> + + enableLogging + \ArangoDBClient\Exception::enableLogging() + + Turn on exception logging + + + \ArangoDBClient\Exception + + + disableLogging + \ArangoDBClient\Exception::disableLogging() + + Turn off exception logging + + + \ArangoDBClient\Exception + + + eJyFUsFu4jAQvecr5rASFEHocoSqpUurVqtWqsoekSLHDIm1yTgaGyiq+u87NoFW0Ur1ZWy/ec/zXnJ105RNkowHgwQGcMuKCnv3C14eX0BXBslP2wr4prHxxpI0ht55o/RfVSDAmbaInRFUW19aFgx+K4KlR6wVUYS0bQ5sitLD4rybXP6cDMGzEUFy8FDnj0OBK1sQDuEBWdgHYY+ThFSNTt7GzrOzs4vjeXTfGfhPadynC/CHBmFvqgpyBF+y3RPkB9nhyfG+RApnRhCm2EBmy0HK0tc+Z9YypEkxBWdr9KWhIuIOeYccyGQ9GNrZaodr2aRXOV8HobZ+n6czpAMEcJlOYhC6Us61Xs9WxZ9HWjv4NP+eBFaMJqwBvKLfMoECJ3nLpIwNoxMVFRXsJs7+5XNH2ok9r1VhdPeSj5qt4uj/0m33ONZmm1dGw2ZLOj6bZd4uI6t/ERuOc4fVimfZ4ul2ucwySKE3hZ6UH5K1G10X6J/ROQmvfzGLtI/kIzkmlKnKKNfv5DSdRnAIvdXpp1u1qeerTm9PNP8BNt79Cg== + + + + ArangoDB PHP client: export + + + + + + + + Export + \ArangoDBClient\Export + + Collection export + + + + + + ENTRY_COUNT + \ArangoDBClient\Export::ENTRY_COUNT + 'count' + + Count option index + + + + + ENTRY_BATCHSIZE + \ArangoDBClient\Export::ENTRY_BATCHSIZE + 'batchSize' + + Batch size option index + + + + + ENTRY_FLUSH + \ArangoDBClient\Export::ENTRY_FLUSH + 'flush' + + Flush option index + + + + + ENTRY_RESTRICT + \ArangoDBClient\Export::ENTRY_RESTRICT + 'restrict' + + Export restrictions + + + + + ENTRY_LIMIT + \ArangoDBClient\Export::ENTRY_LIMIT + 'limit' + + Optional limit for the number of documents + + + + + $_connection + \ArangoDBClient\Export::_connection + + + The connection object + + + \ArangoDBClient\Connection + + + + + $_collection + \ArangoDBClient\Export::_collection + + + The collection name or collection object + + + mixed + + + + + $_batchSize + \ArangoDBClient\Export::_batchSize + + + The current batch size (number of result documents retrieved per round-trip) + + + mixed + + + + + $_flat + \ArangoDBClient\Export::_flat + false + + "flat" flag (if set, the query results will be treated as a simple array, not documents) + + + boolean + + + + + $_flush + \ArangoDBClient\Export::_flush + true + + Flush flag (if set, then all documents from the collection that are currently only +in the write-ahead log (WAL) will be moved to the collection's datafiles. This may cause +an initial delay in the export, but will lead to the documents in the WAL not being +excluded from the export run. If the flush flag is set to false, the documents still +in the WAL may be missing in the export result. + + + boolean + + + + + $_type + \ArangoDBClient\Export::_type + + + The underlying collection type + + + + + $_restrictions + \ArangoDBClient\Export::_restrictions + + + export restrictions - either null for no restrictions or an array with a "type" and a "fields" index + + + mixed + + + + + $_limit + \ArangoDBClient\Export::_limit + 0 + + optional limit for export - if specified and positive, will cap the amount of documents in the cursor to +the specified value + + + integer + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string + + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string + + + + + __construct + \ArangoDBClient\Export::__construct() + + Initialize the export + + + \ArangoDBClient\Exception + + + \ArangoDBClient\Connection + + + string + + + array + + + + $connection + + \ArangoDBClient\Connection + + + $collection + + string + + + $data + array() + array + + + + getConnection + \ArangoDBClient\Export::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection + + + + + execute + \ArangoDBClient\Export::execute() + + Execute the export + This will return the results as a Cursor. The cursor can then be used to iterate the results. + + \ArangoDBClient\Exception + + + \ArangoDBClient\ExportCursor + + + + + setBatchSize + \ArangoDBClient\Export::setBatchSize() + + Set the batch size for the export + The batch size is the number of results to be transferred +in one server round-trip. If an export produces more documents +than the batch size, it creates a server-side cursor that +provides the additional results. + +The server-side cursor can be accessed by the client with subsequent HTTP requests. + + \ArangoDBClient\ClientException + + + integer + + + void + + + + $value + + integer + + + + getBatchSize + \ArangoDBClient\Export::getBatchSize() + + Get the batch size for the export + + + integer + + + + + getCursorOptions + \ArangoDBClient\Export::getCursorOptions() + + Return an array of cursor options + + + array + + + + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + eJylWdtuGzcQffdXTAyjkgLJTgu0D07k1lbV2EWaGLaCXhJDoHYpic2KuyW5ttUm/94Zci/cm2y3AtrIu+TM4XDmzCH16vtkneztHT1/vgfP4VQxuYp/PIPL80sIIsGlOQZ+n8TK4Gsa8UPCgk9sxQGKwRM7zr5kqVnHCt/Bz0zCteF8w6S0r4I42SqxWhuYFN++efH1t0MwSqBBqeH1ZnE+xNdRvJJ8CK+5wtlbnH20tyfZhmv0zWtuXxbYcV7EAyNi2YG4Ba8WMqClfHP4nXUTRExrmLrp/+zRQqx1+jyHiw09h4N5GAfpBm1M7PBlKq1bFgmzzcYe2X9TzeFHfyxbRBwR1+zO1hyCWMoMfbz4E79lL/MxP9wyhUvMB1XcJErcMsMRWGmly0sRIwoo4F55j7odb8Q9Dzt95gY6fKZK4fphwUywBi3+5tCX6WbBFcRLUFynkYE8ohofYD7wWx5CgiNUnMpwhE+SwVNxWX/X6K4Ja38ZMbMP+P8V9MUSNDeYhoj1r5SrbYZJw52IIlhwTFCOJkNgGhguYJNEHJhSbDsEGXvYWyEu4jjqQEgoYAxLFukWkD9FqV43MUpgiKqM11LFG4vd20izRsNMFbGPthDLKM9NENJOuFPC8BFbcxYClhz0fz19MygWvYlpD0xcs93TEDLDliLi+hD3V2jYsC0EDHM9t4+lL6QwgiFOHuHbzKEryyEsUuPcROQ6c1GuKBuNaGx4F1zIVW6a3wdRGiKwYtnOKKhUHsLF0j5alpFDeBg48mGjPKy50gZh1MJCfmlJFAOhkSFWVfxZehw+ebMJ1BiTKe2gAMx0rqItOfT3cpvwDpP0qmmqRIllY21oGAEXuAIFMsWwL7HsZVwdgY9w22xW496YNWb6Ptnfx8ch/bEUPAr1PsYi5PdPrUXfVRNxnDj6hEhshLHwskWMgDI/4YFA96GFksQaU+sWt9KmUMASuzdsg0xhiFEaiYRFoNGkiXN/9LA0esuilLctSEjTsRyHcwwvmmuZOBh2RZVYORtI0NrA9O3s6vf55N37tzO00gtoTq9p66xkzEcZPDudTc6vL/6YktGC/loMO2p5lM2f3ry/Pid7Nn9bbE2b6dZp7Gp6Pbu6mNhF5xNaTL5r5gNtWdk0ii3u9PTm4pcL68aaaPFx4QiKYluWdj0LzFrFd6QHAp54Xbd4nzDFNl5XhgOvjY8y5iweIAkhpyBPhjUDFAgsevoceJU/atB6XMWZz3dV6+YTObuvVPRub9xGV4OVpItIBIV2gfnchk+lgem3L2jogxtmTp2/MXy4cc3PaSaLxGBvGJ14kgSHHTQECn2wxvvP+v7SBUJhKM1wr0tZNxh45mvBOkdqiDA5xiD5nTcne95vohm87LKVPxq3OBidrLjxoXpmvrSsvbBZMeat/egIgjUPPlEQ7jhWBdzF6hOlg2NhFLPhqpIFlrxNwxeRNXlpuLaQZ/i2P6jFHLsbLYa28IPm0fL42Kv5m0a4ESr1UoZNfclItHnMWQOTN7su237QHgWpoLYmrMwnzjvLKW+3gSc7t2TS6bjoBn1sGIOWJbvpT/aak+XNAL76quJY6Lmtvp2TihkN2JW+37ZHhREvX3K0zzK4vpEPPUq+HgL9/LkygT7PhMzRts0ZwoceHsJI1PWG0Mv0HT0noTSomKuvhD6YlJiGIqTG7Ns/LHWT97GE7ijCHgILZu/3LqS1U1VFtqgw3a2cRfFbI40vj42PE0+dEdLtESpm/fcoOBP/Ow7OzOMjgXjolOIstRZNPQmrCrHFbL1UnO6YWG1XksvpjjrNjlt9Eul5nXZaqdP6l4aCuOImVbLe5NvP0MqNnexQB5WJueCMDT6j007eppHKSyP9es/N3DSb3cuONUzveZCaHRLIHvCs0FblcvPzsT0Pu9gd5kd9UtoBk+6kmskdEi541FQs85TNb5ygOuRWET5/s3aKGe6W1YhPoVYq+dFoTzA+qXayYef4TMOfWLYqRt3UGm1urNDkcAIvGmm6o2d5jd271igztNWb60uP8uRalOfFzt1RhzlhtVRzs/66G4zn8UECOKiqqYbOeVkNwoNqsltMVsWa1U9v2cbqpzZcqYrctzG8V9E5jxKOXMKShMvwkgS6xsd9/E8fH7+/ejOf/nb57mpGjc+7VrE5V/7tqxTixgSjUpV3eWmPTvBEjKSIKIb56xpLjE7+1LGccxnEIZ/fKYKmHI0OfE2YlRm1Bb/UWsTzsARlvf2syU/Fv53qTnK6Pxh0MdA13c4gJ3i3g/l5r4OQKmORnapHw5yb3GHLKCb1kitVnrkEUq3E8z9Xt5X7RXt7xPK7Y+LeMA24hk2seOPASTdssoZ7iBwHgb0qtPeE1sFIi7C8gViz4uiG9m/xlYPPwlBkR94ObqRlt1gkpsVlsgCREtEutq6t2KbuThA6XWj+V0p/n89ml+gA/9Dd7FsTBO1HXlS6cGDlPzYybzta71KytLqNRe16qMbaVQVvTdUJPFNYc/Sfj0BFlStvB+jVuMl4O/SOd8mi13EahTagxTUTLZWvuOp1FH+D2ccVNF1p//qJaZ8HkQI/artS9yPfHt6VH94HlEOtyXSKn+LKECsvS8nqZUMdvxs9Kme13k1kF20V1VPlk3pjz35GqLf2LnlH75BwcynoCcThg/PPTq+nSOM0v8HpD06e/X45zZz7B/fqxF71B6ae/86bWBlUWrhpMnoWnnwzcTvtD11zlOdM9x3O42P7DM9gH/Mf5D5mv5gtProhVAP/Au9WPJE= + + + + ArangoDB PHP client: value validator + + + + + + + + ValueValidator + \ArangoDBClient\ValueValidator + + A simple validator for values to be stored in the database + + + + + + validate + \ArangoDBClient\ValueValidator::validate() + + Validate the value of a variable + Allowed value types are string, integer, double and boolean. Arrays are also allowed if they contain only one of the former types. + + \ArangoDBClient\ClientException + + + mixed + + + void + + + + $value + + mixed + + + + eJyNVE1v2zAMvftX8FAgWZAlXY5Jg6XrhnY7FRiQU4CAdmhbqCwZktzUWPvfR8kfSYxgmAF/QHzie4+kfPe1zMsomk8mEUzg3qDK9Pdv8Pz0DIkUpNwSXlFW5J/igE4bxnnopsTkBTMC6Hc9hA0hiJXLteEY/EIFvx1RgUqFUKLL2ogsd/DQfy1uvyym4IzghMrCYxE/TTksdaZoCo9keHfNu+dRpLAgy9w0oF2dTIAVRSnPJEPKd7BhwWmICSyv0gGEApcTMAhjtDS0dsWYFSrxnm9ni6AnkWgtbH3ubV+hP5F3HuT4awJtiAJbU0+dAvInW44ltbgOfi+lPrK8BunqknWj8aqNUNmUZTvKyEzhoCveDagOEGstCdWMRRusGzxKq/nRJBOpZ68h0cohG9dK1vwISrwsrlFBpmGbDQRtXG700UJTiB9vCZVOaDVElWiwgEK8Md1NI/5zZ0J37Ria3RhylVHwqsWB4UchJQQ6r5iHR6iw8awYICyUXHY6tDnm4V1yLUTCRULHr7RSidfY044bRZ8CtumQv5hkLOy+KW2Hgfd3JtlznQcrqdQ4XPOVP19SFTtYr9fQrZ3IwljMexNtay7CTTVW/dpHNJSKvsEd4ZXsRWUdJDklL54ASFLBTbNd4wd83HbCJIc2IaCFG1vF22vS/WVJpsvlqag9dnUBPZP9H65abqG4eXy+eCL58EsKDRyK+Eeqs9K2U9OHmolSdBzO8Hj0sx2wWPAxCiNMjtr/xai19RExTTjre8aiHV+e+OUyxKYw2nU/sV3784h3l1Cf8S+uaaQg + + + + ArangoDB PHP client: graph handler + + + + + + + + + + \ArangoDBClient\Handler + GraphHandler + \ArangoDBClient\GraphHandler + + A handler that manages graphs. + + + + + + + ENTRY_GRAPH + \ArangoDBClient\GraphHandler::ENTRY_GRAPH + 'graph' + + documents array index + + + + + OPTION_REVISION + \ArangoDBClient\GraphHandler::OPTION_REVISION + 'revision' + + conditional update of edges or vertices + + + + + OPTION_VERTICES + \ArangoDBClient\GraphHandler::OPTION_VERTICES + 'vertices' + + vertex parameter + + + + + OPTION_EDGES + \ArangoDBClient\GraphHandler::OPTION_EDGES + 'edges' + + direction parameter + + + + + OPTION_KEY + \ArangoDBClient\GraphHandler::OPTION_KEY + '_key' + + direction parameter + + + + + OPTION_COLLECTION + \ArangoDBClient\GraphHandler::OPTION_COLLECTION + 'collection' + + collection parameter + + + + + OPTION_COLLECTIONS + \ArangoDBClient\GraphHandler::OPTION_COLLECTIONS + 'collections' + + collections parameter + + + + + KEY_FROM + \ArangoDBClient\GraphHandler::KEY_FROM + '_from' + + example parameter + + + + + KEY_TO + \ArangoDBClient\GraphHandler::KEY_TO + '_to' + + example parameter + + + + + OPTION_NAME + \ArangoDBClient\GraphHandler::OPTION_NAME + 'name' + + name parameter + + + + + OPTION_EDGE_DEFINITION + \ArangoDBClient\GraphHandler::OPTION_EDGE_DEFINITION + 'edgeDefinition' + + edge definition parameter + + + + + OPTION_EDGE_DEFINITIONS + \ArangoDBClient\GraphHandler::OPTION_EDGE_DEFINITIONS + 'edgeDefinitions' + + edge definitions parameter + + + + + OPTION_ORPHAN_COLLECTIONS + \ArangoDBClient\GraphHandler::OPTION_ORPHAN_COLLECTIONS + 'orphanCollections' + + orphan collection parameter + + + + + OPTION_DROP_COLLECTION + \ArangoDBClient\GraphHandler::OPTION_DROP_COLLECTION + 'dropCollection' + + drop collection + + + + + $cache + \ArangoDBClient\GraphHandler::cache + + + GraphHandler cache store + + + + + $cacheEnabled + \ArangoDBClient\GraphHandler::cacheEnabled + false + + + + + + + + $batchsize + \ArangoDBClient\GraphHandler::batchsize + + + batchsize + + + + + $count + \ArangoDBClient\GraphHandler::count + + + count + + + + + $limit + \ArangoDBClient\GraphHandler::limit + + + limit + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string + + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string + + + + + createGraph + \ArangoDBClient\GraphHandler::createGraph() + + Create a graph + This will create a graph using the given graph object and return an array of the created graph object's attributes.<br><br> + + \ArangoDBClient\Exception + + + \ArangoDBClient\Graph + + + array + + + + + $graph + + \ArangoDBClient\Graph + + + + getGraph + \ArangoDBClient\GraphHandler::getGraph() + + Get a graph + This will get a graph.<br><br> + + String + + + array + + + \ArangoDBClient\Graph + false + + + \ArangoDBClient\ClientException + + + + + $graph + + String + + + $options + array() + array + + + + setBatchsize + \ArangoDBClient\GraphHandler::setBatchsize() + + Sets the batchsize for any method creating a cursor. + Will be reset after the cursor has been created. + + integer + + + + $batchsize + + integer + + + + setCount + \ArangoDBClient\GraphHandler::setCount() + + Sets the count for any method creating a cursor. + Will be reset after the cursor has been created. + + integer + + + + $count + + integer + + + + setLimit + \ArangoDBClient\GraphHandler::setLimit() + + Sets the limit for any method creating a cursor. + Will be reset after the cursor has been created. + + integer + + + + $limit + + integer + + + + properties + \ArangoDBClient\GraphHandler::properties() + + Get a graph's properties<br><br> + + + \ArangoDBClient\Exception + + + mixed + + + boolean + + + + + $graph + + mixed + + + + dropGraph + \ArangoDBClient\GraphHandler::dropGraph() + + Drop a graph and remove all its vertices and edges, also drops vertex and edge collections<br><br> + + + \ArangoDBClient\Exception + + + mixed + + + boolean + + + boolean + + + + + $graph + + mixed + + + $dropCollections + true + boolean + + + + addOrphanCollection + \ArangoDBClient\GraphHandler::addOrphanCollection() + + add an orphan collection to the graph. + This will add a further orphan collection to the graph.<br><br> + + \ArangoDBClient\Exception + + + mixed + + + string + + + \ArangoDBClient\Graph + + + + + $graph + + mixed + + + $orphanCollection + + string + + + + deleteOrphanCollection + \ArangoDBClient\GraphHandler::deleteOrphanCollection() + + deletes an orphan collection from the graph. + This will delete an orphan collection from the graph.<br><br> + + \ArangoDBClient\Exception + + + mixed + + + string + + + boolean + + + \ArangoDBClient\Graph + + + + + $graph + + mixed + + + $orphanCollection + + string + + + $dropCollection + false + boolean + + + + getVertexCollections + \ArangoDBClient\GraphHandler::getVertexCollections() + + gets all vertex collection from the graph. + This will get all vertex collection (orphans and used in edge definitions) from the graph.<br><br> + +If this method or any method that calls this method is used in batch mode and caching is off,<br> +then for each call, this method will make an out of batch API call to the db in order to get the appropriate collections.<br><br> + +If caching is on, then the GraphHandler will only call the DB API once for the chosen graph, and return data from cache for the following calls.<br> + + mixed + + + array + + + array + + + \ArangoDBClient\ClientException@since + + + + $graph + + mixed + + + $options + array() + array + + + + addEdgeDefinition + \ArangoDBClient\GraphHandler::addEdgeDefinition() + + adds an edge definition to the graph. + This will add a further edge definition to the graph.<br><br> + + \ArangoDBClient\Exception + + + mixed + + + \ArangoDBClient\EdgeDefinition + + + \ArangoDBClient\Graph + + + + + $graph + + mixed + + + $edgeDefinition + + \ArangoDBClient\EdgeDefinition + + + + deleteEdgeDefinition + \ArangoDBClient\GraphHandler::deleteEdgeDefinition() + + deletes an edge definition from the graph. + This will delete an edge definition from the graph.<br><br> + + \ArangoDBClient\Exception + + + mixed + + + string + + + boolean + + + \ArangoDBClient\Graph + + + + + $graph + + mixed + + + $edgeDefinition + + string + + + $dropCollection + false + boolean + + + + getEdgeCollections + \ArangoDBClient\GraphHandler::getEdgeCollections() + + gets all edge collections from the graph. + This will get all edge collections from the graph.<br><br> + +If this method or any method that calls this method is used in batch mode and caching is off,<br> +then for each call, this method will make an out of batch API call to the db in order to get the appropriate collections.<br><br> + +If caching is on, then the GraphHandler will only call the DB API once for the chosen graph, and return data from cache for the following calls.<br> + + \ArangoDBClient\Exception + + + mixed + + + array + + + + + $graph + + mixed + + + + replaceEdgeDefinition + \ArangoDBClient\GraphHandler::replaceEdgeDefinition() + + replaces an edge definition of the graph. + This will replace an edge definition in the graph.<br><br> + + \ArangoDBClient\Exception + + + mixed + + + \ArangoDBClient\EdgeDefinition + + + \ArangoDBClient\Graph + + + + + $graph + + mixed + + + $edgeDefinition + + \ArangoDBClient\EdgeDefinition + + + + saveVertex + \ArangoDBClient\GraphHandler::saveVertex() + + save a vertex to a graph + This will add the vertex-document to the graph and return the vertex id + +This will throw if the vertex cannot be saved<br><br> + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + string + + + string + + + + + $graph + + mixed + + + $document + + mixed + + + $collection + null + string + + + + getVertex + \ArangoDBClient\GraphHandler::getVertex() + + Get a single vertex from a graph + This will throw if the vertex cannot be fetched from the server<br><br> + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + array + + + string + + + \ArangoDBClient\Document + + + + + $graph + + mixed + + + $vertexId + + mixed + + + $options + array() + array + + + $collection + null + string + + + + hasVertex + \ArangoDBClient\GraphHandler::hasVertex() + + Check if a vertex exists + This will call self::getVertex() internally and checks if there +was an exception thrown which represents an 404 request. + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + boolean + + + + $graph + + mixed + + + $vertexId + + mixed + + + + replaceVertex + \ArangoDBClient\GraphHandler::replaceVertex() + + Replace an existing vertex in a graph, identified graph name and vertex id + This will update the vertex on the server + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced vertex is the same as the one given.<br><br> + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + \ArangoDBClient\Document + + + mixed + + + string + + + boolean + + + + + $graph + + mixed + + + $vertexId + + mixed + + + $document + + \ArangoDBClient\Document + + + $options + array() + mixed + + + $collection + null + string + + + + updateVertex + \ArangoDBClient\GraphHandler::updateVertex() + + Update an existing vertex in a graph, identified by graph name and vertex id + This will update the vertex on the server + +This will throw if the vertex cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed vertex-document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given.<br><br> + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + \ArangoDBClient\Document + + + mixed + + + string + + + boolean + + + + + $graph + + mixed + + + $vertexId + + mixed + + + $document + + \ArangoDBClient\Document + + + $options + array() + mixed + + + $collection + null + string + + + + removeVertex + \ArangoDBClient\GraphHandler::removeVertex() + + Remove a vertex from a graph, identified by the graph name and vertex id<br><br> + + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + mixed + + + string + + + boolean + + + + + $graph + + mixed + + + $vertexId + + mixed + + + $revision + null + mixed + + + $options + array() + mixed + + + $collection + null + string + + + + saveEdge + \ArangoDBClient\GraphHandler::saveEdge() + + save an edge to a graph + This will save the edge to the graph and return the edges-document's id + +This will throw if the edge cannot be saved<br><br> + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + mixed + + + mixed + + + string + + + mixed + + + + + $graph + + mixed + + + $from + + mixed + + + $to + + mixed + + + $label + null + mixed + + + $document + + mixed + + + $collection + null + string + + + + getEdge + \ArangoDBClient\GraphHandler::getEdge() + + Get a single edge from a graph + This will throw if the edge cannot be fetched from the server<br><br> + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + array + + + string + + + \ArangoDBClient\Document + + + + + $graph + + mixed + + + $edgeId + + mixed + + + $options + array() + array + + + $collection + null + string + + + + hasEdge + \ArangoDBClient\GraphHandler::hasEdge() + + Check if an edge exists + This will call self::getEdge() internally and checks if there +was an exception thrown which represents an 404 request. + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + boolean + + + + $graph + + mixed + + + $edgeId + + mixed + + + + replaceEdge + \ArangoDBClient\GraphHandler::replaceEdge() + + Replace an existing edge in a graph, identified graph name and edge id + This will replace the edge on the server + +This will throw if the edge cannot be Replaced + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced edge is the same as the one given.<br><br> + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + \ArangoDBClient\Edge + + + mixed + + + string + + + boolean + + + + + $graph + + mixed + + + $edgeId + + mixed + + + $label + + mixed + + + $document + + \ArangoDBClient\Edge + + + $options + array() + mixed + + + $collection + null + string + + + + updateEdge + \ArangoDBClient\GraphHandler::updateEdge() + + Update an existing edge in a graph, identified by graph name and edge id + This will update the edge on the server + +This will throw if the edge cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed edge-document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given.<br><br> + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + \ArangoDBClient\Edge + + + mixed + + + string + + + boolean + + + + + $graph + + mixed + + + $edgeId + + mixed + + + $label + + mixed + + + $document + + \ArangoDBClient\Edge + + + $options + array() + mixed + + + $collection + null + string + + + + removeEdge + \ArangoDBClient\GraphHandler::removeEdge() + + Remove a edge from a graph, identified by the graph name and edge id<br><br> + + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + mixed + + + string + + + boolean + + + + + $graph + + mixed + + + $edgeId + + mixed + + + $revision + null + mixed + + + $options + array() + mixed + + + $collection + null + string + + + + clearCache + \ArangoDBClient\GraphHandler::clearCache() + + Clears the GraphHandler's cache + + + \ArangoDBClient\GraphHandler + + + + + + getCacheEnabled + \ArangoDBClient\GraphHandler::getCacheEnabled() + + Checks if caching in enabled + + + boolean + + + + + setCacheEnabled + \ArangoDBClient\GraphHandler::setCacheEnabled() + + + + + boolean + + + \ArangoDBClient\GraphHandler + + + + + $useCache + + boolean + + + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler + + + \ArangoDBClient\Connection + + + + $connection + + \ArangoDBClient\Connection + + \ArangoDBClient\Handler + + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection + + + \ArangoDBClient\Handler + + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + + mixed + + + \ArangoDBClient\ClientException + + + + $optionName + + + + \ArangoDBClient\Handler + + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + + string + + + \ArangoDBClient\ClientException + + + + $body + + array + + \ArangoDBClient\Handler + + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array + + + array + + + array + + + array + + + + $options + + array + + + $body + + array + + + $includeArray + array() + array + + \ArangoDBClient\Handler + + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name + + + \ArangoDBClient\ClientException + + + mixed + + + string + + + + $value + + mixed + + \ArangoDBClient\Handler + + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler + + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + + No summary for method setCacheEnabled() + + eJztXe1T20iT/56/Yp4r6rG8Zchmaz+RwC0xTuJnk0AB2b0UoVyyNWBthOSTZAh3t//7dc+bZkYjW8I2GB67KhUjzfT0vHX/uqd7/OY/J+PJixcvf/rpBfmJHKR+fJUcviXHH47JKAppnO+Sq9SfjMnYj4OIplAKC/428Uff/StKiKrTZcXZS3+aj5MU3pF/+TE5zSm99uPYevUO6n0nn/w7RtR4EyVpCBXf+mlOo4y9HSWTuzS8Guekq7798vOrXzskh7JXNM7I++vhhw68jpKrmHbIe5pCq3eS4SyMR8guIa92foEnL1+8iP1rmkFHqNWH18V4yG6TfOznBOhBUxkfkWzHHgvHSMhWZZujyM+AU6z/QVCmP3IaBxkRf7/43xfIJGMAPz+RIBlNr4FgRvw09e9IGAf0h3j5kv0/SuIsJ73PZydfB+9PDo4/kD3SYky2oC8WOSgchHmYxH5EppPAzylJLgkNsGMw/jc0zcMRzRwNHB2f9Y8+D056f/RP4Qs2ktKbMANajnaQEP1BJn4Kw5zjJFcR/KN3ctbv9k6RoGzeQTAIUzpCxuvQ7B2+5wRZxxal9nvvK9IafKd3zhGNovq0ukcfP/a6Z2IAi7ozCWfNKJ+apF39pz/860lEZ9KFbg/enRx9Yn2/TJPrBeicHTEqeeKggRuxTgc/H3zqIRUs72IFppoE9DKMwybLZHDYe9f/3JczglQOFZH5zdSaGqud03JDrjky5MTIH40pyfIkpUY7kzTJYZppQLZYkTKZ3278VLzsxf4wgqLDJIkoiFijhWlGa7ciCe2RSz/KHI12U4qixefCUjyVL8/GYUZuwygiI6MYsBDGVyBsKbkKb2gsnibDv6BtAmySlObTNIavQhiC6MLSnExglG+BwMxBOwynOc123gzTffxncfJbPk6T24z0fozoBOfBfs8ml48T2eLkt4F/arJ2Ow5HoCOTCAQ58hPGlwmoH7YMBYu8fJ6QoWLXbkt2DnumHhoqRJ+R6TAKR+RyGnPRw2kyRj2d3TYrzbUKfrasdQdTeH7xWr0GvilMMPF47e39K5r3zBpem/gZ0mlrZF2kzy+AODzc3s9BNWY4JGfJAfbOaxct/v2i4I2NdgbfgCmDdEajy91dXQ6Yn719ojH8O4UWOtUEStuRE7DYn0Hg6OT4w4ElcQ0OjtIJQIduIYK9tqKmjfbWNI1EB8iXNMp2d7+cfOQ6XCuUAkwBEhRHM4etw1roJnHMaXvt7f1JkuUeUuvIIn9lSTyg8SgJ6OAW+JrQ1BPj29ZGfwvLCQ5UQ6yBf2VIWispepfRvB+DtAMA0Q88Vv9coI2Lc7bydnc5FukfXrjre0YxUA8dYtEpzXcFpRMBQGbyAYgFq6v6Yp9p03UQRbKrf5dEWcLmsqGad60Q0krsZeFCJmky0RqrbuLw5OjYghNYtzsLUgz9fDTOwv+xpXt4g2J4S712gZEpglpXLfYKathVovA6rKjCXjk0Hs3nqoyrokylVOdS+xSkP6gTIbaJENwMbehC2arFFQvZSiZcPm6TI/ENhPcE8Tv8j5VhBYyTKiHOFuD/MeVo65pvpqHwjf9na6D6kh8GhIt93tGO6IHqAAr4khZAwcNkzgcagWjY3R1OwyiAvz1LDnXIOadrbKE8vbOFfw0pBQ+YkNKlP0COHPWN6j/IYVuxiDEVUENV1RQH2DF+pQQriokhOW8NwuwzvW1dFABGljHE7jTKoYQQJlzDvgMczHUYa1SJnI6i3n5t06gUegYFt9ArSS1OskpYndKcQxC1lVGlA2C6E+uVAwXcFz4ZTdMsSXdk3T9xewE8gRZwj13mzPClohjYwhm8pRJqBDvuXRfGuSZIZq5caOatLOgVdUqLlS+nokd7hqQSA1E5Ekw8PcooOGRmeQS6WMjjZSt6znuwpyTtvB4z6fooPXaI/HKPP2Ihj5et6DHvwZ5SFBU91vQFwH0wUiboP6DZYmj/OvyBho5E+/x/pjZgJHywjphagZEJQRv7KKRBnbx3KC2pDNDcAkIn7K/MsF40E4XPA2ORhEw/pWBJsOI0TZNUUeWKYZ5aKEbDc1sC0IZ4ozoi+1FC9rzYXglku6VxHeVyeNT98glkIdkhrZcD7lJruZVNIYlrKJYKeVmCtI7VdIjIS5qi3Nq8Tm5g1mFaQtha0jnF3jHHEujaKEsYZMukx0u+1N03S1yPxec+K1OSZCsS9I+BFxHrwKJAIQAQh+nFAiVlhjuKIbE4yVFsIJGJQyyYi9+Pbv07EE/plHZ49aWtdGTAREClju2xhle+AxbFV9XV0YCLg2NmvyEVbuudW4g/azE71HpoUK7YQQGNwKCp2kQ4eFWIww8CnLiylSRgMkfqlXCeVYe5THEVzKPi3kf32k7l/bTQhhIlt2wLD4gi+85+wd6B3gMv0BavX7WHzBb5rvhlzq4A0rYXotgfNpsPqxsa7oxO4Rs5Pjg5YwcGvf8yVrXA/zOcRrqhvF8eAFXxYmErp6YvBlluN7WEuMyM6S2xrEZvi9s8n2iW+VfUa1cM/+KG0hM3kLigy9wiCw856ggtTqQWjWWKrNXIrMZCi8Mih9jS0QUeL1iKiLFbAAxUKsJAUyVggPnYBh0GL/6aZrlqb/bsLCIreZv1xWUJYcjt8QTlqKN7DUVryRFZgiC6dJ3RAzfI4ZJyYbFsIhw1pBup+xBS9wpdE2hHCSPpHjKX+X2dFDy+frldNs1AUoRx6Zi2XU8wkz7aI9Cm8JqYPhQWBjICLjKjEHyTzTK/FLkGTc+4wcNSlLFQIrm87GjtIScx89Gw8zYk2jGIsk5f+9+5mpnmKMU59YPjPisvsXEwxJaTNEC/TcIGCh/DboJNmIbocNdstxkd17mNO5xDpGQcEzO+kji6EzzA+8O3jKcERS32iAn1cZLJE9yOfnbL9gKbC37YLCtcAovJLTbPBnin2q9fYQ83+CyiNS3v+r1a55X9qGP4ggRJ2d7SPm8m+/IIwwdDe1dfhctrJAr3W/THKJoGQpGCMbqtoMCNH03pLhbkaj8hoqyGNFgAknA7JDAP/L18F/K1yOXMzkr6cEgvfSCeKffHm5fQqwqcYR7TCxxn6Yea8AN27B9MqukHxg1Oc1aHMswJLZ+WbA1A8HXZPmYfpX71KBFNWyCnHq6JdtGjf/4TBA5qokL/Wevooo2F/hFmA6w6q1w5JMHugAY3oOtvgR4/JpxF1Tk2bNCL7u/tCR+TxQErZnMhyrJe0etJDlpbGzbpECpzct7iy9/RU/xIXVyT1o295loaPLN6K7syk10HweZ81uCq/O0e/rZqr4I5xRVzV1pptV12tpBkoSfGs4oVtzVSgFY8qUK72gZlkKHrT2DE6SeEJXs6ne39MOvHb60yXmkQylSqhqECfcujvhP631Oa5R63lpzdfNiz5UWx/WqGh9W9hy1RKsWgfIUj7FT3dWVJmnslU+txhFxdObIAPTk2lmghFNFH3Zbq03XNpJSCRXGnc50fi1ixrffxrc+ksVQ3lRw0C6EvgrrNGEQ7Vk84rHAXW71cskfdZKNwEJnsPCkvEAZDuhw+Vp/cQZwLCu2GrvKN1+bRfOW28GjuKZ9DYaV+8qV4yd0iR4smLGUGpDTydSE0zz/u9I6XqOrn8GjPC4f58v3h9YTd8/CFoxQsdW09/eCy4sYN/uQEqnKD2wFCjb3g8whsvNuljq+9d/uRohN1R2ZDPSGSg8puy4eT/ZpxWsP36LBl59unZg8dtuhsv5td/f4xk/WA/MZftPEXrZm/aAl7rGa9sv9lnsfF1tEpnUT+yG316GlD1TpaUHAREIdYz8jnskJ/ixjHZ+pzKfWAtXsiTEav/Wg+mekmenFtDYjMx3wEGQMDcHhetiS6gHGb8hrb8jIRw/mr49eiLAnt3MaCqh66rwJy/FgkBCCTwTJSHgxptogkk+RU94mQXsVAymDsDnYE/8JUTx7kqMZbZPszq8k6/zejwEeWTyeJKdpQmcouuQ1ztKNSdPGgARRTR1wTPr3GAEiwdG7CQCWSVn+saEroFrvKQetqlXwWnAO3AQ6iZMa4qKBuPgbOP49n0BIyxMh3jMHZI/E0ih5MdCPhMBv4Yn8LlspQYyBfddl9PUpWms+1zctqqcW1Z1NwCRfZeDVI1MdpT4yUzWnpBIo/16V7VWSJ1rKbVFdkHY54gmLpvUWA8VxB5B/A/yvXCV61Rmgd6CuZbQPclHwnBDstq3VHqEJlj6qYMVdmufr5zzMiERxQWkyxfcMAK7TM8N2C7VLa3KoOYF6+5NoAPTgZyaZckOU47re0hdlcurOoQ8K8SBm7StSRJHMijZPvILhj4Veho++Ybholtzt6a11/ijzvkj5IBOozIeWru7FI/7ADDTN3OBdo8h4ZxgQI51wI7x2zC5T0A4nqmUF1jEWFBgBKaUgx8nzI3UFIFIawH3htZDg0qf3JOj70sxDL3mmMoITnqgMz3TqFPwuHA5X4aASLOs5ZtanIuuPDx1gPmRpizjDZYamciW5RMuZteKS65VX6LVRlN+rCJcHE1nwzUugNwkSQqidPylu6AantD+tKEV74nAuuistEjMrFLSDOqvb9H1bLCBGVf6FsK+q7WOOyOo2UJyXjTUaR0urMIzgPq81GVZcUJknPgshoCoXWEmdx5vsBsXAWW+XhZUhTq6J96QZ8ZsbI7s7HQm8mNQJEMWr1zXB/IIJN5fxmb14O95F1EasqY1H53U68jJG6PTNytE77VzHgtA8hIND4QNG1uMjGsDzGrMxyGn9ZDNGDAFgLn9bAswmJEj+ogV8PxTZtCFUVPiqQqly7zsjbx4CvqjDqAmSD/phE6HVtvWxp/Gp1kAOB2lidNsM8v9itR2GW6zBTJ4Y8sbobfPrc8Kl559gy4ae2gC4sN0kDd/zKgUct91BjG1AChrmmH2ep5FByIIkuomFcK8oDQX/AnpUZImUEwc4suZ+pkGxtpbIAXXLEzUC2vHlBkrn1uc9bOfDY4o/F5YYpneD9MOwe2pj8+vOv8ISdPZQkso08yJ940ornzAmPQ8QrHrja8BmhZIQ3zcwCKAU+WRydFOBkNjSxNYwI2pmpTsZ+VqVObC1Rds6CCaHBwFOG7opBhNkCBqESiLsokHdvKBPFlJWWcHVwYzkvSvc8sBUpfbo2L2XPLvLOzS9QTrir2T1DOLmgws0BJNqlaOLDw4eFVMDjRCYDofaM5AErEYXx+8LmSaQPsxE13vEx3qK2nnVswhPtNAd3H3ZNrplY4qFOsX4CY4XCdpvvThX3MGurUZjDHOJb9fqXZJLAsrvDSAYRLcb3lBcl3PSE71dRMmTfsavTqzGjV8hckRDWlkSRUSwhvJ7KzhyzPTZI6Q1P4cIGO9wU9XMfjF0qJA/KFEmMuQJ4shY3zKSJnSfbQ7otznWKkeG2bSa2NEsIi8UVsAte3KpOx5Zs4cy0cYrEeKQYT6+HJXtHwtVKl7ThqYeNzpdIUMlNXcOJeBml3L/SJiI2xcjRYxErW2KBefjHKLme+Hk4DKMwv8MrHBMWiAN8sql9tfOKT68K7mnXsM5q2mfKQpIrSZhEamFxBu0rzaGbrSy5xqXGy22HQYucS9eKWORhXNAJA8D2PPcQu4cWFysup6GVqbIX7Zr2lWKej6ZgXWx2McJidgU7I9xPMJjQo0t4nUM32M4GnN8CNJG3kLnPXz5+FMxxw685Q7d+mL9L0tO7eCS4Ei4vxgiakUkKeyCD97DN4jAzrjJWS1NsZPYdLxvz5alDEGbfCcUbnGWnlEjQmiaXkX8FEibg18tBJX6ptIyZQoGa6gZj/W5WWrbkYW1bF4hY7WVYYk6qrdqy6FkbS3dj6laQ2pi69zN1iwXNVvjgmqZX1DNP4ovfs9jnCsA86zfWJF5OriZUOAUFkurHPF7bM6dSEOpYceP4aWmikGeBOmxjTt0rATfF/p8H/bPB6dfPXevCc9YCVzIt/td9WzjpHX886PYGx0cf+92vbXN2L9Rf5vFQX/OYzlXWsETQmARhb51qSEvdOWEXRtScOeyqSfscTh0V2BYQtof7mm0QVd+5NvlCOJ81YorDglTlemU5hzW6W5I4zfiYTXx2vM0jHGVW+ZJqZ0uIu+6bHog2in5auavqwc/IbHeWcfOjbRp/4VC2vmU8vFu1cVz3NM20px7StLbtu5Va2MV58cbG1mzsCfNr2TPBHZ2goHI/jPkYFcdsfLXiBGUrNMmXbzivne35ndLJZ1C0bsMT10Y6hdbVb9GhOcmTSJWQ0WYlFOEgsGlyEfMRpto8oUo3T0iZbe8hFzqdW/RRix3P4P0jmdTyJ9k21vRaWNN8Op6kMa0Kb2zpjS29saUXtqWl3mLWNLTAxM2KTO4vx4cHZ+tucRtzszG4l2Jwi9iMh7WmG9rT2pzP+VkOBrPrmNMl94LrJ+r2Kn/Lg5USoGJP/pRcYU6rIosEjdaxh0/E74W4oj5tO7jIvinbwk8sprOGLSaJKDFh3oLqsmSN1Bxxx0kF1bU6/JyPqJtEpq6L+bbsg0PYKKCO1sjMWZNg2Ic3cfjt+tUmjq7aUV9vDJyNgfOcDJyNUVKTkcPex14zo6QexF8Y3i/3GpWG6Pl+0HnxX+GysSfPDBc3TtRIDGfl1QUOs9LB2S/dbWuBUHUTw/kdVU8gLZzhdEkOOW/hk5ZQ4hWVYMiIWSlP5lSJfMCesoonoWobeOZvFIaBgasgUTrKwLJ2sGBlIrtYHo+cx14P+fAey4R0vpbunY6Od4gU4AZnFy3SpCPnREKb9clTrwUjrOtv+FMdRFTczvV6JhkLQFhvXfDBSeBxwIO7LzWhg1W5nme09q0CjLqVTaKeWVNiXCagCtW9SEBnrVDAbKmX2DKcIl6Ll2rJneFG3EYdZMZje6oy+OAs8WC3lS60sT/zIk20y6l+730dvDs5+sQgAbZdXezs6ILTzpPXS0UK4hafR0i/bxJuwiSnHF4t3ASf1ww2waLnKEqaBZqUqj1mIjYbhuZp2BaGeUpJ2Mh6PxDkWD/umX7d+PeJNqnXcxtfT2+TOs7W73aTzyrWfkM0JkCJeY3b08m25twuxackSC3Jo7SBgvVYWSkUXFZudQlZqOXy0HnV9dFDvazqmhhYJVPPgr74rlkatbB/G2VRM2n1jHKol5BBLZDFSvKnXcrhcXKnnZxs8qYXyZvmKLRW1rQArJWbVF6yq3DKPaLCLXAvOH6MoPCHiQbnY7rySPCHMGQaxBwYXteyoxXrt1pW3R5Xe6a71YTDNYLA69lTm6iEtYlKWMt05jW1FR8sldltLvJt3eE79clFX2/MyI0Zaa2UTax10UIWRnjUzP+S/XOU4767E3qTtVYe/mClQZvNrCwoe2tM/QDUOhNkprhY61htfWo0T0CpuOgelL/cvkarCUpD8dZ/tMiOxukOPll+QLcWjlp8GoRuN+zxPXtbJyMb9mM/Btsn5zm5nqValngIaDq7HsTP1TjOppGLrEHKd0dN4TM8jbtnxvcsm76c7z3PrNeyvZdk1T9eprcZmvNc8ryfq3XPc8LNOVtmRnhzZ8CzttmfVxr4c08C/7f1QfCp2Lggis/GBbFxQfwbuCAeL937gTwLmwvWHj/fe6WmOXmgKJRnlEMurHOVQy6tcvdkLNm2VtnjpVDVGrnjwnB6jhaeM2e8ZBDLNKZ7JotvzmTX9Ux2kym+LrYQzxSvsIWeaJb4xgraWEHWSvl7Y7jcLyV8huGiz+OTywhf1SmVqrl4Njj+p0c8A1BJub+aSc4PABEjmrYy0JajsYxWtjUI42OmBhgh3S6S8Gy5LTrB6AvR7kjiwkKVTKuQaiSC+hS0O42Z0p6h8+bFFOOwIlM9TqnEuM6a4F8UrWJUKH2JB7dAw3cXGtbMYlFRnDXIojBuAFl8zoBDT0YYSj/wo9DPPH1l7O6yN4AAvwGU8a9onH0TrvfhN2MJwUr8f9uEO8k= + + + + ArangoDB PHP client: streaming transaction collection + + + + + + + \ArangoDBClient\Collection + StreamingTransactionCollection + \ArangoDBClient\StreamingTransactionCollection + + Streaming transaction collection object + <br> + + + + + + ENTRY_ID + \ArangoDBClient\Collection::ENTRY_ID + 'id' + + Collection id index + + + + + ENTRY_NAME + \ArangoDBClient\Collection::ENTRY_NAME + 'name' + + Collection name index + + + + + ENTRY_TYPE + \ArangoDBClient\Collection::ENTRY_TYPE + 'type' + + Collection type index + + + + + ENTRY_WAIT_SYNC + \ArangoDBClient\Collection::ENTRY_WAIT_SYNC + 'waitForSync' + + Collection 'waitForSync' index + + + + + ENTRY_JOURNAL_SIZE + \ArangoDBClient\Collection::ENTRY_JOURNAL_SIZE + 'journalSize' + + Collection 'journalSize' index + + + + + ENTRY_STATUS + \ArangoDBClient\Collection::ENTRY_STATUS + 'status' + + Collection 'status' index + + + + + ENTRY_KEY_OPTIONS + \ArangoDBClient\Collection::ENTRY_KEY_OPTIONS + 'keyOptions' + + Collection 'keyOptions' index + + + + + ENTRY_IS_SYSTEM + \ArangoDBClient\Collection::ENTRY_IS_SYSTEM + 'isSystem' + + Collection 'isSystem' index + + + + + ENTRY_IS_VOLATILE + \ArangoDBClient\Collection::ENTRY_IS_VOLATILE + 'isVolatile' + + Collection 'isVolatile' index + + + + + ENTRY_DISTRIBUTE_SHARDS_LIKE + \ArangoDBClient\Collection::ENTRY_DISTRIBUTE_SHARDS_LIKE + 'distributeShardsLike' + + Collection 'distributeShardsLike' index + + + + + ENTRY_NUMBER_OF_SHARDS + \ArangoDBClient\Collection::ENTRY_NUMBER_OF_SHARDS + 'numberOfShards' + + Collection 'numberOfShards' index + + + + + ENTRY_REPLICATION_FACTOR + \ArangoDBClient\Collection::ENTRY_REPLICATION_FACTOR + 'replicationFactor' + + Collection 'replicationFactor' index + + + + + ENTRY_MIN_REPLICATION_FACTOR + \ArangoDBClient\Collection::ENTRY_MIN_REPLICATION_FACTOR + 'minReplicationFactor' + + Collection 'minReplicationFactor' index + + + + + ENTRY_SHARDING_STRATEGY + \ArangoDBClient\Collection::ENTRY_SHARDING_STRATEGY + 'shardingStrategy' + + Collection 'shardingStrategy' index + + + + + ENTRY_SHARD_KEYS + \ArangoDBClient\Collection::ENTRY_SHARD_KEYS + 'shardKeys' + + Collection 'shardKeys' index + + + + + ENTRY_SMART_JOIN_ATTRIBUTE + \ArangoDBClient\Collection::ENTRY_SMART_JOIN_ATTRIBUTE + 'smartJoinAttribute' + + Collection 'smartJoinAttribute' index + + + + + OPTION_PROPERTIES + \ArangoDBClient\Collection::OPTION_PROPERTIES + 'properties' + + properties option + + + + + TYPE_DOCUMENT + \ArangoDBClient\Collection::TYPE_DOCUMENT + 2 + + document collection type + + + + + TYPE_EDGE + \ArangoDBClient\Collection::TYPE_EDGE + 3 + + edge collection type + + + + + STATUS_NEW_BORN + \ArangoDBClient\Collection::STATUS_NEW_BORN + 1 + + New born collection + + + + + STATUS_UNLOADED + \ArangoDBClient\Collection::STATUS_UNLOADED + 2 + + Unloaded collection + + + + + STATUS_LOADED + \ArangoDBClient\Collection::STATUS_LOADED + 3 + + Loaded collection + + + + + STATUS_BEING_UNLOADED + \ArangoDBClient\Collection::STATUS_BEING_UNLOADED + 4 + + Collection being unloaded + + + + + STATUS_DELETED + \ArangoDBClient\Collection::STATUS_DELETED + 5 + + Deleted collection + + + + + $_trx + \ArangoDBClient\StreamingTransactionCollection::_trx + + + The transaction - assigned on construction + + + \ArangoDBClient\StreamingTransaction + + + + + $_name + \ArangoDBClient\StreamingTransactionCollection::_name + + + Collection name - assigned on construction + + + string + + + + + + $_mode + \ArangoDBClient\StreamingTransactionCollection::_mode + + + Lock mode for this collection, i.e. 'read', 'write' or 'exclusive' + + + string + + + + + $_id + \ArangoDBClient\Collection::_id + + + The collection id (might be NULL for new collections) + + + mixed + + + + + $_name + \ArangoDBClient\Collection::_name + + + The collection name (might be NULL for new collections) + + + string + + + + + $_type + \ArangoDBClient\Collection::_type + + + The collection type (might be NULL for new collections) + + + integer + + + + + $_waitForSync + \ArangoDBClient\Collection::_waitForSync + + + The collection waitForSync value (might be NULL for new collections) + + + boolean + + + + + $_journalSize + \ArangoDBClient\Collection::_journalSize + + + The collection journalSize value (might be NULL for new collections) + + + integer + + + + + $_isSystem + \ArangoDBClient\Collection::_isSystem + + + The collection isSystem value (might be NULL for new collections) + + + boolean + + + + + $_isVolatile + \ArangoDBClient\Collection::_isVolatile + + + The collection isVolatile value (might be NULL for new collections) + + + boolean + + + + + $_distributeShardsLike + \ArangoDBClient\Collection::_distributeShardsLike + + + The distributeShardsLike value (might be NULL for new collections) + + + mixed + + + + + $_numberOfShards + \ArangoDBClient\Collection::_numberOfShards + + + The collection numberOfShards value (might be NULL for new collections) + + + mixed + + + + + $_replicationFactor + \ArangoDBClient\Collection::_replicationFactor + + + The replicationFactor value (might be NULL for new collections) + + + mixed + + + + + $_minReplicationFactor + \ArangoDBClient\Collection::_minReplicationFactor + + + The minimum replicationFactor value for writes to be successful + + + mixed + + + + + $_shardingStrategy + \ArangoDBClient\Collection::_shardingStrategy + + + The shardingStrategy value (might be NULL for new collections) + + + mixed + + + + + $_shardKeys + \ArangoDBClient\Collection::_shardKeys + + + The collection shardKeys value (might be NULL for new collections) + + + array + + + + + $_smartJoinAttribute + \ArangoDBClient\Collection::_smartJoinAttribute + + + The smartJoinAttribute value (might be NULL for new collections) + + + mixed + + + + + $_status + \ArangoDBClient\Collection::_status + + + The collection status value + + + integer + + + + + $_keyOptions + \ArangoDBClient\Collection::_keyOptions + + + The collection keyOptions value + + + array + + + + + __construct + \ArangoDBClient\StreamingTransactionCollection::__construct() + + Constructs a streaming transaction collection object + + + \ArangoDBClient\StreamingTransaction + + + string + + + string + + + + + $trx + + \ArangoDBClient\StreamingTransaction + + + $name + + string + + + $mode + + string + + + + __toString + \ArangoDBClient\StreamingTransactionCollection::__toString() + + Return the name of the collection + Returns the collection as JSON-encoded string + + + string + + + + + + getName + \ArangoDBClient\StreamingTransactionCollection::getName() + + Return the name of the collection + + + string + + + + + + getMode + \ArangoDBClient\StreamingTransactionCollection::getMode() + + Return the lock mode of the collection + + + string + + + + + getTrxId + \ArangoDBClient\StreamingTransactionCollection::getTrxId() + + Return the transaction's id + + + string + + + + + __construct + \ArangoDBClient\Collection::__construct() + + Constructs an empty collection + + + string + + + \ArangoDBClient\ClientException + + + + $name + null + string + + \ArangoDBClient\Collection + + + createFromArray + \ArangoDBClient\Collection::createFromArray() + + Factory method to construct a new collection + + + \ArangoDBClient\ClientException + + + array + + + \ArangoDBClient\Collection + + + + $values + + array + + \ArangoDBClient\Collection + + + getDefaultType + \ArangoDBClient\Collection::getDefaultType() + + Get the default collection type + + + string + + + \ArangoDBClient\Collection + + + __clone + \ArangoDBClient\Collection::__clone() + + Clone a collection + Returns the clone + + + void + + + \ArangoDBClient\Collection + + + __toString + \ArangoDBClient\Collection::__toString() + + Get a string representation of the collection + Returns the collection as JSON-encoded string + + + string + + + \ArangoDBClient\Collection + + + toJson + \ArangoDBClient\Collection::toJson() + + Returns the collection as JSON-encoded string + + + string + + + \ArangoDBClient\Collection + + + toSerialized + \ArangoDBClient\Collection::toSerialized() + + Returns the collection as a serialized string + + + string + + + \ArangoDBClient\Collection + + + getAll + \ArangoDBClient\Collection::getAll() + + Get all collection attributes + + + array + + + \ArangoDBClient\Collection + + + set + \ArangoDBClient\Collection::set() + + Set a collection attribute + The key (attribute name) must be a string. + +This will validate the value of the attribute and might throw an +exception if the value is invalid. + + \ArangoDBClient\ClientException + + + string + + + mixed + + + void + + + + $key + + string + + + $value + + mixed + + \ArangoDBClient\Collection + + + setId + \ArangoDBClient\Collection::setId() + + Set the collection id + This will throw if the id of an existing collection gets updated to some other id + + \ArangoDBClient\ClientException + + + mixed + + + boolean + + + + $id + + mixed + + \ArangoDBClient\Collection + + + getId + \ArangoDBClient\Collection::getId() + + Get the collection id (if already known) + Collection ids are generated on the server only. + +Collection ids are numeric but might be bigger than PHP_INT_MAX. +To reliably store a collection id elsewhere, a PHP string should be used + + mixed + + + \ArangoDBClient\Collection + + + setName + \ArangoDBClient\Collection::setName() + + Set the collection name + + + \ArangoDBClient\ClientException + + + string + + + void + + + + $name + + string + + \ArangoDBClient\Collection + + + getName + \ArangoDBClient\Collection::getName() + + Get the collection name (if already known) + + + string + + + \ArangoDBClient\Collection + + + setType + \ArangoDBClient\Collection::setType() + + Set the collection type. + This is useful before a collection is create() 'ed in order to set a different type than the normal one. +For example this must be set to 3 in order to create an edge-collection. + + \ArangoDBClient\ClientException + + + integer + + + void + + + + $type + + integer + + \ArangoDBClient\Collection + + + getType + \ArangoDBClient\Collection::getType() + + Get the collection type (if already known) + + + string + + + \ArangoDBClient\Collection + + + setStatus + \ArangoDBClient\Collection::setStatus() + + Set the collection status. + This is useful before a collection is create()'ed in order to set a status. + + \ArangoDBClient\ClientException + + + integer + + + void + + + + $status + + integer + + \ArangoDBClient\Collection + + + getStatus + \ArangoDBClient\Collection::getStatus() + + Get the collection status (if already known) + + + integer + + + \ArangoDBClient\Collection + + + setKeyOptions + \ArangoDBClient\Collection::setKeyOptions() + + Set the collection key options. + + + \ArangoDBClient\ClientException + + + array + + + void + + + + $keyOptions + + array + + \ArangoDBClient\Collection + + + getKeyOptions + \ArangoDBClient\Collection::getKeyOptions() + + Get the collection key options (if already known) + + + array + + + \ArangoDBClient\Collection + + + setWaitForSync + \ArangoDBClient\Collection::setWaitForSync() + + Set the waitForSync value + + + boolean + + + void + + + + $value + + boolean + + \ArangoDBClient\Collection + + + getWaitForSync + \ArangoDBClient\Collection::getWaitForSync() + + Get the waitForSync value (if already known) + + + boolean + + + \ArangoDBClient\Collection + + + setJournalSize + \ArangoDBClient\Collection::setJournalSize() + + Set the journalSize value + + + integer + + + void + + + + $value + + integer + + \ArangoDBClient\Collection + + + getJournalSize + \ArangoDBClient\Collection::getJournalSize() + + Get the journalSize value (if already known) + + + integer + + + \ArangoDBClient\Collection + + + setIsSystem + \ArangoDBClient\Collection::setIsSystem() + + Set the isSystem value + + + boolean + + + void + + + + $value + + boolean + + \ArangoDBClient\Collection + + + getIsSystem + \ArangoDBClient\Collection::getIsSystem() + + Get the isSystem value (if already known) + + + boolean + + + \ArangoDBClient\Collection + + + setIsVolatile + \ArangoDBClient\Collection::setIsVolatile() + + Set the isVolatile value + + + boolean + + + void + + + + $value + + boolean + + \ArangoDBClient\Collection + + + getIsVolatile + \ArangoDBClient\Collection::getIsVolatile() + + Get the isVolatile value (if already known) + + + boolean + + + \ArangoDBClient\Collection + + + setDistributeShardsLike + \ArangoDBClient\Collection::setDistributeShardsLike() + + Set the distribute shards like value + + + string + + + void + + + + $value + + string + + \ArangoDBClient\Collection + + + getDistributeShardsLike + \ArangoDBClient\Collection::getDistributeShardsLike() + + Get the distributeShardsLike (if already known) + + + mixed + + + \ArangoDBClient\Collection + + + setNumberOfShards + \ArangoDBClient\Collection::setNumberOfShards() + + Set the numberOfShards value + + + integer + + + void + + + + $value + + integer + + \ArangoDBClient\Collection + + + getNumberOfShards + \ArangoDBClient\Collection::getNumberOfShards() + + Get the numberOfShards value (if already known) + + + mixed + + + \ArangoDBClient\Collection + + + setReplicationFactor + \ArangoDBClient\Collection::setReplicationFactor() + + Set the replicationFactor value + + + mixed + + + void + + + + $value + + mixed + + \ArangoDBClient\Collection + + + getReplicationFactor + \ArangoDBClient\Collection::getReplicationFactor() + + Get the replicationFactor value (if already known) + + + mixed + + + \ArangoDBClient\Collection + + + setMinReplicationFactor + \ArangoDBClient\Collection::setMinReplicationFactor() + + Set the minReplicationFactor value + + + integer + + + void + + + + $value + + integer + + \ArangoDBClient\Collection + + + getMinReplicationFactor + \ArangoDBClient\Collection::getMinReplicationFactor() + + Get the minReplicationFactor value (if already known) + + + mixed + + + \ArangoDBClient\Collection + + + setShardingStrategy + \ArangoDBClient\Collection::setShardingStrategy() + + Set the shardingStrategy value + + + string + + + void + + + + $value + + string + + \ArangoDBClient\Collection + + + getShardingStrategy + \ArangoDBClient\Collection::getShardingStrategy() + + Get the sharding strategy value (if already known) + + + mixed + + + \ArangoDBClient\Collection + + + setShardKeys + \ArangoDBClient\Collection::setShardKeys() + + Set the shardKeys value + + + array + + + void + + + + $value + + array + + \ArangoDBClient\Collection + + + getShardKeys + \ArangoDBClient\Collection::getShardKeys() + + Get the shardKeys value (if already known) + + + array + + + \ArangoDBClient\Collection + + + setSmartJoinAttribute + \ArangoDBClient\Collection::setSmartJoinAttribute() + + Set the smart join attribute value + + + string + + + void + + + + $value + + string + + \ArangoDBClient\Collection + + + getSmartJoinAttribute + \ArangoDBClient\Collection::getSmartJoinAttribute() + + Get the smart join attribute value (if already known) + + + mixed + + + \ArangoDBClient\Collection + + + eJytVU2P2jAQvedXzGGlsChAP9RD2bLdlkq7rdpqVTgiIZOY4G5iR7ZDWVX97x072eCYr65KDmBlZp7fezOO370vVkUQDLrdALrwQRKeik8f4f7uHuKMUa6HoLSkJGc8BY1hRWLNBIdYZBm1Syw0tTcFiR9ISgEamLFFsEFS6pWQGIMvhMNEU5oTzm0oFsWjZOlKw7hZvXrx8m20pXObL+4iDGci5TSCWyqx+hGrB0HASU4V7k29ba8aVZMTAkAsfuLK17FHhWI8NgJf99/YzeOMKLXFn27hx1t0utGUJwqcV8HvwFhh+ZmnC9MVbbHrASIzVJuA5cqxC2Vtt614KrxZE7mXAUI4gHX6wP4Xkq2JpnAx13KDPnlcHKLG3GdywaCxuucabGAOMDChXQpfRfwAuUgoLHFq9IopBy4C1qd9CFFzEkYQ/pJM0xAwMaSbOCsVW9PwKLXsCf4AKRNCUrvG1NIVkJPHopmqNo+CSJLvb9gFdgNM29qz4JXWIi5sa9rPIc/9UmusX9p4st/eaI+5tW3lImMxLEtebTyfNyPSOagzqgREFZlLC1QdCgQk0nx4hi6Qzb6sBwUQAkeidz23jlXPyOJeeQmOS6NqSz/DMWNUsaky/thffwR+UF1KbltkocXSrt2vYbvfOUlZ7L+UFcq/HZUde7WY2MJO2zaAGtbVflYt/0M7pfo75pyRczOwzyd+tllHVd8Q5pQqd6qOKHIOfaiAJadkuB+eJvsg0ancfE58ph5RPEG9a8w1iTVhCJCzvejmJGNEdZyjPBzaAPo1Q054aXI1q6/Nxez4tRgi/l+n73yn + + + + ArangoDB PHP client: admin document handler + + + + + + + + + \ArangoDBClient\Handler + AdminHandler + \ArangoDBClient\AdminHandler + + Provides access to ArangoDB's administration interface + The admin handler utilizes ArangoDB's Admin API. + + + + + + OPTION_DETAILS + \ArangoDBClient\AdminHandler::OPTION_DETAILS + 'details' + + details for server version + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string + + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string + + + + + getEngine + \ArangoDBClient\AdminHandler::getEngine() + + Get the server's storage engine + This will throw if the engine data cannot be retrieved + + \ArangoDBClient\Exception + + + mixed + + + + + + getServerVersion + \ArangoDBClient\AdminHandler::getServerVersion() + + Get the server version + This will throw if the version cannot be retrieved + + boolean + + + \ArangoDBClient\Exception + + + string + + + + + $details + false + boolean + + + + getServerRole + \ArangoDBClient\AdminHandler::getServerRole() + + Get the server role + This will throw if the role cannot be retrieved + + \ArangoDBClient\Exception + + + string + + + + + + getServerTime + \ArangoDBClient\AdminHandler::getServerTime() + + Get the server time + This will throw if the time cannot be retrieved + + \ArangoDBClient\Exception + + + double + + + + + + getServerLog + \ArangoDBClient\AdminHandler::getServerLog() + + Get the server log + This will throw if the log cannot be retrieved + + \ArangoDBClient\Exception + + + array + + + array + + + + + $options + array() + array + + + + reloadServerRouting + \ArangoDBClient\AdminHandler::reloadServerRouting() + + Reload the server's routing information +The call triggers a reload of the routing information from the _routing collection + This will throw if the routing cannot be reloaded + + \ArangoDBClient\Exception + + + boolean + + + + + + getServerStatistics + \ArangoDBClient\AdminHandler::getServerStatistics() + + Get the server statistics +Returns the statistics information. The returned objects contains the statistics figures, grouped together +according to the description returned by _admin/statistics-description. + For instance, to access a figure userTime from the group system, you first select the sub-object +describing the group stored in system and in that sub-object the value for userTime is stored in the +attribute of the same name.In case of a distribution, the returned object contains the total count in count +and the distribution list in counts. +For more information on the statistics returned, please lookup the statistics interface description at + + + \ArangoDBClient\Exception + + + array + + + + + + + getServerStatisticsDescription + \ArangoDBClient\AdminHandler::getServerStatisticsDescription() + + Returns a description of the statistics returned by getServerStatistics(). + The returned objects contains a list of statistics groups in the attribute groups +and a list of statistics figures in the attribute figures. +For more information on the statistics returned, please lookup the statistics interface description at + + + \ArangoDBClient\Exception + + + array + + + array + + + + + + $options + array() + array + + + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler + + + \ArangoDBClient\Connection + + + + $connection + + \ArangoDBClient\Connection + + \ArangoDBClient\Handler + + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection + + + \ArangoDBClient\Handler + + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + + mixed + + + \ArangoDBClient\ClientException + + + + $optionName + + + + \ArangoDBClient\Handler + + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + + string + + + \ArangoDBClient\ClientException + + + + $body + + array + + \ArangoDBClient\Handler + + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array + + + array + + + array + + + array + + + + $options + + array + + + $body + + array + + + $includeArray + array() + array + + \ArangoDBClient\Handler + + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name + + + \ArangoDBClient\ClientException + + + mixed + + + string + + + + $value + + mixed + + \ArangoDBClient\Handler + + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler + + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + eJzlWV9v2zgSf/enmIcAdgrHbtN9cppcvbGbeJHGge0ucGgLl5ZomxtJ1JJUGu+i331nSEqWZadxc7k9HNZAUUWc/7/hzJB68690mdZq7RcvavACuoolC9n7GW4ubyCIBE9MB1gYiwRCGWQx/g1LloQRV0hOHG9TFtyyBQcomM8tn11kmVlKhWvwC0tgbDiPWZJUlt4h3y28ZysrFN4GMl0psVgaOC+ejl++Om6CUQJVJRou4tllE5cjuUh4Ey64Qrkry61FEpA1AK9ax/imXaslLOYa7eQVE08Kv2+UvBMh18CCgGsNRhakde0CILRRzAiZgEgMV3MU50MwWXIfIx8ayIyIxB8oriSkaym6N4PWXpHb4UYQMe3lXHpF/N7wJNTg/679WSMO6xT9XkDIDRORhjmGWnN1hzz4T6MbnqJt/w9kog0MbyaD4fW01590B1djOIW6Z6+fWKqq8AtuwKDzTjD6qI1U5BFPFiLhniynniyFhq8iipBHya8g5pbZ0ULIDIMAk0MamHFQHLHmdzysCHlreTX07wOemrUbxToyZiqBWNzzEI4As07OfuOBAbcgkkVZq0gwMDErCcoj/5qiXopQms0iEcA8SwKbBAtu+lZG49DFxYWefgcKsw0DyjGCBwa9PjpD6nOZJNzyNg7ti8YHFelO58Poatq/vhhc9w9PChHei0KSZfhFE68j+lb7PhgVlB/BwBPvE/+UKRbDTMoIDvLkOoKJyjhtGrQSGMRScZ95CELuwxORxG1HoCGU+eNSRmGOY1GwNv3NUXz1OIpjG69fHXuj8OkU5izS/LCKbaYiXFtD1+29H1xPf+2Pxrh1TmoFIUa2EHZYErAp5JJHKVedDktT3Mc3FFuNrxtE0YSPxf6D0zMsfhn/XMqRb7UfzjgSW5JwYDcd/U4fSLW93MmTlaTtNK9M8LHukap/3jOTlYz2LCVE+Yw15PuZV7IOGry1aMGH617/He7jHnam4XDUG1x3J8NRE3o/j/sjzJDDSnIet17ul5wj1NHYmYkevGo6On3T0fCqf/I3JskmzhSZEsiPoGxEvCfKRPmMKIcSw84tyv6xjDIp04bF6VMLywQFbGP3wx3C4ToZvO8/BzTk1f7Q4JC1HzJI+BzAuBbDlGIrOJCWRLtW7t7JOeRvzZIZ7DRz6uW2AnCdReZIc9OpSH2Tng09E8Pu1HkzU2fFWiTO6llqZB3VuEghFXpHDuFAhm5oyFJqcIzeHUXoVtSCa2m4M6F4CXGmrfcSLZLzzps2yi7ZUFY5RywiaMPLTSJ85krhvNaGV1srX5mbYdpwvLVGwwwuvN5aCPksI5afNlfam+bUrQN1wBhAJGJhdAFqHgMMAL1C37SPeogjFGyF44t98wUhC+ELBfaLDXqcGTaLVji1BlGmxR1vbZlal/M5okdAgL4VqdU3FwqD6lZyW3awahy50fzCfsubZPEMcxhzxgGLFhNYJY+IbZc0w5Rx0Rg9kBI6C5bOYdQkVCF4BXiWSIyYC9SMO2WhODNkBA7sv2eIOWqNRLhLqbQ6SekYH3MACnO5wDcKmA5wXKA8wJ0XCuWqBqnClSbpwbNMiQRjIbR9RwccqVx5k7nZaEoJPKtTILBxKjUdiSDADZvQWUsEaDyyc7XLds5UsLTIDRNE2Zecqgt41MApohjEDR5hfHtttVoPJWi1aLtCUKoJ5Zp9x5SQGRpuUOwsM6gU4bc7t0OeNV3CNtfFvenMoHS1NknamCyWWUJpt4H5jM9puk0Zzv723NB6ame4kotGpcidwsfPj/T5hybGaqu4Gl40C8GHT54CfuhEUu0jIx5JFm4eEZXEwzFl5fbJi87RAe0xjPRigVMiYqacCJkPeFvMMFcytovTfDWQUeSc2Xds9Hyl1kVanzxS0OnoB7PCaczHPWvP9tTwAFy4TbdHhdHww2RwfTEd9a+GXZxI6/UdaNKRYt8pADeKEdqIQK/hdWXREhWrZXBaFtOi8LqTeFECtjjnYpFhfjWxYMosRQYj0dklXQs5jdXiZUuaEqkPoVczW8HU3se017KPSpTFjn2HhRLNMAwRatru7m5/mLcEMu0GuHWSWctAr7ThcRNWMvPNSXNKOedQNjtynuZ6nO5ZXp+8DIN1xLZPJ81WH5G4GryW4StahOdrusMpLBK6JAFpihDlRS/fM5ohNd2AtQZ0wNfcFcOQ7rOIEAPS9LPTBkybKLmSGNiKiArtQ6HSl82ySKyzek2pN0JurwfKW1gm1UzIbWlCGnGyOZLyNku3U83fxG0kAjPVfRmJ5BZgaUyqO+12KAPdYvbiIJy1Ahm3LyeTm3Z345avm4TvZSIwxAhbWyQhv28tTRztV1JKNj7fScU2i+qa5nRLWDSVcaG4t45I43CLyxel1/u1qrXUx46h+7an8aQ7GYwng/Nxk3re/6o/+bluI33kFoTlyrIzJq11Onyv3DG3K1BBSbitBtrv4tL2de/Le2wnu6+Z2/x+4Z+788ol///3WLrAaGURTrRmRaM11n/AYNmhlvoBgxIBmeAXmzgRZ8rR2KemTaGQrdw7enDdGc1kaBw1FM+7Y7b3yVS31yR5FhbtGoGMGXpHETIcDxM3UmtBVyl5dpJvlATrfYza/43dE3GxPtmxz98f42OevFULqzK2LY14sjD2FDKY2/78lSV0J21vjbB5CjKYMInZvYixpzmGYtdbCjxG2QzHIfS7ZrI7JiJGjm4MPWWOIFOKvpp5LnsawiDZ5ohbCDv7hhP/Wc1/xkJfbh//vVPKug1Me/3x+Whgv0D93QeXb/7b2pRFgulG+Qtbp2NXcH7+lH98/OS/Ocw+lQlpvP4LCNYG2Q== + + + + ArangoDB PHP client: document handler + + + + + + + + \ArangoDBClient\DocumentHandler + EdgeHandler + \ArangoDBClient\EdgeHandler + + A handler that manages edges + An edge-document handler that fetches edges from the server and +persists them on the server. It does so by issuing the +appropriate HTTP requests to the server. + + + + + + ENTRY_DOCUMENTS + \ArangoDBClient\EdgeHandler::ENTRY_DOCUMENTS + 'edge' + + documents array index + + + + + + ENTRY_EDGES + \ArangoDBClient\EdgeHandler::ENTRY_EDGES + 'edges' + + edges array index + + + + + OPTION_COLLECTION + \ArangoDBClient\EdgeHandler::OPTION_COLLECTION + 'collection' + + collection parameter + + + + + + OPTION_EXAMPLE + \ArangoDBClient\EdgeHandler::OPTION_EXAMPLE + 'example' + + example parameter + + + + + + OPTION_FROM + \ArangoDBClient\EdgeHandler::OPTION_FROM + 'from' + + example parameter + + + + + OPTION_TO + \ArangoDBClient\EdgeHandler::OPTION_TO + 'to' + + example parameter + + + + + OPTION_VERTEX + \ArangoDBClient\EdgeHandler::OPTION_VERTEX + 'vertex' + + vertex parameter + + + + + OPTION_DIRECTION + \ArangoDBClient\EdgeHandler::OPTION_DIRECTION + 'direction' + + direction parameter + + + + + ENTRY_DOCUMENTS + \ArangoDBClient\DocumentHandler::ENTRY_DOCUMENTS + 'documents' + + documents array index + + + + + OPTION_COLLECTION + \ArangoDBClient\DocumentHandler::OPTION_COLLECTION + 'collection' + + collection parameter + + + + + OPTION_EXAMPLE + \ArangoDBClient\DocumentHandler::OPTION_EXAMPLE + 'example' + + example parameter + + + + + OPTION_OVERWRITE + \ArangoDBClient\DocumentHandler::OPTION_OVERWRITE + 'overwrite' + + overwrite option + + + + + OPTION_RETURN_OLD + \ArangoDBClient\DocumentHandler::OPTION_RETURN_OLD + 'returnOld' + + option for returning the old document + + + + + OPTION_RETURN_NEW + \ArangoDBClient\DocumentHandler::OPTION_RETURN_NEW + 'returnNew' + + option for returning the new document + + + + + $_connection + \ArangoDBClient\Handler::_connection + + + Connection object + + + \ArangoDBClient\Connection + + + + + $_documentClass + \ArangoDBClient\DocumentClassable::_documentClass + '\ArangoDBClient\Document' + + + + + string + + + + + $_edgeClass + \ArangoDBClient\DocumentClassable::_edgeClass + '\ArangoDBClient\Edge' + + + + + string + + + + + __construct + \ArangoDBClient\EdgeHandler::__construct() + + Construct a new handler + + + \ArangoDBClient\Connection + + + + $connection + + \ArangoDBClient\Connection + + + + createFromArrayWithContext + \ArangoDBClient\EdgeHandler::createFromArrayWithContext() + + Intermediate function to call the createFromArray function from the right context + + + + + \ArangoDBClient\Edge + + + \ArangoDBClient\ClientException + + + + + $data + + + + + $options + + + + + + saveEdge + \ArangoDBClient\EdgeHandler::saveEdge() + + save an edge to an edge-collection + This will save the edge to the collection and return the edges-document's id + +This will throw if the document cannot be saved + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + mixed + + + array + + + mixed + + + + + $collection + + mixed + + + $from + + mixed + + + $to + + mixed + + + $document + + mixed + + + $options + array() + array + + + + edges + \ArangoDBClient\EdgeHandler::edges() + + Get connected edges for a given vertex + + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + string + + + array + + + array + + + + + $collection + + mixed + + + $vertexHandle + + mixed + + + $direction + 'any' + string + + + $options + array() + array + + + + inEdges + \ArangoDBClient\EdgeHandler::inEdges() + + Get connected inbound edges for a given vertex + + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + array + + + + $collection + + mixed + + + $vertexHandle + + mixed + + + + outEdges + \ArangoDBClient\EdgeHandler::outEdges() + + Get connected outbound edges for a given vertex + + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + array + + + + $collection + + mixed + + + $vertexHandle + + mixed + + + + lazyCreateCollection + \ArangoDBClient\EdgeHandler::lazyCreateCollection() + + + + + + array + + + + + $collection + + mixed + + + $options + + array + + + + get + \ArangoDBClient\DocumentHandler::get() + + Get a single document from a collection + Alias method for getById() + + \ArangoDBClient\Exception + + + string + + + mixed + + + array + + + \ArangoDBClient\Document + + + + $collection + + string + + + $documentId + + mixed + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + has + \ArangoDBClient\DocumentHandler::has() + + Check if a document exists + This will call self::get() internally and checks if there +was an exception thrown which represents an 404 request. + + \ArangoDBClient\Exception + + + string + + + mixed + + + boolean + + + + $collection + + string + + + $documentId + + mixed + + \ArangoDBClient\DocumentHandler + + + getById + \ArangoDBClient\DocumentHandler::getById() + + Get a single document from a collection + This will throw if the document cannot be fetched from the server. + + \ArangoDBClient\Exception + + + string + + + mixed + + + array + + + \ArangoDBClient\Document + + + + $collection + + string + + + $documentId + + mixed + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + getHead + \ArangoDBClient\DocumentHandler::getHead() + + Gets information about a single documents from a collection + This will throw if the document cannot be fetched from the server + + \ArangoDBClient\Exception + + + string + + + mixed + + + boolean + + + string + + + array + + + + $collection + + string + + + $documentId + + mixed + + + $revision + null + string + + + $ifMatch + null + boolean + + \ArangoDBClient\DocumentHandler + + + createFromArrayWithContext + \ArangoDBClient\DocumentHandler::createFromArrayWithContext() + + Intermediate function to call the createFromArray function from the right context + + + + + \ArangoDBClient\Document + + + \ArangoDBClient\ClientException + + + + $data + + + + + $options + + + + \ArangoDBClient\DocumentHandler + + + store + \ArangoDBClient\DocumentHandler::store() + + Store a document to a collection + This is an alias/shortcut to save() and replace(). Instead of having to determine which of the 3 functions to use, +simply pass the document to store() and it will figure out which one to call. + +This will throw if the document cannot be saved or replaced. + + \ArangoDBClient\Exception + + + \ArangoDBClient\Document + + + mixed + + + array + + + mixed + + + + + $document + + \ArangoDBClient\Document + + + $collection + null + mixed + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + insert + \ArangoDBClient\DocumentHandler::insert() + + insert a document into a collection + This will add the document to the collection and return the document's id + +This will throw if the document cannot be saved + + \ArangoDBClient\Exception + + + mixed + + + \ArangoDBClient\Document + array + + + array + + + mixed + + + + + $collection + + mixed + + + $document + + \ArangoDBClient\Document|array + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + save + \ArangoDBClient\DocumentHandler::save() + + Insert a document into a collection + This is an alias for insert(). + + + $collection + + + + + $document + + + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + update + \ArangoDBClient\DocumentHandler::update() + + Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document. + Attention - The behavior of this method has changed since version 1.1 + +This will update the document on the server + +This will throw if the document cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the document to-be-replaced is the same as the one given. + + \ArangoDBClient\Exception + + + \ArangoDBClient\Document + + + array + + + boolean + + + + $document + + \ArangoDBClient\Document + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + updateById + \ArangoDBClient\DocumentHandler::updateById() + + Update an existing document in a collection, identified by collection id and document id +Attention - The behavior of this method has changed since version 1.1 + This will update the document on the server + +This will throw if the document cannot be updated + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the document to-be-updated is the same as the one given. + + \ArangoDBClient\Exception + + + string + + + mixed + + + \ArangoDBClient\Document + + + array + + + boolean + + + + $collection + + string + + + $documentId + + mixed + + + $document + + \ArangoDBClient\Document + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + replace + \ArangoDBClient\DocumentHandler::replace() + + Replace an existing document in a collection, identified by the document itself + This will replace the document on the server + +This will throw if the document cannot be replaced + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given. + + \ArangoDBClient\Exception + + + \ArangoDBClient\Document + + + array + + + boolean + + + + $document + + \ArangoDBClient\Document + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + replaceById + \ArangoDBClient\DocumentHandler::replaceById() + + Replace an existing document in a collection, identified by collection id and document id + This will update the document on the server + +This will throw if the document cannot be Replaced + +If policy is set to error (locally or globally through the ConnectionOptions) +and the passed document has a _rev value set, the database will check +that the revision of the to-be-replaced document is the same as the one given. + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + \ArangoDBClient\Document + + + array + + + boolean + + + + $collection + + mixed + + + $documentId + + mixed + + + $document + + \ArangoDBClient\Document + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + remove + \ArangoDBClient\DocumentHandler::remove() + + Remove a document from a collection, identified by the document itself + + + \ArangoDBClient\Exception + + + \ArangoDBClient\Document + + + array + + + boolean + + + + $document + + \ArangoDBClient\Document + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + removeById + \ArangoDBClient\DocumentHandler::removeById() + + Remove a document from a collection, identified by the collection id and document id + + + \ArangoDBClient\Exception + + + mixed + + + mixed + + + mixed + + + array + + + boolean + + + + $collection + + mixed + + + $documentId + + mixed + + + $revision + null + mixed + + + $options + array() + array + + \ArangoDBClient\DocumentHandler + + + getDocumentId + \ArangoDBClient\DocumentHandler::getDocumentId() + + Helper function to get a document id from a document or a document id value + + + \ArangoDBClient\ClientException + + + mixed + + + mixed + + + + $document + + mixed + + \ArangoDBClient\DocumentHandler + + + getRevision + \ArangoDBClient\DocumentHandler::getRevision() + + Helper function to get a document id from a document or a document id value + + + \ArangoDBClient\ClientException + + + mixed + + + mixed + + + + $document + + mixed + + \ArangoDBClient\DocumentHandler + + + lazyCreateCollection + \ArangoDBClient\DocumentHandler::lazyCreateCollection() + + + + + mixed + + + array + + + + $collection + + mixed + + + $options + + array + + \ArangoDBClient\DocumentHandler + + + __construct + \ArangoDBClient\Handler::__construct() + + Construct a new handler + + + \ArangoDBClient\Connection + + + + $connection + + \ArangoDBClient\Connection + + \ArangoDBClient\Handler + + + getConnection + \ArangoDBClient\Handler::getConnection() + + Return the connection object + + + \ArangoDBClient\Connection + + + \ArangoDBClient\Handler + + + getConnectionOption + \ArangoDBClient\Handler::getConnectionOption() + + Return a connection option +This is a convenience function that calls json_encode_wrapper on the connection + + + + mixed + + + \ArangoDBClient\ClientException + + + + $optionName + + + + \ArangoDBClient\Handler + + + json_encode_wrapper + \ArangoDBClient\Handler::json_encode_wrapper() + + Return a json encoded string for the array passed. + This is a convenience function that calls json_encode_wrapper on the connection + + array + + + string + + + \ArangoDBClient\ClientException + + + + $body + + array + + \ArangoDBClient\Handler + + + includeOptionsInBody + \ArangoDBClient\Handler::includeOptionsInBody() + + Helper function that runs through the options given and includes them into the parameters array given. + Only options that are set in $includeArray will be included. +This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . + + array + + + array + + + array + + + array + + + + $options + + array + + + $body + + array + + + $includeArray + array() + array + + \ArangoDBClient\Handler + + + makeCollection + \ArangoDBClient\Handler::makeCollection() + + Turn a value into a collection name + + + \ArangoDBClient\ClientException + + + mixed + + + string + + + + $value + + mixed + + \ArangoDBClient\Handler + + + addTransactionHeader + \ArangoDBClient\Handler::addTransactionHeader() + + Add a transaction header to the array of headers in case this is a transactional operation + + + array + + + mixed + + + + $headers + + array + + + $collection + + mixed + + \ArangoDBClient\Handler + + + setDocumentClass + \ArangoDBClient\DocumentClassable::setDocumentClass() + + Sets the document class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + setEdgeClass + \ArangoDBClient\DocumentClassable::setEdgeClass() + + Sets the edge class to use + + + string + + + \ArangoDBClient\DocumentClassable + + + + $class + + string + + \ArangoDBClient\DocumentClassable + + + + No summary for method lazyCreateCollection() + + eJztWm1zGrcW/u5foXo8ATLYbtNv3Ng3LiY2GSf22CRtx2EYsStAzaLdroRtetP/fs/Ry65WLDY4zbfuTBLQ6rw951Uir/+bzbKdncOXL3fIS3KSUzFNT38hV+dXJEo4E6pD4jRazOETmVERJyyHjbj3TUajL3TKCCnIuppCv6QLNUtzeEfeUUFuFGNzKkTw6i3QfSHv6VIzJW+iNFvmfDpTpFt8evXjT6/aROUcRAlJzubj8za8TtKpYG1yxnLguwTqw50dQedMglYsUOg/pX3OBqJmVBEgBa6SsBj+tmadCP11P7TaUEyYimaOgkzydA7rjEiW38EW2IksMpZLLpXEV3OSCm/LAekrABRoZUrGS8KlXHAxxR1ISbMsTzOwVTFyPhhckZz9uWCaVepz2cgFkosIXxHy08GPGqEooVKSHuh+bo1iD4qJWJJTa61d3/nfDtJp1PB5WQSBJDTPKSguYvZgXx7qf6NUSEV6HwbXv49OL7sf38PHG3JEGohVA3wQcDQQbsKtd3rWKzjJGlZRmiQsUhygzmgOUaAwoFa4XV4N+pcfRt3Li4teFz8iz5K2TscHOs8StgnX3m8n768uelpNQ/Vt/N5eX75HZhhj38ZpcIl8VFrDBWJJsYdNmHzqXQ96vyEjQ1PDLOb55k447V+XPigoa7h2kSpfRIpQIth9WYT0a7frjRaJm4XVYS8qP+8T7wtk0piRhWRxlYdRMluMEx6RyUKY3aNR5BRo1nNvaTqTMJoDzbFsdnxKf7s1EZ89NeNy/1gy5fKvixnabHyupvNnTNkGUCLR3ysQ9QVAPWexLhuF5mBnRJNEl40oZ/DuLYTSic63YlNRwUyxBTXBt6oe3L2YKhqupRnykSFFztQiF7rUFGtqlqf3koS2mX96DxHTrB71RmDHr1zNukblptauXSgUemVvhMVDwwsRZ4Ev1zynWNU9gk4nkLsirPBM6Jp3Cwh5bTg0B0haayThEyLpHWu2oANoN7EYG4UucAchmBz9K2hS75Y5fwBiNNErg/t+TeQxodBwoIdCp4HOKxbzcZFBjo2LQHCz+0SADcZGsWBSh8ZxkTuO2pRxVOLxgNDKfr1LeRyGRX0YFLskM63M716dDmKIC83WJrmsEfdQape2tq0FTn2IkdthGEPGj1iEAmWbuz3dzGKoYDgw3AFIzr9QB2dpfECuEkalrjuk1Hp3feRIzcWEBAJvP+6X6gcQDSCkyT2HjNek6DhHq0tAGQ+Anotyt0sW805DEh6vZW0ggOitxEUEo12qMDZQdEjtPLzWt34c+0Fsn+1j2bLSxa3y7JuCZ1pYPRHARUIiWHuMxEuYksQCu1+XPG1EDL9lUF2Ytgi+p+M/wEg0Cr7ocKxNsiJEfXFmjSYujtOJXSqqSWjVyvM6O760nKGDkc7rcX68MW3CjxumSHbLeQo9p9fCAIT44XYMxrhZMgWlESbmg9eHwGgrofeUq7dpfrMUEcrThZVpsKHzwgEBJAOYELk5m6d3NAFYWE6NmTqiOfRoKlSy1OELbCBYBUevAI+Yyy8H2wDRx8yAZOHGMpmxiE84elwrUsUBUi1mE7pIlBYMCkDp4OB/rRgGS5ZBoYm3hOUwOw4zzK++gBIkEQRImb7aSWVFNgcHfWjQK+urqa5i1YqKCdbGNNq2uvqZX3ToOf3iRZQvyp+jwOlNLkfU9mYrtdXyuGsJT80Alc0FPEdPzQJOXsng750VNnrMQ6qmhsjbXN0ySJsAXmVK1NnvqQzuSRYxs9naF1f6fbOqvoW6TW4r6/hUk0Y/R8eO+ZSpcs41IprhAqBgx/hfT/qD0c3vH7qtdkXMsPgW+gkcBVY2nX63q2Vj2CIvXpDHN3z9WrW2RvdmSy88aUL3uncy6K0Gi2GZ0L+W3UCBIOKNeyre93wLgyJ6rvQx6HSSJAB/X8BpXn3MYAuMAr7DF3li3UI+5sk5SzIcdqAawFndOBuWm/AHrPh4faEPyOSANA4b8PcTyu3lTGZgPyvjaQW2LJXgIdCi7bb8IVMxYiJKYza6z1GT3AzBrYriSRpRl8BOjuZ/YV+cMxoDqacPxsQPBWHohfUjV+MUqhjW2AmHcaYQPNMCoKq7OxmnRmONg9CyFXXfSQTCA43HoTem5aGtH2NeOxObpTE+NJUk79uJvh83tQK3WEg7HXPd0T8drq0O1+yOSy1khey692kYJhvq/cNRGH4gdSXcHwH6DECGiYQLaJ88LgANb7/WAVw1XH5g980JTSRr1Zy5VtRcOx6fMeUO9dDS7HUcjk5kyu+g01bmtWdNoiuj6H44gG8zjJI9o5E5uhA3ItoLGMA2Te5WTlWW8155s2IVceOemx/0/WCDimXjgFwC35xACks+BkmfaLIAbBoc5rEXpJEuVKP+7BbOlY8NlZvNIuFEuSEVjnUj2+Ncokgc7nCiQ0PtOw2gOxsTqgCs8ULB+ZmceqjoWNtigLLipyLN2TmHaV2cFJx9JeQM8mWmN/xzstePbsYD+6UnguDfcnjTNEEf8wO07QfdkQmt7z3FuTkHC211aJEsmRT92t5EEjO0VJReT+RdNx57phUEQ6/gPqf73hTtF6hNn6yY+dxOPGWmEXtk1QI/piqagVZqpYf94t6sFntXbgvi+spdTGAjjmW7MQQZOqQ9G3T7rDxP9lJTrKskt54DoIwzGs2I7XHGj94vAUMsumb4CGc2zfp2WAK6xYVhLQYOKc14w2bExThdiO/TlKo96Zs6UrUhPdaOnlmL6isPF70nak9YUpwPjEefrlzY6tbelVddBd3wX1+t9xXA892dhQPJWm9ZEGx2V/A0wHhL+Osvwsjr76ar4803DjfPmGzWXpG5gWKjqzJ9TbbpRFErcrDMGIrddbP2LoL2Ssd+eSNUbN9G1tqXuxgHWs7PWo6+l36GjHI8svGap8rEchGyG5zX1/1CtPbCQUOGTeXnske4X/m2kOeCHMJc/xA/guMUlc3KDxr6BWTFZ/cfHtyvZePP3j5MmP8DIK/JBg== + + + + ArangoDB PHP client: connection options + + + + + + + + \ArrayAccess + ConnectionOptions + \ArangoDBClient\ConnectionOptions + + Simple container class for connection options. + This class also provides the default values for the connection +options and will perform a simple validation of them.<br> +It provides array access to its members.<br> +<br> + + + + + OPTION_ENDPOINT + \ArangoDBClient\ConnectionOptions::OPTION_ENDPOINT + 'endpoint' + + Endpoint string index constant + + + + + OPTION_HOST + \ArangoDBClient\ConnectionOptions::OPTION_HOST + 'host' + + Host name string index constant (deprecated, use endpoint instead) + + + + + OPTION_PORT + \ArangoDBClient\ConnectionOptions::OPTION_PORT + 'port' + + Port number index constant (deprecated, use endpoint instead) + + + + + OPTION_TIMEOUT + \ArangoDBClient\ConnectionOptions::OPTION_TIMEOUT + 'timeout' + + Timeout value index constant + + + + + OPTION_FAILOVER_TRIES + \ArangoDBClient\ConnectionOptions::OPTION_FAILOVER_TRIES + 'failoverTries' + + Number of servers tried in case of failover +if set to 0, then an unlimited amount of servers will be tried + + + + + OPTION_FAILOVER_TIMEOUT + \ArangoDBClient\ConnectionOptions::OPTION_FAILOVER_TIMEOUT + 'failoverTimeout' + + Max amount of time (in seconds) that is spent waiting on failover + + + + + OPTION_TRACE + \ArangoDBClient\ConnectionOptions::OPTION_TRACE + 'trace' + + Trace function index constant + + + + + OPTION_VERIFY_CERT + \ArangoDBClient\ConnectionOptions::OPTION_VERIFY_CERT + 'verifyCert' + + "verify certificates" index constant + + + + + OPTION_VERIFY_CERT_NAME + \ArangoDBClient\ConnectionOptions::OPTION_VERIFY_CERT_NAME + 'verifyCertName' + + "verify certificate host name" index constant + + + + + OPTION_ALLOW_SELF_SIGNED + \ArangoDBClient\ConnectionOptions::OPTION_ALLOW_SELF_SIGNED + 'allowSelfSigned' + + "allow self-signed" index constant + + + + + OPTION_CA_FILE + \ArangoDBClient\ConnectionOptions::OPTION_CA_FILE + 'caFile' + + "caFile" index constant + + + + + OPTION_CIPHERS + \ArangoDBClient\ConnectionOptions::OPTION_CIPHERS + 'ciphers' + + ciphers allowed to be used in SSL + + + + + OPTION_ENHANCED_TRACE + \ArangoDBClient\ConnectionOptions::OPTION_ENHANCED_TRACE + 'enhancedTrace' + + Enhanced trace + + + + + OPTION_CREATE + \ArangoDBClient\ConnectionOptions::OPTION_CREATE + 'createCollection' + + "Create collections if they don't exist" index constant + + + + + OPTION_REVISION + \ArangoDBClient\ConnectionOptions::OPTION_REVISION + 'rev' + + Update revision constant + + + + + OPTION_UPDATE_POLICY + \ArangoDBClient\ConnectionOptions::OPTION_UPDATE_POLICY + 'policy' + + Update policy index constant + + + + + OPTION_UPDATE_KEEPNULL + \ArangoDBClient\ConnectionOptions::OPTION_UPDATE_KEEPNULL + 'keepNull' + + Update keepNull constant + + + + + OPTION_REPLACE_POLICY + \ArangoDBClient\ConnectionOptions::OPTION_REPLACE_POLICY + 'policy' + + Replace policy index constant + + + + + OPTION_DELETE_POLICY + \ArangoDBClient\ConnectionOptions::OPTION_DELETE_POLICY + 'policy' + + Delete policy index constant + + + + + OPTION_WAIT_SYNC + \ArangoDBClient\ConnectionOptions::OPTION_WAIT_SYNC + 'waitForSync' + + Wait for sync index constant + + + + + OPTION_LIMIT + \ArangoDBClient\ConnectionOptions::OPTION_LIMIT + 'limit' + + Limit index constant + + + + + OPTION_SKIP + \ArangoDBClient\ConnectionOptions::OPTION_SKIP + 'skip' + + Skip index constant + + + + + OPTION_BATCHSIZE + \ArangoDBClient\ConnectionOptions::OPTION_BATCHSIZE + 'batchSize' + + Batch size index constant + + + + + OPTION_JOURNAL_SIZE + \ArangoDBClient\ConnectionOptions::OPTION_JOURNAL_SIZE + 'journalSize' + + Wait for sync index constant + + + + + OPTION_IS_SYSTEM + \ArangoDBClient\ConnectionOptions::OPTION_IS_SYSTEM + 'isSystem' + + Wait for sync index constant + + + + + OPTION_IS_VOLATILE + \ArangoDBClient\ConnectionOptions::OPTION_IS_VOLATILE + 'isVolatile' + + Wait for sync index constant + + + + + OPTION_AUTH_USER + \ArangoDBClient\ConnectionOptions::OPTION_AUTH_USER + 'AuthUser' + + Authentication user name + + + + + OPTION_AUTH_PASSWD + \ArangoDBClient\ConnectionOptions::OPTION_AUTH_PASSWD + 'AuthPasswd' + + Authentication password + + + + + OPTION_AUTH_TYPE + \ArangoDBClient\ConnectionOptions::OPTION_AUTH_TYPE + 'AuthType' + + Authentication type + + + + + OPTION_CONNECTION + \ArangoDBClient\ConnectionOptions::OPTION_CONNECTION + 'Connection' + + Connection + + + + + OPTION_RECONNECT + \ArangoDBClient\ConnectionOptions::OPTION_RECONNECT + 'Reconnect' + + Reconnect flag + + + + + OPTION_BATCH + \ArangoDBClient\ConnectionOptions::OPTION_BATCH + 'Batch' + + Batch flag + + + + + OPTION_BATCHPART + \ArangoDBClient\ConnectionOptions::OPTION_BATCHPART + 'BatchPart' + + Batchpart flag + + + + + OPTION_DATABASE + \ArangoDBClient\ConnectionOptions::OPTION_DATABASE + 'database' + + Database flag + + + + + OPTION_CHECK_UTF8_CONFORM + \ArangoDBClient\ConnectionOptions::OPTION_CHECK_UTF8_CONFORM + 'CheckUtf8Conform' + + UTF-8 CHeck Flag + + + + + OPTION_MEMCACHED_SERVERS + \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_SERVERS + 'memcachedServers' + + Entry for memcached servers array + + + + + OPTION_MEMCACHED_OPTIONS + \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_OPTIONS + 'memcachedOptions' + + Entry for memcached options array - - \ArangoDBClient\Exception - - - mixed - - - mixed - - - mixed - - - mixed - - - string - - - boolean - - - - $graph - - mixed - - - $edgeId - - mixed - - - $revision - null - mixed - - - $options - array() - mixed - - - $collection - null - string - - - - clearCache - \ArangoDBClient\GraphHandler::clearCache() - - Clears the GraphHandler's cache + + + OPTION_MEMCACHED_ENDPOINTS_KEY + \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_ENDPOINTS_KEY + 'memcachedEndpointsKey' + + Entry for memcached endpoints key - - \ArangoDBClient\GraphHandler - - - - - getCacheEnabled - \ArangoDBClient\GraphHandler::getCacheEnabled() - - Checks if caching in enabled + + + OPTION_MEMCACHED_PERSISTENT_ID + \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_PERSISTENT_ID + 'memcachedPersistentId' + + Entry for memcached persistend id - - boolean - - - - setCacheEnabled - \ArangoDBClient\GraphHandler::setCacheEnabled() - - + + + OPTION_MEMCACHED_TTL + \ArangoDBClient\ConnectionOptions::OPTION_MEMCACHED_TTL + 'memcachedTtl' + + Entry for memcached cache ttl - - boolean - - - \ArangoDBClient\GraphHandler - - - - $useCache - - boolean - - - - __construct - \ArangoDBClient\Handler::__construct() - - Construct a new handler + + + OPTION_NOTIFY_CALLBACK + \ArangoDBClient\ConnectionOptions::OPTION_NOTIFY_CALLBACK + 'notifyCallback' + + Entry for notification callback - - \ArangoDBClient\Connection - - - $connection - - \ArangoDBClient\Connection - - \ArangoDBClient\Handler - - - getConnection - \ArangoDBClient\Handler::getConnection() - - Return the connection object + + + $_values + \ArangoDBClient\ConnectionOptions::_values + array() + + The current options - - \ArangoDBClient\Connection + + array - \ArangoDBClient\Handler - - - getConnectionOption - \ArangoDBClient\Handler::getConnectionOption() - - Return a connection option -This is a convenience function that calls json_encode_wrapper on the connection + + + $_currentEndpointIndex + \ArangoDBClient\ConnectionOptions::_currentEndpointIndex + 0 + + The index into the endpoints array that we will connect to (or are currently +connected to). This index will be increased in case the currently connected +server tells us there is a different leader. We will then simply connect +to the new leader, adjusting this index. If we don't know the new leader +we will try the next server from the list of endpoints until we find the leader +or have tried to often - - - mixed + + integer - - \ArangoDBClient\ClientException + + + + $_cache + \ArangoDBClient\ConnectionOptions::_cache + null + + Optional Memcached instance for endpoints caching + + + \ArangoDBClient\Memcached - - $optionName - - - - \ArangoDBClient\Handler - - - json_encode_wrapper - \ArangoDBClient\Handler::json_encode_wrapper() - - Return a json encoded string for the array passed. - This is a convenience function that calls json_encode_wrapper on the connection - + + + __construct + \ArangoDBClient\ConnectionOptions::__construct() + + Set defaults, use options provided by client and validate them + + array - - string - - + \ArangoDBClient\ClientException - $body + $options array - \ArangoDBClient\Handler - - includeOptionsInBody - \ArangoDBClient\Handler::includeOptionsInBody() - - Helper function that runs through the options given and includes them into the parameters array given. - Only options that are set in $includeArray will be included. -This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) . - + + getAll + \ArangoDBClient\ConnectionOptions::getAll() + + Get all options + + array - - array + + + + offsetSet + \ArangoDBClient\ConnectionOptions::offsetSet() + + Set and validate a specific option, necessary for ArrayAccess + + + \ArangoDBClient\Exception - - array + + string - - array + + mixed + + + void - $options + $offset - array + string - $body + $value - array + mixed + + + offsetExists + \ArangoDBClient\ConnectionOptions::offsetExists() + + Check whether an option exists, necessary for ArrayAccess + + + string + + + boolean + + - $includeArray - array() - array + $offset + + string - \ArangoDBClient\Handler - - makeCollection - \ArangoDBClient\Handler::makeCollection() - - Turn a value into a collection name + + offsetUnset + \ArangoDBClient\ConnectionOptions::offsetUnset() + + Remove an option and validate, necessary for ArrayAccess - - \ArangoDBClient\ClientException - - - mixed + + \ArangoDBClient\Exception - + string + + void + - $value + $offset - mixed + string - \ArangoDBClient\Handler - - setDocumentClass - \ArangoDBClient\Handler::setDocumentClass() - - Sets the document class to use + + offsetGet + \ArangoDBClient\ConnectionOptions::offsetGet() + + Get a specific option, necessary for ArrayAccess - + + \ArangoDBClient\ClientException + + string - - \ArangoDBClient\Handler + + mixed - $class + $offset string - \ArangoDBClient\Handler - - - No summary for method setCacheEnabled() - - eJztXW1z27ay/p5fgXPGcyR1ZKfp9JMT+9aRlUSnSeyxnfZmXI+HEmGLDU3qEpQd33P73+8u3giAoERakt8qzWQik8Bi8ba7z2IXevNfk/HkxYuXP/zwgvxA9rIguUz335LDD4dkFEc0ybfJZRZMxmQcJGFMMyiFBX+ZBKNvwSUlRNfp8eL8ZTDNx2kG78i/g4Qc55ReBUnivHoH9b6RT8EtJ2q9idMsgopvgyynMeNvR+nkNosuxznp6W8//fjq5y7JoewlTRh5fzX80IXXcXqZ0C55TzNo9VYxzKJkhOwS8mrrJ3jy8sWLJLiiDDpCnT68LsZDdZvk4yAnQA+aYmJE2JY7Fp6RUK2qNkdxwIBTrP9BUqbfc5qEjMi/X/znBTLJGcDPDyRMR9MrIMhIkGXBLYmSkH6XL1/y/0dpwnLS/3xy9PX8/dHe4QeyQ1qcyRb0xSEHhcMoj9IkiMl0EgY5JekFoSF2DMb/mmZ5NKLM08DB4cng4PP5Uf+3wTF8wUYyeh0xoOVpBwnR72QSZDDMOU5yFcHf+kcng17/GAmq5j0EwyijI2S8Ds3+/ntBkHdsUWq/9r8irfNv9NY7onFcn1bv4OPHfu9EDmBRdyZh1ozysU3a13/6PbiaxHQmXej2+bujg0+87xdZerUAnZMDTiVPPTRwI9bp4Oe9T32kguV9rMBUk5BeREnUZJmc7/ffDT4P1IwglX1NZH4ztabGaee43JBvjiw5MQpGY0pYnmbUameSpTlMMw3JBi9SJvPLdZDJl/0kGMZQdJimMQURa7UwZbR2K4rQDrkIYuZptJdRFC2BEJbyqXp5Mo4YuYnimIysYsBClFyCsKXkMrqmiXyaDv+EtgmwSTKaT7MEvkphCKILSwsyoVW+BQIzB+0wnOaUbb0ZZrv4z+Hkl3ycpTeM9L+P6ATnwX3PJ1eME9kQ5DeBf2qzdjOORqAj0xgEOfITJRcpqB++DCWLonyekqFm121LdQ57ph9aKsSckekwjkbkYpoI0SNockbbJrsdXlpoFfxsOOsOpvD07LV+DXxTmGDSFrU3dy9p3rdrtDskYEinY5D1kT49A+LwcHM3B9XIcEhO0j3sXbtTtPjXi4I3PtoMvgFTFmlG44vtbVMO2J+dXWIw/CuFFrrVBErbURBw2J9B4ODo8MOeI3EtDg6yCZgOvUIEtzuamjHaG9Mslh0gX7KYbW9/OfoodLhRKAMzBUhQHM0ctg5voZcmiaDd7mzuTlKWt5FaVxX5k6XJOU1GaUjPb4CvCc3acnw7xuhvYDnJgW6IN/BvhqSNkrJ3jOaDBKQdGBCDsM3rn0pr4+yUr7ztbWGLDPbP/PXbVjFQD13i0CnNdwWlI2mAzOQDLBasruvLfWZM114cq67+VRJlKZ/Lhmret0JIK3WXhc8yydKJ0Vh1E/tHB4eOOYF1e7NMimGQj8Ys+l9XukfXKIY39GufMTJFo9ZXi7+CGm6VOLqKKqrwVx6NR/O5KuOyKFMp1YXUPgbpD+pEim0iBTe3Nkyh7NQSioVspBMhHzfJgfwGwnuC9jv8j5VhBYzTKiHOF+D/ceXo6po/bKDwh/jP1UD1JT8MiBD7oqNd2QPdARTwJS2AgofLnA80BtGwvT2cRnEIf7cdOdQlp4KutYXy7NYV/jWkFDzgQsqU/mBy5KhvdP9BDruKRY6pNDV0VUNxAI4JKiVYUUwOyWnrPGKf6U3rzDFgVEemcQ5vpBARmvUd2L9Cd/HGtKjpaqqd1y6NSmFnUfALu5K0EiSrhNQxzYXpobcwqnIwlG7lOhUGAu6HgIymGUuzLVX3d9xWYJZAC7i3LnIOeKksBhiYwVuqTIxwy7/boiQ3BMjMFQvNvFUF20Wd0iIVy6jo0Y4loeRAVI4EF0sPMgoeWVkegR4WaouyFT0XPdjREnZej7lUfZAee0R9uccfsVBblK3osejBjlYQFT029ASY+QBOJug3oGwxK/8q+o4AR1n54n+uLmAkAkBFXJ3AyESghQMUzqBG3nuUlVICCLOA0BH/i1moxYAmYh44iyTieikDBMGL0yxLM01VKIR56qAYjbYfAUAb8o3uiOpHyaIXxXZKxrVfCtdRKvsHvS+fQBaSLdJ6eS5caS2/kikkcQ2FUiEvS6asZzXto8WlIKhAmVfpNcw6TEsEW0s5pfg77lACHRuzlJtqTHm61EvTbbPE9Vh87rIyFUm+IkH/WHYi2jiwKFAIgGnD9WFhHTHLDcUtsCTNUWwgkYlHLNiLP4hvglsQT9mUdkX1pa10ZMC2fEod2+ENr3wHLGpXVVdH4JaEhxy3IRWB8U4dS5+1OP50HlqUK3ZQSGMAMlWbCAevyuIIwhAnroyOpHksLPRKM55Xh7nMcBXMo+LfR3faTuX9tNCGkiU3XGQHRJF9b79g70DvgRdoS9Sv2kN2i2JX/DRnVwBp1/tQ7A+XzfvVDQ13RrfwiRzuHZ3wg4L+f1urWtr9M5xFJkDeLQ+Arni2MLqp6YNBljtNEZCQmQm9IQ5abG8IrPOJMhZc0nanYvj/9gBJCDrmF1l4uFFHaAkitWgsU2StRmY1FlrCLPKILdO6wGMFRxFxdgsDA5WKBGi6BAywGNuwy82LP6cs1+3Nnp1FZKVos764LFkYans8QTnq6V5D0VpyQJZMEFO6zuiB38gRknJhsWxbOHpI11L3PqTuJbomEEdJkHQHmcv9vV4KbbF+BS6bMpAUUVI6nu3UE8xkgHgE2pReE9uHwsM/RsAFswrBN9Us90uRK9D0nBs8JEUZCyXSi4uu0R5yknAfDT9nQ6Jdiyjv9FXwTaiZaY5SXFDfOxzw8so2DofYcpqF6LdJ+UDhY9hNsAmzCB3tBnab0XGT26QrOERK1vEw5ytN4lvJA7zff8t5SlHUYo+4UB+nTJ3cds0zW74X+FyIQ2ZV4QJYTG+weT7AW9X+/Ao83OCziNZ0vOp3al1UDuKu5QuSJFV7S/u8meyqo4sAgPa2uQqX10gc7bbo91E8DaUiBTC6qU2B6yCe0m0sKNR+SmRZw9LggUfS7ZDCPIj36l0k1qKQM1sr6cM+vQiAONPujzcvoVcVdoZ9PC/tOEc/1DQ/YMf+xqWaeVDc4BRndVaGPaGFOtIFzkHw9fg+5h+tfs3oEENbIKdtXBOdokf/+hcIHNREhf5z1tFZBwv9I2LnWHVWuXIogtsBw9yArr8FeuJ4cBZV79jwQS+6v7MjfUwOB7yYy4Usy3tFryY5aG1j2JRDqMzJaUssf09P8aN0cU1a1+6aaxnmmdNb1ZWZ7HoINuezBlflb3fwt1V7Fewprpi70kqr7bJzhSQPObGeVay4jZE2aOWTKmvX2KDcZOgFExhx+gnNkh2TzuZuxAbJW6dMuzQIZSpVw1BhfaujviP6P1PK8rZAS95u3u+Z8qK2/WqGh9e9A5YoleKmfIUj7Nj0dbE0y9slqPUwQq6uHFmAnhobR7QQitZH3Zbq0/XNpJKCRXGvc10cizgxrXfxrc+ksVQ3lRo0x0JfxOq2Yw/dGD3psMJd7PRyyR51m43CQWSz86S8QBgE6XP4OH3yB28uKLQbusrXXpsH85W7wqO5p3wOhZX6yZfiJfeLHCOKsJQRkNE4MIXQPP+41zteomqewyOelw7z5fvD6wm75+ELRylY6trj9IOrims3+JMTqNoN7gYINfaCzyOw9m6XOv7ovdsPFJ1oOjIb6gmZFFR2W96f7DfAaQ3fowfLzsendg89WHS2382tfveYyXqG/NpftPYXPTJ/0RL2WM16Zf/LPI+Lq6MzOomDkR/1mOlC1TpaUvARkIdYz8jnskJ/ixzHZ+pzKfWAt3skIWO782A+mek6evHRAggWYD6CioEBc3heliS6gHGbihqb6hIRy/lr2q9FWRK5OY0FVTN0XwfkBIlMCEAmw2WkPFjSbBFJpsjp7hMpvYqBVMHYXewI/oUpniLIUY+3zPLnqMk5/7ejwEeOTydNKGIoprNLbqIccVSGLh4EQAn1xDXh0ysMgASkcx2FOoG0+uNEU0K3+BUORler5LPkHLgNcRAVM9YFBXXzMXD+RTyDkZAhR75rDc4OSaZxfG+iGwlH7DyQ+1uyVDY19DLZIaIfPumgaldbeWZHd2RX3aZKR0jiuSmeq0JDjJb9pHoybXAkMgxL7x0CnOcKIv8A/l/5juCqRXprz1yKfB3jrhJLOdxqOa17Yg0qe1TFjL20ytVPf5wRSuCxheUUu1cD8ELLjL8t2C7lva3qBOXlSyHO0QXDCJsKSZTjuN/QFqZjmd6eLonyIufrMtVnitwLNE6/geRNpGOEjr5hvmic3myZrfWCKfK8TQawpWnApUygL7Uig/0uNMz92UIiqQtgOBMgXXMpfbfsLlAyCJVZzhHRIRaVIhwoZRHF0PGh8OcgURjCQdjuIMORTe133vFhwCIse2swgiJayH5MVesWDikcDtTCoxEs6iTn1aYybU4MH2c94nqEe7NUh5V2JSYk5My79o3uVrvS8aAr+80mXBJcbM3HgVLwEy6CdD111N0yEaCxP5y7QEThUyU7vbeAWJWL6zu8Vd2LO5yW0cbTDoIy2DN3scFldR6oyCrGK4hirZa5S2+esTXbLLqgMElmGgOjGRR6lIaSYH4QEsdQ4qs8uoho5lR0b8uAz8wg1+35xsybSY0ITww7fTPcPZfRomp+2ZuXw11kXQabqmBScSmTKGPlXs8M/azT/mUChtaHCEzIZE/TdbhgY1geY15mOY2/LIboXixQx8CsYZCmJE6DsIYBui+3aUNbU9tHhamp1q43dPYh7E9dGHUBskG/T2J0m7Zetgx+jTrIgbTaeJ0Ot3l+cluPI5abZqZJDHniddf26XOzT+3LwpZpfhoL6MzxczTwp6/c8Kjj35FipRK/Cbolt47HHOihSYsTrv0A9DtsPOYIMuMyQzw5FN6eQjx1tN4BE1GYzdxSVvcfKDI3gfA8azcaX8GJvFowoxO8pYXfApuQn3/8GZ7wE4CSWHXNB/I7nnfiaW8qogHxogUh+wNOKB3hfS+zrIzCyFjcxCgsjNn2hasmZOjMTJ0wDliVTnBFfdlFCjjAsOWOuYlWDCLMFjAIlUBmxaG6AUPjDFvgORLSw81rW6iUblvgK1J5Vl1eyv5V5F1gKNAwuDX5bT84uaCH7QEkxpVk8iOCeOXWxkM9Lsig9owQficdhPP7wuVJJvHyEbXeiTHeoK6y9GzCI+NMBXcfdk2tmUQZNd1i/YTWCoXtNt+pKW9BNlajxLTCTnfqDS7IJIVld4vxBDJmS+ypdpwK/AjfL+N0yL9jV6eXY06vEJwyLaujiCKjWEL6HjVYHPM9dp7Ra5FIhQ12BZ4EYA+IlUrJgzJFEeN4XqRMCXSlcHKebg7ppjxdKUZGAFQmtzRPy0rkBawLXpuqz6iWDFNmApUiPR0pJtOrYQm0KJuz0jFs+ctho4slElZyUxf9kDajVDhJOkRGiFiZcjxuZEMusDb+MUqvJkEeDaM4ym/xAsWUh8MAn3xqX229EtOrQ2w6NSBWTZClYY5aSRLX6IUlGHQvFIdutlh6hUtNlNuMwhY5Vf4RucijpKAThWCgiwxA7B7CJl5cTUOL6bJnnZogSTMvRlOyLje7HGE5u5KdEe4nGEzo0QW8zqEbfGeDsd6KA5a3kLnPXz5+lMwJ9NacoZsgyt+l2fFtMpJcSb8VZwSxYJrBHmDwHrZZEjHrImG9NOVG5t/xyq9A+f7DiH0jFO9PVp3SIsFomlzEwSVImFBc8gaVxJXOKnIJBWpmor763ayEp+R+AarPiFjtlVRyTqqhaVn0PBq4usarFaTWePVueLVY0HyFn1/R7JK27fPw4tckdoUCsE/crTWJV4PrCZWePWlJDRIRNd22p1IS6jrR2/hpGaJQ5GJ6AK6g3i4Zbpr93/cGJ+fHXz/3nOvGeQtCybTEX3dt4ah/+HGv1z8/PPg46H3t2LN7pv+yz3gGhttzrrKGJYJgEoS9czSh4LZ3ws6s2DV72HWT7mGa9ve7CAjbw33NN4iu712bYiGczhoxzWFBqnK98sy/Gt0tSZxmfMwmPjvq5QHOI6scQrVzFuRN801PNRvFIK3c33TvB12uF8u6f9GFxl+EKVsfGQ9vVw2O6x6J2XjqPqG1i+9WirCLQ981xjYw9oT7tdyZEI5OUFB5ECVijIqzMrFacYLYCiH58oHzo8Oe3yidfAZF6weeuDayKbSufwkO4aRI5dRCxpiVSMZ0wKbJZeBGlBnzhCrdPubk2L6NXJh0btBHLXc8N+8fCFKrH0Rbo+lHgabFdDxJMK0Lr7H0GkuvsfTCWFrpLY6moQUublYEub8c7u+drBG3s1z+DohbRljcL5xuCKiNOZ/z6xjczq6Dp0v+Bd8vxO1U/qQGLyWtih31S24FntZFFgn9rAOIj+TPdvhiN10gXCTBlMHwE4vMrAHGFBEtJuzLSH1Q1sqQkVeNVFB9VKef803qJvGljwW/LfvkEDYK6KNHhHMeSUjr/WMcccl9NcYxVTvq6zXCWSOc54Rw1qikJiP7/Y/9Zqiknom/sHm/3NtMGlrPdzOdF/8xLNf2FAna8uKHGvnZvLy+R2FWVjb/wblNIxKqbn62uCrqCWRncztdkUPOW/ikJZV4RSUYMmJXytM5VeIAbE9Vpa1M1Q7wLN5oGwYGroJE6SwDy7rRgpX55HJ5PHA6eT3LR/RY5YWLtXTnrHC8yqMwbnB2EZGmXTUnyrR5POnitcwI5xYa8dQ0IiouyXo9k4xjQDhvfeaDl8DDGA/+vtQ0HZzK9Vyjd0jux2mpm9pvNlMoU75sK5sQF4O0RKmWWuV+69mqg8y0+f6ojCQ4Sduwc0p3xLifeWEjxn1Pv/a/nr87OvjE1Tu2XV3s5OBM0M7T10vV+vJinAdIiG8SO8KloBpeI3YEn9eMHMGip2L9NYkaKVV7yNRoPgzNE6Mde+QppUUj64NQkuP9uGNCdOOf/FknQ89t/HF6jvTZtHldmnpWsfYbWlbSwLBvRns6+c+C26X4hySpJXmH1mZdPVZWatYtK9u5ZFno5XLfmc71rYcGec4VpizSbJbjLLFpoxRnLn2eUYLzEtKbpaWwkuRmn7B/mMRmLyfrpOZFkpqFVVkrpVkaoJWbVN1Dq+2OO4RsO8a65PghIrbvJ1RbjOnKw7TvA5g0iAewPKJlJyjWb7Wcun2hxmxXqG3e1ojQroeP1hEDjyZi4FHmGj9S7HdvecZ++Ce2dVfs1CcXGr2GhWtY6KyUdSB00QKLYjwGFn+p/nnKCV/cEb1mrZWHJjg5ynYzK4uY3hjTIAS1zgWZLS6aBFJbc3sfcdTm1BjIvlRcdg/KX2xeIWqC0lC89c8W2TI43cInyw+2NkJFi0+DsOqGPb5jb+ukS8N+HCSAfXKRMNt2VMsSD/Vs59W9+K0ax8A0cnk1yMfu6il8hqdrd0zHnoXpy8nY82C9kYq9JFT/cGnYdtjMc0nCfq7oXiRs23O2zHTt5s6AZ43Zn1eO9nPP0P7b+iDEVKxdEMVn7YJYuyD+Bi6Ih8vFvifPwjoX++FzsVcKzck9RZU8o/xuic51frdC5f7JWDK21pndpdDTGnndEjg9R4TnzecuAWKVYnTHRO71mexjPZNdZ3E/FiwksrgrsNATzeBeo6A1CnJWyl9r4HK3dO0ZwMWcxyeXrb2qUypdc/FMbfzPjHgGQyUT/mouOT+AiRjTrMVAW47GKlrZ1SCcj5kaYIR0e0ii7cpt2QlOX4p2T1IWFqpkWodUIxHUp6DdacKV9gydNy+mGIcVmeoLSiXGTdYk/7JoFaNS6St7cAM0fG+hYWUOi5rirEGWhXEDqOJzBhx6MgIDj50HcRSwtrkytrf5G7AA/wBTJrikCftDut6Hf1hLCFbi/wPdwPae - - - - ArangoDB PHP client: default values - - - - - - - - DefaultValues - \ArangoDBClient\DefaultValues - - Contains default values used by the client - <br> - - - - - DEFAULT_PORT - \ArangoDBClient\DefaultValues::DEFAULT_PORT - 8529 - - Default port number (used if no port specified) - - - - - DEFAULT_TIMEOUT - \ArangoDBClient\DefaultValues::DEFAULT_TIMEOUT - 30 - - Default timeout value (used if no timeout value specified) - - - - - DEFAULT_FAILOVER_TRIES - \ArangoDBClient\DefaultValues::DEFAULT_FAILOVER_TRIES - 3 - - Default number of failover servers to try (used in case there is an automatic failover) -if set to 0, then an unlimited amount of servers will be tried - - - - - DEFAULT_FAILOVER_TIMEOUT - \ArangoDBClient\DefaultValues::DEFAULT_FAILOVER_TIMEOUT - 30 - - Default max amount of time (in seconds) that is spent waiting on failover - - - - - DEFAULT_AUTH_TYPE - \ArangoDBClient\DefaultValues::DEFAULT_AUTH_TYPE - 'Basic' - - Default Authorization type (use HTTP basic authentication) - - - - - DEFAULT_WAIT_SYNC - \ArangoDBClient\DefaultValues::DEFAULT_WAIT_SYNC - false - - Default value for waitForSync (fsync all data to disk on document updates/insertions/deletions) - - - - - DEFAULT_JOURNAL_SIZE - \ArangoDBClient\DefaultValues::DEFAULT_JOURNAL_SIZE - 33554432 - - Default value for collection journal size - - - - - DEFAULT_IS_VOLATILE - \ArangoDBClient\DefaultValues::DEFAULT_IS_VOLATILE - false - - Default value for isVolatile + + getCurrentEndpoint + \ArangoDBClient\ConnectionOptions::getCurrentEndpoint() + + Get the current endpoint to use + + string + - - - DEFAULT_CREATE - \ArangoDBClient\DefaultValues::DEFAULT_CREATE - false - - Default value for createCollection (create the collection on the fly when the first document is added to an unknown collection) + + + haveMultipleEndpoints + \ArangoDBClient\ConnectionOptions::haveMultipleEndpoints() + + Whether or not we have multiple endpoints to connect to + + boolean + - - - DEFAULT_CONNECTION - \ArangoDBClient\DefaultValues::DEFAULT_CONNECTION - 'Keep-Alive' - - Default value for HTTP Connection header + + + addEndpoint + \ArangoDBClient\ConnectionOptions::addEndpoint() + + Add a new endpoint to the list of endpoints +if the endpoint is already in the list, it will not be added again +as a side-effect, this method will modify _currentEndpointIndex + + string + + + void + - - - DEFAULT_VERIFY_CERT - \ArangoDBClient\DefaultValues::DEFAULT_VERIFY_CERT - false - - Default value for SSL certificate verification + + $endpoint + + string + + + + nextEndpoint + \ArangoDBClient\ConnectionOptions::nextEndpoint() + + Return the next endpoint from the list of endpoints +As a side-effect this function switches to a new endpoint + + string + - - - DEFAULT_VERIFY_CERT_NAME - \ArangoDBClient\DefaultValues::DEFAULT_VERIFY_CERT_NAME - false - - Default value for SSL certificate host name verification + + + getDefaults + \ArangoDBClient\ConnectionOptions::getDefaults() + + Get the default values for the options + + array + - - - DEFAULT_ALLOW_SELF_SIGNED - \ArangoDBClient\DefaultValues::DEFAULT_ALLOW_SELF_SIGNED - true - - Default value for accepting self-signed SSL certificates + + + getSupportedAuthTypes + \ArangoDBClient\ConnectionOptions::getSupportedAuthTypes() + + Return the supported authorization types + + array + - - - DEFAULT_CIPHERS - \ArangoDBClient\DefaultValues::DEFAULT_CIPHERS - null - - Default value for ciphers to be used in SSL + + + getSupportedConnectionTypes + \ArangoDBClient\ConnectionOptions::getSupportedConnectionTypes() + + Return the supported connection types + + array + - - - DEFAULT_UPDATE_POLICY - \ArangoDBClient\DefaultValues::DEFAULT_UPDATE_POLICY - \ArangoDBClient\UpdatePolicy::ERROR - - Default update policy + + + validate + \ArangoDBClient\ConnectionOptions::validate() + + Validate the options + + \ArangoDBClient\ClientException + + + void + - - - DEFAULT_REPLACE_POLICY - \ArangoDBClient\DefaultValues::DEFAULT_REPLACE_POLICY - \ArangoDBClient\UpdatePolicy::ERROR - - Default replace policy + + + loadOptionsFromCache + \ArangoDBClient\ConnectionOptions::loadOptionsFromCache() + + load and merge connection options from optional Memcached cache into +ihe current settings + + void + - - - DEFAULT_DELETE_POLICY - \ArangoDBClient\DefaultValues::DEFAULT_DELETE_POLICY - \ArangoDBClient\UpdatePolicy::ERROR - - Default delete policy + + + storeOptionsInCache + \ArangoDBClient\ConnectionOptions::storeOptionsInCache() + + store the updated options in the optional Memcached cache + + void + - - - DEFAULT_CHECK_UTF8_CONFORM - \ArangoDBClient\DefaultValues::DEFAULT_CHECK_UTF8_CONFORM - false - - Default value for checking if data is UTF-8 conform + + + getEndpointsCache + \ArangoDBClient\ConnectionOptions::getEndpointsCache() + + Initialize and return a memcached cache instance, +if option "memcachedServers" is set + + \ArangoDBClient\Memcached + - + - eJydVltP4zgUfu+vOG8UBFO2DBJbZi+ZNKWZCU2VpoxYIUVu4rReHDuKHdjOav/7HLsX6EjNFvqSNOfyfedqf/qjXJStVufkpAUn4FREzGX/M4yHY0g5o0L3IKM5qbmGJ8JrqlDNaP5ZkvSRzCnA1si1+lZIar2QFcrgCxEw0ZQWRAgrSmW5rNh8ocHdvnXPf+megq4YOhQKborZ8BTFXM4FPYUbWqH1Eq07rZYgBVWITX+Cvd7G4EqhCUM3u7yhVjSD2RL0gq5DW4fyaVb9flBUionUiADOP3QtHTJTuiKpRodEKeivEO9Wifq3ZVQtK/M72YihlJUGURczWkHb0mI5CLn6rkqaspzR7Hht1rHPVAqloe8NnGkQJ+MwiuE3uLrs/oqB74HRrKCyXse/A7QrOQgx9m+9cGpAL86vrXwf7DowmUNOGJdP+K5ohQ8FGqGr5YaKgJQoaupRUWAKsFOwb2RBNEu3thtOhrmi2rg4PzU2wujXgrOCafRGClkLbVA3YM+Mc5hR01Y0a4hs4PhBeOdFSRz53sQE2BxfQf55hWZSCW2MRVF0m6lj5Ea0CQfTiirPhGkm5iDFNqSDuBycbseOGvuOWUMMvSxXpYZhHI9hRhTm0kwjcmGp1WmqsjONh0l8P/YQ+OizMT7a31+r7slxzk2QA1lNliKFdq7Mg2DyM6KJKVjG1KNJQCbTujBJqUsUUdXBKaWV4aQ6GeXUvjXR++b4cTK5H7lILydc0UPIpZJzmtrs/C3rShAOin2nDTBfwmk0coJk4v9lEnFxcXn58eNF9xAwpu4kxzTzJv/+JLkLAyf2A+9NgVQUs+a+hNNefVlttJfPpg3wS86X8GzmxP5hFRLYFsBMW5bh2GB17Bg9CvksXjlpqoIbeU78Jua2F3EvizXDBSVZ4xy44WjkubEfjkwjfqW0PHM4e6IHdeNkEkBq+io3HU8BR271itANmDh2/uA+cT27WtexNU3efsSFRL/mpHoHdjJybt+UXJKmtLQ7RlGenymGh2b2MyXVNPRBEH5LJl4wwI6/GXl9RNdVfVhPsnKx3uy4ajd7HcGbiuuPh15kNq2oOd+PstoSeCpyli4b/E3HfexHPBMD371Hr1NrN7ZmvZ4XRWG0H6SiJTe3if9Fibxx4LjvhbHr7QCUvhd4747lVVkWNH00LYGnpt3COPDTeHB2ZeBQoWgqz9BzvyaofWXGcBBGty/d+F+rZW86CeGMqPbOfafXs6JTOHrY3OQe1peo2cOO5tHxdesHwdIT5g== + eJzFXOtTGzkS/85foaW4s9kYyO6Hqy0ScusYE7wxxoUNuRxJuYRHxrPMq2bGEHY3//t16zUvzQvYOn8Ijkf961ar1Wq1WvP238E62No6+PHHLfIj6YfUu/WP35Pp6ZQsHZt58SFZ+p7HlrHte8QP8E8ETbH1rwFd3tFbRogmHHAa/pBu4rUfwjPyG/XILGbMpZ7HHy394DG0b9cxGehvP7/+6eceiUMbAL2IfHBvTnvw2PFvPdYjH1gI1I9AfbC15VGXRcCb5di+0f2Y2W7gMJQ8prbHQugLjSKyAnmKvdmX3Zmv7Ug2pE7kkyD0722LRSReM2KxFd04MbmnzoYJJPw5QUMECUioZ5EH23FIwEJo6RJKIiERkNsWFdxXiODuv70J3yHxKE440jCkj4QulwyEiX1ixxFxmXvDwki3l3/rByKyvSU+IuT1/s9cg6KTAy37uZSby+gCXUS+9FGEPpdg688tpOa6xQ+qCrq+CUNomtgEf6Ra/HpPQ9EN+csB/xuE9j2NGdlZSEUekeuvMG4GfNuz2Df4F7qPmmaeFfg2iiaUE69pTB6Y0LMcBlRV10e+WjxH8VdtmAWtdvfFaAseHOIGOS5DRiNoYXtkCV/EECugBEFBRiy8B+OKmeNEZMMNBTgDLiWWvVoxrh+HUYuF++STlBUaecIcNKLCk1312IOk6hFq/b6JYtu7hSdK4H0yWmHXLd/rxOTO8x9yZApPqScOH2WLb7ESehX6Lv/RsaMYjTFR8MaLbQeJV8BOtMnAgobX9J7hZOXaBOqYeSYDsL24ZPilVoeS6YgPxBF5XbQFYZzUIWfMXdLlmg9PFFM0apyGidz4FDRlEkTTlomDD4G/t3GcoghKShJBl2EohNnA4KEY2R7yH8n5dD46nyyGk+Pp+WgyB+COErNThD/1gQSdmhmfdC0WhGwJklo9MLNkLnBFwNDslotwej7j7NfAw8B66ofAeoOe5SW5Ts8vONcA4A1c57bL/I10po21OR+dDc8vOW4sAAAaW+XhJ6I/YNPC1iNpqWpWw4MVtR3/PjFpG9ty//G6J2YorFkbz7FdGz0Gdf2NF6cRlc/gyOUyn/RH4/Or4cVifjEazlB0xXkOhFFJB87otxRL7CzpgvARA2wr2hW+D7xBFKCDeaA2dxCwpuS6VSlQok0tktZqYcBCXG1XG08snI1H7KI/GPLxQnoD7jZwtVfgB1kY2ysbjS3abgwP3RidfF4MhsLYBNaAhWV2YeBG1mruPYntYtI/G2Z5TwDL1FPqOOCnI+as9iIbYhqrOcP+eHz+aTEbjk8Ws9GHyfAYOXK8GcDNOFpZl5f0xHZadG7QX5yMxrxPgtTQl6UdrHEOcBHECgAzYSMXztlsXAE/mp4OL/hEkCgG/KG3Ru8OwGg2Ve71tD8ZDI8TO2OScl5mbwNY4GMM2xxHhD4RTn2Y8I9yNWXfYDlsoa6LYX8utMWRBxrYwP0ysJB5yO7tCKdRPfzF8Go0gy/IAMjKMQPfsZePjcW+nB6D2OCmx6PBZ+Gokb4c/46xYLIRkVYz7I/D4XRyOR4juqI24F+wwEHf0rIDF8PpGMa8SQ+OmcPaa+h4OB4209AncL88EIkevWVj/E/90Xwx+zwZIDZ68BM/nAGAgcEYF6HGwOPR2Yi7Q752GeBmd3bQGG32cTRFsAiIDFjvabxcQzD7R/NV/H1/Pjidjf7LJ80N0s+A/MX0+tv55cWkP14oDr/7mxCCxxflMZrByM3mwzNkYEezRwiH3JdEvzof9+fSC9vRle/AjtHoifsbjFViXMrQoYALDvliVrGWXM5PF5ez4QViI/kl0NQjB7BhfPDDikiHA0/7s9mnYwU9RSKrHjx+DOoknn+eDhXsHJobQAeprXgZ1uB8MhkO5tKjJhRGx6Q2lSuH3pZDXgwlKCJqotK5Ug3GJwcC8cZlIAEN66TiQNO+CIw40ZQaQ/FjGtMbDIqr8cCl99/3Z3wMLEliWi3mJ3u/kMEpW96Rk0rAwelw8HEB7X/BQTk5v+CTabAGyst49QsMDSZOZFSjPsVAAXe2OMNcvTdUAXox95DhfzY8G/RBiGOIqy6uZEiiUWYCpCSoMrHVqZ+mbMUPWbYyD9OCbbL5vWON2Kot6QwW6M8Z5mqTG31kjy0kCEBPEDKBIMSucA+JBFNQ9gi852S+GB1nJJgqqHhUFs+aJBB79zh2mnCfz8cZnvPYqWXl+XK7wIM2iHpv6PKunNnkfM73BxC2v+8PPiI7jvA4kKSmRRk2nzLFGIndtjIomRO0yM2jzMjy9KJMJPIUlStRFNiv4CCoK/NkOwpoD1Yg2ChSpyxjF69D/4Fn/tIpxC/iz/DbkgUF5xpsbiAqSjaGiwXXRLhZxt0se5Es+FNP5x1MZ+29S9KAvPnCZeEt6+Iu6fDwlsXHUiXd3V6ClPgE/QVi+K4dwQ6+m8W9Fki5dMzXXfLPfybE+PnBjhZcgoYAu6muFLtTQoXJzoYtvyad/L6VV5rjU+UqTkLfHaAhd1Nqkc2UiahH3wtW9wGsDmyyzCBCFkPwJO1oL92SUExym/K7OYOAMew7Tjc/+hI5q4syKXFuZEyeYuJjiVNSytMjsOayKKJywqZz12Yjz5tzburIPNyOv1phWmhPZOf8leSXa+3a32B+kh2RzoLW4gtK4huZyO7f+zmPmdeeYD9DsxZfe5JJ9Wy6lq3R4ET7J9gGX4rJw5phUhsHW3RFbJCjFho3a9So0LyCbnzfAXWCP2E4xXMSrKiDfhLle7Aj1kCTQ06plFlilEY/ojRaqq4L5vr3LKWntMX+n+zzifZ26UWJxeWVtPHqtdPKzrgPev6ENq9SL6I2Mb3VrNate+o4B/inrNOOMF7AbHIDVX8oVzQuaT+IRRFCuwXLmG4vN+ML65GQCk+EcorpdkYeHxQlb4fsK4XsGhcdo6/WQ141rKnTs+TwIPYxvClRtRygvcKJC1AlZ3x1K84ge7bU3SU53cK+lIVxt+2a/6ZGJ2a6a9XKdOSl9Yf/5nX4STpfEYLigRw/dnMhIrLxMDkJ/k3qqXGmGs0PMYhEx+WxzDA1VDiinEmR9B7i79P5Eo9FmoZ578hPZQbatyzwOzhD0n02HogqEpEpTp2DYQo8ZNTCtKIm7RE7Fq4BB+0G1gQLw3d6S20dOGD4RCII6/fYagU67onTXRfG25elA65v4VmF0WqqvZuWby8rLnQPRHnq2gCkekJpFoVR5l4LxljIkm7411/kBwVweGhHV+iEUg2ae7AoAOx41d22pSfTPVSriNipdf4RdbZ7JMUi7d/Ut0RdRySRz/NDF7D/YCkJU4ubfmyZqfBEF9eWDPXLTYWdFUwCZM1DoOR3WCoZbAZIM0S0wh1YW8jROxVW5sYARzPT16Oa3gqUPAwXucIJYpgKcrwpEql+otMqPr6B3t5lf/5uGOGMcSrII6m8vKwHB3mvoBylWNUZOFKGem6//bvm8bjCfWMEKFFPK6e3p5yeUEM+JItikF5uH0deZvP4vaDi9KcY8nLPoQtLtMbKS0u08835P+H+tK+JHuwYxOLrWnY06uKGgjCVPg1b/o1Rgh5rzG80ok45iR1RlXG+GqZApB1o3LRXqTKhV6/eZGdBlbm9OzIwL0t4lNfxmCww5WtT2qmLkLKiF/UCq3yJeBW2nhNNRXTZ6Vke15bUAzbMpPC/MDEUiqnEMm23sk4pimFly8a6SYbMvJu9zqjFaHUk94Hl4Jp87ZUT8poiwwcIsX6qgpLXBZkpZUeuuD4PD4+HJ/3L8ZxTVADm6msaAGYpGkHLSpkW0IKiAjyH2UDueszSFPs70qE8p2vd7AXrYC+AnUCnEZA6pNDCVRtG6TFDXgI99ZuJgUn7jI7+9fp1BaEsymihXEFRAZktmGgCmaGoQM5VMjRAzlJUQGdrGJpAZygqhZZ1KUUN13iApO6h6dhoigrUpKigrTyZeoFG8qQpKoCTIoGCSDzwrCbVFQDNZEpRVM2L5PS7IW5CUeXLePVV8VOv/FwBVxsdpWv/mvUlRdEMVxT3tcHlFBXgxUK+OvACRdXwytK99uOgqvIMlGWGISiq+qoLTdpKk64keQIlLxVp2g9NUensVIVHAbXOSkU9R/HTlJRXcLQm1cUaRdLOIhLVSlXWUCzNqNFikaICPn88nu6YCmy7Oy5m/29xe55sSkuTzamdaLQJsOgcE278/pH9R1Jj1Cwsh73nuhFMbWw+UyCqaqk8Su+8p5G97LTrYWrX8OTulWA071tSRFXTw4HjR6zTI52PjAV7fce+Z+X9vUqVN9TUK5hPfjKJTeh89qyGYg175hhEXkXAndzGM98S0d1PDrUM2c/6MgTcPokShHSmtJagxREPL2qP1v7GsXgCWuZHOuatbzOpcSOWSG3XpKNE6xYiozGlRcYBitktC0uEPjggS+qJeyk2PyXRuQW8ngQKOEDIpwxN/nCtaQ1IRe/cDd4y8FWG+pHc+DAL+TDhObG+G/ScAcqYVfNSGEMCdBPchtRiiRZ5Hs7L5dTkp3nlSydeBocHB/zAsa4f0KZzWNeSG1m6VAY/xgNqg6JMZwEZjT+3JAgU6dI79NfigI1nkqnzQB8jkVBWBTSGDGlr3T6hqqjQ6WfnO1/6+KHh8SpgfC07vBG4tWPd9lDRMNYPeGmseKiKaW7vNnVY28NG3B9IW9jIe6ahLjhOVyOYVVG4ulsMVr8Wjk2y3lNXUxVm9Q4Lkny16Tg9m0s2nuoFf+d5XrBr9pM7GMFkLAGkx6iEC5TPgPO2mQMt3AcsLiej/5imMo4YFo0of/ia53yxNbF8l+L1PH95x1rMYOG+srlywiC0r5RvNhs3Fw8apyK8FxAtwxnlDEJ2u3CxwLy7fXDY/WK92t05EKME//AHJs94q0SVd0/5kVEyRaADuFqC6CucHha7Z44f8HuXOM2sjRvoi74JaCqWtVhMbad9h7v8rFrIff1TZmmpPVqsX3X1blOt0550tRk562RNUHoFOl05a9p79LhDyNDs6v+1iGZgiS3ZHokChmeFMUnK6VlKSsE00VJhF/NCuiqyls6u8AA/22nNpqxZbE6E/zMSNtREgXY320HjsIkbgFN+/e3wUO99qlhmct/pUOsJWNls9zPBMvntVDFnfvuJFdY8Muf16IbjOeGw/OKrCcRlBHxrhcKyU1VwYPx4Vbtsp14swslvPc2l3/mT6x31OoNkEdenpfoQNLscSooj8QqEvIEL+SrDqOxhN4fjjCvHo+TA6Gt+sWZ1x9B1EXKCkN0tvESg30aOJ0TqWX1/30r+zVstP+3mseSGT43kVpIsTyuz1yebo/F8vWCNTyiD0LRtqyBKSgTeHhWD9qJRp+Nj/lYVfG+Kb9CrPPWXak3pkDScfBlxnz/3hFzCvhqWVaRNDEPF7o7NAz4Cf98a9P6GvHq1YxsrxGzyw9FRZUWIccoIobNVUSC0XWH7qVA/dpJwrZGHmc/HacOSHqouHCnzUD0lf4/Looe0mMociVtXeEcaVxSVlC1cYFMvtekRvXLoovLt/M3Ebf76D1ZWD5XM773C1cjk7TmAjxG2fbsJ0VeE3PzwV4i9q+e9waZNlaDaJCoNXPrg5iMhb2yaPbHUgHiRj9mONFP+HixVWt/RSuvIuyVt8bMrk7qIWu3zir2qXKAkqFGyBjX/xWuyWKK3n0286qSUbJMO500d1e9OAs5ftBK7TWpTdoudZW4QP3ZTAYSw+DHI2d01r72yLbXU7Ej0VGUCBdZtbFBWxpREA2rdbTr2Cq1Y45obf3UH0sS1tQ0oKatsQLbJ20BRm+mRADXKoKBruLUpaI1hnF46+RfDRc+EZ+4KRorg+xagi6kNHaZR15At4497pPNFvXBQ3Xq9+VJojX3/H1oIFM8= - + diff --git a/lib/ArangoDBClient/Document.php b/lib/ArangoDBClient/Document.php index c70fbd97..0e7384fd 100644 --- a/lib/ArangoDBClient/Document.php +++ b/lib/ArangoDBClient/Document.php @@ -31,7 +31,7 @@ class Document implements \JsonSerializable /** * The document key (might be NULL for new documents) * - * @var string - document id + * @var string - document key */ protected $_key; diff --git a/lib/ArangoDBClient/Urls.php b/lib/ArangoDBClient/Urls.php index c1d77375..fd639f37 100644 --- a/lib/ArangoDBClient/Urls.php +++ b/lib/ArangoDBClient/Urls.php @@ -37,6 +37,11 @@ abstract class Urls * URL base part for all graph-related REST calls */ const URL_GRAPH = '/_api/gharial'; + + /** + * URL base part for all view-related REST calls + */ + const URL_VIEW = '/_api/view'; /** * URL part vertex-related graph REST calls diff --git a/lib/ArangoDBClient/View.php b/lib/ArangoDBClient/View.php new file mode 100644 index 00000000..159051f3 --- /dev/null +++ b/lib/ArangoDBClient/View.php @@ -0,0 +1,127 @@ + + * + * @package ArangoDBClient + * @since 3.4 + */ +class View +{ + /** + * The view id (might be NULL for new views) + * + * @var string - view id + */ + protected $_id; + + /** + * The view name + * + * @var string - view name + */ + protected $_name; + + /** + * View id index + */ + const ENTRY_ID = 'id'; + + /** + * View name index + */ + const ENTRY_NAME = 'name'; + + /** + * View type index + */ + const ENTRY_TYPE = 'type'; + + /** + * Constructs an empty view + * + * @param array $name - name for view + * @param string $type - view type + * + * @since 3.4 + * + * @throws \ArangoDBClient\ClientException + */ + public function __construct($name, $type) + { + $this->_name = $name; + $this->_type = $type; + } + + /** + * Return the view id + * + * @return string - view id + */ + public function getId() + { + return $this->_id; + } + + /** + * Set the view's id + * + * @param string - view id + * + * @return void + */ + public function setId($id) + { + $this->_id = $id; + } + + /** + * Return the view name + * + * @return string - view name + */ + public function getName() + { + return $this->_name; + } + + /** + * Return the view type + * + * @return string - view type + */ + public function getType() + { + return $this->_type; + } + + /** + * Return the view as an array + * + * @return array - view data as an array + */ + public function getAll() + { + return [ + self::ENTRY_ID => $this->getId(), + self::ENTRY_NAME => $this->getName(), + self::ENTRY_TYPE => $this->getType(), + ]; + } +} + +class_alias(View::class, '\triagens\ArangoDb\View'); diff --git a/lib/ArangoDBClient/ViewHandler.php b/lib/ArangoDBClient/ViewHandler.php new file mode 100644 index 00000000..330573b8 --- /dev/null +++ b/lib/ArangoDBClient/ViewHandler.php @@ -0,0 +1,173 @@ +
        + * + * @throws Exception + * + * @param View $view - The view object which holds the information of the view to be created + * + * @return array + * @since 3.4 + */ + public function create(View $view) + { + $params = [ + View::ENTRY_NAME => $view->getName(), + View::ENTRY_TYPE => $view->getType(), + ]; + $url = Urls::URL_VIEW; + $response = $this->getConnection()->post($url, $this->json_encode_wrapper($params)); + $json = $response->getJson(); + $view->setId($json[View::ENTRY_ID]); + + return $view->getAll(); + } + + /** + * Get a view + * + * This will get a view.

        + * + * @param String $view - The name of the view + * + * @return View|false + * @throws \ArangoDBClient\ClientException + * @since 3.4 + */ + public function get($view) + { + $url = UrlHelper::buildUrl(Urls::URL_VIEW, [$view]); + + $response = $this->getConnection()->get($url); + $data = $response->getJson(); + + $result = new View($data[View::ENTRY_NAME], $data[View::ENTRY_TYPE]); + $result->setId($data[View::ENTRY_ID]); + + return $result; + } + + /** + * Get a view's properties

        + * + * @throws Exception + * + * @param mixed $view - view name as a string or instance of View + * + * @return array - Returns an array of attributes. Will throw if there is an error + * @since 3.4 + */ + public function properties($view) + { + if ($view instanceof View) { + $view = $view->getName(); + } + + $url = UrlHelper::buildUrl(Urls::URL_VIEW, [$view, 'properties']); + $result = $this->getConnection()->get($url); + + return $result->getJson(); + } + + /** + * Set a view's properties

        + * + * @throws Exception + * + * @param mixed $view - view name as a string or instance of View + * @param array $properties - array with view properties + * + * @return array - Returns an array of attributes. Will throw if there is an error + * @since 3.4 + */ + public function setProperties($view, array $properties) + { + if ($view instanceof View) { + $view = $view->getName(); + } + + $url = UrlHelper::buildUrl(Urls::URL_VIEW, [$view, 'properties']); + $response = $this->getConnection()->put($url, $this->json_encode_wrapper($properties)); + $json = $response->getJson(); + + return $json; + } + + + /** + * Drop a view

        + * + * @throws Exception + * + * @param mixed $view - view name as a string or instance of View + * + * @return bool - always true, will throw if there is an error + * @since 3.4 + */ + public function drop($view) + { + if ($view instanceof View) { + $view = $view->getName(); + } + + $url = UrlHelper::buildUrl(Urls::URL_VIEW, [$view]); + $this->getConnection()->delete($url); + + return true; + } + + /** + * Rename a view + * + * @throws Exception + * + * @param mixed $view - view name as a string or instance of View + * @param string $name - new name for collection + * + * @return bool - always true, will throw if there is an error + */ + public function rename($view, $name) + { + if ($view instanceof View) { + $view = $view->getName(); + } + + $params = [View::ENTRY_NAME => $name]; + $this->getConnection()->put( + UrlHelper::buildUrl(Urls::URL_VIEW, [$view, self::OPTION_RENAME]), + $this->json_encode_wrapper($params) + ); + + return true; + } +} + +class_alias(ViewHandler::class, '\triagens\ArangoDb\ViewHandler'); diff --git a/tests/DocumentBasicTest.php b/tests/DocumentBasicTest.php index deab404a..b921bea5 100644 --- a/tests/DocumentBasicTest.php +++ b/tests/DocumentBasicTest.php @@ -181,7 +181,7 @@ public function testCreateAndDeleteDocumentWithoutCreatedCollection() try { $this->collectionHandler->drop('ArangoDB_PHP_TestSuite_TestCollection_01' . '_' . static::$testsTimestamp); } catch (\Exception $e) { - #don't bother us, if it's already deleted. + // don't bother us, if it's already deleted. } $document->someAttribute = 'someValue'; diff --git a/tests/QueryCacheTest.php b/tests/QueryCacheTest.php index 196f03b9..d8d7fd36 100644 --- a/tests/QueryCacheTest.php +++ b/tests/QueryCacheTest.php @@ -109,6 +109,11 @@ public function testClear() */ public function testGetEntries() { + if (isCluster($this->connection)) { + // don't execute this test in a cluster + $this->markTestSkipped("test is only meaningful in single server"); + return; + } $this->setupCollection(); $this->cacheHandler->enable(); diff --git a/tests/StatementTest.php b/tests/StatementTest.php index ba89df28..58875b35 100644 --- a/tests/StatementTest.php +++ b/tests/StatementTest.php @@ -13,6 +13,7 @@ function filtered(array $values) { unset($values['executionTime']); unset($values['httpRequests']); + unset($values['peakMemoryUsage']); return $values; } diff --git a/tests/ViewTest.php b/tests/ViewTest.php new file mode 100644 index 00000000..5e56d0df --- /dev/null +++ b/tests/ViewTest.php @@ -0,0 +1,191 @@ +connection = getConnection(); + $this->viewHandler = new ViewHandler($this->connection); + } + + /** + * Test creation of view + */ + public function testCreateViewObject() + { + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + static::assertNull($this->view->getId()); + static::assertEquals('View1' . '_' . static::$testsTimestamp, $this->view->getName()); + static::assertEquals('arangosearch', $this->view->getType()); + } + + /** + * Test creation of view + */ + public function testCreateView() + { + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $result = $this->viewHandler->create($this->view); + static::assertEquals('View1' . '_' . static::$testsTimestamp, $result['name']); + static::assertEquals('arangosearch', $result['type']); + } + + /** + * Test getting a view + */ + public function testGetView() + { + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $this->viewHandler->create($this->view); + + $result = $this->viewHandler->get('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + static::assertEquals('View1' . '_' . static::$testsTimestamp, $result->getName()); + static::assertEquals('arangosearch', $result->getType()); + } + + /** + * Test getting a non-existing view + */ + public function testGetNonExistingView() + { + try { + $this->viewHandler->get('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + } catch (\Exception $exception) { + } + static::assertEquals(404, $exception->getCode()); + } + + /** + * Test view properties + */ + public function testViewProperties() + { + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $result = $this->viewHandler->create($this->view); + static::assertEquals('View1' . '_' . static::$testsTimestamp, $result['name']); + static::assertEquals('arangosearch', $result['type']); + + $result = $this->viewHandler->properties($this->view); + static::assertEquals([], $result['links']); + } + + + /** + * Test set view properties + */ + public function testViewSetProperties() + { + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $result = $this->viewHandler->create($this->view); + static::assertEquals('View1' . '_' . static::$testsTimestamp, $result['name']); + static::assertEquals('arangosearch', $result['type']); + + $properties = [ + 'links' => [ + '_graphs' => [ 'includeAllFields' => true ] + ] + ]; + $result = $this->viewHandler->setProperties($this->view, $properties); + static::assertEquals('arangosearch', $result['type']); + static::assertTrue($result['links']['_graphs']['includeAllFields']); + static::assertEquals([], $result['links']['_graphs']['fields']); + } + + /** + * Test drop view + */ + public function testDropView() + { + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $this->viewHandler->create($this->view); + $result = $this->viewHandler->drop('View1' . '_' . static::$testsTimestamp); + static::assertTrue($result); + } + + /** + * Test drop non-existing view + */ + public function testDropNonExistingView() + { + try { + $this->viewHandler->drop('View1' . '_' . static::$testsTimestamp); + } catch (\Exception $exception) { + } + static::assertEquals(404, $exception->getCode()); + } + + /** + * Test rename view + */ + public function testRenameView() + { + if (isCluster($this->connection)) { + // don't execute this test in a cluster + $this->markTestSkipped("test is only meaningful in a single server"); + return; + } + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $this->viewHandler->create($this->view); + $result = $this->viewHandler->rename('View1' . '_' . static::$testsTimestamp, 'View2' . '_' . static::$testsTimestamp); + static::assertTrue($result); + } + + /** + * Test rename a non-existing view + */ + public function testRenameNonExistingView() + { + if (isCluster($this->connection)) { + // don't execute this test in a cluster + $this->markTestSkipped("test is only meaningful in a single server"); + return; + } + $this->view = new View('View1' . '_' . static::$testsTimestamp, 'arangosearch'); + $this->viewHandler->create($this->view); + try { + $this->viewHandler->rename('View2' . '_' . static::$testsTimestamp, 'View1' . '_' . static::$testsTimestamp); + } catch (\Exception $exception) { + } + static::assertEquals(404, $exception->getCode()); + } + + public function tearDown() + { + $this->viewHandler = new ViewHandler($this->connection); + try { + $this->viewHandler->drop('View1' . '_' . static::$testsTimestamp); + } catch (Exception $e) { + } + try { + $this->viewHandler->drop('View2' . '_' . static::$testsTimestamp); + } catch (Exception $e) { + } + } +} diff --git a/tests/travis/setup_arangodb.sh b/tests/travis/setup_arangodb.sh index ebd460c4..ecab6f8f 100644 --- a/tests/travis/setup_arangodb.sh +++ b/tests/travis/setup_arangodb.sh @@ -36,7 +36,7 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" cd $DIR docker pull arangodb/arangodb-preview:devel -docker run -d -e ARANGO_ROOT_PASSWORD="test" -p 8529:8529 arangodb/arangodb-preview:devel +docker run -d -e ARANGO_ROOT_PASSWORD="test" -p 8529:8529 arangodb/arangodb:3.4.1 sleep 2