Location: PHPKode > projects > ArangoDB-PHP > ArangoDB-PHP-1.3.0/docs/structure.xml
<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a12" title="ArangoDB PHP client API">
  <file path="ValueValidator.php" hash="a612a17bbb9122be7cbbecfa3195fe02" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: value validator</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Jan Steemann"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="18" package="triagens\ArangoDb">
      <extends/>
      <name>ValueValidator</name>
      <full_name>\triagens\ArangoDb\ValueValidator</full_name>
      <docblock line="13">
        <description>A simple validator for values to be stored in the database</description>
        <long-description></long-description>
        <tag line="13" name="package" description="triagens\ArangoDb"/>
      </docblock>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="31" package="triagens\ArangoDb">
        <name>validate</name>
        <full_name>validate</full_name>
        <docblock line="20">
          <description>Validate the value of a variable</description>
          <long-description>&lt;p&gt;Allowed value types are string, integer, double and boolean. Arrays are also allowed if they contain only one of the former types.&lt;/p&gt;</long-description>
          <tag line="20" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="20" name="param" description="- value to validate" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="20" name="return" description="- will throw if an invalid value type is passed" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="31">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="Batch.php" hash="5d76e1c15b46f28034b240dacb46ac61" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: batch</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Frank Mayer"/>
      <tag line="3" name="since" description="1.1"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="23" package="triagens\ArangoDb">
      <extends/>
      <name>Batch</name>
      <full_name>\triagens\ArangoDb\Batch</full_name>
      <docblock line="14">
        <description>Provides batching functionality</description>
        <long-description></long-description>
        <tag line="14" name="package" description="triagens\ArangoDb"/>
        <tag line="14" name="example" description="ArangoDb/examples/batch.php"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="30" namespace="triagens\ArangoDb" package="Default">
        <name>$_batchResponse</name>
        <default></default>
        <docblock line="25">
          <description>Batch Response Object</description>
          <long-description></long-description>
          <tag line="25" name="var" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="38" namespace="triagens\ArangoDb" package="Default">
        <name>$_processed</name>
        <default>false</default>
        <docblock line="33">
          <description>Flag that signals if this batch was processed or not.</description>
          <long-description>&lt;p&gt;Processed =&gt; true ,or not processed =&gt; false&lt;/p&gt;</long-description>
          <tag line="33" name="var" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="46" namespace="triagens\ArangoDb" package="Default">
        <name>$_batchParts</name>
        <default>array()</default>
        <docblock line="41">
          <description>The array of BatchPart objects</description>
          <long-description></long-description>
          <tag line="41" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="54" namespace="triagens\ArangoDb" package="Default">
        <name>$_nextBatchPartId</name>
        <default>null</default>
        <docblock line="49">
          <description>The array of BatchPart objects</description>
          <long-description></long-description>
          <tag line="49" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="62" namespace="triagens\ArangoDb" package="Default">
        <name>$_batchPartCursorOptions</name>
        <default>array()</default>
        <docblock line="57">
          <description>An array of BatchPartCursor options</description>
          <long-description></long-description>
          <tag line="57" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="70" namespace="triagens\ArangoDb" package="Default">
        <name>$_connection</name>
        <default>null</default>
        <docblock line="65">
          <description>The connection object</description>
          <long-description></long-description>
          <tag line="65" name="var" description="" type="\triagens\ArangoDb\Connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="77" namespace="triagens\ArangoDb" package="Default">
        <name>$_sanitize</name>
        <default>false</default>
        <docblock line="72">
          <description>The sanitize default value</description>
          <long-description></long-description>
          <tag line="72" name="var" description="" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="95" package="triagens\ArangoDb">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="80">
          <description>Constructor for Batch instance.</description>
          <long-description>&lt;p&gt;Batch instance by default starts capturing request after initiated.
To disable this, pass startCapture=&gt;false inside the options array parameter&lt;/p&gt;</long-description>
          <tag line="80" name="param" description="that this batch class will monitor for requests in order to batch them. Connection parameter is mandatory." type="\triagens\ArangoDb\Connection" variable="$connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
          <tag line="80" name="param" description="An array of options for Batch construction. See below for options:&#10;&lt;p&gt;Options are :&#10;&lt;li&gt;'_sanitize' - True to remove _id and _rev attributes from result documents returned from this batch. Defaults to false.&lt;/li&gt;&#10;&lt;li&gt;'$startCapture' - Start batch capturing immediately after batch instantiation. Defaults to true.&#10;&lt;/li&gt;&#10;&lt;/p&gt;" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="80" name="return" description="" type="\triagens\ArangoDb\Batch">
            <type by_reference="false">\triagens\ArangoDb\Batch</type>
          </tag>
        </docblock>
        <argument line="95">
          <name>$connection</name>
          <default></default>
          <type>\triagens\ArangoDb\Connection</type>
        </argument>
        <argument line="95">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="123" package="triagens\ArangoDb">
        <name>setConnection</name>
        <full_name>setConnection</full_name>
        <docblock line="116">
          <description>Sets the connection for he current batch.</description>
          <long-description>&lt;p&gt;(mostly internal function)&lt;/p&gt;</long-description>
          <tag line="116" name="param" description="" type="\triagens\ArangoDb\Connection" variable="$connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
          <tag line="116" name="return" description="" type="\triagens\ArangoDb\Batch">
            <type by_reference="false">\triagens\ArangoDb\Batch</type>
          </tag>
        </docblock>
        <argument line="123">
          <name>$connection</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="141" package="triagens\ArangoDb">
        <name>startCapture</name>
        <full_name>startCapture</full_name>
        <docblock line="131">
          <description>Start capturing requests.</description>
          <long-description>&lt;p&gt;To stop capturing, use stopCapture()&lt;/p&gt;

&lt;p&gt;see triagens\ArangoDb\Batch::stopCapture()&lt;/p&gt;</long-description>
          <tag line="131" name="param" description="" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="131" name="return" description="" type="\triagens\ArangoDb\Batch">
            <type by_reference="false">\triagens\ArangoDb\Batch</type>
          </tag>
        </docblock>
        <argument line="141">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="157" package="triagens\ArangoDb">
        <name>stopCapture</name>
        <full_name>stopCapture</full_name>
        <docblock line="149">
          <description>Stop capturing requests.</description>
          <long-description>&lt;p&gt;If the batch has not been processed yet, more requests can be appended by calling startCapture() again.&lt;/p&gt;

&lt;p&gt;see Batch::startCapture()&lt;/p&gt;</long-description>
          <tag line="149" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="149" name="return" description="" type="\triagens\ArangoDb\Batch">
            <type by_reference="false">\triagens\ArangoDb\Batch</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="175" package="triagens\ArangoDb">
        <name>isActive</name>
        <full_name>isActive</full_name>
        <docblock line="170">
          <description>Returns true, if this batch is active in its associated connection.</description>
          <long-description></long-description>
          <tag line="170" name="return" description="" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="189" package="triagens\ArangoDb">
        <name>isCapturing</name>
        <full_name>isCapturing</full_name>
        <docblock line="184">
          <description>Returns true, if this batch is capturing requests.</description>
          <long-description></long-description>
          <tag line="184" name="return" description="" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="200" package="triagens\ArangoDb">
        <name>activate</name>
        <full_name>activate</full_name>
        <docblock line="195">
          <description>Activates the batch.</description>
          <long-description>&lt;p&gt;This sets the batch active in its associated connection and also starts capturing.&lt;/p&gt;</long-description>
          <tag line="195" name="return" description="$this" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="214" package="triagens\ArangoDb">
        <name>setActive</name>
        <full_name>setActive</full_name>
        <docblock line="209">
          <description>Sets the batch active in its associated connection.</description>
          <long-description></long-description>
          <tag line="209" name="return" description="$this" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="229" package="triagens\ArangoDb">
        <name>setCapture</name>
        <full_name>setCapture</full_name>
        <docblock line="222">
          <description>Sets the batch's associated connection into capture mode.</description>
          <long-description></long-description>
          <tag line="222" name="param" description="" type="boolean" variable="$state">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="222" name="return" description="$this" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
        <argument line="229">
          <name>$state</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="244" package="triagens\ArangoDb">
        <name>getActive</name>
        <full_name>getActive</full_name>
        <docblock line="237">
          <description>Gets active batch in given connection.</description>
          <long-description></long-description>
          <tag line="237" name="param" description="" type="\triagens\ArangoDb\Connection" variable="$connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
          <tag line="237" name="return" description="" type="$this">
            <type by_reference="false">$this</type>
          </tag>
        </docblock>
        <argument line="244">
          <name>$connection</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="259" package="triagens\ArangoDb">
        <name>getConnectionCaptureMode</name>
        <full_name>getConnectionCaptureMode</full_name>
        <docblock line="252">
          <description>Returns true, if given connection is in batch-capture mode.</description>
          <long-description></long-description>
          <tag line="252" name="param" description="" type="\triagens\ArangoDb\Connection" variable="$connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
          <tag line="252" name="return" description="" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="259">
          <name>$connection</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="272" package="triagens\ArangoDb">
        <name>setBatchRequest</name>
        <full_name>setBatchRequest</full_name>
        <docblock line="265">
          <description>Sets connection into Batch-Request mode.</description>
          <long-description>&lt;p&gt;This is necessary to distinguish between normal and the batch request.&lt;/p&gt;</long-description>
          <tag line="265" name="param" description="" type="boolean" variable="$state">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="265" name="return" description="" type="$this">
            <type by_reference="false">$this</type>
          </tag>
        </docblock>
        <argument line="272">
          <name>$state</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="288" package="triagens\ArangoDb">
        <name>nextBatchPartId</name>
        <full_name>nextBatchPartId</full_name>
        <docblock line="281">
          <description>Sets the id of the next batch-part.</description>
          <long-description>&lt;p&gt;The id can later be used to retrieve the batch-part.&lt;/p&gt;</long-description>
          <tag line="281" name="param" description="" type="mixed" variable="$batchPartId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="281" name="return" description="" type="\triagens\ArangoDb\Batch">
            <type by_reference="false">\triagens\ArangoDb\Batch</type>
          </tag>
        </docblock>
        <argument line="288">
          <name>$batchPartId</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="303" package="triagens\ArangoDb">
        <name>nextBatchPartCursorOptions</name>
        <full_name>nextBatchPartCursorOptions</full_name>
        <docblock line="296">
          <description>Set client side cursor options (for example: sanitize) for the next batch part.</description>
          <long-description></long-description>
          <tag line="296" name="param" description="" type="mixed" variable="$batchPartCursorOptions">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="296" name="return" description="" type="\triagens\ArangoDb\Batch">
            <type by_reference="false">\triagens\ArangoDb\Batch</type>
          </tag>
        </docblock>
        <argument line="303">
          <name>$batchPartCursorOptions</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="319" package="triagens\ArangoDb">
        <name>append</name>
        <full_name>append</full_name>
        <docblock line="311">
          <description>Append the request to the batch-part</description>
          <long-description></long-description>
          <tag line="311" name="param" description="- The method of the request (GET, POST...)" type="mixed" variable="$method">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="311" name="param" description="- The request that will get appended to the batch" type="mixed" variable="$request">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="311" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="319">
          <name>$method</name>
          <default></default>
          <type/>
        </argument>
        <argument line="319">
          <name>$request</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="359" package="triagens\ArangoDb">
        <name>splitWithContentIdKey</name>
        <full_name>splitWithContentIdKey</full_name>
        <docblock line="351">
          <description>Split batch request and use ContentId as array key</description>
          <long-description></long-description>
          <tag line="351" name="param" description="" type="mixed" variable="$pattern">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="351" name="param" description="" type="mixed" variable="$string">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="351" name="return" description="$array - Array of batch-parts" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="359">
          <name>$pattern</name>
          <default></default>
          <type/>
        </argument>
        <argument line="359">
          <name>$string</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="384" package="triagens\ArangoDb">
        <name>process</name>
        <full_name>process</full_name>
        <docblock line="378">
          <description>Processes this batch.</description>
          <long-description>&lt;p&gt;This sends the captured requests to the server as one batch.&lt;/p&gt;</long-description>
          <tag line="378" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="378" name="return" description="- true if processing of the batch was  or the HttpResponse object in case of a failure. A successful process just means that tha parts were processed. Each part has it's own response though and should be checked on its own." type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="437" package="triagens\ArangoDb">
        <name>countParts</name>
        <full_name>countParts</full_name>
        <docblock line="432">
          <description>Get the total count of the batch parts</description>
          <long-description></long-description>
          <tag line="432" name="return" description="$count" type="integer">
            <type by_reference="false">integer</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="453" package="triagens\ArangoDb">
        <name>getPart</name>
        <full_name>getPart</full_name>
        <docblock line="445">
          <description>Get the batch part identified by the array key (0.</description>
          <long-description>&lt;p&gt;..n) or its id (if it was set with nextBatchPartId($id) )&lt;/p&gt;</long-description>
          <tag line="445" name="param" description="the batch part id. Either it's numeric key or a given name." type="mixed" variable="$partId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="445" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="445" name="return" description="$batchPart" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="453">
          <name>$partId</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="472" package="triagens\ArangoDb">
        <name>getPartResponse</name>
        <full_name>getPartResponse</full_name>
        <docblock line="465">
          <description>Get the batch part identified by the array key (0.</description>
          <long-description>&lt;p&gt;..n) or its id (if it was set with nextBatchPartId($id) )&lt;/p&gt;</long-description>
          <tag line="465" name="param" description="the batch part id. Either it's numeric key or a given name." type="mixed" variable="$partId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="465" name="return" description="$partId" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="472">
          <name>$partId</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="487" package="triagens\ArangoDb">
        <name>getProcessedPartResponse</name>
        <full_name>getProcessedPartResponse</full_name>
        <docblock line="480">
          <description>Get the batch part identified by the array key (0.</description>
          <long-description>&lt;p&gt;..n) or its id (if it was set with nextBatchPartId($id) )&lt;/p&gt;</long-description>
          <tag line="480" name="param" description="the batch part id. Either it's numeric key or a given name." type="mixed" variable="$partId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="480" name="return" description="$partId" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="487">
          <name>$partId</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="500" package="triagens\ArangoDb">
        <name>getBatchParts</name>
        <full_name>getBatchParts</full_name>
        <docblock line="495">
          <description>Returns the array of batch-parts</description>
          <long-description></long-description>
          <tag line="495" name="return" description="$_batchParts" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="511" package="triagens\ArangoDb">
        <name>getCursorOptions</name>
        <full_name>getCursorOptions</full_name>
        <docblock line="506">
          <description>Return an array of cursor options</description>
          <long-description></long-description>
          <tag line="506" name="return" description="- array of options" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="522" package="triagens\ArangoDb">
        <name>getConnection</name>
        <full_name>getConnection</full_name>
        <docblock line="517">
          <description>Return this batch's connection</description>
          <long-description></long-description>
          <tag line="517" name="return" description="" type="\triagens\ArangoDb\Connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="AqlUserFunction.php" hash="3ffef18747316bcb156a988d2ea74602" package="Default">
    <docblock line="3">
      <description>ArangoDB PHP client: AqlUserFunction</description>
      <long-description></long-description>
      <tag line="3" name="author" description="Frank Mayer"/>
      <tag line="3" name="copyright" description="Copyright 2013, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="44" package="triagens\ArangoDb">
      <extends/>
      <name>AqlUserFunction</name>
      <full_name>\triagens\ArangoDb\AqlUserFunction</full_name>
      <docblock line="12">
        <description>Class AqlUserFunction</description>
        <long-description>&lt;p&gt;AqlUserFunction object
