diff --git a/README.md b/README.md index 4d4826b3..c026e0f4 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ ##### Table of Contents - [Description](#description) +- [Requirements](#requirements) - [Installing the PHP client](#installing) - [Using packagist/composer](#using_packagist) - [Cloning the git repository](#cloning_git) @@ -25,7 +26,7 @@ - [Deleting a document](#deleting_document) - [Dropping a collection](#dropping_collection) - [Putting it all together](#alltogether) -- [Requirements](#requirements) + - [More information](#more_info)
@@ -54,6 +55,19 @@ The client library provides document and collection classes you can use to work
+ + + +# Requirements + +* ArangoDB database server version 1.3 (detailed info [here](https://github.com/triAGENS/ArangoDB-PHP/wiki/Important-versioning-information-on-ArangoDB-PHP#arangodb-php-client-to-arangodb-server-interoperability-matrix)) + +* PHP version 5.3 or higher (Travis-tested with 5.4 and 5.5) + +
+ + +
## Installing the PHP client @@ -559,14 +573,6 @@ Here's the full code that combines all the pieces outlined above:
-
-# Requirements - -* ArangoDB database server version 1.2 (detailed info [here](https://github.com/triAGENS/ArangoDB-PHP/wiki/Important-versioning-information-on-ArangoDB-PHP#arangodb-php-client-to-arangodb-server-interoperability-matrix)) - -* PHP version 5.3 or higher (Travis-tested with 5.4 and 5.5) - - # More information diff --git a/docs/classes/triagens.ArangoDb.AdminHandler.html b/docs/classes/triagens.ArangoDb.AdminHandler.html index 7c846547..71e6a7dc 100644 --- a/docs/classes/triagens.ArangoDb.AdminHandler.html +++ b/docs/classes/triagens.ArangoDb.AdminHandler.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -68,7 +67,6 @@ Returns the statistics information.">Get the server statistics Returns the statistics information.
    getServerStatistics()
  • Returns a description of the statistics returned by getServerStatistics().
    getServerStatisticsDescription()
  • -
  • Get the server status
    getServerStatus()
  • Get the server time
    getServerTime()
  • Get the server version
    getServerVersion()
  • package -ArangoDbPhpClient +triagens\ArangoDb since @@ -134,7 +132,7 @@

     Methods

    Construct a new handler

    -
    __construct(\triagens\ArangoDb\Connection $connection) : void
    +
    __construct(\triagens\ArangoDb\Connection $connection) : \triagens\ArangoDb\Handler
    Inherited
    @@ -149,6 +147,8 @@

    $connection

  • connection to be used
  • +

    Returns

    +
    \triagens\ArangoDb\Handler
    @@ -187,11 +187,11 @@

    Parameters

    $options

    array

    Options are :
    -

  • 'upto' - returns all log entries upto a log-level. Note that log-level must be one of:
  • +
  • 'upto' - returns all log entries up to a log-level. Note that log-level must be one of:
  • fatal / 0
  • error / 1
  • @@ -298,33 +298,6 @@

    Returns

    array
    -
    -

    Get the server status

    -
    getServerStatus() : array
    -
    -
    -

    This will throw if the status cannot be retrieved

    - - - -
    since1.2
    -

    Exceptions

    - - - -
    \triagens\ArangoDb\Exception
    -

    Returns

    -
    -array- The call returns an array with the attributes described here: http://www.arangodb.org/manuals/1.2.beta3/HttpSystem.html#HttpSystemStatus -['system']['userTime'] -['system']['systemTime'] -['system']['numberOfThreads'] -['system']['residentSize'] -['system']['virtualSize'] -['system']['minorPageFaults'] -['system']['majorPageFaults']
    -
    -

    Get the server time

    getServerTime() : double
    @@ -431,7 +404,7 @@

    Returns

    Return an array of cursor options

    -
    getCursorOptions(bool $options) : array
    +
    getCursorOptions(mixed $options) : array
    Inherited
    @@ -442,7 +415,7 @@

    Return an array of cursor options

    Parameters

    $options

    -bool
      +mixed
      • $options might be a boolean sanitize value, or an array of options, with or without a '_sanitize' key.
    @@ -614,7 +587,7 @@

    details for server version

    + generated on 2013-05-11T17:21:44+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.AqlUserFunction.html b/docs/classes/triagens.ArangoDb.AqlUserFunction.html index 7a9f3a90..638bf4b0 100644 --- a/docs/classes/triagens.ArangoDb.AqlUserFunction.html +++ b/docs/classes/triagens.ArangoDb.AqlUserFunction.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -81,12 +80,16 @@

     Properties

    + 
    +

    +
     : mixed
    +
    +
    +
    + + + + + + + + + +
    magic
    property_action
    +
    +
     

    $code : string
    @@ -447,6 +468,12 @@

    + 
    +

    +
    $_action : string
    +
    +
    +
     

    $attributes : array
    @@ -480,7 +507,7 @@

    Collections index

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.Autoloader.html b/docs/classes/triagens.ArangoDb.Autoloader.html index ba1f8152..4f849e0e 100644 --- a/docs/classes/triagens.ArangoDb.Autoloader.html +++ b/docs/classes/triagens.ArangoDb.Autoloader.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -100,7 +99,7 @@ process classes from its own namespace and ignore all others.

    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    @@ -171,7 +170,7 @@

    Class file extension

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.Batch.html b/docs/classes/triagens.ArangoDb.Batch.html index b1f9ad55..5715a43e 100644 --- a/docs/classes/triagens.ArangoDb.Batch.html +++ b/docs/classes/triagens.ArangoDb.Batch.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -61,25 +60,25 @@ @@ -91,11 +90,10 @@ @@ -110,7 +109,7 @@
    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    @@ -140,6 +139,11 @@

    Get the batch part identified by the array key (0.

    ..n) or its id (if it was set with nextBatchPartId($id) )

    +

    Exceptions

    + + + +
    \triagens\ArangoDb\ClientException

    Returns

    mixed$partId
    @@ -157,12 +161,12 @@

    Returns

    Gets the response for he current batch part.

    -
    getResponse() : \triagens\ArangoDb\Batch
    +
    getResponse() : \triagens\ArangoDb\HttpResponse
    @@ -265,7 +269,7 @@

     Properties

     

    -
    $_batch : array
    +
    $_batch : \triagens\ArangoDb\Batch
    @@ -306,7 +310,7 @@

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.BindVars.html b/docs/classes/triagens.ArangoDb.BindVars.html index dff0c0f9..928618c8 100644 --- a/docs/classes/triagens.ArangoDb.BindVars.html +++ b/docs/classes/triagens.ArangoDb.BindVars.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -94,7 +93,7 @@
    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    @@ -107,7 +106,9 @@

    Get the value of a bind variable with a specific name

    Parameters

    $name

    -string

    name - name of bind variable

    +string

    Returns

    @@ -149,11 +150,15 @@

    Set the value of a single bind variable or set all bind variables at onceParameters

    $name

    -mixed

    name - name of bind variable OR an array with all bind variables

    +mixed

    $value

    -string

    value - value for bind variable

    +string

    Exceptions

    @@ -177,7 +182,7 @@

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.ClientException.html b/docs/classes/triagens.ArangoDb.ClientException.html index ffcfbda1..7686829e 100644 --- a/docs/classes/triagens.ArangoDb.ClientException.html +++ b/docs/classes/triagens.ArangoDb.ClientException.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -80,7 +79,7 @@

    something the server is not involved in.

    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    @@ -102,7 +101,7 @@

    Returns

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.Collection.html b/docs/classes/triagens.ArangoDb.Collection.html index c05a199b..1b608c95 100644 --- a/docs/classes/triagens.ArangoDb.Collection.html +++ b/docs/classes/triagens.ArangoDb.Collection.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -110,7 +109,7 @@ @@ -142,7 +141,7 @@
  • geo index option
    OPTION_GEO_INDEX
  • hash index option
    OPTION_HASH_INDEX
  • ignoreNull option
    OPTION_IGNORE_NULL
  • -
  • latidude parameter
    OPTION_LATITUDE
  • +
  • latitude parameter
    OPTION_LATITUDE
  • left parameter
    OPTION_LEFT
  • limit parameter
    OPTION_LIMIT
  • load option
    OPTION_LOAD
  • @@ -185,13 +184,13 @@ appropriate HTTP requests to the server.

    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    Construct a new handler

    -
    __construct(\triagens\ArangoDb\Connection $connection) : void
    +
    __construct(\triagens\ArangoDb\Connection $connection) : \triagens\ArangoDb\Handler
    Inherited
    @@ -206,6 +205,8 @@

    $connection

  • connection to be used
  • +

    Returns

    +
    @@ -296,7 +297,7 @@

    $options

  • 'hiddenAttributes' - Deprecated, please use '_hiddenAttributes'.
  • This is actually the same as setting hidden attributes using setHiddenAttributes() on a document.
    - The difference is, that if you're returning a resultset of documents, the getall() is already called
    + The difference is, that if you're returning a resultset of documents, the getAll() is already called
    and the hidden attributes would not be applied to the attributes.

    @@ -685,7 +686,7 @@

    $options

  • 'hiddenAttributes' - Deprecated, please use '_hiddenAttributes'.
  • This is actually the same as setting hidden attributes using setHiddenAttributes() on a document.
    - The difference is, that if you're returning a resultset of documents, the getall() is already called
    + The difference is, that if you're returning a resultset of documents, the getAll() is already called
    and the hidden attributes would not be applied to the attributes.

    @@ -740,7 +741,7 @@

    $options

    Options are :

  • 'excludeSystem' - With a value of true, all system collections will be excluded from the response.
  • 'keys' - With a value of "collections", the index of the resulting array is numerical, - With a value of "names", the index of the resulting array are the collection names.
  • + With a value of "names", the index of the resulting array are the collection names.

    Returns

    @@ -1083,7 +1084,7 @@

    Returns

    Load a collection into the server's memory

    -
    load(mixed $collection) : bool
    +
    load(mixed $collection) : \triagens\ArangoDb\HttpResponse

    This will load the given collection into the server's memory.

    @@ -1101,7 +1102,7 @@

    Exceptions

    Returns

    -bool- always true, will throw if there is an error
    +\triagens\ArangoDb\HttpResponse- HTTP response object
    @@ -1142,7 +1143,7 @@

    $options

  • 'hiddenAttributes' - Deprecated, please use '_hiddenAttributes'.
  • This is actually the same as setting hidden attributes using setHiddenAttributes() on a document.
    - The difference is, that if you're returning a resultset of documents, the getall() is already called
    + The difference is, that if you're returning a resultset of documents, the getAll() is already called
    and the hidden attributes would not be applied to the attributes.

  • 'distance' - If given, the attribute key used to store the distance. (optional) @@ -1206,7 +1207,7 @@

    $options

  • 'hiddenAttributes' - Deprecated, please use '_hiddenAttributes'.
  • This is actually the same as setting hidden attributes using setHiddenAttributes() on a document.
    - The difference is, that if you're returning a resultset of documents, the getall() is already called
    + The difference is, that if you're returning a resultset of documents, the getAll() is already called
    and the hidden attributes would not be applied to the attributes.

  • 'closed' - If true, use interval including left and right, otherwise exclude right, but include left. @@ -1381,7 +1382,7 @@

    Returns

  • Unload a collection from the server's memory

    -
    unload(mixed $collection) : bool
    +
    unload(mixed $collection) : \triagens\ArangoDb\HttpResponse

    This will unload the given collection from the server's memory.

    @@ -1399,7 +1400,7 @@

    Exceptions

    Returns

    -bool- always true, will throw if there is an error
    +\triagens\ArangoDb\HttpResponse- HTTP response object
    @@ -1499,7 +1500,7 @@

    $options

  • 'hiddenAttributes' - Deprecated, please use '_hiddenAttributes'.
  • This is actually the same as setting hidden attributes using setHiddenAttributes() on a document.
    - The difference is, that if you're returning a resultset of documents, the getall() is already called
    + The difference is, that if you're returning a resultset of documents, the getAll() is already called
    and the hidden attributes would not be applied to the attributes.

  • 'distance' - If given, the attribute key used to store the distance. (optional) @@ -1558,7 +1559,7 @@

    Returns

  • Return an array of cursor options

    -
    getCursorOptions(bool $options) : array
    +
    getCursorOptions(mixed $options) : array
    Inherited
    @@ -1569,7 +1570,7 @@

    Return an array of cursor options

    Parameters

    $options

    -bool
      +mixed
      • $options might be a boolean sanitize value, or an array of options, with or without a '_sanitize' key.
    @@ -1837,7 +1838,7 @@

    ignoreNull option

     
    -

    latidude parameter

    +

    latitude parameter

    OPTION_LATITUDE 
    @@ -1951,7 +1952,7 @@

    unload option

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.ConnectException.html b/docs/classes/triagens.ArangoDb.ConnectException.html index c8d95614..7bb2ae49 100644 --- a/docs/classes/triagens.ArangoDb.ConnectException.html +++ b/docs/classes/triagens.ArangoDb.ConnectException.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -80,7 +79,7 @@
    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    @@ -102,7 +101,7 @@

    Returns

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.Connection.html b/docs/classes/triagens.ArangoDb.Connection.html index b3c3d1b6..b1c4a4d4 100644 --- a/docs/classes/triagens.ArangoDb.Connection.html +++ b/docs/classes/triagens.ArangoDb.Connection.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -72,13 +71,14 @@
  • Get the client version
    getClientVersion()
  • Get an option set for the connection
    getOption()
  • Get the client version (alias for getClientVersion)
    getVersion()
  • +
  • Returns true if this connection is in Batch-Capture mode
    isInBatchCaptureMode()
  • This is a json_encode() wrapper that also checks if the data is utf-8 conform.
    json_encode_wrapper()
  • Parse the response return the body values as an assoc array
    parseResponse()
  • Issue an HTTP PATCH request with the data provided
    patch()
  • Issue an HTTP POST request with the data provided
    post()
  • Issue an HTTP PUT request with the data provided
    put()
  • Sets the active Batch for this connection
    setActiveBatch()
  • -
  • Sets connection into Batchrequest mode.
    setBatchRequest()
  • +
  • Sets connection into Batch-request mode.
    setBatchRequest()
  • Sets the batch capture state (true, if capturing)
    setCaptureBatch()
  • Stop capturing commands
    stopCaptureBatch()
  • @@ -97,7 +97,7 @@ @@ -113,7 +112,7 @@
  • Skip index constant
    OPTION_SKIP
  • Timeout value index constant
    OPTION_TIMEOUT
  • Trace function index constant
    OPTION_TRACE
  • -
  • Update keepnull constant
    OPTION_UPDATE_KEEPNULL
  • +
  • Update keepNull constant
    OPTION_UPDATE_KEEPNULL
  • Update policy index constant
    OPTION_UPDATE_POLICY
  • Wait for sync index constant
    OPTION_WAIT_SYNC
  • @@ -141,13 +140,13 @@ It provides array access to its members.

    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    Set defaults, use options provided by client and validate them

    -
    __construct(array $options) : void
    +
    __construct(array $options) : \triagens\ArangoDb\ConnectionOptions
    @@ -158,11 +157,8 @@

    $options

  • initial options
  • -

    Exceptions

    - - - -
    \triagens\ArangoDb\ClientException
    +

    Returns

    +
    @@ -484,7 +480,7 @@

    Trace function index constant

     
    -

    Update keepnull constant

    +

    Update keepNull constant

    OPTION_UPDATE_KEEPNULL 
    @@ -508,7 +504,7 @@

    Wait for sync index constant

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.Cursor.html b/docs/classes/triagens.ArangoDb.Cursor.html index 92a08a90..0d4cca9b 100644 --- a/docs/classes/triagens.ArangoDb.Cursor.html +++ b/docs/classes/triagens.ArangoDb.Cursor.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -133,13 +132,13 @@ remaining results from the server.

    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    Initialise the cursor with the first results and some metadata

    -
    __construct(\triagens\ArangoDb\Connection $connection, array $data, array $options) : void
    +
    __construct(\triagens\ArangoDb\Connection $connection, array $data, array $options) : \triagens\ArangoDb\Cursor
    @@ -162,6 +161,8 @@

    $options

  • cursor options
  • +

    Returns

    +
    @@ -472,7 +473,7 @@

    sanitize option entry

    + generated on 2013-05-11T17:21:44+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.DefaultValues.html b/docs/classes/triagens.ArangoDb.DefaultValues.html index d9cfd66e..4bf1b8d5 100644 --- a/docs/classes/triagens.ArangoDb.DefaultValues.html +++ b/docs/classes/triagens.ArangoDb.DefaultValues.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -91,7 +90,7 @@
    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Constants

    @@ -168,7 +167,7 @@

    Default value for waitForSync (fsync all data to disk on document updates/in
    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.Document.html b/docs/classes/triagens.ArangoDb.Document.html index 4bf42ee2..4b139150 100644 --- a/docs/classes/triagens.ArangoDb.Document.html +++ b/docs/classes/triagens.ArangoDb.Document.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -107,7 +106,7 @@ @@ -138,13 +137,13 @@ appropriate HTTP requests to the server.

    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    Construct a new handler

    -
    __construct(\triagens\ArangoDb\Connection $connection) : void
    +
    __construct(\triagens\ArangoDb\Connection $connection) : \triagens\ArangoDb\Handler
    Inherited
    @@ -159,6 +158,8 @@

    $connection

  • connection to be used
  • +

    Returns

    +
    @@ -400,7 +401,7 @@

    $options

  • 'hiddenAttributes' - Deprecated, please use '_hiddenAttributes'.
  • This is actually the same as setting hidden attributes using setHiddenAttributes() on a document.
    - The difference is, that if you're returning a resultset of documents, the getall() is already called
    + The difference is, that if you're returning a resultset of documents, the getAll() is already called
    and the hidden attributes would not be applied to the attributes.

    @@ -550,7 +551,7 @@

    Replace an existing document in a collection, identified by the document its

    This will throw if the document cannot be updated

    -

    If policy is set to error (locally or globally through the connectionoptions) +

    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.

    Parameters

    @@ -590,7 +591,7 @@

    Replace an existing document in a collection, identified by collection id an

    This will throw if the document cannot be Replaced

    -

    If policy is set to error (locally or globally through the connectionoptions) +

    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.

    Parameters

    @@ -737,7 +738,7 @@

    Update an existing document in a collection, identified by the including _id

    This will throw if the document cannot be updated

    -

    If policy is set to error (locally or globally through the connectionoptions) +

    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.

    Parameters

    @@ -779,7 +780,7 @@

    Update an existing document in a collection, identified by collection id and

    This will throw if the document cannot be updated

    -

    If policy is set to error (locally or globally through the connectionoptions) +

    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.

    Parameters

    @@ -875,7 +876,7 @@

    Returns

    Return an array of cursor options

    -
    getCursorOptions(bool $options) : array
    +
    getCursorOptions(mixed $options) : array
    Inherited
    @@ -886,7 +887,7 @@

    Return an array of cursor options

    Parameters

    $options

    -bool
      +mixed
      • $options might be a boolean sanitize value, or an array of options, with or without a '_sanitize' key.
    @@ -1139,7 +1140,7 @@

    example parameter

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.Edge.html b/docs/classes/triagens.ArangoDb.Edge.html index 7b4b2e0c..e908167b 100644 --- a/docs/classes/triagens.ArangoDb.Edge.html +++ b/docs/classes/triagens.ArangoDb.Edge.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -114,7 +113,7 @@  Constants

    Constructs an empty document

    -
    __construct(array $options) : void
    +
    __construct(array $options) : \triagens\ArangoDb\Document
    Inherited
    @@ -173,6 +172,8 @@

    $options

  • optional, initial $options for document
  • +

    Returns

    +
    @@ -399,7 +400,7 @@

    Convenience function to get the document handle (if already known) - is an a
    Inherited

    Document handles are generated on the server only. Document handles consist of collection id and -document id, in the format collectionid/documentid

    +document id, in the format collectionId/documentId

    @@ -446,7 +447,7 @@

    Get the internal document id (if already known)

    Inherited

    Document ids are generated on the server only. Document ids consist of collection id and -document id, in the format collectionid/documentid

    +document id, in the format collectionId/documentId

    inherited_from \triagens\ArangoDb\Document::getHandle()
    @@ -558,7 +559,7 @@

    Exceptions

    Set the changed flag

    -
    setChanged(bool $value) : void
    +
    setChanged(bool $value) : bool
    Inherited
    @@ -573,6 +574,8 @@

    $value

  • change flag
  • +

    Returns

    +
    bool
    @@ -880,7 +883,7 @@

    Document _from index

     
    -

    hidden atttribute index

    +

    hidden attribute index

    ENTRY_HIDDEN 
    Inherited
    @@ -988,7 +991,7 @@

    waitForSync option index

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.EdgeHandler.html b/docs/classes/triagens.ArangoDb.EdgeHandler.html index f79f1b51..8119dc16 100644 --- a/docs/classes/triagens.ArangoDb.EdgeHandler.html +++ b/docs/classes/triagens.ArangoDb.EdgeHandler.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -144,13 +143,13 @@ appropriate HTTP requests to the server.

    inherited_from \triagens\ArangoDb\Document::getInternalId()
    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    Construct a new handler

    -
    __construct(\triagens\ArangoDb\Connection $connection) : void
    +
    __construct(\triagens\ArangoDb\Connection $connection) : \triagens\ArangoDb\Handler
    Inherited
    @@ -171,11 +170,13 @@

    $connection

  • connection to be used
  • +

    Returns

    +

    Intermediate function to call the createFromArray function from the right context

    -
    createFromArrayWithContext($data, $options) : \triagens\ArangoDb\Document
    +
    createFromArrayWithContext($data, $options) : \triagens\ArangoDb\Edge
    @@ -183,7 +184,7 @@

    Parameters

    $data

    $options

    Returns

    - +
    @@ -422,7 +423,7 @@

    $options

  • 'hiddenAttributes' - Deprecated, please use '_hiddenAttributes'.
  • This is actually the same as setting hidden attributes using setHiddenAttributes() on a document.
    - The difference is, that if you're returning a resultset of documents, the getall() is already called
    + The difference is, that if you're returning a resultset of documents, the getAll() is already called
    and the hidden attributes would not be applied to the attributes.

    @@ -642,7 +643,7 @@

    Replace an existing document in a collection, identified by the document its

    This will throw if the document cannot be updated

    -

    If policy is set to error (locally or globally through the connectionoptions) +

    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.

    @@ -686,7 +687,7 @@

    Replace an existing document in a collection, identified by collection id an

    This will throw if the document cannot be Replaced

    -

    If policy is set to error (locally or globally through the connectionoptions) +

    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.

    @@ -856,7 +857,7 @@

    Update an existing document in a collection, identified by the including _id

    This will throw if the document cannot be updated

    -

    If policy is set to error (locally or globally through the connectionoptions) +

    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.

    @@ -902,7 +903,7 @@

    Update an existing document in a collection, identified by collection id and

    This will throw if the document cannot be updated

    -

    If policy is set to error (locally or globally through the connectionoptions) +

    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.

    @@ -1001,7 +1002,7 @@

    Returns

    Return an array of cursor options

    -
    getCursorOptions(bool $options) : array
    +
    getCursorOptions(mixed $options) : array
    Inherited
    @@ -1018,7 +1019,7 @@

    Return an array of cursor options

    Parameters

    $options

    -bool
      +mixed
      • $options might be a boolean sanitize value, or an array of options, with or without a '_sanitize' key.
    @@ -1335,7 +1336,7 @@

    vertex parameter

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.Endpoint.html b/docs/classes/triagens.ArangoDb.Endpoint.html index 219c3c60..a31de69b 100644 --- a/docs/classes/triagens.ArangoDb.Endpoint.html +++ b/docs/classes/triagens.ArangoDb.Endpoint.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -111,13 +110,13 @@

    Note: SSL support is added in ArangoDB server 1.1

    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    Create a new endpoint

    -
    __construct(string $value) : void
    +
    __construct(string $value) : \triagens\ArangoDb\Endpoint
    @@ -133,6 +132,8 @@

    Exceptions

    \triagens\ArangoDb\ClientException +

    Returns

    +
    @@ -253,7 +254,7 @@

    UNIX socket endpoint type

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.Exception.html b/docs/classes/triagens.ArangoDb.Exception.html index 75e8ffdf..6104cc40 100644 --- a/docs/classes/triagens.ArangoDb.Exception.html +++ b/docs/classes/triagens.ArangoDb.Exception.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -76,7 +75,7 @@
    - +
    packageArangoDbPhpClienttriagens\ArangoDb
    @@ -85,7 +84,7 @@
    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.Graph.html b/docs/classes/triagens.ArangoDb.Graph.html index c586e421..7ffaaabf 100644 --- a/docs/classes/triagens.ArangoDb.Graph.html +++ b/docs/classes/triagens.ArangoDb.Graph.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -114,7 +113,7 @@  Constants +

    Returns

    +
    \triagens\ArangoDb\Handler
    @@ -151,14 +152,14 @@

    Returns

    Return an array of cursor options

    -
    getCursorOptions(bool $options) : array
    +
    getCursorOptions(mixed $options) : array

    Parameters

    $options

    -bool
      +mixed
      • $options might be a boolean sanitize value, or an array of options, with or without a '_sanitize' key.
    @@ -300,7 +301,7 @@

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.HttpHelper.html b/docs/classes/triagens.ArangoDb.HttpHelper.html index 56a6e5a0..bfc46c70 100644 --- a/docs/classes/triagens.ArangoDb.HttpHelper.html +++ b/docs/classes/triagens.ArangoDb.HttpHelper.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -103,7 +102,7 @@
    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    @@ -221,6 +220,11 @@

    $request

  • complete HTTP request as a string
  • +

    Exceptions

    + + + +
    \triagens\ArangoDb\ClientException

    Returns

    string- HTTP response string as provided by the server
    @@ -318,7 +322,7 @@

    HTTP protocol version used, hard-coded to version 1.1

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.HttpResponse.html b/docs/classes/triagens.ArangoDb.HttpResponse.html index 8bd9943d..c5429a1d 100644 --- a/docs/classes/triagens.ArangoDb.HttpResponse.html +++ b/docs/classes/triagens.ArangoDb.HttpResponse.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -82,7 +81,7 @@
  • $_header
  • $_headers
  • $_httpCode
  • -
  • $_result
  • +
  • $_result
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -112,13 +111,13 @@
    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    Initialise the scope

    -
    __construct(callable $initFunc, callable $exitFunc) : void
    +
    __construct(callable $initFunc, callable $exitFunc) : \triagens\ArangoDb\Scope
    @@ -135,6 +134,8 @@

    $exitFunc

  • function to be called when scope if left
  • +

    Returns

    +
    @@ -224,7 +225,7 @@

    Scope has not been entered

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.ServerException.html b/docs/classes/triagens.ArangoDb.ServerException.html index 14686dc1..8c15139c 100644 --- a/docs/classes/triagens.ArangoDb.ServerException.html +++ b/docs/classes/triagens.ArangoDb.ServerException.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -105,7 +104,7 @@ getDetails() function.

    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    @@ -207,7 +206,7 @@

    Error message index

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.Statement.html b/docs/classes/triagens.ArangoDb.Statement.html index 53c52580..30808861 100644 --- a/docs/classes/triagens.ArangoDb.Statement.html +++ b/docs/classes/triagens.ArangoDb.Statement.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -90,7 +89,7 @@ @@ -233,7 +232,7 @@

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.TraceResponse.html b/docs/classes/triagens.ArangoDb.TraceResponse.html index d09957ce..66b590fb 100644 --- a/docs/classes/triagens.ArangoDb.TraceResponse.html +++ b/docs/classes/triagens.ArangoDb.TraceResponse.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -232,7 +231,7 @@

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.Transaction.html b/docs/classes/triagens.ArangoDb.Transaction.html index 40ea474b..ac796ce3 100644 --- a/docs/classes/triagens.ArangoDb.Transaction.html +++ b/docs/classes/triagens.ArangoDb.Transaction.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -169,7 +168,7 @@ $this->setReadCollections($array or $string if single collection)

    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    @@ -682,7 +681,7 @@

    WRITE index

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.UpdatePolicy.html b/docs/classes/triagens.ArangoDb.UpdatePolicy.html index c4c6ba37..098d47e7 100644 --- a/docs/classes/triagens.ArangoDb.UpdatePolicy.html +++ b/docs/classes/triagens.ArangoDb.UpdatePolicy.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -88,7 +87,7 @@
    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Methods

    @@ -133,7 +132,7 @@

    last update will win in case of conflicting versions

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.UrlHelper.html b/docs/classes/triagens.ArangoDb.UrlHelper.html index 3072774f..4283de14 100644 --- a/docs/classes/triagens.ArangoDb.UrlHelper.html +++ b/docs/classes/triagens.ArangoDb.UrlHelper.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -59,7 +58,7 @@  Methods @@ -67,7 +66,6 @@
  • base URL part for admin routing reload
    URL_ADMIN_ROUTING_RELOAD
  • base URL part for admin statistics
    URL_ADMIN_STATISTICS
  • base URL part for admin statistics-description
    URL_ADMIN_STATISTICS_DESCRIPTION
  • -
  • base URL part for admin status
    URL_ADMIN_STATUS
  • base URL part for admin time
    URL_ADMIN_TIME
  • base URL part for admin version
    URL_ADMIN_VERSION
  • base URL part for any
    URL_ANY
  • @@ -114,7 +112,7 @@
    - +
    packageArangoDbPhpClienttriagens\ArangoDb

     Constants

    @@ -172,12 +170,6 @@

    base URL part for admin statistics-description

    - 
    -

    base URL part for admin status

    -
    URL_ADMIN_STATUS 
    -
    -
    -
     

    base URL part for admin time

    URL_ADMIN_TIME 
    @@ -329,7 +321,7 @@

    base URL part for select-range

    + generated on 2013-05-11T17:21:44+03:00.
    diff --git a/docs/classes/triagens.ArangoDb.User.html b/docs/classes/triagens.ArangoDb.User.html index abdc4ecf..61007670 100644 --- a/docs/classes/triagens.ArangoDb.User.html +++ b/docs/classes/triagens.ArangoDb.User.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -107,7 +106,7 @@ @@ -110,7 +109,7 @@
    + generated on 2013-05-11T17:21:44+03:00.
    diff --git a/docs/graph_class.html b/docs/graph_class.html index 227c6b8d..d92b0870 100644 --- a/docs/graph_class.html +++ b/docs/graph_class.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -65,7 +64,7 @@
    + generated on 2013-05-11T17:21:44+03:00.
    diff --git a/docs/index.html b/docs/index.html index 23993c98..5f8fc389 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -62,7 +61,6 @@

    Documentation

    @@ -86,7 +84,7 @@

    Documentation

    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/markers.html b/docs/markers.html index 94fecf29..ea109aba 100644 --- a/docs/markers.html +++ b/docs/markers.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -70,7 +69,7 @@
    + generated on 2013-05-11T17:21:44+03:00.
    diff --git a/docs/namespaces/triagens.ArangoDb.html b/docs/namespaces/triagens.ArangoDb.html index 8698bd6d..1e03b22c 100644 --- a/docs/namespaces/triagens.ArangoDb.html +++ b/docs/namespaces/triagens.ArangoDb.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -372,7 +371,7 @@

    VertexHandler + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/namespaces/triagens.html b/docs/namespaces/triagens.html index e8c23a09..78b75d96 100644 --- a/docs/namespaces/triagens.html +++ b/docs/namespaces/triagens.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -383,7 +382,7 @@

    VertexHandler + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/packages/Default.html b/docs/packages/Default.html index 1ca397df..8675a631 100644 --- a/docs/packages/Default.html +++ b/docs/packages/Default.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -68,7 +67,7 @@
    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/packages/triagens.ArangoDb.html b/docs/packages/triagens.ArangoDb.html index 682b4ba8..a07da28c 100644 --- a/docs/packages/triagens.ArangoDb.html +++ b/docs/packages/triagens.ArangoDb.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -63,9 +62,62 @@ +
  • ValueValidator
  • +
  • Batch
  • AqlUserFunction
  • +
  • Vertex
  • +
  • Exception
  • +
  • BindVars
  • +
  • Scope
  • +
  • ConnectionOptions
  • +
  • Statement
  • +
  • DocumentHandler
  • +
  • UserHandler
  • +
  • Connection
  • TraceRequest
  • +
  • DefaultValues
  • +
  • ConnectException
  • +
  • ClientException
  • +
  • ServerException
  • +
  • Graph
  • +
  • HttpResponse
  • +
  • BatchPart
  • +
  • UpdatePolicy
  • +
  • CollectionHandler
  • +
  • Endpoint
  • +
  • Collection
  • +
  • HttpHelper
  • +
  • VertexHandler
  • +
  • Transaction
  • +
  • Document
  • +
  • UrlHelper
  • +
  • Handler
  • +
  • Edge
  • +
  • EdgeHandler
  • +
  • Autoloader
  • TraceResponse
  • +
  • User
  • +
  • Urls
  • +
  • AdminHandler
  • +
  • Cursor
  • +
  • GraphHandler
  • @@ -78,6 +130,13 @@

    Classes and interfaces

    +
    +

    AdminHandler +

    +

    An admin handler that utilizes the ArangoDB's Admin API.

    +
    +« More » +

    AqlUserFunction

    @@ -85,6 +144,201 @@

    AqlUserFunction
    « More »

    +
    +

    Autoloader +

    +

    Handles automatic loading of missing class files +The autoloader can be nested with other autoloaders.

    +
    +« More » +
    +
    +

    Batch +

    +

    Provides batching functionality

    +
    +« More » +
    +
    +

    BatchPart +

    +

    Provides batch part functionality

    +
    +« More » +
    +
    +

    BindVars +

    +

    A simple container for bind variables +This container also handles validation of the bind values.

    +
    +« More » +
    +
    +

    ClientException +

    +

    This exception type will be thrown by the client when there is an error +on the client side, i.e.

    +
    +« More » +
    +
    +

    Collection +

    +

    Value object representing a collection

    +
    +« More » +
    +
    +

    CollectionHandler +

    +

    A collection handler that fetches collection data from the server and +creates collections on the server.

    +
    +« More » +
    +
    +

    ConnectException +

    +

    This exception type will be thrown by the client when there is an error +during connecting to the server

    +
    +« More » +
    +
    +

    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.

    +
    +« More » +
    +
    +

    ConnectionOptions +

    +

    Simple container class for connection options.

    +
    +« More » +
    +
    +

    Cursor +

    +

    Provides access to the results of a read-only statement

    +
    +« More » +
    +
    +

    DefaultValues +

    +

    Contains default values used by the client

    +
    +« More » +
    +
    +

    Document +

    +

    Value object representing a single collection-based document

    +
    +« More » +
    +
    +

    DocumentHandler +

    +

    A document handler that fetches documents from the server and +persists them on the server.

    +
    +« More » +
    +
    +

    Edge +

    +

    Value object representing a single collection-based document

    +
    +« More » +
    +
    +

    EdgeHandler +

    +

    An edge-document handler that fetches edges from the server and +persists them on the server.

    +
    +« More » +
    +
    +

    Endpoint +

    +

    Endpoint specification

    +
    +« More » +
    +
    +

    Exception +

    +

    Exception base class used to throw Arango specific exceptions

    +
    +« More » +
    +
    +

    Graph +

    +

    Value object representing a graph

    +
    +« More » +
    +
    +

    GraphHandler +

    +

    A graph handler that manages graphs.

    +
    +« More » +
    +
    +

    Handler +

    +

    A base class for REST-based handlers

    +
    +« More » +
    +
    +

    HttpHelper +

    +

    Helper methods for HTTP request/response handling

    +
    +« More » +
    +
    +

    HttpResponse +

    +

    Container class for HTTP responses

    +
    +« More » +
    +
    +

    Scope +

    +

    Executes a function on scope entry and executes another function +(cleanup) when the scope is exited

    +
    +« More » +
    +
    +

    ServerException +

    +

    This exception type will be thrown by the client when the server returns an +error in response to a client request.

    +
    +« More » +
    +
    +

    Statement +

    +

    Container for a read-only ("select") statement +A statement is an AQL query that can be issued to the +server.

    +
    +« More » +

    TraceRequest

    @@ -99,13 +353,80 @@

    TraceResponse

    « More »
    +
    +

    Transaction +

    +

    Transaction object +A transaction is an object that is used to prepare and send a transaction +to the server.

    +
    +« More » +
    +
    +

    UpdatePolicy +

    +

    Document update policies

    +
    +« More » +
    +
    +

    UrlHelper +

    +

    Some helper methods to construct and process URLs

    +
    +« More » +
    +
    +

    Urls +

    +

    Some basic URLs

    +
    +« More » +
    +
    +

    User +

    +

    Value object representing a single User document

    +
    +« More » +
    +
    +

    UserHandler +

    +

    A user-document handler that fetches vertices from the server and +persists them on the server.

    +
    +« More » +
    +
    +

    ValueValidator +

    +

    A simple validator for values to be stored in the database

    +
    +« More » +
    +
    +

    Vertex +

    +

    Value object representing a single vertex document

    +
    +« More » +
    +
    +

    VertexHandler +

    +

    A vertex-document handler that fetches vertices from the server and +persists them on the server.

    +
    +« More » +
    + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/packages/triagens.html b/docs/packages/triagens.html index 06c6d457..f10f94f8 100644 --- a/docs/packages/triagens.html +++ b/docs/packages/triagens.html @@ -22,7 +22,6 @@
  • Namespaces
  •  triagens
  • Packages
  • -
  •  ArangoDbPhpClient
  •  triagens
  • @@ -79,6 +78,13 @@

    Classes and interfaces

    +
    +

    AdminHandler +

    +

    An admin handler that utilizes the ArangoDB's Admin API.

    +
    +« More » +

    AqlUserFunction

    @@ -86,6 +92,201 @@

    AqlUserFunction
    « More »

    +
    +

    Autoloader +

    +

    Handles automatic loading of missing class files +The autoloader can be nested with other autoloaders.

    +
    +« More » +
    +
    +

    Batch +

    +

    Provides batching functionality

    +
    +« More » +
    +
    +

    BatchPart +

    +

    Provides batch part functionality

    +
    +« More » +
    +
    +

    BindVars +

    +

    A simple container for bind variables +This container also handles validation of the bind values.

    +
    +« More » +
    +
    +

    ClientException +

    +

    This exception type will be thrown by the client when there is an error +on the client side, i.e.

    +
    +« More » +
    +
    +

    Collection +

    +

    Value object representing a collection

    +
    +« More » +
    +
    +

    CollectionHandler +

    +

    A collection handler that fetches collection data from the server and +creates collections on the server.

    +
    +« More » +
    +
    +

    ConnectException +

    +

    This exception type will be thrown by the client when there is an error +during connecting to the server

    +
    +« More » +
    +
    +

    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.

    +
    +« More » +
    +
    +

    ConnectionOptions +

    +

    Simple container class for connection options.

    +
    +« More » +
    +
    +

    Cursor +

    +

    Provides access to the results of a read-only statement

    +
    +« More » +
    +
    +

    DefaultValues +

    +

    Contains default values used by the client

    +
    +« More » +
    +
    +

    Document +

    +

    Value object representing a single collection-based document

    +
    +« More » +
    +
    +

    DocumentHandler +

    +

    A document handler that fetches documents from the server and +persists them on the server.

    +
    +« More » +
    +
    +

    Edge +

    +

    Value object representing a single collection-based document

    +
    +« More » +
    +
    +

    EdgeHandler +

    +

    An edge-document handler that fetches edges from the server and +persists them on the server.

    +
    +« More » +
    +
    +

    Endpoint +

    +

    Endpoint specification

    +
    +« More » +
    +
    +

    Exception +

    +

    Exception base class used to throw Arango specific exceptions

    +
    +« More » +
    +
    +

    Graph +

    +

    Value object representing a graph

    +
    +« More » +
    +
    +

    GraphHandler +

    +

    A graph handler that manages graphs.

    +
    +« More » +
    +
    +

    Handler +

    +

    A base class for REST-based handlers

    +
    +« More » +
    +
    +

    HttpHelper +

    +

    Helper methods for HTTP request/response handling

    +
    +« More » +
    +
    +

    HttpResponse +

    +

    Container class for HTTP responses

    +
    +« More » +
    +
    +

    Scope +

    +

    Executes a function on scope entry and executes another function +(cleanup) when the scope is exited

    +
    +« More » +
    +
    +

    ServerException +

    +

    This exception type will be thrown by the client when the server returns an +error in response to a client request.

    +
    +« More » +
    +
    +

    Statement +

    +

    Container for a read-only ("select") statement +A statement is an AQL query that can be issued to the +server.

    +
    +« More » +

    TraceRequest

    @@ -100,6 +301,73 @@

    TraceResponse

    « More »
    +
    +

    Transaction +

    +

    Transaction object +A transaction is an object that is used to prepare and send a transaction +to the server.

    +
    +« More » +
    +
    +

    UpdatePolicy +

    +

    Document update policies

    +
    +« More » +
    +
    +

    UrlHelper +

    +

    Some helper methods to construct and process URLs

    +
    +« More » +
    +
    +

    Urls +

    +

    Some basic URLs

    +
    +« More » +
    +
    +

    User +

    +

    Value object representing a single User document

    +
    +« More » +
    +
    +

    UserHandler +

    +

    A user-document handler that fetches vertices from the server and +persists them on the server.

    +
    +« More » +
    +
    +

    ValueValidator +

    +

    A simple validator for values to be stored in the database

    +
    +« More » +
    +
    +

    Vertex +

    +

    Value object representing a single vertex document

    +
    +« More » +
    +
    +

    VertexHandler +

    +

    A vertex-document handler that fetches vertices from the server and +persists them on the server.

    +
    +« More » +
    @@ -107,7 +375,7 @@

    TraceResponse + generated on 2013-05-11T17:21:43+03:00.
    diff --git a/docs/structure.xml b/docs/structure.xml index 77db0c7b..d817f0d5 100644 --- a/docs/structure.xml +++ b/docs/structure.xml @@ -1,32 +1,32 @@ - + ArangoDB PHP client: value validator - + - + ValueValidator \triagens\ArangoDb\ValueValidator A simple validator for values to be stored in the database - + - + validate validate Validate the value of a variable - <p>Allowed value types are string, integer, double and booleans. Arrays are also allowed if they contain only one of the former types.</p> + <p>Allowed value types are string, integer, double and boolean. Arrays are also allowed if they contain only one of the former types.</p> \triagens\ArangoDb\ClientException - + mixed @@ -41,523 +41,525 @@ - + ArangoDB PHP client: batch - + - + Batch \triagens\ArangoDb\Batch Provides batching functionality - - + + - + + $_batchResponse + + + Batch Response Object + + + \triagens\ArangoDb\HttpResponse + + + + $_processed false - + Flag that signals if this batch was processed or not. <p>Processed => true ,or not processed => false</p> - + boolean - + $_batchParts array() - + The array of BatchPart objects - + array - + $_nextBatchPartId null - + The array of BatchPart objects - + array - + $_batchPartCursorOptions array() - + An array of BatchPartCursor options - + array - + $_connection null - + The connection object - - object - - - - - $_alphaKeys - 0 - - The $_alphaKeys object for the batchpart creation - - - object + + \triagens\ArangoDb\Connection - + $_sanitize false - + The sanitize default value - + object - + __construct __construct - + Constructor for Batch instance. <p>Batch instance by default starts capturing request after initiated. To disable this, pass startCapture=>false inside the options array parameter</p> - + \triagens\ArangoDb\Connection - - + + array + + \triagens\ArangoDb\Batch - + $connection \triagens\ArangoDb\Connection - + $options array() - + setConnection setConnection - + Sets the connection for he current batch. <p>(mostly internal function)</p> - + \triagens\ArangoDb\Connection - + \triagens\ArangoDb\Batch - + $connection - + startCapture startCapture - - Start capuring requests. + + Start capturing requests. <p>To stop capturing, use stopCapture()</p> <p>see triagens\ArangoDb\Batch::stopCapture()</p> - + array - + \triagens\ArangoDb\Batch - + $options array() - + stopCapture stopCapture - + Stop capturing requests. <p>If the batch has not been processed yet, more requests can be appended by calling startCapture() again.</p> <p>see Batch::startCapture()</p> - - array + + \triagens\ArangoDb\ClientException - + \triagens\ArangoDb\Batch - - $options - array() - - - + isActive isActive - + Returns true, if this batch is active in its associated connection. - + bool - + isCapturing isCapturing - + Returns true, if this batch is capturing requests. - + bool - + activate activate - + Activates the batch. - <p>This sets the batch active in its assiated connection and also starts capturing.</p> - - array - - + <p>This sets the batch active in its associated connection and also starts capturing.</p> + object - - $options - array() - - - + setActive setActive - - Sets the batch active in its assiated connection. + + Sets the batch active in its associated connection. - - object - - + object - - $object - - - - + setCapture setCapture - - Sets the batch's assciated connection into capture mode. + + Sets the batch's associated connection into capture mode. - + boolean - + object - + $state - + getActive getActive - + Gets active batch in given connection. - + \triagens\ArangoDb\Connection + + $this + - + $connection - - getCapture - getCapture - - Returns true, if given connection is in batch mode. + + getConnectionCaptureMode + getConnectionCaptureMode + + Returns true, if given connection is in batch-capture mode. - + \triagens\ArangoDb\Connection + + bool + - + $connection - + setBatchRequest setBatchRequest - + Sets connection into Batch-Request mode. <p>This is necessary to distinguish between normal and the batch request.</p> - - \triagens\ArangoDb\Connection + + boolean + + + $this - + $state - + nextBatchPartId nextBatchPartId - - Sets the id of the next batchpart. - <p>The id can later be used to retrieve the batchpart.</p> - + + Sets the id of the next batch-part. + <p>The id can later be used to retrieve the batch-part.</p> + mixed - + \triagens\ArangoDb\Batch - + $batchPartId - + nextBatchPartCursorOptions nextBatchPartCursorOptions - + Set client side cursor options (for example: sanitize) for the next batch part. - + mixed - + \triagens\ArangoDb\Batch - + $batchPartCursorOptions - + append append - - Append the request to the batchpart + + Append the request to the batch-part - + mixed - + mixed - + \triagens\ArangoDb\HttpResponse - + $method - + $request - + splitWithContentIdKey splitWithContentIdKey - + Split batch request and use ContentId as array key - + mixed - + mixed - + array - + $pattern - + $string - + process process - + Processes this batch. <p>This sends the captured requests to the server as one batch.</p> - + + \triagens\ArangoDb\ClientException + + bool - + countParts countParts - + Get the total count of the batch parts - + integer - + getPart getPart - + Get the batch part identified by the array key (0. <p>..n) or its id (if it was set with nextBatchPartId($id) )</p> - - + + mixed + + + \triagens\ArangoDb\ClientException + + mixed - + $partId - + getPartResponse getPartResponse - + Get the batch part identified by the array key (0. <p>..n) or its id (if it was set with nextBatchPartId($id) )</p> - - + + mixed + + mixed - + $partId - + getProcessedPartResponse getProcessedPartResponse - + Get the batch part identified by the array key (0. <p>..n) or its id (if it was set with nextBatchPartId($id) )</p> - - + + mixed + + mixed - + $partId - + getBatchParts getBatchParts - - Returns the array of batchparts + + Returns the array of batch-parts - + array - + getCursorOptions getCursorOptions - + Return an array of cursor options - + array - + getConnection getConnection - + Return this batch's connection - + \triagens\ArangoDb\Connection - + ArangoDB PHP client: AqlUserFunction - + AqlUserFunction \triagens\ArangoDb\AqlUserFunction @@ -591,52 +593,66 @@ $this->code('function (){your code};');</p> string + + mixed + - + ENTRY_NAME ENTRY_NAME 'name' - + Collections index - + ENTRY_CODE ENTRY_CODE 'code' - + Action index - + $_connection null - + The connection object - + \triagens\ArangoDb\Connection - + $attributes array() - + The transaction's attributes. - + array - + + $_action + '' + + The transaction's action. + + + string + + + + __construct __construct - + Initialise the AqlUserFunction object <p>The $attributesArray array can be used to specify the name and code for the user function in form of an array.</p> @@ -645,120 +661,120 @@ array( 'name' => 'myFunctions:myFunction', 'code' => 'function (){}' )</p> - + \triagens\ArangoDb\Connection - + array - + \triagens\ArangoDb\AqlUserFunction - + $connection \triagens\ArangoDb\Connection - + $attributesArray null array - + register register - + Registers the user function <p>If no parameters ($name,$code) are passed, it will use the properties of the object.</p> <p>If $name and/or $code are passed, it will override the object's properties with the passed ones</p> - + null - + null - + \triagens\ArangoDb\Exception - + mixed - + $name null - + $code null - + unregister unregister - + Unregister the user function <p>If no parameter ($name) is passed, it will use the property of the object.</p> <p>If $name is passed, it will override the object's property with the passed one</p> - + null - + \triagens\ArangoDb\Exception - + mixed - + $name null - + getRegisteredUserFunctions getRegisteredUserFunctions - + Get registered user functions <p>The method can optionally be passed a $namespace parameter to narrow the results down to a specific namespace.</p> - + null - + \triagens\ArangoDb\Exception - + mixed - + $namespace null - + getConnection getConnection - + Return the connection object - + \triagens\ArangoDb\Connection - + setName setName - + Set name of the user function. <p>It must have at least one namespace, but also can have sub-namespaces. correct: @@ -767,166 +783,166 @@ correct: <p>wrong: 'myFunction'</p> - + string - + $value - + getName getName - + Get name value - + string - + setCode setCode - + Set user function code - + string - + $value - + getCode getCode - + Get user function code - + string - + set set - + Set an attribute - - - + + + \triagens\ArangoDb\ClientException - + $key - + $value - + __set __set - + Set an attribute, magic method <p>This is a magic method that allows the object to be used without declaring all attributes first.</p> - + \triagens\ArangoDb\ClientException - + string - + mixed - + void - + $key - + $value - + get get - + Get an attribute - + string - + mixed - + $key - + __get __get - + Get an attribute, magic method <p>This function is mapped to get() internally.</p> - + string - + mixed - + $key - + __toString __toString - + Returns the action string - + string - + buildAttributesFromArray buildAttributesFromArray - + Build the object's attributes from a given array - + - + $options @@ -934,56 +950,56 @@ declaring all attributes first.</p> - + ArangoDB PHP client: single vertex document - + - + \triagens\ArangoDb\Document Vertex \triagens\ArangoDb\Vertex Value object representing a single vertex document - + - + ArangoDB PHP client: exception base class - + - + \Exception Exception \triagens\ArangoDb\Exception Exception base class used to throw Arango specific exceptions - + - + ArangoDB PHP client: bind variables - + - + BindVars \triagens\ArangoDb\BindVars @@ -991,7 +1007,7 @@ declaring all attributes first.</p> A simple container for bind variables This container also handles validation of the bind values. - + $_values @@ -1004,7 +1020,7 @@ This container also handles validation of the bind values. - + getAll getAll @@ -1015,7 +1031,7 @@ This container also handles validation of the bind values. - + getCount getCount @@ -1026,13 +1042,13 @@ This container also handles validation of the bind values. - + get get Get the value of a bind variable with a specific name - + string @@ -1045,7 +1061,7 @@ This container also handles validation of the bind values. - + set set @@ -1058,10 +1074,10 @@ than these types.</p> \triagens\ArangoDb\ClientException - + mixed - + string @@ -1081,15 +1097,15 @@ than these types.</p> - + ArangoDB PHP client: scope - + - + Scope \triagens\ArangoDb\Scope @@ -1097,9 +1113,9 @@ than these types.</p> Executes a function on scope entry and executes another function (cleanup) when the scope is exited - + - + STATE_NONE STATE_NONE 0 @@ -1108,7 +1124,7 @@ than these types.</p> - + STATE_ENTERED STATE_ENTERED 1 @@ -1117,7 +1133,7 @@ than these types.</p> - + STATE_LEFT STATE_LEFT 2 @@ -1170,7 +1186,7 @@ than these types.</p> - + __construct __construct @@ -1182,8 +1198,8 @@ than these types.</p> callable - - void + + \triagens\ArangoDb\Scope @@ -1197,7 +1213,7 @@ than these types.</p> - + __destruct __destruct @@ -1208,7 +1224,7 @@ than these types.</p> - + leave leave @@ -1222,7 +1238,7 @@ duplicate execution of the exit func.</p> - + enter enter @@ -1233,7 +1249,7 @@ duplicate execution of the exit func.</p> - + __clone __clone @@ -1249,15 +1265,15 @@ duplicate execution of the exit func.</p> - + ArangoDB PHP client: connection options - + - + \ArrayAccess ConnectionOptions @@ -1267,9 +1283,9 @@ duplicate execution of the exit func.</p> <p>This class also provides the default values for the connection options and will perform a simple validation of them. It provides array access to its members.</p> - + - + OPTION_ENDPOINT OPTION_ENDPOINT 'endpoint' @@ -1278,7 +1294,7 @@ It provides array access to its members.</p> - + OPTION_HOST OPTION_HOST 'host' @@ -1287,7 +1303,7 @@ It provides array access to its members.</p> - + OPTION_PORT OPTION_PORT 'port' @@ -1296,7 +1312,7 @@ It provides array access to its members.</p> - + OPTION_TIMEOUT OPTION_TIMEOUT 'timeout' @@ -1305,7 +1321,7 @@ It provides array access to its members.</p> - + OPTION_TRACE OPTION_TRACE 'trace' @@ -1314,7 +1330,7 @@ It provides array access to its members.</p> - + OPTION_ENHANCED_TRACE OPTION_ENHANCED_TRACE 'enhancedTrace' @@ -1323,7 +1339,7 @@ It provides array access to its members.</p> - + OPTION_CREATE OPTION_CREATE 'createCollection' @@ -1332,7 +1348,7 @@ It provides array access to its members.</p> - + OPTION_REVISION OPTION_REVISION 'rev' @@ -1341,7 +1357,7 @@ It provides array access to its members.</p> - + OPTION_UPDATE_POLICY OPTION_UPDATE_POLICY 'policy' @@ -1350,16 +1366,16 @@ It provides array access to its members.</p> - + OPTION_UPDATE_KEEPNULL OPTION_UPDATE_KEEPNULL 'keepNull' - Update keepnull constant + Update keepNull constant - + OPTION_REPLACE_POLICY OPTION_REPLACE_POLICY 'policy' @@ -1368,7 +1384,7 @@ It provides array access to its members.</p> - + OPTION_DELETE_POLICY OPTION_DELETE_POLICY 'policy' @@ -1377,7 +1393,7 @@ It provides array access to its members.</p> - + OPTION_WAIT_SYNC OPTION_WAIT_SYNC 'waitForSync' @@ -1386,7 +1402,7 @@ It provides array access to its members.</p> - + OPTION_LIMIT OPTION_LIMIT 'limit' @@ -1395,7 +1411,7 @@ It provides array access to its members.</p> - + OPTION_SKIP OPTION_SKIP 'skip' @@ -1404,7 +1420,7 @@ It provides array access to its members.</p> - + OPTION_BATCHSIZE OPTION_BATCHSIZE 'batchSize' @@ -1413,7 +1429,7 @@ It provides array access to its members.</p> - + OPTION_JOURNAL_SIZE OPTION_JOURNAL_SIZE 'journalSize' @@ -1422,7 +1438,7 @@ It provides array access to its members.</p> - + OPTION_IS_SYSTEM OPTION_IS_SYSTEM 'isSystem' @@ -1431,7 +1447,7 @@ It provides array access to its members.</p> - + OPTION_IS_VOLATILE OPTION_IS_VOLATILE 'isVolatile' @@ -1440,7 +1456,7 @@ It provides array access to its members.</p> - + OPTION_AUTH_USER OPTION_AUTH_USER 'AuthUser' @@ -1449,7 +1465,7 @@ It provides array access to its members.</p> - + OPTION_AUTH_PASSWD OPTION_AUTH_PASSWD 'AuthPasswd' @@ -1458,7 +1474,7 @@ It provides array access to its members.</p> - + OPTION_AUTH_TYPE OPTION_AUTH_TYPE 'AuthType' @@ -1467,7 +1483,7 @@ It provides array access to its members.</p> - + OPTION_CONNECTION OPTION_CONNECTION 'Connection' @@ -1476,7 +1492,7 @@ It provides array access to its members.</p> - + OPTION_RECONNECT OPTION_RECONNECT 'Reconnect' @@ -1485,7 +1501,7 @@ It provides array access to its members.</p> - + OPTION_BATCH OPTION_BATCH 'Batch' @@ -1494,7 +1510,7 @@ It provides array access to its members.</p> - + OPTION_BATCHPART OPTION_BATCHPART 'BatchPart' @@ -1503,7 +1519,7 @@ It provides array access to its members.</p> - + OPTION_CHECK_UTF8_CONFORM OPTION_CHECK_UTF8_CONFORM 'CheckUtf8Conform' @@ -1534,204 +1550,201 @@ It provides array access to its members.</p> - + __construct __construct Set defaults, use options provided by client and validate them - - \triagens\ArangoDb\ClientException - array - - void + + \triagens\ArangoDb\ConnectionOptions - + $options array - + getAll getAll - + Get all options - + array - + offsetSet offsetSet - + Set and validate a specific option, necessary for ArrayAccess - + \triagens\ArangoDb\Exception - + string - + mixed - + void - + $offset - + $value - + offsetExists offsetExists - + Check whether an option exists, necessary for ArrayAccess - + string - + bool - + $offset - + offsetUnset offsetUnset - + Remove an option and validate, necessary for ArrayAccess - + \triagens\ArangoDb\Exception - + string - + void - + $offset - + offsetGet offsetGet - + Get a specific option, necessary for ArrayAccess - + \triagens\ArangoDb\ClientException - + string - + mixed - + $offset - + getEndpoint getEndpoint - + Get the endpoint object for the connection - + \triagens\ArangoDb\ClientException - + \triagens\ArangoDb\Endpoint - + getDefaults getDefaults - + Get the default values for the options - + array - + getSupportedAuthTypes getSupportedAuthTypes - + Return the supported authorization types - + array - + getSupportedConnectionTypes getSupportedConnectionTypes - + Return the supported connection types - + array - + validate validate - + Validate the options - + \triagens\ArangoDb\ClientException - + void - + ArangoDB PHP client: statement - + - + Statement \triagens\ArangoDb\Statement @@ -1762,9 +1775,9 @@ be done:<br /> a list of documents with a "value" attribute<br /> - use the "_flat" option for the statement to indicate that you don't want to treat the statement result as a list of documents, but as a flat list</p> - + - + ENTRY_QUERY ENTRY_QUERY 'query' @@ -1773,7 +1786,7 @@ be done:<br /> - + ENTRY_COUNT ENTRY_COUNT 'count' @@ -1782,7 +1795,7 @@ be done:<br /> - + ENTRY_BATCHSIZE ENTRY_BATCHSIZE 'batchSize' @@ -1791,7 +1804,7 @@ be done:<br /> - + ENTRY_BINDVARS ENTRY_BINDVARS 'bindVars' @@ -1826,7 +1839,7 @@ be done:<br /> $_batchSize null - The current batch size (number of result documents retrieved per roundtrip) + The current batch size (number of result documents retrieved per round-trip) mixed @@ -1877,7 +1890,7 @@ be done:<br /> - + __construct __construct @@ -1902,112 +1915,109 @@ option should be specified in $data.</p> array - - void - - + $connection \triagens\ArangoDb\Connection - + $data array - + getConnection getConnection - + Return the connection object - + \triagens\ArangoDb\Connection - + execute execute - + Execute the statement <p>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.</p> - + \triagens\ArangoDb\Exception - + \triagens\ArangoDb\Cursor - + explain explain - + Explain the statement's execution plan <p>This will post the query to the server and return the execution plan as an array.</p> - + \triagens\ArangoDb\Exception - + Array - + validate validate - + Validates the statement <p>This will post the query to the server for validation and return the validation result as an array.</p> - + \triagens\ArangoDb\Exception - + Array - + __invoke __invoke - + Invoke the statement <p>This will simply call execute(). Arguments are ignored.</p> - + \triagens\ArangoDb\Exception - + mixed - + \triagens\ArangoDb\Cursor - + $args - + __toString __toString - + Return a string representation of the statement - + string - + bind bind - + Bind a parameter to the statement <p>This method can either be called with a string $key and a separate value in $value, or with an array of all bind @@ -2016,176 +2026,176 @@ bind parameters in $key, with $value being NULL.</p> <p>Allowed value types for bind parameters are string, int, double, bool and array. Arrays must not contain any other than these types.</p> - + \triagens\ArangoDb\Exception - + mixed - + mixed - + void - + $key - + $value null - + getBindVars getBindVars - + Get all bind parameters as an array - + array - + setQuery setQuery - + Set the query string - + \triagens\ArangoDb\ClientException - + string - + void - + $query - + getQuery getQuery - + Get the query string - + string - + setCount setCount - + Set the count option for the statement - + bool - + void - + $value - + getCount getCount - + Get the count option value of the statement - + bool - + setBatchSize setBatchSize - + Set the batch size for the statement <p>The batch size is the number of results to be transferred -in one server roundtrip. If a query produces more results +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.</p> <p>The server-side cursor can be accessed by the client with subsequent HTTP requests.</p> - + \triagens\ArangoDb\ClientException - + int - + void - + $value - + getBatchSize getBatchSize - + Get the batch size for the statement - + int - + buildData buildData - + Build an array of data to be posted to the server when issuing the statement - + array - + getCursorOptions getCursorOptions - + Return an array of cursor options - + array - + ArangoDB PHP client: document handler - + - + \triagens\ArangoDb\Handler DocumentHandler \triagens\ArangoDb\DocumentHandler @@ -2194,9 +2204,9 @@ provides the additional results.</p> persists them on the server. <p>It does so by issuing the appropriate HTTP requests to the server.</p> - + - + ENTRY_DOCUMENTS ENTRY_DOCUMENTS 'documents' @@ -2205,7 +2215,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_COLLECTION OPTION_COLLECTION 'collection' @@ -2214,7 +2224,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_EXAMPLE OPTION_EXAMPLE 'example' @@ -2223,7 +2233,7 @@ appropriate HTTP requests to the server.</p> - + get get @@ -2261,7 +2271,7 @@ appropriate HTTP requests to the server.</p> array - + getById getById @@ -2299,7 +2309,7 @@ appropriate HTTP requests to the server.</p> array - + createFromArrayWithContext createFromArrayWithContext @@ -2322,7 +2332,7 @@ appropriate HTTP requests to the server.</p> - + getAllIds getAllIds @@ -2345,7 +2355,7 @@ appropriate HTTP requests to the server.</p> - + getByExample getByExample @@ -2360,7 +2370,7 @@ appropriate HTTP requests to the server.</p> mixed - + bool array @@ -2385,7 +2395,7 @@ appropriate HTTP requests to the server.</p> - + add add @@ -2427,7 +2437,7 @@ appropriate HTTP requests to the server.</p> - + store store @@ -2470,7 +2480,7 @@ simply pass the document to store() and it will figure out which one to call.< - + save save @@ -2512,7 +2522,7 @@ simply pass the document to store() and it will figure out which one to call.< - + update update @@ -2523,7 +2533,7 @@ simply pass the document to store() and it will figure out which one to call.< <p>This will throw if the document cannot be updated</p> -<p>If policy is set to error (locally or globally through the connectionoptions) +<p>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.</p> @@ -2550,7 +2560,7 @@ that the revision of the document to-be-replaced is the same as the one given.&l - + updateById updateById @@ -2560,7 +2570,7 @@ Attention - The behavior of this method has changed since version 1.1 @@ -2603,7 +2613,7 @@ that the revision of the document to-be-updated is the same as the one given.< - + replace replace @@ -2612,7 +2622,7 @@ that the revision of the document to-be-updated is the same as the one given.< <p>This will throw if the document cannot be updated</p> -<p>If policy is set to error (locally or globally through the connectionoptions) +<p>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.</p> @@ -2639,7 +2649,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + replaceById replaceById @@ -2648,7 +2658,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l <p>This will throw if the document cannot be Replaced</p> -<p>If policy is set to error (locally or globally through the connectionoptions) +<p>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.</p> @@ -2691,7 +2701,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + delete delete @@ -2722,7 +2732,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + remove remove @@ -2752,7 +2762,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + deleteById deleteById @@ -2799,7 +2809,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + removeById removeById @@ -2845,7 +2855,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + getDocumentId getDocumentId @@ -2867,7 +2877,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + getRevision getRevision @@ -2889,7 +2899,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + getCollectionId getCollectionId @@ -2913,15 +2923,15 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + ArangoDB PHP client: user document handler - + - + \triagens\ArangoDb\Handler UserHandler \triagens\ArangoDb\UserHandler @@ -2930,10 +2940,10 @@ that the revision of the to-be-replaced document is the same as the one given.&l persists them on the server. <p>It does so by issuing the appropriate HTTP requests to the server.</p> - + - + addUser addUser @@ -2956,8 +2966,7 @@ appropriate HTTP requests to the server.</p> array - - bool + array @@ -2991,7 +3000,7 @@ appropriate HTTP requests to the server.</p> - + replaceUser replaceUser @@ -3002,7 +3011,7 @@ appropriate HTTP requests to the server.</p> \triagens\ArangoDb\Exception - + mixed @@ -3014,8 +3023,7 @@ appropriate HTTP requests to the server.</p> array - - bool + array @@ -3048,102 +3056,101 @@ appropriate HTTP requests to the server.</p> - + updateUser updateUser - + Update an existing user, identified by the username <p>This will update the user-document on the server</p> <p>This will throw if the document cannot be updated</p> - + \triagens\ArangoDb\Exception - + mixed - + mixed - + mixed - + array - - bool + array - + bool - + $username - + $passwd null - + $active null - + $extra null - + $options array() - + get get - + Get a single user-document, identified by the username <p>This will throw if the document cannot be fetched from the server</p> - + \triagens\ArangoDb\Exception - + mixed - + \triagens\ArangoDb\User - + $username - + removeUser removeUser - + Remove a user, identified by the username - + \triagens\ArangoDb\Exception - + mixed - + bool - + $username @@ -3151,15 +3158,15 @@ appropriate HTTP requests to the server.</p> - + ArangoDB PHP client: connection - + - + Connection \triagens\ArangoDb\Connection @@ -3169,7 +3176,7 @@ As all access is done using HTTP, we do not need to establish a persistent connection and keep its state. <p>Instead, connections are established on the fly for each request and are destroyed afterwards.</p> - + $_apiVersion @@ -3226,500 +3233,509 @@ and are destroyed afterwards.</p> - + $_activeBatch null - + $_activeBatch object - + array - + $_captureBatch false - + $_captureBatch boolean - - array + + boolean - + $_batchRequest false - - $_captureBatch boolean + + $_batchRequest boolean - - array + + boolean - + __construct __construct - + Set up the connection object, validate the options provided - + \triagens\ArangoDb\Exception - + array - - void + + \triagens\ArangoDb\Connection - + $options array - + __destruct __destruct - + Close existing connection handle if a keep-alive connection was used - + void - + getOption getOption - + Get an option set for the connection - + \triagens\ArangoDb\ClientException - + string - + mixed - + $name - + get get - + Issue an HTTP GET request - + \triagens\ArangoDb\Exception - + string - + \triagens\ArangoDb\HttpResponse - + $url - + post post - + Issue an HTTP POST request with the data provided - + \triagens\ArangoDb\Exception - + string - + string - + \triagens\ArangoDb\HttpResponse - + $url - + $data - + put put - + Issue an HTTP PUT request with the data provided - + \triagens\ArangoDb\Exception - + string - + string - + \triagens\ArangoDb\HttpResponse - + $url - + $data - + patch patch - + Issue an HTTP PATCH request with the data provided - + \triagens\ArangoDb\Exception - + string - + string - + \triagens\ArangoDb\HttpResponse - + $url - + $data - + delete delete - + Issue an HTTP DELETE request with the data provided - + \triagens\ArangoDb\Exception - + string - + \triagens\ArangoDb\HttpResponse - + $url - + getHandle getHandle - + Get a connection handle <p>If keep-alive connections are used, the handle will be stored and re-used</p> - + + \triagens\ArangoDb\ClientException + + resource - + parseResponse parseResponse - + Parse the response return the body values as an assoc array - + \triagens\ArangoDb\Exception - + \triagens\ArangoDb\HttpResponse - + \triagens\ArangoDb\HttpResponse - + $response \triagens\ArangoDb\HttpResponse - + executeRequest executeRequest - + Execute an HTTP request and return the results <p>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.</p> <p>The function might temporarily alter the value of the php.ini value 'default_socket_timeout' but will restore it.</p> - + \triagens\ArangoDb\Exception - + string - + string - + string - + \triagens\ArangoDb\HttpResponse - + $method - + $url - + $data - + getVersion getVersion - + Get the client version (alias for getClientVersion) - + string - + getClientVersion getClientVersion - + Get the client version - + string - + stopCaptureBatch stopCaptureBatch - + Stop capturing commands - - array - - + \triagens\ArangoDb\Batch - - $options - array() - - - + getActiveBatch getActiveBatch - + returns the active batch + + \triagens\ArangoDb\Batch + - + setActiveBatch setActiveBatch - + Sets the active Batch for this connection - + \triagens\ArangoDb\Batch - - \triagens\ArangoDb\the + + \triagens\ArangoDb\Batch - + $batch - + setCaptureBatch setCaptureBatch - + Sets the batch capture state (true, if capturing) - + boolean - - \triagens\ArangoDb\$state - - + $state - + setBatchRequest setBatchRequest - - Sets connection into Batchrequest mode. - <p>This is needed for some oprtations to act differently when in this mode</p> - + + Sets connection into Batch-request mode. + <p>This is needed for some operations to act differently when in this mode.</p> + boolean - - $state - - - + + $state + + + + + + isInBatchCaptureMode + isInBatchCaptureMode + + Returns true if this connection is in Batch-Capture mode + + + bool + + - + getBatches getBatches - + returns the active batch - + doBatch doBatch - + This is a helper function to executeRequest that captures requests if we're in batch mode - + mixed - + string - - \triagens\ArangoDb\the + + mixed - + $method - + $request - + detect_utf detect_utf - + This function checks that the encoding of a string is utf. <p>It only checks for printable characters.</p> - + array - + boolean - + $string - + check_encoding check_encoding - + This function checks that the encoding of the keys and values of the array are utf-8, recursively. <p>It will raise an exception if it encounters wrong encoded strings.</p> - + array + + \triagens\ArangoDb\ClientException + - + $data - + json_encode_wrapper json_encode_wrapper - + This is a json_encode() wrapper that also checks if the data is utf-8 conform. <p>internally it calls the check_encoding() method. If that method does not throw -an Exception, this method will happilly return the json_encoded data.</p> - +an Exception, this method will happily return the json_encoded data.</p> + mixed - + mixed - + string - + $data - + $options null @@ -3727,11 +3743,11 @@ an Exception, this method will happilly return the json_encoded data.</p>< - + ArangoDB PHP client: connection - + @@ -3898,24 +3914,24 @@ an Exception, this method will happilly return the json_encoded data.</p>< - + ArangoDB PHP client: default values - + - + DefaultValues \triagens\ArangoDb\DefaultValues Contains default values used by the client - + - + DEFAULT_PORT DEFAULT_PORT 8529 @@ -3924,7 +3940,7 @@ an Exception, this method will happilly return the json_encoded data.</p>< - + DEFAULT_TIMEOUT DEFAULT_TIMEOUT 30 @@ -3933,7 +3949,7 @@ an Exception, this method will happilly return the json_encoded data.</p>< - + DEFAULT_WAIT_SYNC DEFAULT_WAIT_SYNC false @@ -3942,7 +3958,7 @@ an Exception, this method will happilly return the json_encoded data.</p>< - + DEFAULT_JOURNAL_SIZE DEFAULT_JOURNAL_SIZE 33554432 @@ -3951,7 +3967,7 @@ an Exception, this method will happilly return the json_encoded data.</p>< - + DEFAULT_IS_VOLATILE DEFAULT_IS_VOLATILE false @@ -3960,7 +3976,7 @@ an Exception, this method will happilly return the json_encoded data.</p>< - + DEFAULT_CREATE DEFAULT_CREATE false @@ -3969,7 +3985,7 @@ an Exception, this method will happilly return the json_encoded data.</p>< - + DEFAULT_CONNECTION DEFAULT_CONNECTION "Close" @@ -3978,7 +3994,7 @@ an Exception, this method will happilly return the json_encoded data.</p>< - + DEFAULT_UPDATE_POLICY DEFAULT_UPDATE_POLICY \triagens\ArangoDb\UpdatePolicy::ERROR @@ -3987,7 +4003,7 @@ an Exception, this method will happilly return the json_encoded data.</p>< - + DEFAULT_REPLACE_POLICY DEFAULT_REPLACE_POLICY \triagens\ArangoDb\UpdatePolicy::ERROR @@ -3996,7 +4012,7 @@ an Exception, this method will happilly return the json_encoded data.</p>< - + DEFAULT_DELETE_POLICY DEFAULT_DELETE_POLICY \triagens\ArangoDb\UpdatePolicy::ERROR @@ -4005,7 +4021,7 @@ an Exception, this method will happilly return the json_encoded data.</p>< - + DEFAULT_CHECK_UTF8_CONFORM DEFAULT_CHECK_UTF8_CONFORM true @@ -4016,15 +4032,15 @@ an Exception, this method will happilly return the json_encoded data.</p>< - + ArangoDB PHP client: connect exception - + - + \triagens\ArangoDb\Exception ConnectException \triagens\ArangoDb\ConnectException @@ -4032,9 +4048,9 @@ an Exception, this method will happilly return the json_encoded data.</p>< This exception type will be thrown by the client when there is an error during connecting to the server - + - + __toString __toString @@ -4047,15 +4063,15 @@ during connecting to the server - + ArangoDB PHP client: client exception - + - + \triagens\ArangoDb\Exception ClientException \triagens\ArangoDb\ClientException @@ -4063,9 +4079,9 @@ during connecting to the server This exception type will be thrown by the client when there is an error on the client side, i.e. <p>something the server is not involved in.</p> - + - + __toString __toString @@ -4078,15 +4094,15 @@ on the client side, i.e. - + ArangoDB PHP client: server exception - + - + \triagens\ArangoDb\Exception ServerException \triagens\ArangoDb\ServerException @@ -4097,9 +4113,9 @@ error in response to a client request. the server. In case the server provides additional details about the error, these details can be queried using the getDetails() function.</p> - + - + ENTRY_CODE ENTRY_CODE 'errorNum' @@ -4108,7 +4124,7 @@ getDetails() function.</p> - + ENTRY_MESSAGE ENTRY_MESSAGE 'errorMessage' @@ -4128,7 +4144,7 @@ getDetails() function.</p> - + __toString __toString @@ -4139,7 +4155,7 @@ getDetails() function.</p> - + setDetails setDetails @@ -4159,7 +4175,7 @@ that occurred, they will be put here.</p> array - + getDetails getDetails @@ -4171,7 +4187,7 @@ that occurred, they can be queries using the method</p> - + getServerCode getServerCode @@ -4183,7 +4199,7 @@ that occurred, this will return the server error code</p> - + getServerMessage getServerMessage @@ -4197,26 +4213,26 @@ that occurred, this will return the server error string</p> - + ArangoDB PHP client: single document - + - + \triagens\ArangoDb\Document Graph \triagens\ArangoDb\Graph Value object representing a graph - + - + ENTRY_VERTICES ENTRY_VERTICES 'vertices' @@ -4225,7 +4241,7 @@ that occurred, this will return the server error string</p> - + ENTRY_EDGES ENTRY_EDGES 'edges' @@ -4256,7 +4272,7 @@ that occurred, this will return the server error string</p> - + __construct __construct @@ -4268,8 +4284,8 @@ that occurred, this will return the server error string</p> array - - void + + \triagens\ArangoDb\Graph @@ -4283,7 +4299,7 @@ that occurred, this will return the server error string</p>array - + setVerticesCollection setVerticesCollection @@ -4303,7 +4319,7 @@ that occurred, this will return the server error string</p> - + getVerticesCollection getVerticesCollection @@ -4315,7 +4331,7 @@ that occurred, this will return the server error string</p> - + setEdgesCollection setEdgesCollection @@ -4335,7 +4351,7 @@ that occurred, this will return the server error string</p> - + getEdgesCollection getEdgesCollection @@ -4347,7 +4363,7 @@ that occurred, this will return the server error string</p> - + set set @@ -4381,24 +4397,24 @@ exception if the value is invalid.</p> - + ArangoDB PHP client: HTTP response - + - + HttpResponse \triagens\ArangoDb\HttpResponse Container class for HTTP responses - + - + HEADER_LOCATION HEADER_LOCATION 'location' @@ -4444,7 +4460,7 @@ exception if the value is invalid.</p> $_result '' - The result statusline (first line of HTTP response header) + The result status-line (first line of HTTP response header) string @@ -4462,7 +4478,7 @@ exception if the value is invalid.</p> - + __construct __construct @@ -4474,133 +4490,130 @@ exception if the value is invalid.</p> string - - void - - + $responseString - + getHttpCode getHttpCode - + Return the HTTP status code of the response - + int - + getHeader getHeader - + Return an individual HTTP headers of the response - + string - + string - + $name - + getHeaders getHeaders - + Return the HTTP headers of the response - + array - + getLocationHeader getLocationHeader - + Return the location HTTP header of the response - + string - + getBody getBody - + Return the body of the response - + string - + getResult getResult - + Return the result line (first header line) of the response - + string - + getJson getJson - + Return the data from the JSON-encoded body - + \triagens\ArangoDb\ClientException - + array - + setupHeaders setupHeaders - + Set up an array of HTTP headers - + void - + ArangoDB PHP client: batchpart - + - + BatchPart \triagens\ArangoDb\BatchPart Provides batch part functionality - + $_cursorOptions @@ -4663,12 +4676,12 @@ exception if the value is invalid.</p> The batch that this instance is part of - - array + + \triagens\ArangoDb\Batch - + __construct __construct @@ -4678,7 +4691,7 @@ exception if the value is invalid.</p> \triagens\ArangoDb\Batch - + mixed @@ -4690,11 +4703,11 @@ exception if the value is invalid.</p> mixed - + mixed - - \triagens\ArangoDb\Batch + + \triagens\ArangoDb\BatchPart @@ -4728,7 +4741,7 @@ exception if the value is invalid.</p> - + setBatch setBatch @@ -4747,7 +4760,7 @@ exception if the value is invalid.</p> - + setId setId @@ -4766,7 +4779,7 @@ exception if the value is invalid.</p> - + getId getId @@ -4777,7 +4790,7 @@ exception if the value is invalid.</p> - + setType setType @@ -4796,7 +4809,7 @@ exception if the value is invalid.</p> - + getType getType @@ -4807,7 +4820,7 @@ exception if the value is invalid.</p> - + setRequest setRequest @@ -4826,7 +4839,7 @@ exception if the value is invalid.</p> - + getRequest getRequest @@ -4837,7 +4850,7 @@ exception if the value is invalid.</p> - + setResponse setResponse @@ -4856,18 +4869,18 @@ exception if the value is invalid.</p> - + getResponse getResponse Gets the response for he current batch part. - - \triagens\ArangoDb\Batch + + \triagens\ArangoDb\HttpResponse - + getHttpCode getHttpCode @@ -4878,48 +4891,51 @@ exception if the value is invalid.</p> - + getProcessedResponse getProcessedResponse Get the batch part identified by the array key (0. <p>..n) or its id (if it was set with nextBatchPartId($id) )</p> + + \triagens\ArangoDb\ClientException + mixed - + getCursorOptions getCursorOptions - + Return an array of cursor options - + array - + ArangoDB PHP client: update policies - + - + UpdatePolicy \triagens\ArangoDb\UpdatePolicy Document update policies - + - + LAST LAST 'last' @@ -4928,7 +4944,7 @@ exception if the value is invalid.</p> - + ERROR ERROR 'error' @@ -4937,7 +4953,7 @@ exception if the value is invalid.</p> - + validate validate @@ -4961,15 +4977,15 @@ exception if the value is invalid.</p> - + ArangoDB PHP client: collection handler - + - + \triagens\ArangoDb\Handler CollectionHandler \triagens\ArangoDb\CollectionHandler @@ -4978,9 +4994,9 @@ exception if the value is invalid.</p> creates collections on the server. <p>It does so by issuing the appropriate HTTP requests to the server.</p> - + - + ENTRY_DOCUMENTS ENTRY_DOCUMENTS 'documents' @@ -4989,7 +5005,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_COLLECTION OPTION_COLLECTION 'collection' @@ -4998,7 +5014,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_EXAMPLE OPTION_EXAMPLE 'example' @@ -5007,7 +5023,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_NEW_VALUE OPTION_NEW_VALUE 'newValue' @@ -5016,7 +5032,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_CREATE_COLLECTION OPTION_CREATE_COLLECTION 'createCollection' @@ -5025,7 +5041,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_ATTRIBUTE OPTION_ATTRIBUTE 'attribute' @@ -5034,7 +5050,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_LEFT OPTION_LEFT 'left' @@ -5043,7 +5059,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_RIGHT OPTION_RIGHT 'right' @@ -5052,7 +5068,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_CLOSED OPTION_CLOSED 'closed' @@ -5061,16 +5077,16 @@ appropriate HTTP requests to the server.</p> - + OPTION_LATITUDE OPTION_LATITUDE 'latitude' - latidude parameter + latitude parameter - + OPTION_LONGITUDE OPTION_LONGITUDE 'longitude' @@ -5079,7 +5095,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_DISTANCE OPTION_DISTANCE 'distance' @@ -5088,7 +5104,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_RADIUS OPTION_RADIUS 'radius' @@ -5097,7 +5113,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_SKIP OPTION_SKIP 'skip' @@ -5106,7 +5122,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_LIMIT OPTION_LIMIT 'limit' @@ -5115,7 +5131,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_FIELDS OPTION_FIELDS 'fields' @@ -5124,7 +5140,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_UNIQUE OPTION_UNIQUE 'unique' @@ -5133,7 +5149,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_TYPE OPTION_TYPE 'type' @@ -5142,7 +5158,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_CAP_CONSTRAINT OPTION_CAP_CONSTRAINT 'cap' @@ -5151,7 +5167,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_SIZE OPTION_SIZE 'size' @@ -5160,7 +5176,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_GEO_INDEX OPTION_GEO_INDEX 'geo' @@ -5169,7 +5185,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_IGNORE_NULL OPTION_IGNORE_NULL 'ignoreNull' @@ -5178,7 +5194,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_CONSTRAINT OPTION_CONSTRAINT 'constraint' @@ -5187,7 +5203,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_GEOJSON OPTION_GEOJSON 'geoJson' @@ -5196,7 +5212,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_HASH_INDEX OPTION_HASH_INDEX 'hash' @@ -5205,7 +5221,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_FULLTEXT_INDEX OPTION_FULLTEXT_INDEX 'fulltext' @@ -5214,7 +5230,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_MIN_LENGTH OPTION_MIN_LENGTH 'minLength' @@ -5223,7 +5239,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_SKIPLIST_INDEX OPTION_SKIPLIST_INDEX 'skiplist' @@ -5232,7 +5248,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_COUNT OPTION_COUNT 'count' @@ -5241,7 +5257,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_PROPERTIES OPTION_PROPERTIES 'properties' @@ -5250,7 +5266,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_FIGURES OPTION_FIGURES 'figures' @@ -5259,7 +5275,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_LOAD OPTION_LOAD 'load' @@ -5268,7 +5284,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_UNLOAD OPTION_UNLOAD 'unload' @@ -5277,7 +5293,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_TRUNCATE OPTION_TRUNCATE 'truncate' @@ -5286,7 +5302,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_RENAME OPTION_RENAME 'rename' @@ -5295,7 +5311,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_EXCLUDE_SYSTEM OPTION_EXCLUDE_SYSTEM 'excludeSystem' @@ -5304,7 +5320,7 @@ appropriate HTTP requests to the server.</p> - + get get @@ -5326,7 +5342,7 @@ appropriate HTTP requests to the server.</p> - + getProperties getProperties @@ -5348,7 +5364,7 @@ appropriate HTTP requests to the server.</p> - + getCount getCount @@ -5371,7 +5387,7 @@ appropriate HTTP requests to the server.</p> - + count count @@ -5393,7 +5409,7 @@ appropriate HTTP requests to the server.</p> - + getFigures getFigures @@ -5416,7 +5432,7 @@ appropriate HTTP requests to the server.</p> - + figures figures @@ -5438,7 +5454,7 @@ appropriate HTTP requests to the server.</p> - + add add @@ -5463,7 +5479,7 @@ appropriate HTTP requests to the server.</p> \triagens\ArangoDb\Collection - + create create @@ -5495,7 +5511,7 @@ This will throw if the collection cannot be created</p> - + createCapConstraint createCapConstraint @@ -5512,1006 +5528,1006 @@ This will throw if the collection cannot be created</p> array - + $collectionId - + $size - + createGeoIndex createGeoIndex - + Create a geo index - + string - + array - + boolean - + boolean - + boolean - - + + array - + $collectionId - + $fields array - + $geoJson null - + $constraint null - + $ignoreNull null - + createHashIndex createHashIndex - + Create a hash index - + string - + array - + boolean - - + + array - + $collectionId - + $fields array - + $unique null - + createFulltextIndex createFulltextIndex - + Create a fulltext index - + string - + array - + int - - + + array - + $collectionId - + $fields array - + $minLength null - + createSkipListIndex createSkipListIndex - + Create a skip-list index - + string - + array - + bool - - + + array - + $collectionId - + $fields array - + $unique null - + index index - + Creates an index on a collection on the server <p>This will create an index on the collection on the server and return its id</p> <p>This will throw if the index cannot be created</p> - + \triagens\ArangoDb\Exception - + mixed - + string - + array - + bool - + array - + array - + $collectionId - + $type "" - + $attributes array() - + $unique false - + $indexOptions array() - + getIndex getIndex - + Get the information about an index in a collection - + string - + string - + array - + $collection - + $indexId - + getIndexes getIndexes - + Get indexes of a collection <p>This will throw if the collection cannot be fetched from the server</p> - + \triagens\ArangoDb\Exception - + mixed - + array - + $collectionId - + dropIndex dropIndex - + Drop an index - + \triagens\ArangoDb\Exception - + mixed - + bool - + $indexHandle - + delete delete - + Delete a collection - + \triagens\ArangoDb\Exception - + mixed - + bool - + - + $collection - + drop drop - + Drop a collection - + \triagens\ArangoDb\Exception - + mixed - + bool - + $collection - + rename rename - + Rename a collection - + \triagens\ArangoDb\Exception - + mixed - + string - + bool - + $collection - + $name - + load load - + Load a collection into the server's memory <p>This will load the given collection into the server's memory.</p> - + \triagens\ArangoDb\Exception - + mixed - - bool + + \triagens\ArangoDb\HttpResponse - + $collection - + unload unload - + Unload a collection from the server's memory <p>This will unload the given collection from the server's memory.</p> - + \triagens\ArangoDb\Exception - + mixed - - bool + + \triagens\ArangoDb\HttpResponse - + $collection - + truncate truncate - + Truncate a collection <p>This will remove all documents from the collection but will leave the metadata and indexes intact.</p> - + \triagens\ArangoDb\Exception - + mixed - + bool - + $collection - + byExample byExample - + Get document(s) by specifying an example <p>This will throw if the list cannot be fetched from the server</p> - + \triagens\ArangoDb\Exception - + mixed - + mixed - + bool array - + \triagens\ArangoDb\cursor - + $collectionId - + $document - + $options array() - + firstExample firstExample - + Get the first document matching a given example. <p>This will throw if the document cannot be fetched from the server</p> - + \triagens\ArangoDb\Exception - + mixed - + mixed - + bool array - + \triagens\ArangoDb\Document - + - + $collectionId - + $document - + $options array() - + any any - + Get a random document from the collection. <p>This will throw if the document cannot be fetched from the server</p> - + \triagens\ArangoDb\Exception - + mixed - + \triagens\ArangoDb\Document - + - + $collectionId - + updateByExample updateByExample - + Update document(s) matching a given example <p>This will update the document(s) on the server</p> <p>This will throw if the document cannot be updated</p> - + \triagens\ArangoDb\Exception - + mixed - + mixed - + mixed - + mixed - + bool - + - + $collectionId - + $example - + $newValue - + $options array() - + replaceByExample replaceByExample - + Replace document(s) matching a given example <p>This will replace the document(s) on the server</p> <p>This will throw if the document cannot be replaced</p> - + \triagens\ArangoDb\Exception - + mixed - + mixed - + mixed - + mixed - + bool - + - + $collectionId - + $example - + $newValue - + $options array() - + removeByExample removeByExample - + Remove document(s) by specifying an example <p>This will throw on any error</p> - + \triagens\ArangoDb\Exception - + mixed - + mixed - + bool array - + int - + - + $collectionId - + $document - + $options array() - + range range - + Get document(s) by specifying range <p>This will throw if the list cannot be fetched from the server</p> - + \triagens\ArangoDb\Exception - + mixed - + string - + mixed - + mixed - + array - + \triagens\ArangoDb\Cursor - + $collectionId - + $attribute - + $left - + $right - + $options array() - + near near - + Get document(s) by specifying near <p>This will throw if the list cannot be fetched from the server</p> - + \triagens\ArangoDb\Exception - + mixed - + double - + double - + array - + \triagens\ArangoDb\Cursor - + $collectionId - + $latitude - + $longitude - + $options array() - + within within - + Get document(s) by specifying within <p>This will throw if the list cannot be fetched from the server</p> - + \triagens\ArangoDb\Exception - + mixed - + double - + double - + int - + array - + \triagens\ArangoDb\Cursor - + $collectionId - + $latitude - + $longitude - + $radius - + $options array() - + getAllIds getAllIds - + Get the list of all documents' ids from a collection <p>This will throw if the list cannot be fetched from the server</p> - + \triagens\ArangoDb\Exception - + mixed - + array - + $collectionId - + isValidCollectionId isValidCollectionId - + Checks if the collectionId given, is valid. <p>Returns true if it is, or false if it is not.</p> - - + + bool - + $collectionId - + getAllCollections getAllCollections - + Get list of all available collections per default with the collection names as index. <p>Returns empty array if none are available.</p> - + array - + array - + $options array() - + getCollectionId getCollectionId - + Gets the collectionId from the given collectionObject or string/integer - + mixed - + mixed - + $collection - + getCollectionName getCollectionName - + Gets the collectionId from the given collectionObject or string/integer - + mixed - + mixed - + $collection - + importFromFile importFromFile - + Import documents from a file <p>This will throw on all errors except insertion errors</p> - + \triagens\ArangoDb\Exception - + mixed - + mixed - + array - + int - + $collectionId - + $importFileName - + $options array('createCollection' => false, 'type' => null) - + import import - + Import documents into a collection <p>This will throw on all errors except insertion errors</p> - + \triagens\ArangoDb\Exception - + mixed - + mixed - + array - + int - + $collectionId - + $importData - + $options array('createCollection' => false, 'type' => null) @@ -6519,15 +6535,15 @@ This will throw if the collection cannot be created</p> - + ArangoDB PHP client: endpoint - + - + Endpoint \triagens\ArangoDb\Endpoint @@ -6540,9 +6556,9 @@ the following endpoint types are currently supported (more to be added later): - ssl://host:port for SSL connections (provided the server supports this)</p> <p>Note: SSL support is added in ArangoDB server 1.1</p> - + - + TYPE_TCP TYPE_TCP 'tcp' @@ -6551,7 +6567,7 @@ the following endpoint types are currently supported (more to be added later): - + TYPE_SSL TYPE_SSL 'ssl' @@ -6560,7 +6576,7 @@ the following endpoint types are currently supported (more to be added later): - + TYPE_UNIX TYPE_UNIX 'unix' @@ -6569,7 +6585,7 @@ the following endpoint types are currently supported (more to be added later): - + REGEXP_TCP REGEXP_TCP '/^tcp:\/\/(.+?):(\d+)\/?$/' @@ -6578,7 +6594,7 @@ the following endpoint types are currently supported (more to be added later): - + REGEXP_SSL REGEXP_SSL '/^ssl:\/\/(.+?):(\d+)\/?$/' @@ -6587,7 +6603,7 @@ the following endpoint types are currently supported (more to be added later): - + REGEXP_UNIX REGEXP_UNIX '/^unix:\/\/(.+)$/' @@ -6607,91 +6623,91 @@ the following endpoint types are currently supported (more to be added later): - + __construct __construct Create a new endpoint - - \triagens\ArangoDb\ClientException - string - - void + + \triagens\ArangoDb\ClientException + + + \triagens\ArangoDb\Endpoint - + $value - + __toString __toString - + Return a string representation of the endpoint - + string - + getType getType - + Return the type of an endpoint - + string - + string - + $value - + getHost getHost - + Return the host name of an endpoint - + string - + string - + $value - + isValid isValid - + check whether an endpoint specification is valid - + string - + bool - + $value @@ -6699,24 +6715,24 @@ the following endpoint types are currently supported (more to be added later): - + ArangoDB PHP client: single collection - + - + Collection \triagens\ArangoDb\Collection Value object representing a collection - + - + ENTRY_ID ENTRY_ID 'id' @@ -6725,7 +6741,7 @@ the following endpoint types are currently supported (more to be added later): - + ENTRY_NAME ENTRY_NAME 'name' @@ -6734,7 +6750,7 @@ the following endpoint types are currently supported (more to be added later): - + ENTRY_TYPE ENTRY_TYPE 'type' @@ -6743,7 +6759,7 @@ the following endpoint types are currently supported (more to be added later): - + ENTRY_WAIT_SYNC ENTRY_WAIT_SYNC 'waitForSync' @@ -6752,7 +6768,7 @@ the following endpoint types are currently supported (more to be added later): - + ENTRY_JOURNAL_SIZE ENTRY_JOURNAL_SIZE 'journalSize' @@ -6761,7 +6777,7 @@ the following endpoint types are currently supported (more to be added later): - + ENTRY_STATUS ENTRY_STATUS 'status' @@ -6770,7 +6786,7 @@ the following endpoint types are currently supported (more to be added later): - + ENTRY_KEY_OPTIONS ENTRY_KEY_OPTIONS 'keyOptions' @@ -6779,7 +6795,7 @@ the following endpoint types are currently supported (more to be added later): - + ENTRY_IS_SYSTEM ENTRY_IS_SYSTEM 'isSystem' @@ -6788,16 +6804,16 @@ the following endpoint types are currently supported (more to be added later): - + ENTRY_IS_VOLATILE ENTRY_IS_VOLATILE 'isVolatile' - Collection 'isVolatile' sindex + Collection 'isVolatile' index - + OPTION_PROPERTIES OPTION_PROPERTIES 'properties' @@ -6806,7 +6822,7 @@ the following endpoint types are currently supported (more to be added later): - + TYPE_DOCUMENT TYPE_DOCUMENT 2 @@ -6815,7 +6831,7 @@ the following endpoint types are currently supported (more to be added later): - + TYPE_EDGE TYPE_EDGE 3 @@ -6824,7 +6840,7 @@ the following endpoint types are currently supported (more to be added later): - + STATUS_NEW_BORN STATUS_NEW_BORN 1 @@ -6833,7 +6849,7 @@ the following endpoint types are currently supported (more to be added later): - + STATUS_UNLOADED STATUS_UNLOADED 2 @@ -6842,7 +6858,7 @@ the following endpoint types are currently supported (more to be added later): - + STATUS_LOADED STATUS_LOADED 3 @@ -6851,16 +6867,16 @@ the following endpoint types are currently supported (more to be added later): - + STATUS_BEING_UNLOADED STATUS_BEING_UNLOADED 4 - Collectiong being unloaded + Collection being unloaded - + STATUS_DELETED STATUS_DELETED 5 @@ -6968,18 +6984,18 @@ the following endpoint types are currently supported (more to be added later): - + __construct __construct Constructs an empty collection - - void + + \triagens\ArangoDb\Collection - + createFromArray createFromArray @@ -7001,7 +7017,7 @@ the following endpoint types are currently supported (more to be added later): array - + getDefaultType getDefaultType @@ -7012,7 +7028,7 @@ the following endpoint types are currently supported (more to be added later): - + __clone __clone @@ -7023,7 +7039,7 @@ the following endpoint types are currently supported (more to be added later): - + __toString __toString @@ -7034,7 +7050,7 @@ the following endpoint types are currently supported (more to be added later): - + toJson toJson @@ -7045,7 +7061,7 @@ the following endpoint types are currently supported (more to be added later): - + toSerialized toSerialized @@ -7056,7 +7072,7 @@ the following endpoint types are currently supported (more to be added later): - + getAll getAll @@ -7067,7 +7083,7 @@ the following endpoint types are currently supported (more to be added later): - + set set @@ -7100,7 +7116,7 @@ exception if the value is invalid.</p> - + setId setId @@ -7112,8 +7128,8 @@ exception if the value is invalid.</p> mixed - - void + + bool @@ -7122,7 +7138,7 @@ exception if the value is invalid.</p> - + getId getId @@ -7136,7 +7152,7 @@ To reliably store a collection id elsewhere, a PHP string should be used</p&g - + setName setName @@ -7158,7 +7174,7 @@ To reliably store a collection id elsewhere, a PHP string should be used</p&g - + getName getName @@ -7169,7 +7185,7 @@ To reliably store a collection id elsewhere, a PHP string should be used</p&g - + setType setType @@ -7192,7 +7208,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + getType getType @@ -7203,7 +7219,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + setStatus setStatus @@ -7225,7 +7241,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + getStatus getStatus @@ -7236,7 +7252,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + setKeyOptions setKeyOptions @@ -7258,7 +7274,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + getKeyOptions getKeyOptions @@ -7269,7 +7285,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + setWaitForSync setWaitForSync @@ -7288,7 +7304,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + getWaitForSync getWaitForSync @@ -7299,7 +7315,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + setJournalSize setJournalSize @@ -7318,7 +7334,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + getJournalSize getJournalSize @@ -7329,7 +7345,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + setIsSystem setIsSystem @@ -7348,7 +7364,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + getIsSystem getIsSystem @@ -7359,7 +7375,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + setIsVolatile setIsVolatile @@ -7378,7 +7394,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + getIsVolatile getIsVolatile @@ -7391,24 +7407,24 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + ArangoDB PHP client: http helper methods - + - + HttpHelper \triagens\ArangoDb\HttpHelper Helper methods for HTTP request/response handling - + - + METHOD_POST METHOD_POST 'POST' @@ -7417,7 +7433,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + METHOD_PUT METHOD_PUT 'PUT' @@ -7426,7 +7442,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + METHOD_DELETE METHOD_DELETE 'DELETE' @@ -7435,7 +7451,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + METHOD_GET METHOD_GET 'GET' @@ -7444,7 +7460,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + METHOD_HEAD METHOD_HEAD 'HEAD' @@ -7453,7 +7469,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + METHOD_PATCH METHOD_PATCH 'PATCH' @@ -7462,7 +7478,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + CHUNK_SIZE CHUNK_SIZE 8192 @@ -7471,7 +7487,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + EOL EOL "\r\n" @@ -7480,7 +7496,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + PROTOCOL PROTOCOL 'HTTP/1.1' @@ -7489,7 +7505,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + MIME_BOUNDARY MIME_BOUNDARY 'XXXsubpartXXX' @@ -7498,7 +7514,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + validateMethod validateMethod @@ -7520,7 +7536,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + buildRequest buildRequest @@ -7563,7 +7579,7 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + transfer transfer @@ -7575,79 +7591,82 @@ For example this must be set to 3 in order to create an edge-collection.</p&g string + + \triagens\ArangoDb\ClientException + string - + $socket - + $request - + createConnection createConnection - + Create a one-time HTTP connection by opening a socket to the server <p>It is the caller's responsibility to close the socket</p> - + \triagens\ArangoDb\ConnectException - + \triagens\ArangoDb\ConnectionOptions - + resource - + $options \triagens\ArangoDb\ConnectionOptions - + parseHttpMessage parseHttpMessage - + Splits a http message into its header and body. - + string - + \triagens\ArangoDb\ClientException - + array - + $httpMessage - + parseHeaders parseHeaders - + Process a string of HTTP headers into an array of header => values. - + string - + array - + $headers @@ -7655,17 +7674,17 @@ For example this must be set to 3 in order to create an edge-collection.</p&g - + ArangoDB PHP client: vertex document handler - + - + \triagens\ArangoDb\DocumentHandler VertexHandler \triagens\ArangoDb\VertexHandler @@ -7674,10 +7693,10 @@ For example this must be set to 3 in order to create an edge-collection.</p&g persists them on the server. <p>It does so by issuing the appropriate HTTP requests to the server.</p> - + - + createFromArrayWithContext createFromArrayWithContext @@ -7702,15 +7721,15 @@ appropriate HTTP requests to the server.</p> - + ArangoDB PHP client: transaction - + - + Transaction \triagens\ArangoDb\Transaction @@ -7760,97 +7779,97 @@ $this->setReadCollections($array or $string if single collection)</p> int - + - + ENTRY_COLLECTIONS ENTRY_COLLECTIONS 'collections' - + Collections index - + ENTRY_ACTION ENTRY_ACTION 'action' - + Action index - + ENTRY_WAIT_FOR_SYNC ENTRY_WAIT_FOR_SYNC 'waitForSync' - + WaitForSync index - + ENTRY_LOCK_TIMEOUT ENTRY_LOCK_TIMEOUT 'lockTimeout' - + Lock timeout index - + ENTRY_PARAMS ENTRY_PARAMS 'params' - + Params index - + ENTRY_READ ENTRY_READ 'read' - + Read index - + ENTRY_WRITE ENTRY_WRITE 'write' - + WRITE index - + $_connection null - + The connection object - + \triagens\ArangoDb\Connection - + $attributes array() - + The transaction's attributes. - + array - + __construct __construct - + Initialise the transaction object <p>The $transaction array can be used to specify the collections, action and further options for the transaction in form of an array.</p> @@ -7865,359 +7884,359 @@ array( 'action' => 'function (){}', 'waitForSync' => true )</p> - + \triagens\ArangoDb\Connection - + array - + \triagens\ArangoDb\Transaction - + $connection \triagens\ArangoDb\Connection - + $transactionArray null array - + execute execute - + Execute the transaction <p>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.</p> - + \triagens\ArangoDb\Exception - + mixed - + getConnection getConnection - + Return the connection object - + \triagens\ArangoDb\Connection - + setCollections setCollections - + Set the collections array. <p>The array should have 2 sub-arrays, namely 'read' and 'write' which should hold the respective collections for the transaction</p> - + array - + $value array - + getCollections getCollections - + Get collections array <p>This holds the read and write collections of the transaction</p> - + array - + setAction setAction - + set action value - + string - + $value - + getAction getAction - + get action value - + string - + setWaitForSync setWaitForSync - + set waitForSync value - + bool - + $value - + getWaitForSync getWaitForSync - + get waitForSync value - + bool - + setLockTimeout setLockTimeout - + Set lockTimeout value - + int - + $value - + getLockTimeout getLockTimeout - + Get lockTimeout value - + int - + setParams setParams - + Set params value - + array - + $value array - + getParams getParams - + Get params value - + array - + setWriteCollections setWriteCollections - + Convenience function to directly set write-collections without having to access them from the collections attribute. - + array - + $value - + getWriteCollections getWriteCollections - + Convenience function to directly get write-collections without having to access them from the collections attribute. - + array - + setReadCollections setReadCollections - + Convenience function to directly set read-collections without having to access them from the collections attribute. - + array - + $value - + getReadCollections getReadCollections - + Convenience function to directly get read-collections without having to access them from the collections attribute. - + array - + set set - + Sets an attribute - - - + + + \triagens\ArangoDb\ClientException - + $key - + $value - + __set __set - + Set an attribute, magic method <p>This is a magic method that allows the object to be used without declaring all document attributes first.</p> - + \triagens\ArangoDb\ClientException - + string - + mixed - + void - + $key - + $value - + get get - + Get an attribute - + string - + mixed - + $key - + __get __get - + Get an attribute, magic method <p>This function is mapped to get() internally.</p> - + string - + mixed - + $key - + __toString __toString - + Returns the action string - + string - + buildTransactionAttributesFromArray buildTransactionAttributesFromArray - + Build the object's attributes from a given array - + - + $options @@ -8225,24 +8244,24 @@ declaring all document attributes first.</p> - + ArangoDB PHP client: single document - + - + Document \triagens\ArangoDb\Document Value object representing a single collection-based document - + - + ENTRY_ID ENTRY_ID '_id' @@ -8251,7 +8270,7 @@ declaring all document attributes first.</p> - + ENTRY_KEY ENTRY_KEY '_key' @@ -8260,7 +8279,7 @@ declaring all document attributes first.</p> - + ENTRY_REV ENTRY_REV '_rev' @@ -8269,7 +8288,7 @@ declaring all document attributes first.</p> - + ENTRY_ISNEW ENTRY_ISNEW '_isNew' @@ -8278,16 +8297,16 @@ declaring all document attributes first.</p> - + ENTRY_HIDDEN ENTRY_HIDDEN '_hidden' - hidden atttribute index + hidden attribute index - + OPTION_WAIT_FOR_SYNC OPTION_WAIT_FOR_SYNC 'waitForSync' @@ -8296,7 +8315,7 @@ declaring all document attributes first.</p> - + OPTION_POLICY OPTION_POLICY 'policy' @@ -8305,7 +8324,7 @@ declaring all document attributes first.</p> - + OPTION_KEEPNULL OPTION_KEEPNULL 'keepNull' @@ -8391,7 +8410,7 @@ declaring all document attributes first.</p> - + __construct __construct @@ -8400,8 +8419,8 @@ declaring all document attributes first.</p> array - - void + + \triagens\ArangoDb\Document @@ -8410,7 +8429,7 @@ declaring all document attributes first.</p> array - + createFromArray createFromArray @@ -8440,7 +8459,7 @@ declaring all document attributes first.</p> array - + __clone __clone @@ -8451,7 +8470,7 @@ declaring all document attributes first.</p> - + __toString __toString @@ -8464,7 +8483,7 @@ declaring all document attributes first.</p> - + toJson toJson @@ -8483,7 +8502,7 @@ declaring all document attributes first.</p> - + toSerialized toSerialized @@ -8502,7 +8521,7 @@ declaring all document attributes first.</p> - + filterHiddenAttributes filterHiddenAttributes @@ -8521,7 +8540,7 @@ declaring all document attributes first.</p> - + set set @@ -8553,7 +8572,7 @@ exception if the value is invalid.</p> - + __set __set @@ -8585,7 +8604,7 @@ This function is mapped to set() internally.</p> - + get get @@ -8604,7 +8623,7 @@ This function is mapped to set() internally.</p> - + __get __get @@ -8623,7 +8642,7 @@ This function is mapped to set() internally.</p> - + getAll getAll @@ -8642,7 +8661,7 @@ This function is mapped to set() internally.</p> - + setHiddenAttributes setHiddenAttributes @@ -8661,7 +8680,7 @@ This function is mapped to set() internally.</p> array - + getHiddenAttributes getHiddenAttributes @@ -8672,7 +8691,7 @@ This function is mapped to set() internally.</p> - + setChanged setChanged @@ -8681,8 +8700,8 @@ This function is mapped to set() internally.</p> bool - - void + + bool @@ -8691,7 +8710,7 @@ This function is mapped to set() internally.</p> - + getChanged getChanged @@ -8702,7 +8721,7 @@ This function is mapped to set() internally.</p> - + setIsNew setIsNew @@ -8721,7 +8740,7 @@ This function is mapped to set() internally.</p> - + getIsNew getIsNew @@ -8732,7 +8751,7 @@ This function is mapped to set() internally.</p> - + setInternalId setInternalId @@ -8754,7 +8773,7 @@ This function is mapped to set() internally.</p> - + setInternalKey setInternalKey @@ -8776,19 +8795,19 @@ This function is mapped to set() internally.</p> - + getInternalId getInternalId Get the internal document id (if already known) <p>Document ids are generated on the server only. Document ids consist of collection id and -document id, in the format collectionid/documentid</p> +document id, in the format collectionId/documentId</p> string - + getInternalKey getInternalKey @@ -8799,19 +8818,19 @@ document id, in the format collectionid/documentid</p> - + getHandle getHandle Convenience function to get the document handle (if already known) - is an alias to getInternalId() <p>Document handles are generated on the server only. Document handles consist of collection id and -document id, in the format collectionid/documentid</p> +document id, in the format collectionId/documentId</p> string - + getId getId @@ -8823,7 +8842,7 @@ bigger than PHP_INT_MAX. To reliably store a document id elsewhere, a PHP string - + getKey getKey @@ -8834,7 +8853,7 @@ bigger than PHP_INT_MAX. To reliably store a document id elsewhere, a PHP string - + getCollectionId getCollectionId @@ -8846,7 +8865,7 @@ bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP stri - + setRevision setRevision @@ -8868,7 +8887,7 @@ To reliably store a document id elsewhere, a PHP string should be used</p> - + getRevision getRevision @@ -8881,24 +8900,24 @@ To reliably store a document id elsewhere, a PHP string should be used</p> - + ArangoDB PHP client: URL helper methods - + - + UrlHelper \triagens\ArangoDb\UrlHelper Some helper methods to construct and process URLs - + - + getDocumentIdFromLocation getDocumentIdFromLocation @@ -8917,7 +8936,7 @@ To reliably store a document id elsewhere, a PHP string should be used</p> - + getCollectionIdFromLocation getCollectionIdFromLocation @@ -8936,11 +8955,11 @@ To reliably store a document id elsewhere, a PHP string should be used</p> - + buildUrl buildUrl - Construct a URL from a base URL and additional parts, seperated with '/' each + Construct a URL from a base URL and additional parts, separated with '/' each <p>This function accepts variable arguments.</p> string @@ -8955,7 +8974,7 @@ To reliably store a document id elsewhere, a PHP string should be used</p> - + appendParamsUrl appendParamsUrl @@ -8982,7 +9001,7 @@ To reliably store a document id elsewhere, a PHP string should be used</p> array - + getBoolString getBoolString @@ -9003,22 +9022,22 @@ To reliably store a document id elsewhere, a PHP string should be used</p> - + ArangoDB PHP client: base handler - + - + Handler \triagens\ArangoDb\Handler A base class for REST-based handlers - + $_connection @@ -9031,7 +9050,7 @@ To reliably store a document id elsewhere, a PHP string should be used</p> - + __construct __construct @@ -9040,8 +9059,8 @@ To reliably store a document id elsewhere, a PHP string should be used</p> \triagens\ArangoDb\Connection - - void + + \triagens\ArangoDb\Handler @@ -9050,7 +9069,7 @@ To reliably store a document id elsewhere, a PHP string should be used</p> \triagens\ArangoDb\Connection - + getConnection getConnection @@ -9061,7 +9080,7 @@ To reliably store a document id elsewhere, a PHP string should be used</p> - + getConnectionOption getConnectionOption @@ -9079,14 +9098,14 @@ This is a convenience function that calls json_encode_wrapper on the connection< - + getCursorOptions getCursorOptions Return an array of cursor options - - bool + + mixed array @@ -9098,7 +9117,7 @@ This is a convenience function that calls json_encode_wrapper on the connection< - + json_encode_wrapper json_encode_wrapper @@ -9117,7 +9136,7 @@ This is a convenience function that calls json_encode_wrapper on the connection< - + validateAndIncludeOldSingleParameterInParams validateAndIncludeOldSingleParameterInParams @@ -9154,7 +9173,7 @@ This is only for options that are to be sent to the ArangoDB server.</p> - + includeOptionsInParams includeOptionsInParams @@ -9190,7 +9209,7 @@ This is only for options that are to be sent to the ArangoDB server in form of u - + includeOptionsInBody includeOptionsInBody @@ -9228,24 +9247,24 @@ This is only for options that are to be sent to the ArangoDB server in a json bo - + ArangoDB PHP client: single document - + - + \triagens\ArangoDb\Document Edge \triagens\ArangoDb\Edge Value object representing a single collection-based document - + - + ENTRY_FROM ENTRY_FROM '_from' @@ -9254,7 +9273,7 @@ This is only for options that are to be sent to the ArangoDB server in a json bo - + ENTRY_TO ENTRY_TO '_to' @@ -9285,7 +9304,7 @@ This is only for options that are to be sent to the ArangoDB server in a json bo - + __clone __clone @@ -9296,7 +9315,7 @@ This is only for options that are to be sent to the ArangoDB server in a json bo - + set set @@ -9329,7 +9348,7 @@ exception if the value is invalid.</p> - + getFrom getFrom @@ -9340,7 +9359,7 @@ exception if the value is invalid.</p> - + getTo getTo @@ -9351,7 +9370,7 @@ exception if the value is invalid.</p> - + setFrom setFrom @@ -9370,7 +9389,7 @@ exception if the value is invalid.</p> - + setTo setTo @@ -9391,16 +9410,16 @@ exception if the value is invalid.</p> - + ArangoDB PHP client: document handler - + - + \triagens\ArangoDb\DocumentHandler EdgeHandler \triagens\ArangoDb\EdgeHandler @@ -9409,9 +9428,9 @@ exception if the value is invalid.</p> persists them on the server. <p>It does so by issuing the appropriate HTTP requests to the server.</p> - + - + ENTRY_DOCUMENTS ENTRY_DOCUMENTS 'edge' @@ -9420,7 +9439,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_COLLECTION OPTION_COLLECTION 'collection' @@ -9429,7 +9448,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_EXAMPLE OPTION_EXAMPLE 'example' @@ -9438,7 +9457,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_FROM OPTION_FROM 'from' @@ -9447,7 +9466,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_TO OPTION_TO 'to' @@ -9456,7 +9475,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_VERTEX OPTION_VERTEX 'vertex' @@ -9465,7 +9484,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_DIRECTION OPTION_DIRECTION 'direction' @@ -9474,7 +9493,7 @@ appropriate HTTP requests to the server.</p> - + createFromArrayWithContext createFromArrayWithContext @@ -9482,8 +9501,8 @@ appropriate HTTP requests to the server.</p> - - \triagens\ArangoDb\Document + + \triagens\ArangoDb\Edge @@ -9497,7 +9516,7 @@ appropriate HTTP requests to the server.</p> - + add add @@ -9516,211 +9535,219 @@ appropriate HTTP requests to the server.</p> bool + + mixed + void + - + $collectionId - + $document \triagens\ArangoDb\Document - + $create null - + save save - + Just throw an exception if save() is called on edges. - - + + \triagens\ArangoDb\Exception - + mixed - + \triagens\ArangoDb\Document - + bool + + mixed + void + - + $collectionId - + $document - + $create null - + saveEdge saveEdge - + save an edge to an edge-collection <p>This will save the edge to the collection and return the edges-document's id</p> <p>This will throw if the document cannot be saved</p> - + \triagens\ArangoDb\Exception - + mixed - + mixed - + mixed - + mixed - + bool array - + mixed - + - + $collectionId - + $from - + $to - + $document - + $options array() - + edges edges - + Get edges for a given vertex - + \triagens\ArangoDb\Exception - + mixed - + mixed - + string - + array - + - + $collectionId - + $vertexHandle - + $direction 'any' - + inEdges inEdges - + Get inbound edges for a given vertex - + \triagens\ArangoDb\Exception - + mixed - + mixed - + array - + $collectionId - + $vertexHandle - + outEdges outEdges - + Get outbound edges for a given vertex - + \triagens\ArangoDb\Exception - + mixed - + mixed - + array - + $collectionId - + $vertexHandle @@ -9728,18 +9755,18 @@ appropriate HTTP requests to the server.</p> - + ArangoDB PHP client: autoloader - + - + Autoloader \triagens\ArangoDb\Autoloader @@ -9748,9 +9775,9 @@ appropriate HTTP requests to the server.</p> The autoloader can be nested with other autoloaders. <p>It will only process classes from its own namespace and ignore all others.</p> - + - + EXTENSION EXTENSION '.php' @@ -9770,7 +9797,7 @@ process classes from its own namespace and ignore all others.</p> - + init init @@ -9784,7 +9811,7 @@ process classes from its own namespace and ignore all others.</p> - + load load @@ -9805,7 +9832,7 @@ process classes from its own namespace and ignore all others.</p> - + checkEnvironment checkEnvironment @@ -9822,11 +9849,11 @@ Arango PHP client.</p> - + ArangoDB PHP client: connection - + @@ -9988,44 +10015,44 @@ Arango PHP client.</p> - + ArangoDB PHP client: single user document - + - + \triagens\ArangoDb\Document User \triagens\ArangoDb\User Value object representing a single User document - + - + ArangoDB PHP client: Base URLs - + - + Urls \triagens\ArangoDb\Urls Some basic URLs - + - + URL_DOCUMENT URL_DOCUMENT '/_api/document' @@ -10034,7 +10061,7 @@ Arango PHP client.</p> - + URL_EDGE URL_EDGE '/_api/edge' @@ -10043,7 +10070,7 @@ Arango PHP client.</p> - + URL_GRAPH URL_GRAPH '/_api/graph' @@ -10052,7 +10079,7 @@ Arango PHP client.</p> - + URLPART_VERTEX URLPART_VERTEX 'vertex' @@ -10061,7 +10088,7 @@ Arango PHP client.</p> - + URLPART_VERTICES URLPART_VERTICES 'vertices' @@ -10070,7 +10097,7 @@ Arango PHP client.</p> - + URLPART_EDGE URLPART_EDGE 'edge' @@ -10079,7 +10106,7 @@ Arango PHP client.</p> - + URLPART_EDGES URLPART_EDGES 'edges' @@ -10088,7 +10115,7 @@ Arango PHP client.</p> - + URL_COLLECTION URL_COLLECTION '/_api/collection' @@ -10097,7 +10124,7 @@ Arango PHP client.</p> - + URL_INDEX URL_INDEX '/_api/index' @@ -10106,7 +10133,7 @@ Arango PHP client.</p> - + URL_CURSOR URL_CURSOR '/_api/cursor' @@ -10115,7 +10142,7 @@ Arango PHP client.</p> - + URL_EXPLAIN URL_EXPLAIN '/_api/explain' @@ -10124,7 +10151,7 @@ Arango PHP client.</p> - + URL_QUERY URL_QUERY '/_api/query' @@ -10133,7 +10160,7 @@ Arango PHP client.</p> - + URL_EXAMPLE URL_EXAMPLE '/_api/simple/by-example' @@ -10142,7 +10169,7 @@ Arango PHP client.</p> - + URL_FIRST_EXAMPLE URL_FIRST_EXAMPLE '/_api/simple/first-example' @@ -10151,7 +10178,7 @@ Arango PHP client.</p> - + URL_ANY URL_ANY '/_api/simple/any' @@ -10160,7 +10187,7 @@ Arango PHP client.</p> - + URL_REMOVE_BY_EXAMPLE URL_REMOVE_BY_EXAMPLE '/_api/simple/remove-by-example' @@ -10169,7 +10196,7 @@ Arango PHP client.</p> - + URL_UPDATE_BY_EXAMPLE URL_UPDATE_BY_EXAMPLE '/_api/simple/update-by-example' @@ -10178,7 +10205,7 @@ Arango PHP client.</p> - + URL_REPLACE_BY_EXAMPLE URL_REPLACE_BY_EXAMPLE '/_api/simple/replace-by-example' @@ -10187,7 +10214,7 @@ Arango PHP client.</p> - + URL_IMPORT URL_IMPORT '/_api/import' @@ -10196,7 +10223,7 @@ Arango PHP client.</p> - + URL_RANGE URL_RANGE '/_api/simple/range' @@ -10205,7 +10232,7 @@ Arango PHP client.</p> - + URL_NEAR URL_NEAR '/_api/simple/near' @@ -10214,7 +10241,7 @@ Arango PHP client.</p> - + URL_WITHIN URL_WITHIN '/_api/simple/within' @@ -10223,7 +10250,7 @@ Arango PHP client.</p> - + URL_BATCH URL_BATCH '/_api/batch' @@ -10232,7 +10259,7 @@ Arango PHP client.</p> - + URL_TRANSACTION URL_TRANSACTION '/_api/transaction' @@ -10241,7 +10268,7 @@ Arango PHP client.</p> - + URL_ADMIN_VERSION URL_ADMIN_VERSION '/_admin/version' @@ -10250,7 +10277,7 @@ Arango PHP client.</p> - + URL_ADMIN_TIME URL_ADMIN_TIME '/_admin/time' @@ -10259,7 +10286,7 @@ Arango PHP client.</p> - + URL_ADMIN_LOG URL_ADMIN_LOG '/_admin/log' @@ -10268,82 +10295,73 @@ Arango PHP client.</p> - - URL_ADMIN_STATUS - URL_ADMIN_STATUS - '/_admin/status' - - base URL part for admin status - - - - + URL_ADMIN_ROUTING_RELOAD URL_ADMIN_ROUTING_RELOAD '/_admin/routing/reload' - + base URL part for admin routing reload - + URL_ADMIN_MODULES_FLUSH URL_ADMIN_MODULES_FLUSH '/_admin/modules/flush' - + base URL part for admin modules flush - + URL_ADMIN_STATISTICS URL_ADMIN_STATISTICS '/_admin/statistics' - + base URL part for admin statistics - + URL_ADMIN_STATISTICS_DESCRIPTION URL_ADMIN_STATISTICS_DESCRIPTION '/_admin/statistics-description' - + base URL part for admin statistics-description - + URL_AQL_USER_FUNCTION URL_AQL_USER_FUNCTION '/_api/aqlfunction' - + base URL part for AQL user functions statistics - + URL_USER URL_USER '/_api/user' - + base URL part for user management - + ArangoDB PHP client: admin document handler - + - + \triagens\ArangoDb\Handler AdminHandler \triagens\ArangoDb\AdminHandler @@ -10351,10 +10369,10 @@ Arango PHP client.</p> An admin handler that utilizes the ArangoDB's Admin API. <p>It does so by issuing the appropriate HTTP requests to the server.</p> - + - + OPTION_DETAILS OPTION_DETAILS "details" @@ -10363,7 +10381,7 @@ appropriate HTTP requests to the server.</p> - + getServerVersion getServerVersion @@ -10386,7 +10404,7 @@ appropriate HTTP requests to the server.</p> - + getServerTime getServerTime @@ -10401,7 +10419,7 @@ appropriate HTTP requests to the server.</p> - + getServerLog getServerLog @@ -10410,7 +10428,7 @@ appropriate HTTP requests to the server.</p> \triagens\ArangoDb\Exception - + array @@ -10424,59 +10442,44 @@ appropriate HTTP requests to the server.</p> - - getServerStatus - getServerStatus - - Get the server status - <p>This will throw if the status cannot be retrieved</p> - - \triagens\ArangoDb\Exception - - - array - - - - - + flushServerModuleCache flushServerModuleCache - + Flush the server's modules cache The call triggers a flush of the modules cache on the server. <p>See Modules Cache for details about this cache.</p> <p>This will throw if the modules cache cannot be flushed</p> - + \triagens\ArangoDb\Exception - + array - + - + reloadServerRouting reloadServerRouting - + Reload the server's routing information The call triggers a reload of the routing information from the _routing collection <p>This will throw if the routing cannot be reloaded</p> - + \triagens\ArangoDb\Exception - + array - + - + getServerStatistics getServerStatistics - + Get the server statistics Returns the statistics information. <p>The returned objects contains the statistics figures, grouped together @@ -10486,39 +10489,39 @@ describing the group stored in system and in that sub-object the value for userT 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</p> - - + + \triagens\ArangoDb\Exception - + array - - + + - + getServerStatisticsDescription getServerStatisticsDescription - + Returns a description of the statistics returned by getServerStatistics(). <p>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</p> - - + + \triagens\ArangoDb\Exception - + array - + array - - + + - + $options array() @@ -10526,15 +10529,15 @@ For more information on the statistics returned, please lookup the statistics in - + ArangoDB PHP client: result set cursor - + - + \Iterator Cursor @@ -10546,9 +10549,9 @@ For more information on the statistics returned, please lookup the statistics in <p>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.</p> - + - + ENTRY_ID ENTRY_ID 'id' @@ -10557,7 +10560,7 @@ remaining results from the server.</p> - + ENTRY_HASMORE ENTRY_HASMORE 'hasMore' @@ -10566,7 +10569,7 @@ remaining results from the server.</p> - + ENTRY_RESULT ENTRY_RESULT 'result' @@ -10575,7 +10578,7 @@ remaining results from the server.</p> - + ENTRY_SANITIZE ENTRY_SANITIZE '_sanitize' @@ -10584,7 +10587,7 @@ remaining results from the server.</p> - + ENTRY_FLAT ENTRY_FLAT '_flat' @@ -10670,7 +10673,7 @@ remaining results from the server.</p> - + __construct __construct @@ -10685,8 +10688,8 @@ remaining results from the server.</p> array - - void + + \triagens\ArangoDb\Cursor @@ -10705,7 +10708,7 @@ remaining results from the server.</p> array - + delete delete @@ -10720,7 +10723,7 @@ the deletion.</p> - + getCount getCount @@ -10735,7 +10738,7 @@ results from the server</p> - + getAll getAll @@ -10750,7 +10753,7 @@ results from the server</p> - + rewind rewind @@ -10761,7 +10764,7 @@ results from the server</p> - + current current @@ -10772,7 +10775,7 @@ results from the server</p> - + key key @@ -10783,7 +10786,7 @@ results from the server</p> - + next next @@ -10794,7 +10797,7 @@ results from the server</p> - + valid valid @@ -10809,7 +10812,7 @@ results from the server</p> - + add add @@ -10828,7 +10831,7 @@ results from the server</p> array - + addFlatFromArray addFlatFromArray @@ -10847,7 +10850,7 @@ results from the server</p> - + addDocumentsFromArray addDocumentsFromArray @@ -10866,7 +10869,7 @@ results from the server</p> array - + addEdgesFromArray addEdgesFromArray @@ -10885,7 +10888,7 @@ results from the server</p> array - + addVerticesFromArray addVerticesFromArray @@ -10904,7 +10907,7 @@ results from the server</p> array - + sanitize sanitize @@ -10924,7 +10927,7 @@ results from the server</p> array - + fetchOutstanding fetchOutstanding @@ -10938,7 +10941,7 @@ results from the server</p> - + updateLength updateLength @@ -10949,7 +10952,7 @@ results from the server</p> - + getMetadata getMetadata @@ -10962,17 +10965,17 @@ results from the server</p> - + ArangoDB PHP client: graph handler - + - + \triagens\ArangoDb\Handler GraphHandler \triagens\ArangoDb\GraphHandler @@ -10980,10 +10983,10 @@ results from the server</p> A graph handler that manages graphs. <p>It does so by issuing the appropriate HTTP requests to the server.</p> - + - + ENTRY_GRAPH ENTRY_GRAPH 'graph' @@ -10992,7 +10995,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_REVISION OPTION_REVISION 'revision' @@ -11001,7 +11004,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_VERTICES OPTION_VERTICES 'vertices' @@ -11010,7 +11013,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_EDGES OPTION_EDGES 'edges' @@ -11019,7 +11022,7 @@ appropriate HTTP requests to the server.</p> - + OPTION_KEY OPTION_KEY '_key' @@ -11028,7 +11031,7 @@ appropriate HTTP requests to the server.</p> - + KEY_FROM KEY_FROM '_from' @@ -11037,7 +11040,7 @@ appropriate HTTP requests to the server.</p> - + KEY_TO KEY_TO '_to' @@ -11046,7 +11049,7 @@ appropriate HTTP requests to the server.</p> - + createGraph createGraph @@ -11073,7 +11076,7 @@ appropriate HTTP requests to the server.</p> \triagens\ArangoDb\Graph - + getGraph getGraph @@ -11108,7 +11111,7 @@ appropriate HTTP requests to the server.</p> array - + dropGraph dropGraph @@ -11131,7 +11134,7 @@ appropriate HTTP requests to the server.</p> - + properties properties @@ -11154,7 +11157,7 @@ appropriate HTTP requests to the server.</p> - + saveVertex saveVertex @@ -11187,7 +11190,7 @@ appropriate HTTP requests to the server.</p> - + getVertex getVertex @@ -11226,7 +11229,7 @@ appropriate HTTP requests to the server.</p> array - + ReplaceVertex ReplaceVertex @@ -11235,7 +11238,7 @@ appropriate HTTP requests to the server.</p> <p>This will throw if the vertex cannot be Replaced</p> -<p>If policy is set to error (locally or globally through the connectionoptions) +<p>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.</p> @@ -11250,7 +11253,7 @@ that the revision of the to-be-replaced vertex is the same as the one given.< \triagens\ArangoDb\Document - + mixed @@ -11279,7 +11282,7 @@ that the revision of the to-be-replaced vertex is the same as the one given.< - + updateVertex updateVertex @@ -11288,7 +11291,7 @@ that the revision of the to-be-replaced vertex is the same as the one given.< <p>This will throw if the vertex cannot be updated</p> -<p>If policy is set to error (locally or globally through the connectionoptions) +<p>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.</p> @@ -11332,7 +11335,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + removeVertex removeVertex @@ -11379,7 +11382,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + saveEdge saveEdge @@ -11436,7 +11439,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + getEdge getEdge @@ -11475,7 +11478,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l array - + ReplaceEdge ReplaceEdge @@ -11484,7 +11487,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l <p>This will throw if the edge cannot be Replaced</p> -<p>If policy is set to error (locally or globally through the connectionoptions) +<p>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.</p> @@ -11496,7 +11499,7 @@ that the revision of the to-be-replaced edge is the same as the one given.</p mixed - + mixed @@ -11536,7 +11539,7 @@ that the revision of the to-be-replaced edge is the same as the one given.</p - + updateEdge updateEdge @@ -11545,7 +11548,7 @@ that the revision of the to-be-replaced edge is the same as the one given.</p <p>This will throw if the edge cannot be updated</p> -<p>If policy is set to error (locally or globally through the connectionoptions) +<p>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.</p> @@ -11557,7 +11560,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l mixed - + mixed @@ -11597,7 +11600,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + removeEdge removeEdge @@ -11644,7 +11647,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + getNeighborVertices getNeighborVertices @@ -11659,7 +11662,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l mixed - + bool array @@ -11683,7 +11686,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l - + getConnectedEdges getConnectedEdges @@ -11698,7 +11701,7 @@ that the revision of the to-be-replaced document is the same as the one given.&l mixed - + bool array @@ -11724,7 +11727,6 @@ that the revision of the to-be-replaced document is the same as the one given.&l - diff --git a/lib/triagens/ArangoDb/AdminHandler.php b/lib/triagens/ArangoDb/AdminHandler.php index c76d6fab..faa40714 100644 --- a/lib/triagens/ArangoDb/AdminHandler.php +++ b/lib/triagens/ArangoDb/AdminHandler.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: admin document handler * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @author Frank Mayer * @copyright Copyright 2012, triagens GmbH, Cologne, Germany @@ -16,7 +16,7 @@ * An admin handler that utilizes the ArangoDB's Admin API. It does so by issuing the * appropriate HTTP requests to the server. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @since 1.2 */ diff --git a/lib/triagens/ArangoDb/Autoloader.php b/lib/triagens/ArangoDb/Autoloader.php index e69ae622..199510a5 100644 --- a/lib/triagens/ArangoDb/Autoloader.php +++ b/lib/triagens/ArangoDb/Autoloader.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: autoloader * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -15,7 +15,7 @@ * The autoloader can be nested with other autoloaders. It will only * process classes from its own namespace and ignore all others. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class Autoloader { diff --git a/lib/triagens/ArangoDb/Batch.php b/lib/triagens/ArangoDb/Batch.php index 7ff1018b..5b742e78 100644 --- a/lib/triagens/ArangoDb/Batch.php +++ b/lib/triagens/ArangoDb/Batch.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: batch * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer * @since 1.1 * @@ -14,7 +14,7 @@ /** * Provides batching functionality * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @example ArangoDb/examples/batch.php * */ diff --git a/lib/triagens/ArangoDb/BatchPart.php b/lib/triagens/ArangoDb/BatchPart.php index e06c02e2..eb68a97f 100644 --- a/lib/triagens/ArangoDb/BatchPart.php +++ b/lib/triagens/ArangoDb/BatchPart.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: batchpart * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer * @since 1.1 * @@ -14,7 +14,7 @@ /** * Provides batch part functionality * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * */ diff --git a/lib/triagens/ArangoDb/BindVars.php b/lib/triagens/ArangoDb/BindVars.php index 9e367f00..8b7575f8 100644 --- a/lib/triagens/ArangoDb/BindVars.php +++ b/lib/triagens/ArangoDb/BindVars.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: bind variables * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -14,7 +14,7 @@ * A simple container for bind variables * This container also handles validation of the bind values. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class BindVars { diff --git a/lib/triagens/ArangoDb/ClientException.php b/lib/triagens/ArangoDb/ClientException.php index 59c9ba51..c45f9981 100644 --- a/lib/triagens/ArangoDb/ClientException.php +++ b/lib/triagens/ArangoDb/ClientException.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: client exception * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -14,7 +14,7 @@ * 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. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class ClientException extends Exception diff --git a/lib/triagens/ArangoDb/Collection.php b/lib/triagens/ArangoDb/Collection.php index f3c2ec11..be2390fc 100644 --- a/lib/triagens/ArangoDb/Collection.php +++ b/lib/triagens/ArangoDb/Collection.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: single collection * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -13,7 +13,7 @@ /** * Value object representing a collection * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class Collection { diff --git a/lib/triagens/ArangoDb/CollectionHandler.php b/lib/triagens/ArangoDb/CollectionHandler.php index 2a7159c0..1e99549b 100644 --- a/lib/triagens/ArangoDb/CollectionHandler.php +++ b/lib/triagens/ArangoDb/CollectionHandler.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: collection handler * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -15,7 +15,7 @@ * creates collections on the server. It does so by issuing the * appropriate HTTP requests to the server. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class CollectionHandler extends Handler diff --git a/lib/triagens/ArangoDb/ConnectException.php b/lib/triagens/ArangoDb/ConnectException.php index 95b3cf08..9fc74edf 100644 --- a/lib/triagens/ArangoDb/ConnectException.php +++ b/lib/triagens/ArangoDb/ConnectException.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: connect exception * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -14,7 +14,7 @@ * This exception type will be thrown by the client when there is an error * during connecting to the server * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class ConnectException extends Exception diff --git a/lib/triagens/ArangoDb/Connection.php b/lib/triagens/ArangoDb/Connection.php index d65de05f..786005be 100644 --- a/lib/triagens/ArangoDb/Connection.php +++ b/lib/triagens/ArangoDb/Connection.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: connection * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -17,7 +17,7 @@ * Instead, connections are established on the fly for each request * and are destroyed afterwards. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class Connection { diff --git a/lib/triagens/ArangoDb/ConnectionOptions.php b/lib/triagens/ArangoDb/ConnectionOptions.php index e1d52a1c..e3850e91 100644 --- a/lib/triagens/ArangoDb/ConnectionOptions.php +++ b/lib/triagens/ArangoDb/ConnectionOptions.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: connection options * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -16,7 +16,7 @@ * options and will perform a simple validation of them. * It provides array access to its members. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class ConnectionOptions implements \ArrayAccess diff --git a/lib/triagens/ArangoDb/Cursor.php b/lib/triagens/ArangoDb/Cursor.php index 93cb708a..d816761d 100644 --- a/lib/triagens/ArangoDb/Cursor.php +++ b/lib/triagens/ArangoDb/Cursor.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: result set cursor * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -19,7 +19,7 @@ * cursor might issue additional HTTP requests to fetch the * remaining results from the server. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class Cursor implements \Iterator diff --git a/lib/triagens/ArangoDb/DefaultValues.php b/lib/triagens/ArangoDb/DefaultValues.php index db0e5c3d..b4e48fed 100644 --- a/lib/triagens/ArangoDb/DefaultValues.php +++ b/lib/triagens/ArangoDb/DefaultValues.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: default values * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -13,7 +13,7 @@ /** * Contains default values used by the client * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ abstract class DefaultValues { diff --git a/lib/triagens/ArangoDb/Document.php b/lib/triagens/ArangoDb/Document.php index 3b30d040..a95a0dcb 100644 --- a/lib/triagens/ArangoDb/Document.php +++ b/lib/triagens/ArangoDb/Document.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: single document * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -13,7 +13,7 @@ /** * Value object representing a single collection-based document * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class Document { diff --git a/lib/triagens/ArangoDb/DocumentHandler.php b/lib/triagens/ArangoDb/DocumentHandler.php index c3a4d2ea..301ad756 100644 --- a/lib/triagens/ArangoDb/DocumentHandler.php +++ b/lib/triagens/ArangoDb/DocumentHandler.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: document handler * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @author Frank Mayer * @copyright Copyright 2012, triagens GmbH, Cologne, Germany @@ -17,7 +17,7 @@ * persists them on the server. It does so by issuing the * appropriate HTTP requests to the server. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class DocumentHandler extends Handler diff --git a/lib/triagens/ArangoDb/Edge.php b/lib/triagens/ArangoDb/Edge.php index c1e93a92..3a4eb4b8 100644 --- a/lib/triagens/ArangoDb/Edge.php +++ b/lib/triagens/ArangoDb/Edge.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: single document * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -13,7 +13,7 @@ /** * Value object representing a single collection-based document * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class Edge extends Document diff --git a/lib/triagens/ArangoDb/EdgeHandler.php b/lib/triagens/ArangoDb/EdgeHandler.php index 9ea87b91..f384a679 100644 --- a/lib/triagens/ArangoDb/EdgeHandler.php +++ b/lib/triagens/ArangoDb/EdgeHandler.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: document handler * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @author Frank Mayer * @copyright Copyright 2012, triagens GmbH, Cologne, Germany @@ -16,7 +16,7 @@ * persists them on the server. It does so by issuing the * appropriate HTTP requests to the server. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class EdgeHandler extends DocumentHandler diff --git a/lib/triagens/ArangoDb/Endpoint.php b/lib/triagens/ArangoDb/Endpoint.php index d961df48..d24261bc 100644 --- a/lib/triagens/ArangoDb/Endpoint.php +++ b/lib/triagens/ArangoDb/Endpoint.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: endpoint * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -21,7 +21,7 @@ * * Note: SSL support is added in ArangoDB server 1.1 * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class Endpoint { diff --git a/lib/triagens/ArangoDb/Exception.php b/lib/triagens/ArangoDb/Exception.php index b7962dc8..4d3ddc92 100644 --- a/lib/triagens/ArangoDb/Exception.php +++ b/lib/triagens/ArangoDb/Exception.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: exception base class * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -13,7 +13,7 @@ /** * Exception base class used to throw Arango specific exceptions * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class Exception extends \Exception diff --git a/lib/triagens/ArangoDb/Graph.php b/lib/triagens/ArangoDb/Graph.php index 71115dfc..3dd50985 100644 --- a/lib/triagens/ArangoDb/Graph.php +++ b/lib/triagens/ArangoDb/Graph.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: single document * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany * @@ -15,7 +15,7 @@ /** * Value object representing a graph * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * * @since 1.2 */ diff --git a/lib/triagens/ArangoDb/GraphHandler.php b/lib/triagens/ArangoDb/GraphHandler.php index 5e090876..d11a2efe 100644 --- a/lib/triagens/ArangoDb/GraphHandler.php +++ b/lib/triagens/ArangoDb/GraphHandler.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: graph handler * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @author Frank Mayer * @copyright Copyright 2012, triagens GmbH, Cologne, Germany @@ -18,7 +18,7 @@ * It does so by issuing the * appropriate HTTP requests to the server. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @since 1.2 */ class GraphHandler extends diff --git a/lib/triagens/ArangoDb/Handler.php b/lib/triagens/ArangoDb/Handler.php index 79ef3cd9..bfbdba68 100644 --- a/lib/triagens/ArangoDb/Handler.php +++ b/lib/triagens/ArangoDb/Handler.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: base handler * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -13,7 +13,7 @@ /** * A base class for REST-based handlers * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ abstract class Handler { diff --git a/lib/triagens/ArangoDb/HttpHelper.php b/lib/triagens/ArangoDb/HttpHelper.php index e42397cd..b1d4da27 100644 --- a/lib/triagens/ArangoDb/HttpHelper.php +++ b/lib/triagens/ArangoDb/HttpHelper.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: http helper methods * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -13,7 +13,7 @@ /** * Helper methods for HTTP request/response handling * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class HttpHelper { diff --git a/lib/triagens/ArangoDb/HttpResponse.php b/lib/triagens/ArangoDb/HttpResponse.php index 9faa3109..c98c4354 100644 --- a/lib/triagens/ArangoDb/HttpResponse.php +++ b/lib/triagens/ArangoDb/HttpResponse.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: HTTP response * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -13,7 +13,7 @@ /** * Container class for HTTP responses * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class HttpResponse { diff --git a/lib/triagens/ArangoDb/Scope.php b/lib/triagens/ArangoDb/Scope.php index 343808ff..a80b4088 100644 --- a/lib/triagens/ArangoDb/Scope.php +++ b/lib/triagens/ArangoDb/Scope.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: scope * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -14,7 +14,7 @@ * Executes a function on scope entry and executes another function * (cleanup) when the scope is exited * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class Scope { diff --git a/lib/triagens/ArangoDb/ServerException.php b/lib/triagens/ArangoDb/ServerException.php index 15810899..81d2fc97 100644 --- a/lib/triagens/ArangoDb/ServerException.php +++ b/lib/triagens/ArangoDb/ServerException.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: server exception * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -19,7 +19,7 @@ * about the error, these details can be queried using the * getDetails() function. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class ServerException extends Exception diff --git a/lib/triagens/ArangoDb/Statement.php b/lib/triagens/ArangoDb/Statement.php index fce84a03..fd40eb44 100644 --- a/lib/triagens/ArangoDb/Statement.php +++ b/lib/triagens/ArangoDb/Statement.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: statement * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -37,7 +37,7 @@ * - use the "_flat" option for the statement to indicate that you don't want * to treat the statement result as a list of documents, but as a flat list * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class Statement { diff --git a/lib/triagens/ArangoDb/TraceRequest.php b/lib/triagens/ArangoDb/TraceRequest.php index c46b6a07..98f00560 100644 --- a/lib/triagens/ArangoDb/TraceRequest.php +++ b/lib/triagens/ArangoDb/TraceRequest.php @@ -2,7 +2,7 @@ /** * ArangoDB PHP client: connection * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @author Francis Chuang * @copyright Copyright 2012, triagens GmbH, Cologne, Germany diff --git a/lib/triagens/ArangoDb/TraceResponse.php b/lib/triagens/ArangoDb/TraceResponse.php index 23860334..675e99b5 100644 --- a/lib/triagens/ArangoDb/TraceResponse.php +++ b/lib/triagens/ArangoDb/TraceResponse.php @@ -2,7 +2,7 @@ /** * ArangoDB PHP client: connection * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @author Francis Chuang * @copyright Copyright 2012, triagens GmbH, Cologne, Germany diff --git a/lib/triagens/ArangoDb/Transaction.php b/lib/triagens/ArangoDb/Transaction.php index 22f85fcf..dfac6e8f 100644 --- a/lib/triagens/ArangoDb/Transaction.php +++ b/lib/triagens/ArangoDb/Transaction.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: transaction * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer * @copyright Copyright 2013, triagens GmbH, Cologne, Germany */ @@ -48,7 +48,7 @@ * @property bool $waitForSync - WaitForSync on the transaction * @property int $lockTimeout - LockTimeout on the transaction * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class Transaction { diff --git a/lib/triagens/ArangoDb/UpdatePolicy.php b/lib/triagens/ArangoDb/UpdatePolicy.php index 436c84ba..22af8758 100644 --- a/lib/triagens/ArangoDb/UpdatePolicy.php +++ b/lib/triagens/ArangoDb/UpdatePolicy.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: update policies * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -13,7 +13,7 @@ /** * Document update policies * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class UpdatePolicy { diff --git a/lib/triagens/ArangoDb/UrlHelper.php b/lib/triagens/ArangoDb/UrlHelper.php index 735f0550..348deb91 100644 --- a/lib/triagens/ArangoDb/UrlHelper.php +++ b/lib/triagens/ArangoDb/UrlHelper.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: URL helper methods * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -13,7 +13,7 @@ /** * Some helper methods to construct and process URLs * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ abstract class UrlHelper { diff --git a/lib/triagens/ArangoDb/Urls.php b/lib/triagens/ArangoDb/Urls.php index 35ae5f71..a5b24076 100644 --- a/lib/triagens/ArangoDb/Urls.php +++ b/lib/triagens/ArangoDb/Urls.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: Base URLs * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -13,7 +13,7 @@ /** * Some basic URLs * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ abstract class Urls { diff --git a/lib/triagens/ArangoDb/User.php b/lib/triagens/ArangoDb/User.php index a544687a..a083a54e 100644 --- a/lib/triagens/ArangoDb/User.php +++ b/lib/triagens/ArangoDb/User.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: single user document * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer * @since 1.2 */ @@ -13,7 +13,7 @@ /** * Value object representing a single User document * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @since 1.2 */ class User extends diff --git a/lib/triagens/ArangoDb/UserHandler.php b/lib/triagens/ArangoDb/UserHandler.php index 12e208ec..de21dbce 100644 --- a/lib/triagens/ArangoDb/UserHandler.php +++ b/lib/triagens/ArangoDb/UserHandler.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: user document handler * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer * @since 1.2 */ @@ -15,7 +15,7 @@ * persists them on the server. It does so by issuing the * appropriate HTTP requests to the server. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @since 1.2 */ class UserHandler extends diff --git a/lib/triagens/ArangoDb/ValueValidator.php b/lib/triagens/ArangoDb/ValueValidator.php index 3fbc4233..b7f54fcc 100644 --- a/lib/triagens/ArangoDb/ValueValidator.php +++ b/lib/triagens/ArangoDb/ValueValidator.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: value validator * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @copyright Copyright 2012, triagens GmbH, Cologne, Germany */ @@ -13,7 +13,7 @@ /** * A simple validator for values to be stored in the database * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb */ class ValueValidator { diff --git a/lib/triagens/ArangoDb/Vertex.php b/lib/triagens/ArangoDb/Vertex.php index ca1f0c32..321facd7 100644 --- a/lib/triagens/ArangoDb/Vertex.php +++ b/lib/triagens/ArangoDb/Vertex.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: single vertex document * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @author Frank Mayer * @copyright Copyright 2012, triagens GmbH, Cologne, Germany @@ -15,7 +15,7 @@ /** * Value object representing a single vertex document * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @since 1.2 */ class Vertex extends diff --git a/lib/triagens/ArangoDb/VertexHandler.php b/lib/triagens/ArangoDb/VertexHandler.php index 0a509153..ed733f50 100644 --- a/lib/triagens/ArangoDb/VertexHandler.php +++ b/lib/triagens/ArangoDb/VertexHandler.php @@ -3,7 +3,7 @@ /** * ArangoDB PHP client: vertex document handler * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Jan Steemann * @author Frank Mayer * @copyright Copyright 2012, triagens GmbH, Cologne, Germany @@ -17,7 +17,7 @@ * persists them on the server. It does so by issuing the * appropriate HTTP requests to the server. * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @since 1.2 */ class VertexHandler extends diff --git a/tests/AdminTest.php b/tests/AdminTest.php index 43c74e18..e770462e 100644 --- a/tests/AdminTest.php +++ b/tests/AdminTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: AdminTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/AqlUserFunctionTest.php b/tests/AqlUserFunctionTest.php index 6178a705..392d6acb 100644 --- a/tests/AqlUserFunctionTest.php +++ b/tests/AqlUserFunctionTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: AqlUserFunction.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/BatchTest.php b/tests/BatchTest.php index 74191234..c5584dfd 100644 --- a/tests/BatchTest.php +++ b/tests/BatchTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: BatchTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/CollectionBasicTest.php b/tests/CollectionBasicTest.php index 4f61ae3e..69bce5a7 100644 --- a/tests/CollectionBasicTest.php +++ b/tests/CollectionBasicTest.php @@ -4,7 +4,7 @@ * ArangoDB PHP client testsuite * File: CollectionBasicTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/CollectionExtendedTest.php b/tests/CollectionExtendedTest.php index 403423ec..da7cfa96 100644 --- a/tests/CollectionExtendedTest.php +++ b/tests/CollectionExtendedTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: CollectionExtendedTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/ConnectionTest.php b/tests/ConnectionTest.php index 166ed4c0..2928de54 100644 --- a/tests/ConnectionTest.php +++ b/tests/ConnectionTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: ConnectionTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/DocumentBasicTest.php b/tests/DocumentBasicTest.php index d8727dac..053a7d35 100644 --- a/tests/DocumentBasicTest.php +++ b/tests/DocumentBasicTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: DocumentBasicTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/DocumentExtendedTest.php b/tests/DocumentExtendedTest.php index 9123369a..9d20514d 100644 --- a/tests/DocumentExtendedTest.php +++ b/tests/DocumentExtendedTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: DocumentExtendedTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/EdgeBasicTest.php b/tests/EdgeBasicTest.php index 8d5575c9..98af6c1a 100644 --- a/tests/EdgeBasicTest.php +++ b/tests/EdgeBasicTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: EdgeBasicTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/EdgeExtendedTest.php b/tests/EdgeExtendedTest.php index 5896b28a..2460566b 100644 --- a/tests/EdgeExtendedTest.php +++ b/tests/EdgeExtendedTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: EdgeExtendedTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/GraphBasicTest.php b/tests/GraphBasicTest.php index aa4325a0..8a2251ce 100644 --- a/tests/GraphBasicTest.php +++ b/tests/GraphBasicTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: GraphBasicTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/GraphExtendedTest.php b/tests/GraphExtendedTest.php index 20fd9a95..27f9177d 100644 --- a/tests/GraphExtendedTest.php +++ b/tests/GraphExtendedTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: GraphExtendedTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/StatementTest.php b/tests/StatementTest.php index e9504bec..50914c76 100644 --- a/tests/StatementTest.php +++ b/tests/StatementTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: StatementTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/TransactionTest.php b/tests/TransactionTest.php index fa44e8da..984dfd79 100644 --- a/tests/TransactionTest.php +++ b/tests/TransactionTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: TransactionTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/UserBasicTest.php b/tests/UserBasicTest.php index 65a7d9d1..2a5bcbbc 100644 --- a/tests/UserBasicTest.php +++ b/tests/UserBasicTest.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: UserBasicTest.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */ diff --git a/tests/bootstrap.php b/tests/bootstrap.php index 352d812f..76a203fd 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -3,7 +3,7 @@ * ArangoDB PHP client testsuite * File: bootstrap.php * - * @package ArangoDbPhpClient + * @package triagens\ArangoDb * @author Frank Mayer */