An AqlUserFunction is an object that is used to manage AQL User Functions.
It registers, unregisters and lists user functions on the server&lt;/p&gt;

&lt;p&gt;The object encapsulates:&lt;/p&gt;

&lt;ul&gt;
&lt;li&gt;the name of the function&lt;/li&gt;
&lt;li&gt;the actual javascript function&lt;/li&gt;
&lt;/ul&gt;

&lt;p&gt;The object requires the connection object and can be initialized
with or without initial configuration.
Any configuration can be set and retrieved by the object's methods like this:&lt;/p&gt;

&lt;p&gt;$this-&gt;setName('myFunctions:myFunction');
$this-&gt;setCode('function (){your code};');&lt;/p&gt;

&lt;p&gt;or like this:&lt;/p&gt;

&lt;p&gt;$this-&gt;name('myFunctions:myFunction');
$this-&gt;code('function (){your code};');&lt;/p&gt;</long-description>
        <tag line="12" name="property" description="- The name of the user function" type="string" variable="$name">
          <type by_reference="false">string</type>
        </tag>
        <tag line="12" name="property" description="- The code of the user function" type="string" variable="$code">
          <type by_reference="false">string</type>
        </tag>
        <tag line="12" name="property" description="_action" type="mixed" variable="">
          <type by_reference="false">mixed</type>
        </tag>
        <tag line="12" name="package" description="triagens\ArangoDb"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="70" package="triagens\ArangoDb">
        <name>ENTRY_NAME</name>
        <full_name>ENTRY_NAME</full_name>
        <value>'name'</value>
        <docblock line="67">
          <description>Collections index</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="75" package="triagens\ArangoDb">
        <name>ENTRY_CODE</name>
        <full_name>ENTRY_CODE</full_name>
        <value>'code'</value>
        <docblock line="72">
          <description>Action index</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="51" namespace="triagens\ArangoDb" package="Default">
        <name>$_connection</name>
        <default>null</default>
        <docblock line="46">
          <description>The connection object</description>
          <long-description></long-description>
          <tag line="46" name="var" description="" type="\triagens\ArangoDb\Connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="58" namespace="triagens\ArangoDb" package="Default">
        <name>$attributes</name>
        <default>array()</default>
        <docblock line="53">
          <description>The transaction's attributes.</description>
          <long-description></long-description>
          <tag line="53" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="65" namespace="triagens\ArangoDb" package="Default">
        <name>$_action</name>
        <default>''</default>
        <docblock line="60">
          <description>The transaction's action.</description>
          <long-description></long-description>
          <tag line="60" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="95" package="triagens\ArangoDb">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="78">
          <description>Initialise the AqlUserFunction object</description>
          <long-description>&lt;p&gt;The $attributesArray array can be used to specify the name and code for the user function in form of an array.&lt;/p&gt;

&lt;p&gt;Example:
array(
  'name' =&gt; 'myFunctions:myFunction',
  'code' =&gt; 'function (){}'
)&lt;/p&gt;</long-description>
          <tag line="78" name="param" description="- the connection to be used" type="\triagens\ArangoDb\Connection" variable="$connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
          <tag line="78" name="param" description="- user function initialization data" type="array" variable="$attributesArray">
            <type by_reference="false">array</type>
          </tag>
          <tag line="78" name="return" description="" type="\triagens\ArangoDb\AqlUserFunction">
            <type by_reference="false">\triagens\ArangoDb\AqlUserFunction</type>
          </tag>
        </docblock>
        <argument line="95">
          <name>$connection</name>
          <default></default>
          <type>\triagens\ArangoDb\Connection</type>
        </argument>
        <argument line="95">
          <name>$attributesArray</name>
          <default>null</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="118" package="triagens\ArangoDb">
        <name>register</name>
        <full_name>register</full_name>
        <docblock line="104">
          <description>Registers the user function</description>
          <long-description>&lt;p&gt;If no parameters ($name,$code) are passed, it will use the properties of the object.&lt;/p&gt;

&lt;p&gt;If $name and/or $code are passed, it will override the object's properties with the passed ones&lt;/p&gt;</long-description>
          <tag line="104" name="param" description="" type="null" variable="$name">
            <type by_reference="false">null</type>
          </tag>
          <tag line="104" name="param" description="" type="null" variable="$code">
            <type by_reference="false">null</type>
          </tag>
          <tag line="104" name="throws" description="throws exception if registration failed" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="104" name="return" description="true if registration was successful." type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="118">
          <name>$name</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="118">
          <name>$code</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="153" package="triagens\ArangoDb">
        <name>unregister</name>
        <full_name>unregister</full_name>
        <docblock line="140">
          <description>Unregister the user function</description>
          <long-description>&lt;p&gt;If no parameter ($name) is passed, it will use the property of the object.&lt;/p&gt;

&lt;p&gt;If $name is passed, it will override the object's property with the passed one&lt;/p&gt;</long-description>
          <tag line="140" name="param" description="" type="null" variable="$name">
            <type by_reference="false">null</type>
          </tag>
          <tag line="140" name="throws" description="throw exception if the request fails" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="140" name="return" description="true if successful without a return value or the return value if one was set in the action" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="153">
          <name>$name</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="178" package="triagens\ArangoDb">
        <name>getRegisteredUserFunctions</name>
        <full_name>getRegisteredUserFunctions</full_name>
        <docblock line="167">
          <description>Get registered user functions</description>
          <long-description>&lt;p&gt;The method can optionally be passed a $namespace parameter to narrow the results down to a specific namespace.&lt;/p&gt;</long-description>
          <tag line="167" name="param" description="" type="null" variable="$namespace">
            <type by_reference="false">null</type>
          </tag>
          <tag line="167" name="throws" description="throw exception if the request failed" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="167" name="return" description="true if successful without a return value or the return value if one was set in the action" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="178">
          <name>$namespace</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="triagens\ArangoDb" line="197" package="triagens\ArangoDb">
        <name>getConnection</name>
        <full_name>getConnection</full_name>
        <docblock line="192">
          <description>Return the connection object</description>
          <long-description></long-description>
          <tag line="192" name="return" description="- the connection object" type="\triagens\ArangoDb\Connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="215" package="triagens\ArangoDb">
        <name>setName</name>
        <full_name>setName</full_name>
        <docblock line="203">
          <description>Set name of the user function.</description>
          <long-description>&lt;p&gt;It must have at least one namespace, but also can have sub-namespaces.
correct:
'myNamespace:myFunction'
'myRootNamespace:mySubNamespace:myFunction'&lt;/p&gt;

&lt;p&gt;wrong:
'myFunction'&lt;/p&gt;</long-description>
          <tag line="203" name="param" description="" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="215">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="226" package="triagens\ArangoDb">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="221">
          <description>Get name value</description>
          <long-description></long-description>
          <tag line="221" name="return" description="name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="236" package="triagens\ArangoDb">
        <name>setCode</name>
        <full_name>setCode</full_name>
        <docblock line="231">
          <description>Set user function code</description>
          <long-description></long-description>
          <tag line="231" name="param" description="" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="236">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="247" package="triagens\ArangoDb">
        <name>getCode</name>
        <full_name>getCode</full_name>
        <docblock line="242">
          <description>Get user function code</description>
          <long-description></long-description>
          <tag line="242" name="return" description="name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="261" package="triagens\ArangoDb">
        <name>set</name>
        <full_name>set</full_name>
        <docblock line="253">
          <description>Set an attribute</description>
          <long-description></long-description>
          <tag line="253" name="param" description="" type="\triagens\ArangoDb\" variable="$key"/>
          <tag line="253" name="param" description="" type="\triagens\ArangoDb\" variable="$value"/>
          <tag line="253" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
        </docblock>
        <argument line="261">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
        <argument line="261">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="284" package="triagens\ArangoDb">
        <name>__set</name>
        <full_name>__set</full_name>
        <docblock line="271">
          <description>Set an attribute, magic method</description>
          <long-description>&lt;p&gt;This is a magic method that allows the object to be used without
declaring all attributes first.&lt;/p&gt;</long-description>
          <tag line="271" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="271" name="param" description="- attribute name" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="271" name="param" description="- value for attribute" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="271" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="284">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
        <argument line="284">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="306" package="triagens\ArangoDb">
        <name>get</name>
        <full_name>get</full_name>
        <docblock line="299">
          <description>Get an attribute</description>
          <long-description></long-description>
          <tag line="299" name="param" description="- name of attribute" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="299" name="return" description="- value of attribute, NULL if attribute is not set" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="306">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="324" package="triagens\ArangoDb">
        <name>__get</name>
        <full_name>__get</full_name>
        <docblock line="315">
          <description>Get an attribute, magic method</description>
          <long-description>&lt;p&gt;This function is mapped to get() internally.&lt;/p&gt;</long-description>
          <tag line="315" name="param" description="- name of attribute" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="315" name="return" description="- value of attribute, NULL if attribute is not set" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="324">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="335" package="triagens\ArangoDb">
        <name>__toString</name>
        <full_name>__toString</full_name>
        <docblock line="330">
          <description>Returns the action string</description>
          <long-description></long-description>
          <tag line="330" name="return" description="- the current action string" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="345" package="triagens\ArangoDb">
        <name>buildAttributesFromArray</name>
        <full_name>buildAttributesFromArray</full_name>
        <docblock line="340">
          <description>Build the object's attributes from a given array</description>
          <long-description></long-description>
          <tag line="340" name="param" description="" type="\triagens\ArangoDb\" variable="$options"/>
        </docblock>
        <argument line="345">
          <name>$options</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="Vertex.php" hash="298385d8754a95becd54dbec212052ea" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: single vertex document</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Jan Steemann"/>
      <tag line="3" name="author" description="Frank Mayer"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
      <tag line="3" name="since" description="1.2"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="21" package="triagens\ArangoDb">
      <extends>\triagens\ArangoDb\Document</extends>
      <name>Vertex</name>
      <full_name>\triagens\ArangoDb\Vertex</full_name>
      <docblock line="15">
        <description>Value object representing a single vertex document</description>
        <long-description></long-description>
        <tag line="15" name="package" description="triagens\ArangoDb"/>
        <tag line="15" name="since" description="1.2"/>
      </docblock>
    </class>
  </file>
  <file path="Exception.php" hash="4eb9ee47a304c06cbc3851ae7b493dd7" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: exception base class</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Jan Steemann"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="18" package="triagens\ArangoDb">
      <extends>\Exception</extends>
      <name>Exception</name>
      <full_name>\triagens\ArangoDb\Exception</full_name>
      <docblock line="13">
        <description>Exception base class used to throw Arango specific exceptions</description>
        <long-description></long-description>
        <tag line="13" name="package" description="triagens\ArangoDb"/>
      </docblock>
    </class>
  </file>
  <file path="BindVars.php" hash="9891ba9ca23e2be94e746d780f0feaef" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: bind variables</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Jan Steemann"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="19" package="triagens\ArangoDb">
      <extends/>
      <name>BindVars</name>
      <full_name>\triagens\ArangoDb\BindVars</full_name>
      <docblock line="13">
        <description>A simple container for bind variables
This container also handles validation of the bind values.</description>
        <long-description></long-description>
        <tag line="13" name="package" description="triagens\ArangoDb"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="26" namespace="triagens\ArangoDb" package="Default">
        <name>$_values</name>
        <default>array()</default>
        <docblock line="21">
          <description>Current bind values</description>
          <long-description></long-description>
          <tag line="21" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="33" package="triagens\ArangoDb">
        <name>getAll</name>
        <full_name>getAll</full_name>
        <docblock line="28">
          <description>Get all registered bind variables</description>
          <long-description></long-description>
          <tag line="28" name="return" description="- array of all registered bind variables" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="43" package="triagens\ArangoDb">
        <name>getCount</name>
        <full_name>getCount</full_name>
        <docblock line="38">
          <description>Get the number of bind variables registered</description>
          <long-description></long-description>
          <tag line="38" name="return" description="- number of bind variables registered" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="55" package="triagens\ArangoDb">
        <name>get</name>
        <full_name>get</full_name>
        <docblock line="48">
          <description>Get the value of a bind variable with a specific name</description>
          <long-description></long-description>
          <tag line="48" name="param" description="- name of bind variable" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="48" name="return" description="- value of bind variable" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="55">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="80" package="triagens\ArangoDb">
        <name>set</name>
        <full_name>set</full_name>
        <docblock line="64">
          <description>Set the value of a single bind variable or set all bind variables at once</description>
          <long-description>&lt;p&gt;This will also validate the bind values.&lt;/p&gt;

&lt;p&gt;Allowed value types for bind parameters are string, int,
double, bool and array. Arrays must not contain any other
than these types.&lt;/p&gt;</long-description>
          <tag line="64" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="64" name="param" description="- name of bind variable OR an array with all bind variables" type="mixed" variable="$name">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="64" name="param" description="- value for bind variable" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="64" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="80">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="80">
          <name>$value</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="Scope.php" hash="eafdf3fc60d12e8934b97b2236f1e001" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: scope</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Jan Steemann"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="19" package="triagens\ArangoDb">
      <extends/>
      <name>Scope</name>
      <full_name>\triagens\ArangoDb\Scope</full_name>
      <docblock line="13">
        <description>Executes a function on scope entry and executes another function
(cleanup) when the scope is exited</description>
        <long-description></long-description>
        <tag line="13" name="package" description="triagens\ArangoDb"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="52" package="triagens\ArangoDb">
        <name>STATE_NONE</name>
        <full_name>STATE_NONE</full_name>
        <value>0</value>
        <docblock line="49">
          <description>Scope has not been entered</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="57" package="triagens\ArangoDb">
        <name>STATE_ENTERED</name>
        <full_name>STATE_ENTERED</full_name>
        <value>1</value>
        <docblock line="54">
          <description>Scope has been entered but not left</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="62" package="triagens\ArangoDb">
        <name>STATE_LEFT</name>
        <full_name>STATE_LEFT</full_name>
        <value>2</value>
        <docblock line="59">
          <description>Scope has been entered and left</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="26" namespace="triagens\ArangoDb" package="Default">
        <name>$_initFunc</name>
        <default></default>
        <docblock line="21">
          <description>Initialization function (called on scope entry)</description>
          <long-description></long-description>
          <tag line="21" name="var" description="" type="callable">
            <type by_reference="false">callable</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="33" namespace="triagens\ArangoDb" package="Default">
        <name>$_exitFunc</name>
        <default></default>
        <docblock line="28">
          <description>Exit function (called when scope is left)</description>
          <long-description></long-description>
          <tag line="28" name="var" description="" type="callable">
            <type by_reference="false">callable</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="40" namespace="triagens\ArangoDb" package="Default">
        <name>$_value</name>
        <default></default>
        <docblock line="35">
          <description>Value returned by call to init function</description>
          <long-description></long-description>
          <tag line="35" name="var" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="47" namespace="triagens\ArangoDb" package="Default">
        <name>$_state</name>
        <default>self::STATE_NONE</default>
        <docblock line="42">
          <description>Current scope state</description>
          <long-description></long-description>
          <tag line="42" name="var" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="72" package="triagens\ArangoDb">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="64">
          <description>Initialise the scope</description>
          <long-description></long-description>
          <tag line="64" name="param" description="- function to be called when scope is entered" type="callable" variable="$initFunc">
            <type by_reference="false">callable</type>
          </tag>
          <tag line="64" name="param" description="- function to be called when scope if left" type="callable" variable="$exitFunc">
            <type by_reference="false">callable</type>
          </tag>
          <tag line="64" name="return" description="" type="\triagens\ArangoDb\Scope">
            <type by_reference="false">\triagens\ArangoDb\Scope</type>
          </tag>
        </docblock>
        <argument line="72">
          <name>$initFunc</name>
          <default></default>
          <type/>
        </argument>
        <argument line="72">
          <name>$exitFunc</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="90" package="triagens\ArangoDb">
        <name>__destruct</name>
        <full_name>__destruct</full_name>
        <docblock line="83">
          <description>Destroy the scope</description>
          <long-description>&lt;p&gt;This will call leave() to ensure the scope is definitely left&lt;/p&gt;</long-description>
          <tag line="83" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="105" package="triagens\ArangoDb">
        <name>leave</name>
        <full_name>leave</full_name>
        <docblock line="95">
          <description>Leave the scope</description>
          <long-description>&lt;p&gt;This will execute the exit func with the value returned by the
call to the init func.
leave() will check whether the scope has already been left to avoid
duplicate execution of the exit func.&lt;/p&gt;</long-description>
          <tag line="95" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="125" package="triagens\ArangoDb">
        <name>enter</name>
        <full_name>enter</full_name>
        <docblock line="118">
          <description>Enter the scope</description>
          <long-description>&lt;p&gt;This will call the init func and store its result value&lt;/p&gt;</long-description>
          <tag line="118" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="142" package="triagens\ArangoDb">
        <name>__clone</name>
        <full_name>__clone</full_name>
        <docblock line="134">
          <description>Clone function</description>
          <long-description>&lt;p&gt;Scopes should never be cloned so this is private&lt;/p&gt;</long-description>
          <tag line="134" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="134" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="ConnectionOptions.php" hash="b20b3b21a32865d1bcf03b5761096589" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: connection options</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Jan Steemann"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="21" package="triagens\ArangoDb">
      <extends/>
      <implements>\ArrayAccess</implements>
      <name>ConnectionOptions</name>
      <full_name>\triagens\ArangoDb\ConnectionOptions</full_name>
      <docblock line="13">
        <description>Simple container class for connection options.</description>
        <long-description>&lt;p&gt;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.&lt;/p&gt;</long-description>
        <tag line="13" name="package" description="triagens\ArangoDb"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="41" package="triagens\ArangoDb">
        <name>OPTION_ENDPOINT</name>
        <full_name>OPTION_ENDPOINT</full_name>
        <value>'endpoint'</value>
        <docblock line="38">
          <description>Endpoint string index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="46" package="triagens\ArangoDb">
        <name>OPTION_HOST</name>
        <full_name>OPTION_HOST</full_name>
        <value>'host'</value>
        <docblock line="43">
          <description>Host name string index constant (deprecated, use endpoint instead)</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="51" package="triagens\ArangoDb">
        <name>OPTION_PORT</name>
        <full_name>OPTION_PORT</full_name>
        <value>'port'</value>
        <docblock line="48">
          <description>Port number index constant (deprecated, use endpoint instead)</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="56" package="triagens\ArangoDb">
        <name>OPTION_TIMEOUT</name>
        <full_name>OPTION_TIMEOUT</full_name>
        <value>'timeout'</value>
        <docblock line="53">
          <description>Timeout value index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="61" package="triagens\ArangoDb">
        <name>OPTION_TRACE</name>
        <full_name>OPTION_TRACE</full_name>
        <value>'trace'</value>
        <docblock line="58">
          <description>Trace function index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="66" package="triagens\ArangoDb">
        <name>OPTION_ENHANCED_TRACE</name>
        <full_name>OPTION_ENHANCED_TRACE</full_name>
        <value>'enhancedTrace'</value>
        <docblock line="63">
          <description>Enhanced trace</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="71" package="triagens\ArangoDb">
        <name>OPTION_CREATE</name>
        <full_name>OPTION_CREATE</full_name>
        <value>'createCollection'</value>
        <docblock line="68">
          <description>"Create collections if they don't exist" index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="76" package="triagens\ArangoDb">
        <name>OPTION_REVISION</name>
        <full_name>OPTION_REVISION</full_name>
        <value>'rev'</value>
        <docblock line="73">
          <description>Update revision constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="81" package="triagens\ArangoDb">
        <name>OPTION_UPDATE_POLICY</name>
        <full_name>OPTION_UPDATE_POLICY</full_name>
        <value>'policy'</value>
        <docblock line="78">
          <description>Update policy index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="86" package="triagens\ArangoDb">
        <name>OPTION_UPDATE_KEEPNULL</name>
        <full_name>OPTION_UPDATE_KEEPNULL</full_name>
        <value>'keepNull'</value>
        <docblock line="83">
          <description>Update keepNull constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="91" package="triagens\ArangoDb">
        <name>OPTION_REPLACE_POLICY</name>
        <full_name>OPTION_REPLACE_POLICY</full_name>
        <value>'policy'</value>
        <docblock line="88">
          <description>Replace policy index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="96" package="triagens\ArangoDb">
        <name>OPTION_DELETE_POLICY</name>
        <full_name>OPTION_DELETE_POLICY</full_name>
        <value>'policy'</value>
        <docblock line="93">
          <description>Delete policy index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="101" package="triagens\ArangoDb">
        <name>OPTION_WAIT_SYNC</name>
        <full_name>OPTION_WAIT_SYNC</full_name>
        <value>'waitForSync'</value>
        <docblock line="98">
          <description>Wait for sync index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="106" package="triagens\ArangoDb">
        <name>OPTION_LIMIT</name>
        <full_name>OPTION_LIMIT</full_name>
        <value>'limit'</value>
        <docblock line="103">
          <description>Limit index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="111" package="triagens\ArangoDb">
        <name>OPTION_SKIP</name>
        <full_name>OPTION_SKIP</full_name>
        <value>'skip'</value>
        <docblock line="108">
          <description>Skip index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="116" package="triagens\ArangoDb">
        <name>OPTION_BATCHSIZE</name>
        <full_name>OPTION_BATCHSIZE</full_name>
        <value>'batchSize'</value>
        <docblock line="113">
          <description>Batch size index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="121" package="triagens\ArangoDb">
        <name>OPTION_JOURNAL_SIZE</name>
        <full_name>OPTION_JOURNAL_SIZE</full_name>
        <value>'journalSize'</value>
        <docblock line="118">
          <description>Wait for sync index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="126" package="triagens\ArangoDb">
        <name>OPTION_IS_SYSTEM</name>
        <full_name>OPTION_IS_SYSTEM</full_name>
        <value>'isSystem'</value>
        <docblock line="123">
          <description>Wait for sync index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="131" package="triagens\ArangoDb">
        <name>OPTION_IS_VOLATILE</name>
        <full_name>OPTION_IS_VOLATILE</full_name>
        <value>'isVolatile'</value>
        <docblock line="128">
          <description>Wait for sync index constant</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="136" package="triagens\ArangoDb">
        <name>OPTION_AUTH_USER</name>
        <full_name>OPTION_AUTH_USER</full_name>
        <value>'AuthUser'</value>
        <docblock line="133">
          <description>Authentication user name</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="141" package="triagens\ArangoDb">
        <name>OPTION_AUTH_PASSWD</name>
        <full_name>OPTION_AUTH_PASSWD</full_name>
        <value>'AuthPasswd'</value>
        <docblock line="138">
          <description>Authentication password</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="146" package="triagens\ArangoDb">
        <name>OPTION_AUTH_TYPE</name>
        <full_name>OPTION_AUTH_TYPE</full_name>
        <value>'AuthType'</value>
        <docblock line="143">
          <description>Authentication type</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="151" package="triagens\ArangoDb">
        <name>OPTION_CONNECTION</name>
        <full_name>OPTION_CONNECTION</full_name>
        <value>'Connection'</value>
        <docblock line="148">
          <description>Connection</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="156" package="triagens\ArangoDb">
        <name>OPTION_RECONNECT</name>
        <full_name>OPTION_RECONNECT</full_name>
        <value>'Reconnect'</value>
        <docblock line="153">
          <description>Reconnect flag</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="161" package="triagens\ArangoDb">
        <name>OPTION_BATCH</name>
        <full_name>OPTION_BATCH</full_name>
        <value>'Batch'</value>
        <docblock line="158">
          <description>Batch flag</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="166" package="triagens\ArangoDb">
        <name>OPTION_BATCHPART</name>
        <full_name>OPTION_BATCHPART</full_name>
        <value>'BatchPart'</value>
        <docblock line="163">
          <description>Batchpart flag</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="171" package="triagens\ArangoDb">
        <name>OPTION_CHECK_UTF8_CONFORM</name>
        <full_name>OPTION_CHECK_UTF8_CONFORM</full_name>
        <value>'CheckUtf8Conform'</value>
        <docblock line="168">
          <description>UTF-8 CHeck Flag</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="29" namespace="triagens\ArangoDb" package="Default">
        <name>$_values</name>
        <default>array()</default>
        <docblock line="24">
          <description>The current options</description>
          <long-description></long-description>
          <tag line="24" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="36" namespace="triagens\ArangoDb" package="Default">
        <name>$_endpoint</name>
        <default>null</default>
        <docblock line="31">
          <description>The connection endpoint object</description>
          <long-description></long-description>
          <tag line="31" name="var" description="" type="\triagens\ArangoDb\Endpoint">
            <type by_reference="false">\triagens\ArangoDb\Endpoint</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="181" package="triagens\ArangoDb">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="173">
          <description>Set defaults, use options provided by client and validate them</description>
          <long-description></long-description>
          <tag line="173" name="param" description="- initial options" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="173" name="return" description="" type="\triagens\ArangoDb\ConnectionOptions">
            <type by_reference="false">\triagens\ArangoDb\ConnectionOptions</type>
          </tag>
        </docblock>
        <argument line="181">
          <name>$options</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="192" package="triagens\ArangoDb">
        <name>getAll</name>
        <full_name>getAll</full_name>
        <docblock line="187">
          <description>Get all options</description>
          <long-description></long-description>
          <tag line="187" name="return" description="- all options as an array" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="207" package="triagens\ArangoDb">
        <name>offsetSet</name>
        <full_name>offsetSet</full_name>
        <docblock line="197">
          <description>Set and validate a specific option, necessary for ArrayAccess</description>
          <long-description></long-description>
          <tag line="197" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="197" name="param" description="- name of option" type="string" variable="$offset">
            <type by_reference="false">string</type>
          </tag>
          <tag line="197" name="param" description="- value for option" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="197" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="207">
          <name>$offset</name>
          <default></default>
          <type/>
        </argument>
        <argument line="207">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="220" package="triagens\ArangoDb">
        <name>offsetExists</name>
        <full_name>offsetExists</full_name>
        <docblock line="213">
          <description>Check whether an option exists, necessary for ArrayAccess</description>
          <long-description></long-description>
          <tag line="213" name="param" description="-name of option" type="string" variable="$offset">
            <type by_reference="false">string</type>
          </tag>
          <tag line="213" name="return" description="- true if option exists, false otherwise" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="220">
          <name>$offset</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="234" package="triagens\ArangoDb">
        <name>offsetUnset</name>
        <full_name>offsetUnset</full_name>
        <docblock line="225">
          <description>Remove an option and validate, necessary for ArrayAccess</description>
          <long-description></long-description>
          <tag line="225" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="225" name="param" description="- name of option" type="string" variable="$offset">
            <type by_reference="false">string</type>
          </tag>
          <tag line="225" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="234">
          <name>$offset</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="249" package="triagens\ArangoDb">
        <name>offsetGet</name>
        <full_name>offsetGet</full_name>
        <docblock line="240">
          <description>Get a specific option, necessary for ArrayAccess</description>
          <long-description></long-description>
          <tag line="240" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="240" name="param" description="- name of option" type="string" variable="$offset">
            <type by_reference="false">string</type>
          </tag>
          <tag line="240" name="return" description="- value of option, will throw if option is not set" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="249">
          <name>$offset</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="264" package="triagens\ArangoDb">
        <name>getEndpoint</name>
        <full_name>getEndpoint</full_name>
        <docblock line="258">
          <description>Get the endpoint object for the connection</description>
          <long-description></long-description>
          <tag line="258" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="258" name="return" description="- endpoint object" type="\triagens\ArangoDb\Endpoint">
            <type by_reference="false">\triagens\ArangoDb\Endpoint</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="triagens\ArangoDb" line="279" package="triagens\ArangoDb">
        <name>getDefaults</name>
        <full_name>getDefaults</full_name>
        <docblock line="274">
          <description>Get the default values for the options</description>
          <long-description></long-description>
          <tag line="274" name="return" description="- array of default connection options" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="triagens\ArangoDb" line="314" package="triagens\ArangoDb">
        <name>getSupportedAuthTypes</name>
        <full_name>getSupportedAuthTypes</full_name>
        <docblock line="309">
          <description>Return the supported authorization types</description>
          <long-description></long-description>
          <tag line="309" name="return" description="- array with supported authorization types" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="triagens\ArangoDb" line="324" package="triagens\ArangoDb">
        <name>getSupportedConnectionTypes</name>
        <full_name>getSupportedConnectionTypes</full_name>
        <docblock line="319">
          <description>Return the supported connection types</description>
          <long-description></long-description>
          <tag line="319" name="return" description="- array with supported connection types" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="335" package="triagens\ArangoDb">
        <name>validate</name>
        <full_name>validate</full_name>
        <docblock line="329">
          <description>Validate the options</description>
          <long-description></long-description>
          <tag line="329" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="329" name="return" description="- will throw if an invalid option value is found" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="Statement.php" hash="860559c677d82ec9cadc60b63a5ef53d" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: statement</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Jan Steemann"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="42" package="triagens\ArangoDb">
      <extends/>
      <name>Statement</name>
      <full_name>\triagens\ArangoDb\Statement</full_name>
      <docblock line="13">
        <description>Container for a read-only ("select") statement
A statement is an AQL query that can be issued to the
server.</description>
        <long-description>&lt;p&gt;Optional bind parameters can be used when issuing the
statement to separate the statement from the values.
Executing a statement will result in a cursor being created.&lt;/p&gt;

&lt;p&gt;There is an important distinction between two different types of statements:&lt;br /&gt;
- statements that produce a list of documents as their result AND&lt;br /&gt;
- statements that do not produce documents&lt;/p&gt;

&lt;p&gt;For example, a statement such as "FOR e IN example RETURN e" will produce
a list of documents as its result. The result can be treated as a list of
documents, and the document can be updated and sent back to the server by
the client.&lt;/p&gt;

&lt;p&gt;However, the query "RETURN 1 + 1" will not produce a list of documents as
its result, but a list with a single scalar value (the number 2).
"2" is not a valid document so creating a document from it will fail.&lt;/p&gt;

&lt;p&gt;To turn the results of this query into a document, the following needs to
be done:&lt;br /&gt;
- modify the query to "RETURN { value: 1 + 1 }". The result will then be a
  a list of documents with a "value" attribute&lt;br /&gt;
- 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&lt;/p&gt;</long-description>
        <tag line="13" name="package" description="triagens\ArangoDb"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="96" package="triagens\ArangoDb">
        <name>ENTRY_QUERY</name>
        <full_name>ENTRY_QUERY</full_name>
        <value>'query'</value>
        <docblock line="93">
          <description>Query string index</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="101" package="triagens\ArangoDb">
        <name>ENTRY_COUNT</name>
        <full_name>ENTRY_COUNT</full_name>
        <value>'count'</value>
        <docblock line="98">
          <description>Count option index</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="106" package="triagens\ArangoDb">
        <name>ENTRY_BATCHSIZE</name>
        <full_name>ENTRY_BATCHSIZE</full_name>
        <value>'batchSize'</value>
        <docblock line="103">
          <description>Batch size index</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="111" package="triagens\ArangoDb">
        <name>ENTRY_BINDVARS</name>
        <full_name>ENTRY_BINDVARS</full_name>
        <value>'bindVars'</value>
        <docblock line="108">
          <description>Bind variables index</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="49" namespace="triagens\ArangoDb" package="Default">
        <name>$_connection</name>
        <default>null</default>
        <docblock line="44">
          <description>The connection object</description>
          <long-description></long-description>
          <tag line="44" name="var" description="" type="\triagens\ArangoDb\Connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="56" namespace="triagens\ArangoDb" package="Default">
        <name>$_bindVars</name>
        <default></default>
        <docblock line="51">
          <description>The bind variables and values used for the statement</description>
          <long-description></long-description>
          <tag line="51" name="var" description="" type="\triagens\ArangoDb\BindVars">
            <type by_reference="false">\triagens\ArangoDb\BindVars</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="63" namespace="triagens\ArangoDb" package="Default">
        <name>$_batchSize</name>
        <default>null</default>
        <docblock line="58">
          <description>The current batch size (number of result documents retrieved per round-trip)</description>
          <long-description></long-description>
          <tag line="58" name="var" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="70" namespace="triagens\ArangoDb" package="Default">
        <name>$_doCount</name>
        <default>false</default>
        <docblock line="65">
          <description>The count flag (should server return total number of results)</description>
          <long-description></long-description>
          <tag line="65" name="var" description="" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="77" namespace="triagens\ArangoDb" package="Default">
        <name>$_query</name>
        <default>null</default>
        <docblock line="72">
          <description>The query string</description>
          <long-description></long-description>
          <tag line="72" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="84" namespace="triagens\ArangoDb" package="Default">
        <name>$_flat</name>
        <default>false</default>
        <docblock line="79">
          <description>"flat" flag (if set, the query results will be treated as a simple array, not documents)</description>
          <long-description></long-description>
          <tag line="79" name="var" description="" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="91" namespace="triagens\ArangoDb" package="Default">
        <name>$_sanitize</name>
        <default>false</default>
        <docblock line="86">
          <description>Sanitation flag (if set, the _id and _rev attributes will be removed from the results)</description>
          <long-description></long-description>
          <tag line="86" name="var" description="" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="133" package="triagens\ArangoDb">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="113">
          <description>Initialise the statement</description>
          <long-description>&lt;p&gt;The $data property can be used to specify the query text and further
options for the query.&lt;/p&gt;

&lt;p&gt;An important consideration when creating a statement is whether the
statement will produce a list of documents as its result or any other
non-document value. When a statement is created, by default it is
assumed that the statement will produce documents. If this is not the
case, executing a statement that returns non-documents will fail.&lt;/p&gt;

&lt;p&gt;To explicitly mark the statement as returning non-documents, the '_flat'
option should be specified in $data.&lt;/p&gt;</long-description>
          <tag line="113" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="113" name="param" description="- the connection to be used" type="\triagens\ArangoDb\Connection" variable="$connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
          <tag line="113" name="param" description="- statement initialization data" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="133">
          <name>$connection</name>
          <default></default>
          <type>\triagens\ArangoDb\Connection</type>
        </argument>
        <argument line="133">
          <name>$data</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="triagens\ArangoDb" line="166" package="triagens\ArangoDb">
        <name>getConnection</name>
        <full_name>getConnection</full_name>
        <docblock line="161">
          <description>Return the connection object</description>
          <long-description></long-description>
          <tag line="161" name="return" description="- the connection object" type="\triagens\ArangoDb\Connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="180" package="triagens\ArangoDb">
        <name>execute</name>
        <full_name>execute</full_name>
        <docblock line="171">
          <description>Execute the statement</description>
          <long-description>&lt;p&gt;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.&lt;/p&gt;</long-description>
          <tag line="171" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="171" name="return" description="" type="\triagens\ArangoDb\Cursor">
            <type by_reference="false">\triagens\ArangoDb\Cursor</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="197" package="triagens\ArangoDb">
        <name>explain</name>
        <full_name>explain</full_name>
        <docblock line="189">
          <description>Explain the statement's execution plan</description>
          <long-description>&lt;p&gt;This will post the query to the server and return the execution plan as an array.&lt;/p&gt;</long-description>
          <tag line="189" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="189" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="214" package="triagens\ArangoDb">
        <name>validate</name>
        <full_name>validate</full_name>
        <docblock line="206">
          <description>Validates the statement</description>
          <long-description>&lt;p&gt;This will post the query to the server for validation and return the validation result as an array.&lt;/p&gt;</long-description>
          <tag line="206" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="206" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="234" package="triagens\ArangoDb">
        <name>__invoke</name>
        <full_name>__invoke</full_name>
        <docblock line="223">
          <description>Invoke the statement</description>
          <long-description>&lt;p&gt;This will simply call execute(). Arguments are ignored.&lt;/p&gt;</long-description>
          <tag line="223" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="223" name="param" description="- arguments for invocation, will be ignored" type="mixed" variable="$args">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="223" name="return" description="- the result cursor" type="\triagens\ArangoDb\Cursor">
            <type by_reference="false">\triagens\ArangoDb\Cursor</type>
          </tag>
        </docblock>
        <argument line="234">
          <name>$args</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="244" package="triagens\ArangoDb">
        <name>__toString</name>
        <full_name>__toString</full_name>
        <docblock line="239">
          <description>Return a string representation of the statement</description>
          <long-description></long-description>
          <tag line="239" name="return" description="- the current query string" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="267" package="triagens\ArangoDb">
        <name>bind</name>
        <full_name>bind</full_name>
        <docblock line="249">
          <description>Bind a parameter to the statement</description>
          <long-description>&lt;p&gt;This method can either be called with a string $key and a
separate value in $value, or with an array of all bind
bind parameters in $key, with $value being NULL.&lt;/p&gt;

&lt;p&gt;Allowed value types for bind parameters are string, int,
double, bool and array. Arrays must not contain any other
than these types.&lt;/p&gt;</long-description>
          <tag line="249" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="249" name="param" description="- name of bind variable OR an array of all bind variables" type="mixed" variable="$key">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="249" name="param" description="- value for bind variable" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="249" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="267">
          <name>$key</name>
          <default></default>
          <type/>
        </argument>
        <argument line="267">
          <name>$value</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="277" package="triagens\ArangoDb">
        <name>getBindVars</name>
        <full_name>getBindVars</full_name>
        <docblock line="272">
          <description>Get all bind parameters as an array</description>
          <long-description></long-description>
          <tag line="272" name="return" description="- array of bind variables/values" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="291" package="triagens\ArangoDb">
        <name>setQuery</name>
        <full_name>setQuery</full_name>
        <docblock line="282">
          <description>Set the query string</description>
          <long-description></long-description>
          <tag line="282" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="282" name="param" description="- query string" type="string" variable="$query">
            <type by_reference="false">string</type>
          </tag>
          <tag line="282" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="291">
          <name>$query</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="305" package="triagens\ArangoDb">
        <name>getQuery</name>
        <full_name>getQuery</full_name>
        <docblock line="300">
          <description>Get the query string</description>
          <long-description></long-description>
          <tag line="300" name="return" description="- current query string value" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="317" package="triagens\ArangoDb">
        <name>setCount</name>
        <full_name>setCount</full_name>
        <docblock line="310">
          <description>Set the count option for the statement</description>
          <long-description></long-description>
          <tag line="310" name="param" description="- value for count option" type="bool" variable="$value">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="310" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="317">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="327" package="triagens\ArangoDb">
        <name>getCount</name>
        <full_name>getCount</full_name>
        <docblock line="322">
          <description>Get the count option value of the statement</description>
          <long-description></long-description>
          <tag line="322" name="return" description="- current value of count option" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="348" package="triagens\ArangoDb">
        <name>setBatchSize</name>
        <full_name>setBatchSize</full_name>
        <docblock line="332">
          <description>Set the batch size for the statement</description>
          <long-description>&lt;p&gt;The batch size is the number of results to be transferred
in one server round-trip. If a query produces more results
than the batch size, it creates a server-side cursor that
provides the additional results.&lt;/p&gt;

&lt;p&gt;The server-side cursor can be accessed by the client with subsequent HTTP requests.&lt;/p&gt;</long-description>
          <tag line="332" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="332" name="param" description="- batch size value" type="int" variable="$value">
            <type by_reference="false">int</type>
          </tag>
          <tag line="332" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="348">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="362" package="triagens\ArangoDb">
        <name>getBatchSize</name>
        <full_name>getBatchSize</full_name>
        <docblock line="357">
          <description>Get the batch size for the statement</description>
          <long-description></long-description>
          <tag line="357" name="return" description="- current batch size value" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="372" package="triagens\ArangoDb">
        <name>buildData</name>
        <full_name>buildData</full_name>
        <docblock line="367">
          <description>Build an array of data to be posted to the server when issuing the statement</description>
          <long-description></long-description>
          <tag line="367" name="return" description="- array of data to be sent to server" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="395" package="triagens\ArangoDb">
        <name>getCursorOptions</name>
        <full_name>getCursorOptions</full_name>
        <docblock line="390">
          <description>Return an array of cursor options</description>
          <long-description></long-description>
          <tag line="390" name="return" description="- array of options" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="DocumentHandler.php" hash="8c465da30b891d7cb689d08aee09172c" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: document handler</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Jan Steemann"/>
      <tag line="3" name="author" description="Frank Mayer"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="22" package="triagens\ArangoDb">
      <extends>\triagens\ArangoDb\Handler</extends>
      <name>DocumentHandler</name>
      <full_name>\triagens\ArangoDb\DocumentHandler</full_name>
      <docblock line="15">
        <description>A document handler that fetches documents from the server and
persists them on the server.</description>
        <long-description>&lt;p&gt;It does so by issuing the
appropriate HTTP requests to the server.&lt;/p&gt;</long-description>
        <tag line="15" name="package" description="triagens\ArangoDb"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="28" package="triagens\ArangoDb">
        <name>ENTRY_DOCUMENTS</name>
        <full_name>ENTRY_DOCUMENTS</full_name>
        <value>'documents'</value>
        <docblock line="25">
          <description>documents array index</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="33" package="triagens\ArangoDb">
        <name>OPTION_COLLECTION</name>
        <full_name>OPTION_COLLECTION</full_name>
        <value>'collection'</value>
        <docblock line="30">
          <description>collection parameter</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="38" package="triagens\ArangoDb">
        <name>OPTION_EXAMPLE</name>
        <full_name>OPTION_EXAMPLE</full_name>
        <value>'example'</value>
        <docblock line="35">
          <description>example parameter</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="60" package="triagens\ArangoDb">
        <name>get</name>
        <full_name>get</full_name>
        <docblock line="41">
          <description>Get a single document from a collection</description>
          <long-description>&lt;p&gt;Alias method for getById()&lt;/p&gt;</long-description>
          <tag line="41" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="41" name="param" description="- collection id as a string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="41" name="param" description="- document identifier" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="41" name="param" description="- optional, array of options&#10;&lt;p&gt;Options are :&#10;&lt;li&gt;'_includeInternals' - true to include the internal attributes. Defaults to false&lt;/li&gt;&#10;&lt;li&gt;'includeInternals' - Deprecated, please use '_includeInternals'.&lt;/li&gt;&#10;&lt;li&gt;'_ignoreHiddenAttributes' - true to show hidden attributes. Defaults to false&lt;/li&gt;&#10;&lt;li&gt;'ignoreHiddenAttributes' - Deprecated, please use '_ignoreHiddenAttributes'.&lt;/li&gt;&#10;&lt;/p&gt;" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="41" name="return" description="- the document fetched from the server" type="\triagens\ArangoDb\Document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
        </docblock>
        <argument line="60">
          <name>$collectionId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="60">
          <name>$documentId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="60">
          <name>$options</name>
          <default>array()</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="85" package="triagens\ArangoDb">
        <name>getById</name>
        <full_name>getById</full_name>
        <docblock line="66">
          <description>Get a single document from a collection</description>
          <long-description>&lt;p&gt;This will throw if the document cannot be fetched from the server&lt;/p&gt;</long-description>
          <tag line="66" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="66" name="param" description="- collection id as a string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="66" name="param" description="- document identifier" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="66" name="param" description="- optional, array of options&#10;&lt;p&gt;Options are :&#10;&lt;li&gt;'_includeInternals' - true to include the internal attributes. Defaults to false&lt;/li&gt;&#10;&lt;li&gt;'includeInternals' - Deprecated, please use '_includeInternals'.&lt;/li&gt;&#10;&lt;li&gt;'_ignoreHiddenAttributes' - true to show hidden attributes. Defaults to false&lt;/li&gt;&#10;&lt;li&gt;'ignoreHiddenAttributes' - Deprecated, please use '_ignoreHiddenAttributes'.&lt;/li&gt;&#10;&lt;/p&gt;" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="66" name="return" description="- the document fetched from the server" type="\triagens\ArangoDb\Document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
        </docblock>
        <argument line="85">
          <name>$collectionId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="85">
          <name>$documentId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="85">
          <name>$options</name>
          <default>array()</default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="triagens\ArangoDb" line="106" package="triagens\ArangoDb">
        <name>createFromArrayWithContext</name>
        <full_name>createFromArrayWithContext</full_name>
        <docblock line="98">
          <description>Intermediate function to call the createFromArray function from the right context</description>
          <long-description></long-description>
          <tag line="98" name="param" description="" type="\triagens\ArangoDb\" variable="$data"/>
          <tag line="98" name="param" description="" type="\triagens\ArangoDb\" variable="$options"/>
          <tag line="98" name="return" description="" type="\triagens\ArangoDb\Document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
        </docblock>
        <argument line="106">
          <name>$data</name>
          <default></default>
          <type/>
        </argument>
        <argument line="106">
          <name>$options</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="126" package="triagens\ArangoDb">
        <name>getAllIds</name>
        <full_name>getAllIds</full_name>
        <docblock line="112">
          <description>Get the list of all documents' ids from a collection</description>
          <long-description>&lt;p&gt;This will throw if the list cannot be fetched from the server&lt;/p&gt;</long-description>
          <tag line="112" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="112" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="112" name="return" description="- ids of documents in the collection" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="112" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by  CollectionHandler::getAllIds()"/>
        </docblock>
        <argument line="126">
          <name>$collectionId</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="165" package="triagens\ArangoDb">
        <name>getByExample</name>
        <full_name>getByExample</full_name>
        <docblock line="134">
          <description>Get document(s) by specifying an example</description>
          <long-description>&lt;p&gt;This will throw if the list cannot be fetched from the server&lt;/p&gt;</long-description>
          <tag line="134" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="134" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="134" name="param" description="- the example document as a Document object or an array" type="mixed" variable="$document">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="134" name="param" description="- optional, prior to v1.0.0 this was a boolean value for sanitize, since v1.0.0 it's an array of options.&#10;&lt;p&gt;Options are :&lt;br&gt;&#10;&lt;li&gt;'_sanitize' - True to remove _id and _rev attributes from result documents. Defaults to false.&lt;/li&gt;&#10;&lt;li&gt;'sanitize' - Deprecated, please use '_sanitize'.&lt;/li&gt;&#10;&lt;li&gt;'_hiddenAttributes' - Set an array of hidden attributes for created documents.&#10;&lt;li&gt;'hiddenAttributes' - Deprecated, please use '_hiddenAttributes'.&lt;/li&gt;&#10;&lt;p&gt;&#10;                                This is actually the same as setting hidden attributes using setHiddenAttributes() on a document. &lt;br&gt;&#10;                                The difference is, that if you're returning a resultset of documents, the getAll() is already called &lt;br&gt;&#10;                                and the hidden attributes would not be applied to the attributes.&lt;br&gt;&#10;&lt;/p&gt;&#10;&lt;/li&gt;&#10;&lt;li&gt;'batchSize' - can optionally be used to tell the server to limit the number of results to be transferred in one batch&lt;/li&gt;&#10;&lt;li&gt;'skip' -  Optional, The number of documents to skip in the query.&lt;/li&gt;&#10;&lt;li&gt;'limit' -  Optional, The maximal amount of documents to return. 'skip' is applied before the limit restriction.&lt;/li&gt;&#10;&lt;/p&gt;" type="bool|array" variable="$options">
            <type by_reference="false">bool</type>
            <type by_reference="false">array</type>
          </tag>
          <tag line="134" name="return" description="- Returns a cursor containing the result" type="\triagens\ArangoDb\cursor">
            <type by_reference="false">\triagens\ArangoDb\cursor</type>
          </tag>
          <tag line="134" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by CollectionHandler::byExample()"/>
        </docblock>
        <argument line="165">
          <name>$collectionId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="165">
          <name>$document</name>
          <default></default>
          <type/>
        </argument>
        <argument line="165">
          <name>$options</name>
          <default>false</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="196" package="triagens\ArangoDb">
        <name>add</name>
        <full_name>add</full_name>
        <docblock line="173">
          <description>Add a document to a collection</description>
          <long-description>&lt;p&gt;This will add the document to the collection and return the document's id&lt;/p&gt;

&lt;p&gt;This will throw if the document cannot be created&lt;/p&gt;</long-description>
          <tag line="173" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="173" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="173" name="param" description="- the document to be added" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="173" name="param" description="- optional, prior to v1.2.0 this was a boolean value for create. Since v1.0.0 it's an array of options.&#10;&lt;p&gt;Options are :&lt;br&gt;&#10;&lt;li&gt;'create' - create the collection if it does not yet exist.&lt;/li&gt;&#10;&lt;li&gt;'waitForSync' -  if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.&lt;/li&gt;&#10;&lt;/p&gt;" type="bool|array" variable="$options">
            <type by_reference="false">bool</type>
            <type by_reference="false">array</type>
          </tag>
          <tag line="173" name="return" description="- id of document created" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="173" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by save()"/>
        </docblock>
        <argument line="196">
          <name>$collectionId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="196">
          <name>$document</name>
          <default></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="196">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="222" package="triagens\ArangoDb">
        <name>store</name>
        <full_name>store</full_name>
        <docblock line="201">
          <description>Store a document to a collection</description>
          <long-description>&lt;p&gt;This is an alias/shortcut to save() and replace(). Instead of having to determine which of the 3 functions to use,
simply pass the document to store() and it will figure out which one to call.&lt;/p&gt;

&lt;p&gt;This will throw if the document cannot be saved or replaced.&lt;/p&gt;</long-description>
          <tag line="201" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="201" name="param" description="- the document to be added, can be passed as a document or an array" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="201" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="201" name="param" description="- optional, prior to v1.2.0 this was a boolean value for create. Since v1.2.0 it's an array of options.&#10;&lt;p&gt;Options are :&lt;br&gt;&#10;&lt;li&gt;'create' - create the collection if it does not yet exist.&lt;/li&gt;&#10;&lt;li&gt;'waitForSync' -  if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.&lt;/li&gt;&#10;&lt;/p&gt;" type="bool|array" variable="$options">
            <type by_reference="false">bool</type>
            <type by_reference="false">array</type>
          </tag>
          <tag line="201" name="return" description="- id of document created" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="201" name="since" description="1.0"/>
        </docblock>
        <argument line="222">
          <name>$document</name>
          <default></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="222">
          <name>$collectionId</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="222">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="265" package="triagens\ArangoDb">
        <name>save</name>
        <full_name>save</full_name>
        <docblock line="245">
          <description>save a document to a collection</description>
          <long-description>&lt;p&gt;This will add the document to the collection and return the document's id&lt;/p&gt;

&lt;p&gt;This will throw if the document cannot be saved&lt;/p&gt;</long-description>
          <tag line="245" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="245" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="245" name="param" description="- the document to be added, can be passed as a document or an array" type="mixed" variable="$document">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="245" name="param" description="- optional, prior to v1.2.0 this was a boolean value for create. Since v1.0.0 it's an array of options.&#10;&lt;p&gt;Options are :&lt;br&gt;&#10;&lt;li&gt;'create' - create the collection if it does not yet exist.&lt;/li&gt;&#10;&lt;li&gt;'waitForSync' -  if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.&lt;/li&gt;&#10;&lt;/p&gt;" type="bool|array" variable="$options">
            <type by_reference="false">bool</type>
            <type by_reference="false">array</type>
          </tag>
          <tag line="245" name="return" description="- id of document created" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="245" name="since" description="1.0"/>
        </docblock>
        <argument line="265">
          <name>$collectionId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="265">
          <name>$document</name>
          <default></default>
          <type/>
        </argument>
        <argument line="265">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="337" package="triagens\ArangoDb">
        <name>update</name>
        <full_name>update</full_name>
        <docblock line="313">
          <description>Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document.</description>
          <long-description>&lt;p&gt;Attention - The behavior of this method has changed since version 1.1&lt;/p&gt;

&lt;p&gt;This will update the document on the server&lt;/p&gt;

&lt;p&gt;This will throw if the document cannot be updated&lt;/p&gt;

&lt;p&gt;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.&lt;/p&gt;</long-description>
          <tag line="313" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="313" name="param" description="- The patch document that will update the document in question" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="313" name="param" description="- optional, array of options (see below) or the boolean value for $policy (for compatibility prior to version 1.1 of this method)&#10;&lt;p&gt;Options are :&#10;&lt;li&gt;'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])&lt;/li&gt;&#10;&lt;li&gt;'keepNull' - can be used to instruct ArangoDB to delete existing attributes instead setting their values to null. Defaults to true (keep attributes when set to null)&lt;/li&gt;&#10;&lt;li&gt;'waitForSync' - can be used to force synchronisation of the document update operation to disk even in case that the waitForSync flag had been disabled for the entire collection&lt;/li&gt;&#10;&lt;/p&gt;" type="mixed" variable="$options">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="313" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="337">
          <name>$document</name>
          <default></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="337">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="372" package="triagens\ArangoDb">
        <name>updateById</name>
        <full_name>updateById</full_name>
        <docblock line="346">
          <description>Update an existing document in a collection, identified by collection id and document id
Attention - The behavior of this method has changed since version 1.1</description>
          <long-description>&lt;p&gt;This will update the document on the server&lt;/p&gt;

&lt;p&gt;This will throw if the document cannot be updated&lt;/p&gt;

&lt;p&gt;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.&lt;/p&gt;</long-description>
          <tag line="346" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="346" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="346" name="param" description="- document id as string or number" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="346" name="param" description="- patch document which contains the attributes and values to be updated" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="346" name="param" description="- optional, array of options (see below) or the boolean value for $policy (for compatibility prior to version 1.1 of this method)&#10;&lt;p&gt;Options are :&#10;&lt;li&gt;'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])&lt;/li&gt;&#10;&lt;li&gt;'keepNull' - can be used to instruct ArangoDB to delete existing attributes instead setting their values to null. Defaults to true (keep attributes when set to null)&lt;/li&gt;&#10;&lt;li&gt;'waitForSync' - can be used to force synchronisation of the document update operation to disk even in case that the waitForSync flag had been disabled for the entire collection&lt;/li&gt;&#10;&lt;/p&gt;" type="mixed" variable="$options">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="346" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="372">
          <name>$collectionId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="372">
          <name>$documentId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="372">
          <name>$document</name>
          <default></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="372">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="427" package="triagens\ArangoDb">
        <name>replace</name>
        <full_name>replace</full_name>
        <docblock line="405">
          <description>Replace an existing document in a collection, identified by the document itself</description>
          <long-description>&lt;p&gt;This will update the document on the server&lt;/p&gt;

&lt;p&gt;This will throw if the document cannot be updated&lt;/p&gt;

&lt;p&gt;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.&lt;/p&gt;</long-description>
          <tag line="405" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="405" name="param" description="- document to be updated" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="405" name="param" description="- optional, array of options (see below) or the boolean value for $policy (for compatibility prior to version 1.1 of this method)&#10;&lt;p&gt;Options are :&#10;&lt;li&gt;'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])&lt;/li&gt;&#10;&lt;li&gt;'waitForSync' - can be used to force synchronisation of the document update operation to disk even in case that the waitForSync flag had been disabled for the entire collection&lt;/li&gt;&#10;&lt;/p&gt;" type="mixed" variable="$options">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="405" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="427">
          <name>$document</name>
          <default></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="427">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="460" package="triagens\ArangoDb">
        <name>replaceById</name>
        <full_name>replaceById</full_name>
        <docblock line="436">
          <description>Replace an existing document in a collection, identified by collection id and document id</description>
          <long-description>&lt;p&gt;This will update the document on the server&lt;/p&gt;

&lt;p&gt;This will throw if the document cannot be Replaced&lt;/p&gt;

&lt;p&gt;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.&lt;/p&gt;</long-description>
          <tag line="436" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="436" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="436" name="param" description="- document id as string or number" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="436" name="param" description="- document to be updated" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="436" name="param" description="- optional, array of options (see below) or the boolean value for $policy (for compatibility prior to version 1.1 of this method)&#10;&lt;p&gt;Options are :&#10;&lt;li&gt;'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])&lt;/li&gt;&#10;&lt;li&gt;'waitForSync' - can be used to force synchronisation of the document replacement operation to disk even in case that the waitForSync flag had been disabled for the entire collection&lt;/li&gt;&#10;&lt;/p&gt;" type="mixed" variable="$options">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="436" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="460">
          <name>$collectionId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="460">
          <name>$documentId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="460">
          <name>$document</name>
          <default></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="460">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="508" package="triagens\ArangoDb">
        <name>delete</name>
        <full_name>delete</full_name>
        <docblock line="491">
          <description>Delete a document from a collection, identified by the document itself</description>
          <long-description></long-description>
          <tag line="491" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="491" name="param" description="- document to be updated" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="491" name="param" description="- optional, array of options (see below) or the boolean value for $policy (for compatibility prior to version 1.1 of this method)&#10;&lt;p&gt;Options are :&#10;&lt;li&gt;'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])&lt;/li&gt;&#10;&lt;li&gt;'waitForSync' - can be used to force synchronisation of the document replacement operation to disk even in case that the waitForSync flag had been disabled for the entire collection&lt;/li&gt;&#10;&lt;/p&gt;" type="mixed" variable="$options">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="491" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="491" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by remove()"/>
        </docblock>
        <argument line="508">
          <name>$document</name>
          <default></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="508">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="528" package="triagens\ArangoDb">
        <name>remove</name>
        <full_name>remove</full_name>
        <docblock line="514">
          <description>Remove a document from a collection, identified by the document itself</description>
          <long-description></long-description>
          <tag line="514" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="514" name="param" description="- document to be removed" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="514" name="param" description="- optional, array of options (see below) or the boolean value for $policy (for compatibility prior to version 1.1 of this method)&#10;&lt;p&gt;Options are :&#10;&lt;li&gt;'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])&lt;/li&gt;&#10;&lt;li&gt;'waitForSync' - can be used to force synchronisation of the document removal operation to disk even in case that the waitForSync flag had been disabled for the entire collection&lt;/li&gt;&#10;&lt;/p&gt;" type="mixed" variable="$options">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="514" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="528">
          <name>$document</name>
          <default></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="528">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="557" package="triagens\ArangoDb">
        <name>deleteById</name>
        <full_name>deleteById</full_name>
        <docblock line="539">
          <description>Delete a document from a collection, identified by the collection id and document id</description>
          <long-description></long-description>
          <tag line="539" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="539" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="539" name="param" description="- document id as string or number" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="539" name="param" description="- optional revision of the document to be deleted" type="mixed" variable="$revision">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="539" name="param" description="- optional, array of options (see below) or the boolean value for $policy (for compatibility prior to version 1.1 of this method)&#10;&lt;p&gt;Options are :&#10;&lt;li&gt;'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])&lt;/li&gt;&#10;&lt;li&gt;'waitForSync' - can be used to force synchronisation of the document replacement operation to disk even in case that the waitForSync flag had been disabled for the entire collection&lt;/li&gt;&#10;&lt;/p&gt;" type="mixed" variable="$options">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="539" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="539" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by removeById()"/>
        </docblock>
        <argument line="557">
          <name>$collectionId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="557">
          <name>$documentId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="557">
          <name>$revision</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="557">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="581" package="triagens\ArangoDb">
        <name>removeById</name>
        <full_name>removeById</full_name>
        <docblock line="565">
          <description>Remove a document from a collection, identified by the collection id and document id</description>
          <long-description></long-description>
          <tag line="565" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="565" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="565" name="param" description="- document id as string or number" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="565" name="param" description="- optional revision of the document to be deleted" type="mixed" variable="$revision">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="565" name="param" description="- optional, array of options (see below) or the boolean value for $policy (for compatibility prior to version 1.1 of this method)&#10;&lt;p&gt;Options are :&#10;&lt;li&gt;'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])&lt;/li&gt;&#10;&lt;li&gt;'waitForSync' - can be used to force synchronisation of the document removal operation to disk even in case that the waitForSync flag had been disabled for the entire collection&lt;/li&gt;&#10;&lt;/p&gt;" type="mixed" variable="$options">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="565" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="581">
          <name>$collectionId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="581">
          <name>$documentId</name>
          <default></default>
          <type/>
        </argument>
        <argument line="581">
          <name>$revision</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="581">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="617" package="triagens\ArangoDb">
        <name>getDocumentId</name>
        <full_name>getDocumentId</full_name>
        <docblock line="608">
          <description>Helper function to get a document id from a document or a document id value</description>
          <long-description></long-description>
          <tag line="608" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="608" name="param" description="- document id OR document to be updated" type="mixed" variable="$document">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="608" name="return" description="- document id, will throw if there is an error" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="617">
          <name>$document</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="642" package="triagens\ArangoDb">
        <name>getRevision</name>
        <full_name>getRevision</full_name>
        <docblock line="633">
          <description>Helper function to get a document id from a document or a document id value</description>
          <long-description></long-description>
          <tag line="633" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="633" name="param" description="- document id OR document to be updated" type="mixed" variable="$document">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="633" name="return" description="- document id, will throw if there is an error" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="642">
          <name>$document</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="663" package="triagens\ArangoDb">
        <name>getCollectionId</name>
        <full_name>getCollectionId</full_name>
        <docblock line="654">
          <description>Helper function to get a collection id from a document</description>
          <long-description></long-description>
          <tag line="654" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="654" name="param" description="- document id" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="654" name="return" description="- collection id, will throw if there is an error" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="663">
          <name>$document</name>
          <default></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
      </method>
    </class>
  </file>
  <file path="UserHandler.php" hash="6f72797ca96b02aaccaab7de9bc7021f" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: user document handler</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Frank Mayer"/>
      <tag line="3" name="since" description="1.2"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="21" package="triagens\ArangoDb">
      <extends>\triagens\ArangoDb\Handler</extends>
      <name>UserHandler</name>
      <full_name>\triagens\ArangoDb\UserHandler</full_name>
      <docblock line="13">
        <description>A user-document handler that fetches vertices from the server and
persists them on the server.</description>
        <long-description>&lt;p&gt;It does so by issuing the
appropriate HTTP requests to the server.&lt;/p&gt;</long-description>
        <tag line="13" name="package" description="triagens\ArangoDb"/>
        <tag line="13" name="since" description="1.2"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="45" package="triagens\ArangoDb">
        <name>addUser</name>
        <full_name>addUser</full_name>
        <docblock line="25">
          <description>save an user to the user-collection</description>
          <long-description>&lt;p&gt;This will save the user to the user-collection&lt;/p&gt;

&lt;p&gt;This will throw if the user cannot be saved&lt;/p&gt;</long-description>
          <tag line="25" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="25" name="param" description="- The name of the user as a string. This is mandatory." type="mixed" variable="$username">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="25" name="param" description="- The user password as a string. If no password is specified, the empty string will be used." type="mixed" variable="$passwd">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="25" name="param" description="- an optional flag that specifies whether the user is active. If not specified, this will default to true." type="mixed" variable="$active">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="25" name="param" description="- an optional array with arbitrary extra data about the user." type="array" variable="$extra">
            <type by_reference="false">array</type>
          </tag>
          <tag line="25" name="param" description="- an array of options&#10;&lt;p&gt;Options are :&lt;br&gt;&#10;&lt;/p&gt;" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="25" name="return" description="- true, if user could be saved" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="25" name="since" description="1.2"/>
        </docblock>
        <argument line="45">
          <name>$username</name>
          <default></default>
          <type/>
        </argument>
        <argument line="45">
          <name>$passwd</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="45">
          <name>$active</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="45">
          <name>$extra</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="45">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="79" package="triagens\ArangoDb">
        <name>replaceUser</name>
        <full_name>replaceUser</full_name>
        <docblock line="60">
          <description>Replace an existing User, identified by its username</description>
          <long-description>&lt;p&gt;This will replace the user-document on the server&lt;/p&gt;

&lt;p&gt;This will throw if the document cannot be Replaced&lt;/p&gt;</long-description>
          <tag line="60" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="60" name="param" description="- The name of the user as a string, who's user-data is going to be replaced. This is mandatory." type="mixed" variable="$username">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="60" name="param" description="- The user password as a string. If no password is specified, the empty string will be used." type="mixed" variable="$passwd">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="60" name="param" description="- an optional flag that specifies whether the user is active. If not specified, this will default to true." type="mixed" variable="$active">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="60" name="param" description="- an optional array with arbitrary extra data about the user." type="array" variable="$extra">
            <type by_reference="false">array</type>
          </tag>
          <tag line="60" name="param" description="- an array of options&#10;&lt;p&gt;Options are :&#10;&lt;/p&gt;" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="60" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="79">
          <name>$username</name>
          <default></default>
          <type/>
        </argument>
        <argument line="79">
          <name>$passwd</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="79">
          <name>$active</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="79">
          <name>$extra</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="79">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="112" package="triagens\ArangoDb">
        <name>updateUser</name>
        <full_name>updateUser</full_name>
        <docblock line="93">
          <description>Update an existing user, identified by the username</description>
          <long-description>&lt;p&gt;This will update the user-document on the server&lt;/p&gt;

&lt;p&gt;This will throw if the document cannot be updated&lt;/p&gt;</long-description>
          <tag line="93" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="93" name="param" description="- The name of the user as a string, who's user-data is going to be updated. This is mandatory." type="mixed" variable="$username">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="93" name="param" description="- The user password as a string. If no password is specified, the empty string will be used." type="mixed" variable="$passwd">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="93" name="param" description="- an optional flag that specifies whether the user is active. If not specified, this will default to true." type="mixed" variable="$active">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="93" name="param" description="- an optional array with arbitrary extra data about the user." type="array" variable="$extra">
            <type by_reference="false">array</type>
          </tag>
          <tag line="93" name="param" description="- an array of options&#10;&lt;p&gt;Options are :&#10;&lt;/p&gt;" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="93" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="112">
          <name>$username</name>
          <default></default>
          <type/>
        </argument>
        <argument line="112">
          <name>$passwd</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="112">
          <name>$active</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="112">
          <name>$extra</name>
          <default>null</default>
          <type/>
        </argument>
        <argument line="112">
          <name>$options</name>
          <default>array()</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="144" package="triagens\ArangoDb">
        <name>get</name>
        <full_name>get</full_name>
        <docblock line="133">
          <description>Get a single user-document, identified by the username</description>
          <long-description>&lt;p&gt;This will throw if the document cannot be fetched from the server&lt;/p&gt;</long-description>
          <tag line="133" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="133" name="param" description="- username as a string" type="mixed" variable="$username">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="133" name="return" description="- the user-document fetched from the server" type="\triagens\ArangoDb\User">
            <type by_reference="false">\triagens\ArangoDb\User</type>
          </tag>
        </docblock>
        <argument line="144">
          <name>$username</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="166" package="triagens\ArangoDb">
        <name>removeUser</name>
        <full_name>removeUser</full_name>
        <docblock line="157">
          <description>Remove a user, identified by the username</description>
          <long-description></long-description>
          <tag line="157" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="157" name="param" description="- username as a string, of the user that is to be deleted" type="mixed" variable="$username">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="157" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="166">
          <name>$username</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="Connection.php" hash="5b2cfdd5a25061682b9b528ec6df418a" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: connection</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Jan Steemann"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="22" package="triagens\ArangoDb">
      <extends/>
      <name>Connection</name>
      <full_name>\triagens\ArangoDb\Connection</full_name>
      <docblock line="13">
        <description>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.</description>
        <long-description>&lt;p&gt;Instead, connections are established on the fly for each request
and are destroyed afterwards.&lt;/p&gt;</long-description>
        <tag line="13" name="package" description="triagens\ArangoDb"/>
      </docblock>
      <property final="false" static="true" visibility="public" line="29" namespace="triagens\ArangoDb" package="Default">
        <name>$_apiVersion</name>
        <default>'1.2.0'</default>
        <docblock line="24">
          <description>Api Version</description>
          <long-description></long-description>
          <tag line="24" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="36" namespace="triagens\ArangoDb" package="Default">
        <name>$_options</name>
        <default></default>
        <docblock line="31">
          <description>Connection options</description>
          <long-description></long-description>
          <tag line="31" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="43" namespace="triagens\ArangoDb" package="Default">
        <name>$_handle</name>
        <default></default>
        <docblock line="38">
          <description>Connection handle, used in case of keep-alive</description>
          <long-description></long-description>
          <tag line="38" name="var" description="" type="resource">
            <type by_reference="false">resource</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="50" namespace="triagens\ArangoDb" package="Default">
        <name>$_useKeepAlive</name>
        <default></default>
        <docblock line="45">
          <description>Flag if keep-alive connections are used</description>
          <long-description></long-description>
          <tag line="45" name="var" description="" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="57" namespace="triagens\ArangoDb" package="Default">
        <name>$_batches</name>
        <default>array()</default>
        <docblock line="52">
          <description>Batches Array</description>
          <long-description></long-description>
          <tag line="52" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="64" namespace="triagens\ArangoDb" package="Default">
        <name>$_activeBatch</name>
        <default>null</default>
        <docblock line="59">
          <description>$_activeBatch object</description>
          <long-description></long-description>
          <tag line="59" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="71" namespace="triagens\ArangoDb" package="Default">
        <name>$_captureBatch</name>
        <default>false</default>
        <docblock line="66">
          <description>$_captureBatch boolean</description>
          <long-description></long-description>
          <tag line="66" name="var" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="78" namespace="triagens\ArangoDb" package="Default">
        <name>$_batchRequest</name>
        <default>false</default>
        <docblock line="73">
          <description>$_batchRequest boolean</description>
          <long-description></long-description>
          <tag line="73" name="var" description="" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="89" package="triagens\ArangoDb">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="80">
          <description>Set up the connection object, validate the options provided</description>
          <long-description></long-description>
          <tag line="80" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="80" name="param" description="- initial connection options" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="80" name="return" description="" type="\triagens\ArangoDb\Connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
        </docblock>
        <argument line="89">
          <name>$options</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="100" package="triagens\ArangoDb">
        <name>__destruct</name>
        <full_name>__destruct</full_name>
        <docblock line="95">
          <description>Close existing connection handle if a keep-alive connection was used</description>
          <long-description></long-description>
          <tag line="95" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="116" package="triagens\ArangoDb">
        <name>getOption</name>
        <full_name>getOption</full_name>
        <docblock line="107">
          <description>Get an option set for the connection</description>
          <long-description></long-description>
          <tag line="107" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="107" name="param" description="- name of option" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="107" name="return" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="116">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="132" package="triagens\ArangoDb">
        <name>get</name>
        <full_name>get</full_name>
        <docblock line="123">
          <description>Issue an HTTP GET request</description>
          <long-description></long-description>
          <tag line="123" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="123" name="param" description="- GET URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="123" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="132">
          <name>$url</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="149" package="triagens\ArangoDb">
        <name>post</name>
        <full_name>post</full_name>
        <docblock line="139">
          <description>Issue an HTTP POST request with the data provided</description>
          <long-description></long-description>
          <tag line="139" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="139" name="param" description="- POST URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="139" name="param" description="- body to post" type="string" variable="$data">
            <type by_reference="false">string</type>
          </tag>
          <tag line="139" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="149">
          <name>$url</name>
          <default></default>
          <type/>
        </argument>
        <argument line="149">
          <name>$data</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="166" package="triagens\ArangoDb">
        <name>put</name>
        <full_name>put</full_name>
        <docblock line="156">
          <description>Issue an HTTP PUT request with the data provided</description>
          <long-description></long-description>
          <tag line="156" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="156" name="param" description="- PUT URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="156" name="param" description="- body to post" type="string" variable="$data">
            <type by_reference="false">string</type>
          </tag>
          <tag line="156" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="166">
          <name>$url</name>
          <default></default>
          <type/>
        </argument>
        <argument line="166">
          <name>$data</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="183" package="triagens\ArangoDb">
        <name>patch</name>
        <full_name>patch</full_name>
        <docblock line="173">
          <description>Issue an HTTP PATCH request with the data provided</description>
          <long-description></long-description>
          <tag line="173" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="173" name="param" description="- PATCH URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="173" name="param" description="- patch body" type="string" variable="$data">
            <type by_reference="false">string</type>
          </tag>
          <tag line="173" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="183">
          <name>$url</name>
          <default></default>
          <type/>
        </argument>
        <argument line="183">
          <name>$data</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="199" package="triagens\ArangoDb">
        <name>delete</name>
        <full_name>delete</full_name>
        <docblock line="190">
          <description>Issue an HTTP DELETE request with the data provided</description>
          <long-description></long-description>
          <tag line="190" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="190" name="param" description="- DELETE URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="190" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="199">
          <name>$url</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="215" package="triagens\ArangoDb">
        <name>getHandle</name>
        <full_name>getHandle</full_name>
        <docblock line="207">
          <description>Get a connection handle</description>
          <long-description>&lt;p&gt;If keep-alive connections are used, the handle will be stored and re-used&lt;/p&gt;</long-description>
          <tag line="207" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="207" name="return" description="- connection handle" type="resource">
            <type by_reference="false">resource</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="256" package="triagens\ArangoDb">
        <name>parseResponse</name>
        <full_name>parseResponse</full_name>
        <docblock line="247">
          <description>Parse the response return the body values as an assoc array</description>
          <long-description></long-description>
          <tag line="247" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="247" name="param" description="- the response as supplied by the server" type="\triagens\ArangoDb\HttpResponse" variable="$response">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
          <tag line="247" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="256">
          <name>$response</name>
          <default></default>
          <type>\triagens\ArangoDb\HttpResponse</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="300" package="triagens\ArangoDb">
        <name>executeRequest</name>
        <full_name>executeRequest</full_name>
        <docblock line="283">
          <description>Execute an HTTP request and return the results</description>
          <long-description>&lt;p&gt;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.&lt;/p&gt;

&lt;p&gt;The function might temporarily alter the value of the php.ini value 'default_socket_timeout' but
will restore it.&lt;/p&gt;</long-description>
          <tag line="283" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="283" name="param" description="- HTTP request method" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="283" name="param" description="- HTTP URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="283" name="param" description="- data to post in body" type="string" variable="$data">
            <type by_reference="false">string</type>
          </tag>
          <tag line="283" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="300">
          <name>$method</name>
          <default></default>
          <type/>
        </argument>
        <argument line="300">
          <name>$url</name>
          <default></default>
          <type/>
        </argument>
        <argument line="300">
          <name>$data</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="393" package="triagens\ArangoDb">
        <name>getVersion</name>
        <full_name>getVersion</full_name>
        <docblock line="388">
          <description>Get the client version (alias for getClientVersion)</description>
          <long-description></long-description>
          <tag line="388" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="404" package="triagens\ArangoDb">
        <name>getClientVersion</name>
        <full_name>getClientVersion</full_name>
        <docblock line="399">
          <description>Get the client version</description>
          <long-description></long-description>
          <tag line="399" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="415" package="triagens\ArangoDb">
        <name>stopCaptureBatch</name>
        <full_name>stopCaptureBatch</full_name>
        <docblock line="410">
          <description>Stop capturing commands</description>
          <long-description></long-description>
          <tag line="410" name="return" description="- Returns the active batch object" type="\triagens\ArangoDb\Batch">
            <type by_reference="false">\triagens\ArangoDb\Batch</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="428" package="triagens\ArangoDb">
        <name>getActiveBatch</name>
        <full_name>getActiveBatch</full_name>
        <docblock line="423">
          <description>returns the active batch</description>
          <long-description></long-description>
          <tag line="423" name="return" description="active batch" type="\triagens\ArangoDb\Batch">
            <type by_reference="false">\triagens\ArangoDb\Batch</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="440" package="triagens\ArangoDb">
        <name>setActiveBatch</name>
        <full_name>setActiveBatch</full_name>
        <docblock line="433">
          <description>Sets the active Batch for this connection</description>
          <long-description></long-description>
          <tag line="433" name="param" description="- Sets the given batch as active" type="\triagens\ArangoDb\Batch" variable="$batch">
            <type by_reference="false">\triagens\ArangoDb\Batch</type>
          </tag>
          <tag line="433" name="return" description="active batch" type="\triagens\ArangoDb\Batch">
            <type by_reference="false">\triagens\ArangoDb\Batch</type>
          </tag>
        </docblock>
        <argument line="440">
          <name>$batch</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="453" package="triagens\ArangoDb">
        <name>setCaptureBatch</name>
        <full_name>setCaptureBatch</full_name>
        <docblock line="448">
          <description>Sets the batch capture state (true, if capturing)</description>
          <long-description></long-description>
          <tag line="448" name="param" description="true to turn on capture batch mode, false to turn it off" type="boolean" variable="$state">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="453">
          <name>$state</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="464" package="triagens\ArangoDb">
        <name>setBatchRequest</name>
        <full_name>setBatchRequest</full_name>
        <docblock line="459">
          <description>Sets connection into Batch-request mode.</description>
          <long-description>&lt;p&gt;This is needed for some operations to act differently when in this mode.&lt;/p&gt;</long-description>
          <tag line="459" name="param" description="sets the connection state to batch request, meaning it is currently doing a batch request." type="boolean" variable="$state">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="464">
          <name>$state</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="477" package="triagens\ArangoDb">
        <name>isInBatchCaptureMode</name>
        <full_name>isInBatchCaptureMode</full_name>
        <docblock line="470">
          <description>Returns true if this connection is in Batch-Capture mode</description>
          <long-description></long-description>
          <tag line="470" name="return" description="returns the active batch" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="488" package="triagens\ArangoDb">
        <name>getBatches</name>
        <full_name>getBatches</full_name>
        <docblock line="484">
          <description>returns the active batch</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="507" package="triagens\ArangoDb">
        <name>doBatch</name>
        <full_name>doBatch</full_name>
        <docblock line="494">
          <description>This is a helper function to executeRequest that captures requests if we're in batch mode</description>
          <long-description></long-description>
          <tag line="494" name="param" description="- The method of the request (GET, POST...)" type="mixed" variable="$method">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="494" name="param" description="- The request to process&#10;This checks if we're in batch mode and returns a placeholder object,&#10;since we need to return some object that is expected by the caller.&#10;if we're not in batch mode it doesn't return anything, and" type="string" variable="$request">
            <type by_reference="false">string</type>
          </tag>
          <tag line="494" name="return" description="Batchpart or null if not in batch capturing mode" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="507">
          <name>$method</name>
          <default></default>
          <type/>
        </argument>
        <argument line="507">
          <name>$request</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="532" package="triagens\ArangoDb">
        <name>detect_utf</name>
        <full_name>detect_utf</full_name>
        <docblock line="523">
          <description>This function checks that the encoding of a string is utf.</description>
          <long-description>&lt;p&gt;It only checks for printable characters.&lt;/p&gt;</long-description>
          <tag line="523" name="param" description="the data to check" type="array" variable="$string">
            <type by_reference="false">array</type>
          </tag>
          <tag line="523" name="return" description="true if string is UTF-8, false if not" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="532">
          <name>$string</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="564" package="triagens\ArangoDb">
        <name>check_encoding</name>
        <full_name>check_encoding</full_name>
        <docblock line="555">
          <description>This function checks that the encoding of the keys and
values of the array are utf-8, recursively.</description>
          <long-description>&lt;p&gt;It will raise an exception if it encounters wrong encoded strings.&lt;/p&gt;</long-description>
          <tag line="555" name="param" description="the data to check" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
          <tag line="555" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
        </docblock>
        <argument line="564">
          <name>$data</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="603" package="triagens\ArangoDb">
        <name>json_encode_wrapper</name>
        <full_name>json_encode_wrapper</full_name>
        <docblock line="593">
          <description>This is a json_encode() wrapper that also checks if the data is utf-8 conform.</description>
          <long-description>&lt;p&gt;internally it calls the check_encoding() method. If that method does not throw
an Exception, this method will happily return the json_encoded data.&lt;/p&gt;</long-description>
          <tag line="593" name="param" description="the data to encode" type="mixed" variable="$data">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="593" name="param" description="the options for the json_encode() call" type="mixed" variable="$options">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="593" name="return" description="the result of the json_encode" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="603">
          <name>$data</name>
          <default></default>
          <type/>
        </argument>
        <argument line="603">
          <name>$options</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="TraceRequest.php" hash="39a9c5785d319fac2670fc889006406e" package="triagens\ArangoDb">
    <docblock line="2">
      <description>ArangoDB PHP client: connection</description>
      <long-description></long-description>
      <tag line="2" name="package" description="triagens\ArangoDb"/>
      <tag line="2" name="author" description="Jan Steemann"/>
      <tag line="2" name="author" description="Francis Chuang"/>
      <tag line="2" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="19" package="triagens\ArangoDb">
      <extends/>
      <name>TraceRequest</name>
      <full_name>\triagens\ArangoDb\TraceRequest</full_name>
      <docblock line="13">
        <description>Class TraceRequest</description>
        <long-description></long-description>
        <tag line="13" name="author" description="Francis Chuang"/>
        <tag line="13" name="package" description="triagens\ArangoDb"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="26" namespace="triagens\ArangoDb" package="Default">
        <name>$_headers</name>
        <default>array()</default>
        <docblock line="21">
          <description>Stores each header as an array (key =&gt; value) element</description>
          <long-description></long-description>
          <tag line="21" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="33" namespace="triagens\ArangoDb" package="Default">
        <name>$_method</name>
        <default></default>
        <docblock line="28">
          <description>Stores the http method</description>
          <long-description></long-description>
          <tag line="28" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="40" namespace="triagens\ArangoDb" package="Default">
        <name>$_requestUrl</name>
        <default></default>
        <docblock line="35">
          <description>Stores the request url</description>
          <long-description></long-description>
          <tag line="35" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="47" namespace="triagens\ArangoDb" package="Default">
        <name>$_body</name>
        <default></default>
        <docblock line="42">
          <description>Store the string of the body</description>
          <long-description></long-description>
          <tag line="42" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="54" namespace="triagens\ArangoDb" package="Default">
        <name>$_type</name>
        <default>"request"</default>
        <docblock line="49">
          <description>The http message type</description>
          <long-description></long-description>
          <tag line="49" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="64" package="triagens\ArangoDb">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="56">
          <description>Set up the request trace</description>
          <long-description></long-description>
          <tag line="56" name="param" description="- the array of http headers" type="array" variable="$headers">
            <type by_reference="false">array</type>
          </tag>
          <tag line="56" name="param" description="- the request method" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="56" name="param" description="- the request url" type="string" variable="$requestUrl">
            <type by_reference="false">string</type>
          </tag>
          <tag line="56" name="param" description="- the string of http body" type="string" variable="$body">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="64">
          <name>$headers</name>
          <default></default>
          <type/>
        </argument>
        <argument line="64">
          <name>$method</name>
          <default></default>
          <type/>
        </argument>
        <argument line="64">
          <name>$requestUrl</name>
          <default></default>
          <type/>
        </argument>
        <argument line="64">
          <name>$body</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="77" package="triagens\ArangoDb">
        <name>getHeaders</name>
        <full_name>getHeaders</full_name>
        <docblock line="72">
          <description>Get an array of the request headers</description>
          <long-description></long-description>
          <tag line="72" name="return" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="87" package="triagens\ArangoDb">
        <name>getMethod</name>
        <full_name>getMethod</full_name>
        <docblock line="82">
          <description>Get the request method</description>
          <long-description></long-description>
          <tag line="82" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="97" package="triagens\ArangoDb">
        <name>getRequestUrl</name>
        <full_name>getRequestUrl</full_name>
        <docblock line="92">
          <description>Get the request url</description>
          <long-description></long-description>
          <tag line="92" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="107" package="triagens\ArangoDb">
        <name>getBody</name>
        <full_name>getBody</full_name>
        <docblock line="102">
          <description>Get the body of the request</description>
          <long-description></long-description>
          <tag line="102" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="117" package="triagens\ArangoDb">
        <name>getType</name>
        <full_name>getType</full_name>
        <docblock line="112">
          <description>Get the http message type</description>
          <long-description></long-description>
          <tag line="112" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="DefaultValues.php" hash="d269cdb0596faa95a322eaac823d440e" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: default values</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Jan Steemann"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="true" namespace="triagens\ArangoDb" line="18" package="triagens\ArangoDb">
      <extends/>
      <name>DefaultValues</name>
      <full_name>\triagens\ArangoDb\DefaultValues</full_name>
      <docblock line="13">
        <description>Contains default values used by the client</description>
        <long-description></long-description>
        <tag line="13" name="package" description="triagens\ArangoDb"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="23" package="triagens\ArangoDb">
        <name>DEFAULT_PORT</name>
        <full_name>DEFAULT_PORT</full_name>
        <value>8529</value>
        <docblock line="20">
          <description>Default port number (used if no port specified)</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="28" package="triagens\ArangoDb">
        <name>DEFAULT_TIMEOUT</name>
        <full_name>DEFAULT_TIMEOUT</full_name>
        <value>30</value>
        <docblock line="25">
          <description>Default timeout value (used if no timeout value specified)</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="33" package="triagens\ArangoDb">
        <name>DEFAULT_WAIT_SYNC</name>
        <full_name>DEFAULT_WAIT_SYNC</full_name>
        <value>false</value>
        <docblock line="30">
          <description>Default value for waitForSync (fsync all data to disk on document updates/insertions/deletions)</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="38" package="triagens\ArangoDb">
        <name>DEFAULT_JOURNAL_SIZE</name>
        <full_name>DEFAULT_JOURNAL_SIZE</full_name>
        <value>33554432</value>
        <docblock line="35">
          <description>Default value for collection journal size</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="43" package="triagens\ArangoDb">
        <name>DEFAULT_IS_VOLATILE</name>
        <full_name>DEFAULT_IS_VOLATILE</full_name>
        <value>false</value>
        <docblock line="40">
          <description>Default value for isVolatile</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="48" package="triagens\ArangoDb">
        <name>DEFAULT_CREATE</name>
        <full_name>DEFAULT_CREATE</full_name>
        <value>false</value>
        <docblock line="45">
          <description>Default value for createCollection (create the collection on the fly when the first document is added to an unknown collection)</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="53" package="triagens\ArangoDb">
        <name>DEFAULT_CONNECTION</name>
        <full_name>DEFAULT_CONNECTION</full_name>
        <value>"Close"</value>
        <docblock line="50">
          <description>Default value for HTTP Connection header</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="58" package="triagens\ArangoDb">
        <name>DEFAULT_UPDATE_POLICY</name>
        <full_name>DEFAULT_UPDATE_POLICY</full_name>
        <value>\triagens\ArangoDb\UpdatePolicy::ERROR</value>
        <docblock line="55">
          <description>Default update policy</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="63" package="triagens\ArangoDb">
        <name>DEFAULT_REPLACE_POLICY</name>
        <full_name>DEFAULT_REPLACE_POLICY</full_name>
        <value>\triagens\ArangoDb\UpdatePolicy::ERROR</value>
        <docblock line="60">
          <description>Default replace policy</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="68" package="triagens\ArangoDb">
        <name>DEFAULT_DELETE_POLICY</name>
        <full_name>DEFAULT_DELETE_POLICY</full_name>
        <value>\triagens\ArangoDb\UpdatePolicy::ERROR</value>
        <docblock line="65">
          <description>Default delete policy</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="73" package="triagens\ArangoDb">
        <name>DEFAULT_CHECK_UTF8_CONFORM</name>
        <full_name>DEFAULT_CHECK_UTF8_CONFORM</full_name>
        <value>true</value>
        <docblock line="70">
          <description>Default value for checking if data is UTF-8 conform</description>
          <long-description></long-description>
        </docblock>
      </constant>
    </class>
  </file>
  <file path="ConnectException.php" hash="212d8897121afe4e5403b4937c9d30ca" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: connect exception</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Jan Steemann"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="19" package="triagens\ArangoDb">
      <extends>\triagens\ArangoDb\Exception</extends>
      <name>ConnectException</name>
      <full_name>\triagens\ArangoDb\ConnectException</full_name>
      <docblock line="13">
        <description>This exception type will be thrown by the client when there is an error
during connecting to the server</description>
        <long-description></long-description>
        <tag line="13" name="package" description="triagens\ArangoDb"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="27" package="triagens\ArangoDb">
        <name>__toString</name>
        <full_name>__toString</full_name>
        <docblock line="22">
          <description>Return a string representation of the exception</description>
          <long-description></long-description>
          <tag line="22" name="return" description="- string representation" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="ClientException.php" hash="a131c14f4e09eea391dee0c7dd9008ac" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: client exception</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Jan Steemann"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="19" package="triagens\ArangoDb">
      <extends>\triagens\ArangoDb\Exception</extends>
      <name>ClientException</name>
      <full_name>\triagens\ArangoDb\ClientException</full_name>
      <docblock line="13">
        <description>This exception type will be thrown by the client when there is an error
on the client side, i.e.</description>
        <long-description>&lt;p&gt;something the server is not involved in.&lt;/p&gt;</long-description>
        <tag line="13" name="package" description="triagens\ArangoDb"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="27" package="triagens\ArangoDb">
        <name>__toString</name>
        <full_name>__toString</full_name>
        <docblock line="22">
          <description>Return a string representation of the exception</description>
          <long-description></long-description>
          <tag line="22" name="return" description="- string representation" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="ServerException.php" hash="6460d3bd51f465e8498b739838a5aec3" package="triagens\ArangoDb">
    <docblock line="3">
      <description>ArangoDB PHP client: server exception</description>
      <long-description></long-description>
      <tag line="3" name="package" description="triagens\ArangoDb"/>
      <tag line="3" name="author" description="Jan Steemann"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="24" package="triagens\ArangoDb">
      <extends>\triagens\ArangoDb\Exception</extends>
      <name>ServerException</name>
      <full_name>\triagens\ArangoDb\ServerException</full_name>
      <docblock line="13">
        <description>This exception type will be thrown by the client when the server returns an
error in response to a client request.</description>
        <long-description>&lt;p&gt;The exception code is the HTTP status code as returned by
the server. In case the server provides additional details
about the error, these details can be queried using the
getDetails() function.&lt;/p&gt;</long-description>
        <tag line="13" name="package" description="triagens\ArangoDb"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="37" package="triagens\ArangoDb">
        <name>ENTRY_CODE</name>
        <full_name>ENTRY_CODE</full_name>
        <value>'errorNum'</value>
        <docblock line="34">
          <description>Error number index</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="42" package="triagens\ArangoDb">
        <name>ENTRY_MESSAGE</name>
        <full_name>ENTRY_MESSAGE</full_name>
        <value>'errorMessage'</value>
        <docblock line="39">
          <description>Error message index</description>
          <long-description></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="32" namespace="triagens\ArangoDb" package="Default">
        <name>$_details</name>
        <default>array()</default>
        <docblock line="27">
          <description>Optional details for the exception</description>
          <long-description></long-description>
          <tag line="27" name="param" description="" type="array" variable="">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="49" package="triagens\ArangoDb">
        <name>__toString</name>
        <full_name>__toString</full_name>
        <docblock line="44">
          <description>