Location: PHPKode > projects > ArangoDB-PHP > triAGENS-ArangoDB-PHP-f618a05/docs/structure.xml
<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a1" title="ArangoDB PHP client API">
  <file path="triagens/ArangoDb/HttpHelper.php" hash="5030267e3d00c0ac2572e5c484f6a303" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: http helper methods]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>HttpHelper</name>
      <full_name>\triagens\ArangoDb\HttpHelper</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[Helper methods for HTTP request/response handling]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="22" package="Default">
        <name>METHOD_POST</name>
        <value><![CDATA['POST']]></value>
        <docblock line="19">
          <description><![CDATA[HTTP POST string constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="27" package="Default">
        <name>METHOD_PUT</name>
        <value><![CDATA['PUT']]></value>
        <docblock line="24">
          <description><![CDATA[HTTP PUT string constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="32" package="Default">
        <name>METHOD_DELETE</name>
        <value><![CDATA['DELETE']]></value>
        <docblock line="29">
          <description><![CDATA[HTTP DELETE string constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="37" package="Default">
        <name>METHOD_GET</name>
        <value><![CDATA['GET']]></value>
        <docblock line="34">
          <description><![CDATA[HTTP GET string constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="42" package="Default">
        <name>CHUNK_SIZE</name>
        <value><![CDATA[8192]]></value>
        <docblock line="39">
          <description><![CDATA[Chunk size (number of bytes processed in one batch)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="47" package="Default">
        <name>EOL</name>
        <value><![CDATA["\r\n"]]></value>
        <docblock line="44">
          <description><![CDATA[End of line mark used in HTTP]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="52" package="Default">
        <name>PROTOCOL</name>
        <value><![CDATA['HTTP/1.1']]></value>
        <docblock line="49">
          <description><![CDATA[HTTP protocol used]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="61" package="">
        <name>validateMethod</name>
        <type>function</type>
        <docblock line="54">
          <description><![CDATA[Validate an HTTP request method name]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="54" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="54" name="param" description="- method name" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="54" name="return" description="- always true, will throw if an invalid method name is supplied" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="61">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="81" package="">
        <name>buildRequest</name>
        <type>function</type>
        <docblock line="72">
          <description><![CDATA[Create a request string (header and body)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="72" name="param" description="- host name" type="string" variable="$host">
            <type by_reference="false">string</type>
          </tag>
          <tag line="72" name="param" description="- HTTP method" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="72" name="param" description="- HTTP URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="72" name="param" description="- optional body to post" type="string" variable="$body">
            <type by_reference="false">string</type>
          </tag>
          <tag line="72" name="return" description="- assembled HTTP request string" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="81">
          <name>$host</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="81">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="81">
          <name>$url</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="81">
          <name>$body</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="106" package="">
        <name>transfer</name>
        <type>function</type>
        <docblock line="98">
          <description><![CDATA[Execute an HTTP request on an opened socket
It is the caller's responsibility to close the socket]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="98" name="param" description="- connection socket (must be open)" type="resource" variable="$socket">
            <type by_reference="false">resource</type>
          </tag>
          <tag line="98" name="param" description="- complete HTTP request as a string" type="string" variable="$request">
            <type by_reference="false">string</type>
          </tag>
          <tag line="98" name="return" description="- HTTP response string as provided by the server" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="106">
          <name>$socket</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="106">
          <name>$request</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="133" package="">
        <name>createConnection</name>
        <type>function</type>
        <docblock line="125">
          <description><![CDATA[Create a one-time HTTP connection by opening a socket to the server
It is the caller's responsibility to close the socket]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="125" name="throws" description="" type="\triagens\ArangoDb\ConnectException">
            <type by_reference="false">\triagens\ArangoDb\ConnectException</type>
          </tag>
          <tag line="125" name="param" description="- connection options" type="\triagens\ArangoDb\ConnectionOptions" variable="$options">
            <type by_reference="false">\triagens\ArangoDb\ConnectionOptions</type>
          </tag>
          <tag line="125" name="return" description="- socket with server connection, will throw when no connection can be established" type="resource">
            <type by_reference="false">resource</type>
          </tag>
        </docblock>
        <argument line="133">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type>ConnectionOptions</type>
        </argument>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/Scope.php" hash="c71f9ed0151113233b1d5f83c3ba961f" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: scope]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>Scope</name>
      <full_name>\triagens\ArangoDb\Scope</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[Executes a function on scope entry and executes another function
(cleanup) when the scope is exited]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="47" package="Default">
        <name>STATE_NONE</name>
        <value><![CDATA[0]]></value>
        <docblock line="44">
          <description><![CDATA[Scope has not been entered]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="52" package="Default">
        <name>STATE_ENTERED</name>
        <value><![CDATA[1]]></value>
        <docblock line="49">
          <description><![CDATA[Scope has been entered but not left]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="57" package="Default">
        <name>STATE_LEFT</name>
        <value><![CDATA[2]]></value>
        <docblock line="54">
          <description><![CDATA[Scope has been entered and left]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="24" package="Default">
        <name>$_initFunc</name>
        <default><![CDATA[]]></default>
        <docblock line="20">
          <description><![CDATA[Initialization function (called on scope entry)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="20" name="var" description="" type="\triagens\ArangoDb\callable">
            <type by_reference="false">\triagens\ArangoDb\callable</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="30" package="Default">
        <name>$_exitFunc</name>
        <default><![CDATA[]]></default>
        <docblock line="26">
          <description><![CDATA[Exit function (called when scope is left)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="26" name="var" description="" type="\triagens\ArangoDb\callable">
            <type by_reference="false">\triagens\ArangoDb\callable</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="36" package="Default">
        <name>$_value</name>
        <default><![CDATA[]]></default>
        <docblock line="32">
          <description><![CDATA[Value returned by call to init function]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="32" name="var" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="42" package="Default">
        <name>$_state</name>
        <default><![CDATA[self::STATE_NONE]]></default>
        <docblock line="38">
          <description><![CDATA[Current scope state]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="38" 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="66" package="">
        <name>__construct</name>
        <type>function</type>
        <docblock line="59">
          <description><![CDATA[Initialise the scope]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="59" name="param" description="- function to be called when scope is entered" type="\triagens\ArangoDb\callable" variable="$initFunc">
            <type by_reference="false">\triagens\ArangoDb\callable</type>
          </tag>
          <tag line="59" name="param" description="- function to be called when scope if left" type="\triagens\ArangoDb\callable" variable="$exitFunc">
            <type by_reference="false">\triagens\ArangoDb\callable</type>
          </tag>
          <tag line="59" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="66">
          <name>$initFunc</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="66">
          <name>$exitFunc</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="82" package="">
        <name>__destruct</name>
        <type>function</type>
        <docblock line="76">
          <description><![CDATA[Destroy the scope
This will call leave() to ensure the scope is definitely left]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="76" 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="95" package="">
        <name>leave</name>
        <type>function</type>
        <docblock line="86">
          <description><![CDATA[Leave the scope
This will execute the exit func with the value returned by the
call to the init func.]]></description>
          <long-description><![CDATA[<p>leave() will check whether the scope has already been left to avoid
duplicate execution of the exit func.</p>]]></long-description>
          <tag line="86" 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="113" package="">
        <name>enter</name>
        <type>function</type>
        <docblock line="107">
          <description><![CDATA[Enter the scope
This will call the init func and store its result value]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="107" 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="128" package="">
        <name>__clone</name>
        <type>function</type>
        <docblock line="121">
          <description><![CDATA[Clone function
Scopes should never be cloned so this is private]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="121" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="121" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/Exception.php" hash="6fd15ab236fa7cf67fbb1adc2a77f8c9" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: exception base class]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>Exception</name>
      <full_name>\triagens\ArangoDb\Exception</full_name>
      <extends>\Exception</extends>
      <docblock line="13">
        <description><![CDATA[Exception base class used to throw Arango specific exceptions]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
    </class>
  </file>
  <file path="triagens/ArangoDb/Autoloader.php" hash="e23c5fd1ecf0d22cc249b4e2b923ca73" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: autoloader]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="20" package="ArangoDbPhpClient">
      <name>Autoloader</name>
      <full_name>\triagens\ArangoDb\Autoloader</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[Handles automatic loading of missing class files
The autoloader can be nested with other autoloaders. It will only
process classes from its own namespace and ignore all others.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="30" package="Default">
        <name>EXTENSION</name>
        <value><![CDATA['.php']]></value>
        <docblock line="27">
          <description><![CDATA[Class file extension]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="true" visibility="private" line="25" package="Default">
        <name>$libDir</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="21">
          <description><![CDATA[Directory with library files]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="21" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="38" package="">
        <name>init</name>
        <type>function</type>
        <docblock line="32">
          <description><![CDATA[Initialise the autoloader]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="32" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="32" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="53" package="">
        <name>load</name>
        <type>function</type>
        <docblock line="44">
          <description><![CDATA[Handle loading of an unknown class]]></description>
          <long-description><![CDATA[<p>This will only handle class from its own namespace and ignore all others.
This allows multiple autoloaders to be used in a nested fashion.</p>]]></long-description>
          <tag line="44" name="param" description="- name of class to be loaded" type="string" variable="$className">
            <type by_reference="false">string</type>
          </tag>
          <tag line="44" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="53">
          <name>$className</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="triagens\ArangoDb" line="76" package="">
        <name>checkEnvironment</name>
        <type>function</type>
        <docblock line="67">
          <description><![CDATA[Check the runtime environment]]></description>
          <long-description><![CDATA[<p>This will check whether the runtime environment is compatible with the
Arango PHP client.</p>]]></long-description>
          <tag line="67" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="67" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/Collection.php" hash="b7bc700376e0e5c9d4d171a933427a6f" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: single collection]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>Collection</name>
      <full_name>\triagens\ArangoDb\Collection</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[Value object representing a collection]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="40" package="Default">
        <name>ENTRY_ID</name>
        <value><![CDATA['id']]></value>
        <docblock line="37">
          <description><![CDATA[Collection id index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="45" package="Default">
        <name>ENTRY_NAME</name>
        <value><![CDATA['name']]></value>
        <docblock line="42">
          <description><![CDATA[Collection name index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="50" package="Default">
        <name>ENTRY_WAIT_SYNC</name>
        <value><![CDATA['waitForSync']]></value>
        <docblock line="47">
          <description><![CDATA[Collection 'waitForSync' index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="23" package="Default">
        <name>$_id</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="19">
          <description><![CDATA[The collection id (might be NULL for new collections)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="19" name="var" description="- collection id" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="29" package="Default">
        <name>$_name</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="25">
          <description><![CDATA[The collection name (might be NULL for new collections)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="25" name="var" description="- collection name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="35" package="Default">
        <name>$_waitForSync</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="31">
          <description><![CDATA[The collection waitForSync value (might be NULL for new collections)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="31" name="var" description="- waitForSync value" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="57" package="">
        <name>__construct</name>
        <type>function</type>
        <docblock line="52">
          <description><![CDATA[Constructs an empty collection]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="52" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="67" package="">
        <name>createFromArray</name>
        <type>function</type>
        <docblock line="60">
          <description><![CDATA[Factory method to construct a new collection]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="60" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="60" name="param" description="- initial values for collection" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="60" name="return" description="" type="\triagens\ArangoDb\Collection">
            <type by_reference="false">\triagens\ArangoDb\Collection</type>
          </tag>
        </docblock>
        <argument line="67">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="83" package="">
        <name>__clone</name>
        <type>function</type>
        <docblock line="77">
          <description><![CDATA[Clone a collection
Returns the clone]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="77" 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="95" package="">
        <name>__toString</name>
        <type>function</type>
        <docblock line="89">
          <description><![CDATA[Get a string representation of the collection
Returns the collection as JSON-encoded string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="89" name="return" description="- JSON-encoded collection" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="104" package="">
        <name>toJson</name>
        <type>function</type>
        <docblock line="99">
          <description><![CDATA[Returns the collection as JSON-encoded string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="99" name="return" description="- JSON-encoded collection" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="113" package="">
        <name>toSerialized</name>
        <type>function</type>
        <docblock line="108">
          <description><![CDATA[Returns the collection as a serialized string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="108" name="return" description="- PHP serialized collection" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="122" package="">
        <name>getAll</name>
        <type>function</type>
        <docblock line="117">
          <description><![CDATA[Get all collection attributes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="117" name="return" description="- array of all collection attributes" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="142" package="">
        <name>set</name>
        <type>function</type>
        <docblock line="130">
          <description><![CDATA[Set a collection attribute]]></description>
          <long-description><![CDATA[<p>The key (attribute name) must be a string.
This will validate the value of the attribute and might throw an
exception if the value is invalid.</p>]]></long-description>
          <tag line="130" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="130" name="param" description="- attribute name" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="130" name="param" description="- value for attribute" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="130" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="142">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="142">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="173" package="">
        <name>setId</name>
        <type>function</type>
        <docblock line="165">
          <description><![CDATA[Set the collection id
This will throw if the id of an existing collection gets updated to some other id]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="165" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="165" name="param" description="- collection id" type="mixed" variable="$id">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="165" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="173">
          <name>$id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="188" package="">
        <name>getId</name>
        <type>function</type>
        <docblock line="181">
          <description><![CDATA[Get the collection id (if already known)
Collection ids are generated on the server only. Collection ids are numeric but might be
bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="181" name="return" description="- collection id, might be NULL if collection does not yet have an id" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="199" package="">
        <name>setName</name>
        <type>function</type>
        <docblock line="192">
          <description><![CDATA[Set the collection name]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="192" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="192" name="param" description="- name" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="192" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="199">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="214" package="">
        <name>getName</name>
        <type>function</type>
        <docblock line="209">
          <description><![CDATA[Get the collection name (if already known)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="209" 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="224" package="">
        <name>setWaitForSync</name>
        <type>function</type>
        <docblock line="218">
          <description><![CDATA[Set the waitForSync value]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="218" name="param" description="- waitForSync value" type="bool" variable="$value">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="218" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="224">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="239" package="">
        <name>getWaitForSync</name>
        <type>function</type>
        <docblock line="234">
          <description><![CDATA[Get the waitForSync value (if already known)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="234" name="return" description="- waitForSync value" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/DefaultValues.php" hash="a35f0498e1257e8c3f05a644c18a4e38" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: default values]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>DefaultValues</name>
      <full_name>\triagens\ArangoDb\DefaultValues</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[Contains default values used by the client]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="22" package="Default">
        <name>DEFAULT_PORT</name>
        <value><![CDATA[8529]]></value>
        <docblock line="19">
          <description><![CDATA[Default port number (used if no port specified)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="27" package="Default">
        <name>DEFAULT_TIMEOUT</name>
        <value><![CDATA[2]]></value>
        <docblock line="24">
          <description><![CDATA[Default timeout value (used if no timeout value specified)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="32" package="Default">
        <name>DEFAULT_WAIT_SYNC</name>
        <value><![CDATA[false]]></value>
        <docblock line="29">
          <description><![CDATA[Default value for waitForSync (fsync all data to disk on document updates/insertions/deletions)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="37" package="Default">
        <name>DEFAULT_CREATE</name>
        <value><![CDATA[false]]></value>
        <docblock line="34">
          <description><![CDATA[Default value for createCollection (create the collection on the fly when the first document is added to an unknown collection)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="42" package="Default">
        <name>DEFAULT_UPDATE_POLICY</name>
        <value><![CDATA[UpdatePolicy::ERROR]]></value>
        <docblock line="39">
          <description><![CDATA[Default update policy]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
    </class>
  </file>
  <file path="triagens/ArangoDb/ServerException.php" hash="7bc787d15712ddbc6160d9664ad10ee1" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: server exception]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="23" package="ArangoDbPhpClient">
      <name>ServerException</name>
      <full_name>\triagens\ArangoDb\ServerException</full_name>
      <extends>\triagens\ArangoDb\Exception</extends>
      <docblock line="13">
        <description><![CDATA[This exception type will be thrown by the client when the server returns an
error in response to a client request.]]></description>
        <long-description><![CDATA[<p>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.</p>]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="33" package="Default">
        <name>ENTRY_CODE</name>
        <value><![CDATA['errorNum']]></value>
        <docblock line="30">
          <description><![CDATA[Error number index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="38" package="Default">
        <name>ENTRY_MESSAGE</name>
        <value><![CDATA['errorMessage']]></value>
        <docblock line="35">
          <description><![CDATA[Error message index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="28" package="Default">
        <name>$_details</name>
        <default><![CDATA[array()]]></default>
        <docblock line="24">
          <description><![CDATA[Optional details for the exception]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="24" name="param" description="array" type="" variable=""/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="49" package="">
        <name>setDetails</name>
        <type>function</type>
        <docblock line="40">
          <description><![CDATA[Set exception details]]></description>
          <long-description><![CDATA[<p>If the server provides additional details about the error
that occurred, they will be put here.</p>]]></long-description>
          <tag line="40" name="param" description="- array of exception details" type="array" variable="$details">
            <type by_reference="false">array</type>
          </tag>
          <tag line="40" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="49">
          <name>$details</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="61" package="">
        <name>getDetails</name>
        <type>function</type>
        <docblock line="53">
          <description><![CDATA[Get exception details]]></description>
          <long-description><![CDATA[<p>If the server has provided additional details about the error
that occurred, they can be queries using the method</p>]]></long-description>
          <tag line="53" name="return" description="- array of details" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="73" package="">
        <name>getServerCode</name>
        <type>function</type>
        <docblock line="65">
          <description><![CDATA[Get server error code]]></description>
          <long-description><![CDATA[<p>If the server has provided additional details about the error
that occurred, this will return the server error code</p>]]></long-description>
          <tag line="65" name="return" description="- server error code" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="89" package="">
        <name>getServerMessage</name>
        <type>function</type>
        <docblock line="81">
          <description><![CDATA[Get server error message]]></description>
          <long-description><![CDATA[<p>If the server has provided additional details about the error
that occurred, this will return the server error string</p>]]></long-description>
          <tag line="81" name="return" description="- server error message" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/Connection.php" hash="eb2914f0136b1b9b5626b094dca848ec" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: connection]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>Connection</name>
      <full_name>\triagens\ArangoDb\Connection</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[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><![CDATA[<p>Instead, connections are established on the fly for each request
and are destroyed afterwards.</p>]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="27" package="Default">
        <name>$_options</name>
        <default><![CDATA[]]></default>
        <docblock line="23">
          <description><![CDATA[Connection options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="23" 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="36" package="">
        <name>__construct</name>
        <type>function</type>
        <docblock line="29">
          <description><![CDATA[Set up the connection object, validate the options provided]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="29" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="29" name="param" description="- initial connection options" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="29" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="36">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="47" package="">
        <name>getOption</name>
        <type>function</type>
        <docblock line="40">
          <description><![CDATA[Get an option set for the connection]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="40" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="40" name="param" description="name - name of option" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="40" name="return" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="47">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="60" package="">
        <name>get</name>
        <type>function</type>
        <docblock line="53">
          <description><![CDATA[Issue an HTTP GET request]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="53" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="53" name="param" description="- GET URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="53" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="60">
          <name>$url</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="73" package="">
        <name>post</name>
        <type>function</type>
        <docblock line="65">
          <description><![CDATA[Issue an HTTP POST request with the data provided]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="65" name="param" description="- POST URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="65" name="param" description="- body to post" type="string" variable="$data">
            <type by_reference="false">string</type>
          </tag>
          <tag line="65" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="73">
          <name>$url</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="73">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="86" package="">
        <name>put</name>
        <type>function</type>
        <docblock line="78">
          <description><![CDATA[Issue an HTTP PUT request with the data provided]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="78" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="78" name="param" description="- PUT URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="78" name="param" description="- body to post" type="string" variable="$data">
            <type by_reference="false">string</type>
          </tag>
          <tag line="78" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="86">
          <name>$url</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="86">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="98" package="">
        <name>delete</name>
        <type>function</type>
        <docblock line="91">
          <description><![CDATA[Issue an HTTP DELETE request with the data provided]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="91" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="91" name="param" description="- DELETE URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="91" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="98">
          <name>$url</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="110" package="">
        <name>parseResponse</name>
        <type>function</type>
        <docblock line="103">
          <description><![CDATA[Parse the response return the body values as an assoc array]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="103" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="103" 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="103" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="110">
          <name>$response</name>
          <default><![CDATA[]]></default>
          <type>HttpResponse</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="150" package="">
        <name>executeRequest</name>
        <type>function</type>
        <docblock line="136">
          <description><![CDATA[Execute an HTTP request and return the results]]></description>
          <long-description><![CDATA[<p>This function will throw if no connection to the server can be established or if
there is a problem during data exchange with the server.
The function might temporarily alter the value of the php.ini value 'default_socket_timeout' but
will restore it.</p>]]></long-description>
          <tag line="136" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="136" name="param" description="- HTTP request method" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="136" name="param" description="- HTTP URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="136" name="param" description="- data to post in body" type="string" variable="$data">
            <type by_reference="false">string</type>
          </tag>
          <tag line="136" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="150">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="150">
          <name>$url</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="150">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/UpdatePolicy.php" hash="e290147ca50b96bab2f2cbbefe51daec" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: update policies]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>UpdatePolicy</name>
      <full_name>\triagens\ArangoDb\UpdatePolicy</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[Document update policies]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="22" package="Default">
        <name>LAST</name>
        <value><![CDATA['last']]></value>
        <docblock line="19">
          <description><![CDATA[last update will win in case of conflicting versions]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="27" package="Default">
        <name>ERROR</name>
        <value><![CDATA['error']]></value>
        <docblock line="24">
          <description><![CDATA[an error will be returned in case of conflicting versions]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="36" package="">
        <name>validate</name>
        <type>function</type>
        <docblock line="29">
          <description><![CDATA[Check if the supplied policy value is valid]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="29" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="29" name="param" description="- update policy value" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="29" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="36">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/ValueValidator.php" hash="e1d420b487f5ef27ce74687a25ecaeb2" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: value validator]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>ValueValidator</name>
      <full_name>\triagens\ArangoDb\ValueValidator</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[A simple validator for values to be stored in the database]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="27" package="">
        <name>validate</name>
        <type>function</type>
        <docblock line="19">
          <description><![CDATA[Validate the value of a variable
Allowed value types are string, integer, double and booleans. Arrays are also allowed if they contain only one of the former types.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="19" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="19" name="param" description="value - value to validate" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="19" name="return" description="- will throw if an invalid value type is passed" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="27">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/CollectionHandler.php" hash="e7996616405b801eedcd85aa8766f5b6" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: collection handler]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="20" package="ArangoDbPhpClient">
      <name>CollectionHandler</name>
      <full_name>\triagens\ArangoDb\CollectionHandler</full_name>
      <extends>\triagens\ArangoDb\Handler</extends>
      <docblock line="13">
        <description><![CDATA[A collection handler that fetches collection data from the server and
creates collections on the server. It does so by issueing the
appropriate HTTP requests to the server.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="24" package="Default">
        <name>OPTION_COUNT</name>
        <value><![CDATA['count']]></value>
        <docblock line="21">
          <description><![CDATA[count option]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="29" package="Default">
        <name>OPTION_FIGURES</name>
        <value><![CDATA['figures']]></value>
        <docblock line="26">
          <description><![CDATA[figures option]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="34" package="Default">
        <name>OPTION_TRUNCATE</name>
        <value><![CDATA['truncate']]></value>
        <docblock line="31">
          <description><![CDATA[truncate option]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="39" package="Default">
        <name>OPTION_RENAME</name>
        <value><![CDATA['rename']]></value>
        <docblock line="36">
          <description><![CDATA[rename option]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="49" package="">
        <name>get</name>
        <type>function</type>
        <docblock line="41">
          <description><![CDATA[Get information about a collection
This will throw if the collection cannot be fetched from the server]]></description>
          <long-description><![CDATA[]]></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="return" description="- the collection fetched from the server" type="\triagens\ArangoDb\Collection">
            <type by_reference="false">\triagens\ArangoDb\Collection</type>
          </tag>
        </docblock>
        <argument line="49">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="66" package="">
        <name>getCount</name>
        <type>function</type>
        <docblock line="58">
          <description><![CDATA[Get the number of documents in a collection
This will throw if the collection cannot be fetched from the server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="58" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="58" name="param" description="- collection id as a string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="58" name="return" description="- the number of documents in the collection" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="66">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="84" package="">
        <name>getFigures</name>
        <type>function</type>
        <docblock line="76">
          <description><![CDATA[Get figures for a collection
This will throw if the collection cannot be fetched from the server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="76" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="76" name="param" description="- collection id as a string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="76" name="return" description="- the figures for the collection" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="84">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="103" package="">
        <name>add</name>
        <type>function</type>
        <docblock line="94">
          <description><![CDATA[Adds a new collection on the server
This will add the collection on the server and return its id
This will throw if the collection cannot be created]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="94" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="94" name="param" description="- collection object to be created on the server" type="\triagens\ArangoDb\Collection" variable="$collection">
            <type by_reference="false">\triagens\ArangoDb\Collection</type>
          </tag>
          <tag line="94" name="return" description="- id of collection created" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="103">
          <name>$collection</name>
          <default><![CDATA[]]></default>
          <type>Collection</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="129" package="">
        <name>delete</name>
        <type>function</type>
        <docblock line="122">
          <description><![CDATA[Delete a collection]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="122" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="122" name="param" description="- collection id as string or number or collection object" type="mixed" variable="$collection">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="122" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="129">
          <name>$collection</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="154" package="">
        <name>rename</name>
        <type>function</type>
        <docblock line="146">
          <description><![CDATA[Rename a collection]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="146" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="146" name="param" description="- collection id as string or number or collection object" type="mixed" variable="$collection">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="146" name="param" description="- new name for collection" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="146" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="154">
          <name>$collection</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="154">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="180" package="">
        <name>truncate</name>
        <type>function</type>
        <docblock line="172">
          <description><![CDATA[Truncate a collection
This will remove all documents from the collection but will leave the metadata and indexes intact.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="172" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="172" name="param" description="- collection id as string or number or collection object" type="mixed" variable="$collection">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="172" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="180">
          <name>$collection</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/UrlHelper.php" hash="3319961e350a7e3a6f711d3bd99244ed" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: URL helper methods]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>URLHelper</name>
      <full_name>\triagens\ArangoDb\URLHelper</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[Some helper methods to construct and process URLs]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="25" package="">
        <name>getDocumentIdFromLocation</name>
        <type>function</type>
        <docblock line="19">
          <description><![CDATA[Get the document id from a location header]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="19" name="param" description="- HTTP response location header" type="string" variable="$location">
            <type by_reference="false">string</type>
          </tag>
          <tag line="19" name="return" description="- document id parsed from header" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="25">
          <name>$location</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="37" package="">
        <name>buildUrl</name>
        <type>function</type>
        <docblock line="30">
          <description><![CDATA[Construct a URL from a base URL and additional parts, seperated with '/' each
This function accepts variable arguments.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="30" name="param" description="- base URL" type="string" variable="$baseUrl">
            <type by_reference="false">string</type>
          </tag>
          <tag line="30" name="return" description="- assembled URL" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="37">
          <name>$baseUrl</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="59" package="">
        <name>appendParamsUrl</name>
        <type>function</type>
        <docblock line="51">
          <description><![CDATA[Append parameters to a URL
Parameter values will be URL-encoded]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="51" name="param" description="- base URL" type="string" variable="$baseUrl">
            <type by_reference="false">string</type>
          </tag>
          <tag line="51" name="param" description="- an array of parameters" type="array" variable="$params">
            <type by_reference="false">array</type>
          </tag>
          <tag line="51" name="return" description="- the assembled URL" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="59">
          <name>$baseUrl</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="59">
          <name>$params</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="71" package="">
        <name>getBoolString</name>
        <type>function</type>
        <docblock line="65">
          <description><![CDATA[Get a string from a boolean value]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="65" name="param" description="- the value" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="65" name="return" description="- &quot;true&quot; if $value evaluates to true, &quot;false&quot; otherwise" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="71">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/Handler.php" hash="3fe07f2a0d5b03e9102009e7291ca1c1" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: base handler]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>Handler</name>
      <full_name>\triagens\ArangoDb\Handler</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[A base class for REST-based handlers]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="23" package="Default">
        <name>$_connection</name>
        <default><![CDATA[]]></default>
        <docblock line="19">
          <description><![CDATA[Connection object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="19" name="param" description="Connection" type="" variable=""/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="31" package="">
        <name>__construct</name>
        <type>function</type>
        <docblock line="25">
          <description><![CDATA[Construct a new handler]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="25" name="param" description="- connection to be used" type="\triagens\ArangoDb\Connection" variable="$connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
          <tag line="25" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="31">
          <name>$connection</name>
          <default><![CDATA[]]></default>
          <type>Connection</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="triagens\ArangoDb" line="40" package="">
        <name>getConnection</name>
        <type>function</type>
        <docblock line="35">
          <description><![CDATA[Return the connection object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="35" name="return" description="- the connection object" type="\triagens\ArangoDb\Connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/Statement.php" hash="e1745878d5f7b4b6b0320f3137e5cfec" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: statement]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>Statement</name>
      <full_name>\triagens\ArangoDb\Statement</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[Container for a read-only ("select") statement
A statement is an AQL query that can be issued to the
server. Optional bind parameters can be used when issueing the
statement to separate the statement from the values.]]></description>
        <long-description><![CDATA[<p>Executing a statement will result in a cursor being created.</p>]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="62" package="Default">
        <name>ENTRY_QUERY</name>
        <value><![CDATA['query']]></value>
        <docblock line="59">
          <description><![CDATA[Query string index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="67" package="Default">
        <name>ENTRY_COUNT</name>
        <value><![CDATA['count']]></value>
        <docblock line="64">
          <description><![CDATA[Count option index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="72" package="Default">
        <name>ENTRY_BATCHSIZE</name>
        <value><![CDATA['batchSize']]></value>
        <docblock line="69">
          <description><![CDATA[Batch size index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="77" package="Default">
        <name>ENTRY_BINDVARS</name>
        <value><![CDATA['bindVars']]></value>
        <docblock line="74">
          <description><![CDATA[Bind variables index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="27" package="Default">
        <name>$_connection</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="23">
          <description><![CDATA[The connection object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="23" 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="33" package="Default">
        <name>$_bindVars</name>
        <default><![CDATA[]]></default>
        <docblock line="29">
          <description><![CDATA[The bind variables and values used for the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="29" 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="39" package="Default">
        <name>$_batchSize</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="35">
          <description><![CDATA[The current batch size (number of result documents retrieved per roundtrip)]]></description>
          <long-description><![CDATA[]]></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="45" package="Default">
        <name>$_doCount</name>
        <default><![CDATA[false]]></default>
        <docblock line="41">
          <description><![CDATA[The count flag (should server return total number of results)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="41" name="var" description="" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="51" package="Default">
        <name>$_query</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="47">
          <description><![CDATA[The query string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="57" package="Default">
        <name>$_sanitize</name>
        <default><![CDATA[false]]></default>
        <docblock line="53">
          <description><![CDATA[Sanitation flag (if set, the _id and _rev attributes will be removed from the results)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="53" 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="87" package="">
        <name>__construct</name>
        <type>function</type>
        <docblock line="79">
          <description><![CDATA[Initialise the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="79" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="79" 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="79" name="param" description="- statement initialization data" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
          <tag line="79" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="87">
          <name>$connection</name>
          <default><![CDATA[]]></default>
          <type>Connection</type>
        </argument>
        <argument line="87">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="118" package="">
        <name>execute</name>
        <type>function</type>
        <docblock line="110">
          <description><![CDATA[Execute the statement
This will post the query to the server and return the results as
a Cursor. The cursor can then be used to iterate the results.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="110" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="110" 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="133" package="">
        <name>__invoke</name>
        <type>function</type>
        <docblock line="125">
          <description><![CDATA[Invoke the statement
This will simply call execute(). Arguments are ignored.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="125" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="125" name="param" description="- arguments for invocation, will be ignored" type="mixed" variable="$args">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="125" name="return" description="- the result cursor" type="\triagens\ArangoDb\Cursor">
            <type by_reference="false">\triagens\ArangoDb\Cursor</type>
          </tag>
        </docblock>
        <argument line="133">
          <name>$args</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="142" package="">
        <name>__toString</name>
        <type>function</type>
        <docblock line="137">
          <description><![CDATA[Return a string representation of the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="137" 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="160" package="">
        <name>bind</name>
        <type>function</type>
        <docblock line="146">
          <description><![CDATA[Bind a parameter to the statement
This method can either be called with a string $key and a
separate value in $value, or with an array of all bind
bind parameters in $key, with $value being NULL.]]></description>
          <long-description><![CDATA[<p>Allowed value types for bind parameters are string, int,
double, bool and array. Arrays must not contain any other
than these types.</p>]]></long-description>
          <tag line="146" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="146" 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="146" name="param" description="- value for bind variable" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="146" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="160">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="160">
          <name>$value</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="169" package="">
        <name>getBindVars</name>
        <type>function</type>
        <docblock line="164">
          <description><![CDATA[Get all bind parameters as an array]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="164" 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="180" package="">
        <name>setQuery</name>
        <type>function</type>
        <docblock line="173">
          <description><![CDATA[Set the query string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="173" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="173" name="param" description="- query string" type="string" variable="$query">
            <type by_reference="false">string</type>
          </tag>
          <tag line="173" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="180">
          <name>$query</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="193" package="">
        <name>getQuery</name>
        <type>function</type>
        <docblock line="188">
          <description><![CDATA[Get the query string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="188" 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="203" package="">
        <name>setCount</name>
        <type>function</type>
        <docblock line="197">
          <description><![CDATA[Set the count option for the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="197" name="param" description="- value for count option" type="bool" variable="$value">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="197" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="203">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="212" package="">
        <name>getCount</name>
        <type>function</type>
        <docblock line="207">
          <description><![CDATA[Get the count option value of the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="207" 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="228" package="">
        <name>setBatchSize</name>
        <type>function</type>
        <docblock line="216">
          <description><![CDATA[Set the batch size for the statement
The batch size is the number of results to be transferred
in one server roundtrip. If a query produces more results
than the batch size, it creates a server-side cursor that
provides the additional results. The server-side cursor can
be accessed by the client with subsequent HTTP requests.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="216" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="216" name="param" description="- batch size value" type="int" variable="$value">
            <type by_reference="false">int</type>
          </tag>
          <tag line="216" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="228">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="241" package="">
        <name>getBatchSize</name>
        <type>function</type>
        <docblock line="236">
          <description><![CDATA[Get the batch size for the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="236" 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="250" package="">
        <name>buildData</name>
        <type>function</type>
        <docblock line="245">
          <description><![CDATA[Build an array of data to be posted to the server when issueing the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="245" 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="272" package="">
        <name>getCursorOptions</name>
        <type>function</type>
        <docblock line="267">
          <description><![CDATA[Return an array of cursor options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="267" name="return" description="- array of options" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/Cursor.php" hash="f186678230b4c4839b6a612072ad50f8" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: result set cursor]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>Cursor</name>
      <full_name>\triagens\ArangoDb\Cursor</full_name>
      <extends/>
      <extends>\Iterator</extends>
      <docblock line="13">
        <description><![CDATA[Provides access to the results of a read-only statement
The cursor might not contain all results in the beginning.]]></description>
        <long-description><![CDATA[<p>If the result set is too big to be transferred in one go, the
cursor might issue additional HTTP requests to fetch the
remaining results from the server.</p>]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="69" package="Default">
        <name>ENTRY_ID</name>
        <value><![CDATA['id']]></value>
        <docblock line="66">
          <description><![CDATA[result entry for cursor id]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="74" package="Default">
        <name>ENTRY_HASMORE</name>
        <value><![CDATA['hasMore']]></value>
        <docblock line="71">
          <description><![CDATA[result entry for "hasMore" flag]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="79" package="Default">
        <name>ENTRY_RESULT</name>
        <value><![CDATA['result']]></value>
        <docblock line="76">
          <description><![CDATA[result entry for result documents]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="84" package="Default">
        <name>ENTRY_SANITIZE</name>
        <value><![CDATA['sanitize']]></value>
        <docblock line="81">
          <description><![CDATA[sanitize option entry]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="27" package="Default">
        <name>$_connection</name>
        <default><![CDATA[]]></default>
        <docblock line="23">
          <description><![CDATA[The connection object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="23" 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="33" package="Default">
        <name>$_options</name>
        <default><![CDATA[]]></default>
        <docblock line="29">
          <description><![CDATA[Cursor options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="29" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="39" package="Default">
        <name>$_result</name>
        <default><![CDATA[]]></default>
        <docblock line="35">
          <description><![CDATA[The result set]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="35" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="45" package="Default">
        <name>$_hasMore</name>
        <default><![CDATA[]]></default>
        <docblock line="41">
          <description><![CDATA["has more" indicator - if true, the server has more results]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="41" name="var" description="" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="51" package="Default">
        <name>$_id</name>
        <default><![CDATA[]]></default>
        <docblock line="47">
          <description><![CDATA[cursor id - might be NULL if cursor does not have an id]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" name="var" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="57" package="Default">
        <name>$_position</name>
        <default><![CDATA[]]></default>
        <docblock line="53">
          <description><![CDATA[current position in result set iteration (zero-based)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="53" name="var" description="" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="63" package="Default">
        <name>$_length</name>
        <default><![CDATA[]]></default>
        <docblock line="59">
          <description><![CDATA[total length of result set (in number of documents)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="59" name="var" description="" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="94" package="">
        <name>__construct</name>
        <type>function</type>
        <docblock line="86">
          <description><![CDATA[Initialise the cursor with the first results and some metadata]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="86" name="param" description="- connection to be used" type="\triagens\ArangoDb\Connection" variable="$connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
          <tag line="86" name="param" description="- initial result data as returned by the server" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
          <tag line="86" name="param" description="- cursor options" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="86" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="94">
          <name>$connection</name>
          <default><![CDATA[]]></default>
          <type>Connection</type>
        </argument>
        <argument line="94">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
        <argument line="94">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="121" package="">
        <name>delete</name>
        <type>function</type>
        <docblock line="113">
          <description><![CDATA[Explicitly delete the cursor
This might issue an HTTP DELETE request to inform the server about
the deletion.]]></description>
          <long-description><![CDATA[]]></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="return" description="- true if the server acknowledged the deletion request, false otherwise" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="142" package="">
        <name>getCount</name>
        <type>function</type>
        <docblock line="134">
          <description><![CDATA[Get the total number of results in the cursor
This might issue additional HTTP requests to fetch any outstanding
results from the server]]></description>
          <long-description><![CDATA[]]></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="return" description="- total number of results" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="158" package="">
        <name>getAll</name>
        <type>function</type>
        <docblock line="150">
          <description><![CDATA[Get all results as an array
This might issue additional HTTP requests to fetch any outstanding
results from the server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="150" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="150" name="return" description="- an array of all results" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="171" package="">
        <name>rewind</name>
        <type>function</type>
        <docblock line="166">
          <description><![CDATA[Rewind the cursor, necessary for Iterator]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="166" 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="180" package="">
        <name>current</name>
        <type>function</type>
        <docblock line="175">
          <description><![CDATA[Return the current result row, necessary for Iterator]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="175" name="return" description="- the current result row as an assoc 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="189" package="">
        <name>key</name>
        <type>function</type>
        <docblock line="184">
          <description><![CDATA[Return the index of the current result row, necessary for Iterator]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="184" name="return" description="- the current result row index" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="198" package="">
        <name>next</name>
        <type>function</type>
        <docblock line="193">
          <description><![CDATA[Advance the cursor, necessary for Iterator]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="193" 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="210" package="">
        <name>valid</name>
        <type>function</type>
        <docblock line="202">
          <description><![CDATA[Check if cursor can be advanced further, necessary for Iterator
This might issue additional HTTP requests to fetch any outstanding
results from the server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="202" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="202" name="return" description="- true if the cursor can be advanced further, false if cursor is at end" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="235" package="">
        <name>sanitize</name>
        <type>function</type>
        <docblock line="227">
          <description><![CDATA[Sanitize the result set rows
This will remove the _id and _rev attributes from the results if the
"sanitize" option is set]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="227" name="param" description="- array of rows to be sanitized" type="array" variable="$rows">
            <type by_reference="false">array</type>
          </tag>
          <tag line="227" name="return" description="- sanitized rows" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="235">
          <name>$rows</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="251" package="">
        <name>fetchOutstanding</name>
        <type>function</type>
        <docblock line="245">
          <description><![CDATA[Fetch outstanding results from the server]]></description>
          <long-description><![CDATA[]]></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="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="272" package="">
        <name>updateLength</name>
        <type>function</type>
        <docblock line="267">
          <description><![CDATA[Set the length of the (fetched) result set]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="267" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/DocumentHandler.php" hash="9ad42d80ce59350978b9e8c2c3471a45" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: document handler]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="20" package="ArangoDbPhpClient">
      <name>DocumentHandler</name>
      <full_name>\triagens\ArangoDb\DocumentHandler</full_name>
      <extends>\triagens\ArangoDb\Handler</extends>
      <docblock line="13">
        <description><![CDATA[A document handler that fetches documents from the server and
persists them on the server. It does so by issueing the
appropriate HTTP requests to the server.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="24" package="Default">
        <name>ENTRY_DOCUMENTS</name>
        <value><![CDATA['documents']]></value>
        <docblock line="21">
          <description><![CDATA[documents array index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="29" package="Default">
        <name>OPTION_COLLECTION</name>
        <value><![CDATA['collection']]></value>
        <docblock line="26">
          <description><![CDATA[collection parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="34" package="Default">
        <name>OPTION_EXAMPLE</name>
        <value><![CDATA['example']]></value>
        <docblock line="31">
          <description><![CDATA[example parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="45" package="">
        <name>get</name>
        <type>function</type>
        <docblock line="36">
          <description><![CDATA[Get a single document from a collection
Alias method for getById()]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="36" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="36" name="param" description="- collection id as a string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="36" name="param" description="- document identifier" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="36" 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="45">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="45">
          <name>$documentId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="58" package="">
        <name>getById</name>
        <type>function</type>
        <docblock line="49">
          <description><![CDATA[Get a single document from a collection
This will throw if the document cannot be fetched from the server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="49" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="49" name="param" description="- collection id as a string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="49" name="param" description="- document identifier" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="49" 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="58">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="58">
          <name>$documentId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="75" package="">
        <name>getAllIds</name>
        <type>function</type>
        <docblock line="67">
          <description><![CDATA[Get the list of all documents' ids from a collection
This will throw if the list cannot be fetched from the server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="67" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="67" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="67" name="return" description="- ids of documents in the collection" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="75">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="102" package="">
        <name>getByExample</name>
        <type>function</type>
        <docblock line="92">
          <description><![CDATA[Get document(s) by specifying an example
This will throw if the list cannot be fetched from the server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="92" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="92" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="92" 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="92" name="param" description="- remove _id and _rev attributes from result documents" type="bool" variable="$sanitize">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="92" name="return" description="- documents matching the example [0...n]" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="102">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="102">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="102">
          <name>$sanitize</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="129" package="">
        <name>add</name>
        <type>function</type>
        <docblock line="118">
          <description><![CDATA[Add a document to a collection
This will add the document to the collection and return the document's id
This will throw if the document cannot be created]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="118" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="118" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="118" 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="118" name="param" description="- create the collection if it does not yet exist" type="bool" variable="$create">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="118" name="return" description="- id of document created" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="129">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="129">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>Document</type>
        </argument>
        <argument line="129">
          <name>$create</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="167" package="">
        <name>update</name>
        <type>function</type>
        <docblock line="157">
          <description><![CDATA[Update an existing document in a collection, identified by the document itself
This will update the document on the server
This will throw if the document cannot be updated]]></description>
          <long-description><![CDATA[]]></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="- document to be updated" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="157" name="param" description="- update policy to be used in case of conflict" type="bool" variable="$policy">
            <type by_reference="false">bool</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="167">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>Document</type>
        </argument>
        <argument line="167">
          <name>$policy</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="186" package="">
        <name>updateById</name>
        <type>function</type>
        <docblock line="174">
          <description><![CDATA[Update an existing document in a collection, identified by collection id and document id
This will update the document on the server
This will throw if the document cannot be updated]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="174" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="174" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="174" name="param" description="- document id as string or number" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="174" name="param" description="- document to be updated" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="174" name="param" description="- update policy to be used in case of conflict" type="bool" variable="$policy">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="174" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="186">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="186">
          <name>$documentId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="186">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>Document</type>
        </argument>
        <argument line="186">
          <name>$policy</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="208" package="">
        <name>delete</name>
        <type>function</type>
        <docblock line="201">
          <description><![CDATA[Delete a document from a collection, identified by the document itself]]></description>
          <long-description><![CDATA[]]></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="- document to be updated" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="201" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="208">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>Document</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="223" package="">
        <name>deleteById</name>
        <type>function</type>
        <docblock line="215">
          <description><![CDATA[Delete a document from a collection, identified by the collection id and document id]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="215" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="215" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="215" name="param" description="- document id as string or number" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="215" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="223">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="223">
          <name>$documentId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="236" package="">
        <name>getDocumentId</name>
        <type>function</type>
        <docblock line="229">
          <description><![CDATA[Helper function to get a document id from a document or a document id value]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="229" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="229" name="param" description="- document id OR document to be updated" type="mixed" variable="$document">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="229" name="return" description="- document id, will throw if there is an error" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="236">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="258" package="">
        <name>getCollectionId</name>
        <type>function</type>
        <docblock line="251">
          <description><![CDATA[Helper function to get a collection id from a document]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="251" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="251" name="param" description="- document id" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="251" name="return" description="- collection id, will throw if there is an error" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="258">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>Document</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="274" package="">
        <name>getCursorOptions</name>
        <type>function</type>
        <docblock line="268">
          <description><![CDATA[Return an array of cursor options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="268" name="param" description="- sanitize flag" type="bool" variable="$sanitize">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="268" name="return" description="- array of options" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="274">
          <name>$sanitize</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/BindVars.php" hash="7670d9d307bc25f77f720cae9294cd47" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: bind variables]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>BindVars</name>
      <full_name>\triagens\ArangoDb\BindVars</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[A simple container for bind variables
This container also handles validation of the bind values.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="24" package="Default">
        <name>$_values</name>
        <default><![CDATA[array()]]></default>
        <docblock line="20">
          <description><![CDATA[Current bind values]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="20" 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="31" package="">
        <name>getAll</name>
        <type>function</type>
        <docblock line="26">
          <description><![CDATA[Get all registered bind variables]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="26" 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="40" package="">
        <name>getCount</name>
        <type>function</type>
        <docblock line="35">
          <description><![CDATA[Get the number of bind variables registered]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="35" 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="50" package="">
        <name>get</name>
        <type>function</type>
        <docblock line="44">
          <description><![CDATA[Get the value of a bind variable with a specific name]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="44" name="param" description="name - name of bind variable" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="44" name="return" description="- value of bind variable" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="50">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="70" package="">
        <name>set</name>
        <type>function</type>
        <docblock line="58">
          <description><![CDATA[Set the value of a single bind variable or set all bind variables at once
This will also validate the bind values.]]></description>
          <long-description><![CDATA[<p>Allowed value types for bind parameters are string, int,
double, bool and array. Arrays must not contain any other
than these types.</p>]]></long-description>
          <tag line="58" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="58" name="param" description="name - name of bind variable OR an array with all bind variables" type="mixed" variable="$name">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="58" name="param" description="value - value for bind variable" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="58" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="70">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="70">
          <name>$value</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/Urls.php" hash="9a4d7a2ccd2221787d1a61ed148dc751" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: Base URLs]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>URLs</name>
      <full_name>\triagens\ArangoDb\URLs</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[Some basic URLs]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="22" package="Default">
        <name>URL_DOCUMENT</name>
        <value><![CDATA['/document']]></value>
        <docblock line="19">
          <description><![CDATA[URL base part for all document-related REST calls]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="27" package="Default">
        <name>URL_COLLECTION</name>
        <value><![CDATA['/_api/collection']]></value>
        <docblock line="24">
          <description><![CDATA[URL base part for all collection-related REST calls]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="32" package="Default">
        <name>URL_CURSOR</name>
        <value><![CDATA['/_api/cursor']]></value>
        <docblock line="29">
          <description><![CDATA[base URL part for cursor related operations]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="37" package="Default">
        <name>URL_EXAMPLE</name>
        <value><![CDATA['/_api/simple/by-example']]></value>
        <docblock line="34">
          <description><![CDATA[base URL part for select-by-example]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
    </class>
  </file>
  <file path="triagens/ArangoDb/ConnectionOptions.php" hash="11c8a319a8ed7db5c7c959b0d5a6fac1" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: connection options]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>ConnectionOptions</name>
      <full_name>\triagens\ArangoDb\ConnectionOptions</full_name>
      <extends/>
      <extends>\ArrayAccess</extends>
      <docblock line="13">
        <description><![CDATA[Simple container class for connection options.]]></description>
        <long-description><![CDATA[<p>This class also provides the default values for the connection
options and will perform a simple validation of them.
It provides array access to its members.</p>]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="31" package="Default">
        <name>OPTION_HOST</name>
        <value><![CDATA['host']]></value>
        <docblock line="28">
          <description><![CDATA[Host name string index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="36" package="Default">
        <name>OPTION_PORT</name>
        <value><![CDATA['port']]></value>
        <docblock line="33">
          <description><![CDATA[Port number index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="41" package="Default">
        <name>OPTION_TIMEOUT</name>
        <value><![CDATA['timeout']]></value>
        <docblock line="38">
          <description><![CDATA[Timeout value index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="46" package="Default">
        <name>OPTION_TRACE</name>
        <value><![CDATA['trace']]></value>
        <docblock line="43">
          <description><![CDATA[Trace function index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="51" package="Default">
        <name>OPTION_CREATE</name>
        <value><![CDATA['createCollection']]></value>
        <docblock line="48">
          <description><![CDATA["Create collections if they don't exist" index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="56" package="Default">
        <name>OPTION_UPDATE_POLICY</name>
        <value><![CDATA['policy']]></value>
        <docblock line="53">
          <description><![CDATA[Update policy index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="61" package="Default">
        <name>OPTION_WAIT_SYNC</name>
        <value><![CDATA['waitForSync']]></value>
        <docblock line="58">
          <description><![CDATA[Wait for sync index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="26" package="Default">
        <name>$_values</name>
        <default><![CDATA[array()]]></default>
        <docblock line="22">
          <description><![CDATA[The current options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="22" 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="70" package="">
        <name>__construct</name>
        <type>function</type>
        <docblock line="63">
          <description><![CDATA[Set defaults, use options provided by client and validate them]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="63" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="63" name="param" description="- initial options" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="63" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="70">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="80" package="">
        <name>getAll</name>
        <type>function</type>
        <docblock line="75">
          <description><![CDATA[Get all options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="75" 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="92" package="">
        <name>offsetSet</name>
        <type>function</type>
        <docblock line="84">
          <description><![CDATA[Set and validate a specific option, necessary for ArrayAccess]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="84" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="84" name="param" description="- name of option" type="string" variable="$offset">
            <type by_reference="false">string</type>
          </tag>
          <tag line="84" name="param" description="- value for option" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="84" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="92">
          <name>$offset</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="92">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="103" package="">
        <name>offsetExists</name>
        <type>function</type>
        <docblock line="97">
          <description><![CDATA[Check whether an option exists, necessary for ArrayAccess]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="97" name="param" description="-name of option" type="string" variable="$offset">
            <type by_reference="false">string</type>
          </tag>
          <tag line="97" name="return" description="- true if option exists, false otherwise" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="103">
          <name>$offset</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="114" package="">
        <name>offsetUnset</name>
        <type>function</type>
        <docblock line="107">
          <description><![CDATA[Remove an option and validate, necessary for ArrayAccess]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="107" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="107" name="param" description="- name of option" type="string" variable="$offset">
            <type by_reference="false">string</type>
          </tag>
          <tag line="107" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="114">
          <name>$offset</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="126" package="">
        <name>offsetGet</name>
        <type>function</type>
        <docblock line="119">
          <description><![CDATA[Get a specific option, necessary for ArrayAccess]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="119" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="119" name="param" description="- name of option" type="string" variable="$offset">
            <type by_reference="false">string</type>
          </tag>
          <tag line="119" 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="126">
          <name>$offset</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="139" package="">
        <name>getDefaults</name>
        <type>function</type>
        <docblock line="134">
          <description><![CDATA[Get the default values for the options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="134" 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="false" visibility="private" namespace="triagens\ArangoDb" line="156" package="">
        <name>validate</name>
        <type>function</type>
        <docblock line="150">
          <description><![CDATA[Validate the options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="150" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="150" 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="triagens/ArangoDb/ConnectException.php" hash="9eda113d4c287b0298485b4d482de26f" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: connect exception]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>ConnectException</name>
      <full_name>\triagens\ArangoDb\ConnectException</full_name>
      <extends>\triagens\ArangoDb\Exception</extends>
      <docblock line="13">
        <description><![CDATA[This exception type will be thrown by the client when there is an error
during connecting to the server]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
    </class>
  </file>
  <file path="triagens/ArangoDb/Document.php" hash="dfb74fbf4be9c23614c4008926510452" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: single document]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>Document</name>
      <full_name>\triagens\ArangoDb\Document</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[Value object representing a single collection-based document]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="46" package="Default">
        <name>ENTRY_ID</name>
        <value><![CDATA['_id']]></value>
        <docblock line="43">
          <description><![CDATA[Document id index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="51" package="Default">
        <name>ENTRY_REV</name>
        <value><![CDATA['_rev']]></value>
        <docblock line="48">
          <description><![CDATA[Revision id index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="23" package="Default">
        <name>$_id</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="19">
          <description><![CDATA[The document id (might be NULL for new documents)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="19" name="var" description="- document id" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="29" package="Default">
        <name>$_rev</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="25">
          <description><![CDATA[The document revision (might be NULL for new documents)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="25" name="var" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="35" package="Default">
        <name>$_values</name>
        <default><![CDATA[array()]]></default>
        <docblock line="31">
          <description><![CDATA[The document attributes (names/values)]]></description>
          <long-description><![CDATA[]]></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="41" package="Default">
        <name>$_changed</name>
        <default><![CDATA[]]></default>
        <docblock line="37">
          <description><![CDATA[Flag to indicate whether document was changed locally]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="37" 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="58" package="">
        <name>__construct</name>
        <type>function</type>
        <docblock line="53">
          <description><![CDATA[Constructs an empty document]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="53" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="69" package="">
        <name>createFromArray</name>
        <type>function</type>
        <docblock line="62">
          <description><![CDATA[Factory method to construct a new document using the values passed to populate it]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="62" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="62" name="param" description="- initial values for document" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="62" name="return" description="" type="\triagens\ArangoDb\Document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
        </docblock>
        <argument line="69">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="87" package="">
        <name>__clone</name>
        <type>function</type>
        <docblock line="81">
          <description><![CDATA[Clone a document
Returns the clone]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="81" 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="99" package="">
        <name>__toString</name>
        <type>function</type>
        <docblock line="93">
          <description><![CDATA[Get a string representation of the document
Returns the document as JSON-encoded string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="93" name="return" description="- JSON-encoded document" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="108" package="">
        <name>toJson</name>
        <type>function</type>
        <docblock line="103">
          <description><![CDATA[Returns the document as JSON-encoded string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="103" name="return" description="- JSON-encoded document" 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="">
        <name>toSerialized</name>
        <type>function</type>
        <docblock line="112">
          <description><![CDATA[Returns the document as a serialized string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="112" name="return" description="- PHP serialized document" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="133" package="">
        <name>set</name>
        <type>function</type>
        <docblock line="121">
          <description><![CDATA[Set a document attribute]]></description>
          <long-description><![CDATA[<p>The key (attribute name) must be a string.
This will validate the value of the attribute and might throw an
exception if the value is invalid.</p>]]></long-description>
          <tag line="121" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="121" name="param" description="- attribute name" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="121" name="param" description="- value for attribute" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="121" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="133">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="133">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="174" package="">
        <name>__set</name>
        <type>function</type>
        <docblock line="162">
          <description><![CDATA[Set a document attribute, magic method]]></description>
          <long-description><![CDATA[<p>This is a magic method that allows the object to be used without
declaring all document attributes first.
This function is mapped to set() internally.</p>]]></long-description>
          <tag line="162" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="162" name="param" description="- attribute name" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="162" name="param" description="- value for attribute" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="162" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="174">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="174">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="184" package="">
        <name>get</name>
        <type>function</type>
        <docblock line="178">
          <description><![CDATA[Get a document attribute]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="178" name="param" description="- name of attribute" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="178" name="return" description="- value of attribute, NULL if attribute is not set" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="184">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="199" package="">
        <name>__get</name>
        <type>function</type>
        <docblock line="192">
          <description><![CDATA[Get a document attribute, magic method
This function is mapped to get() internally.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="192" name="param" description="- name of attribute" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="192" name="return" description="- value of attribute, NULL if attribute is not set" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="199">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="208" package="">
        <name>getAll</name>
        <type>function</type>
        <docblock line="203">
          <description><![CDATA[Get all document attributes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="203" name="return" description="- array of all document attributes/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="218" package="">
        <name>setChanged</name>
        <type>function</type>
        <docblock line="212">
          <description><![CDATA[Set the changed flag]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="212" name="param" description="- change flag" type="bool" variable="$value">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="212" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="218">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="227" package="">
        <name>getChanged</name>
        <type>function</type>
        <docblock line="222">
          <description><![CDATA[Get the changed flag]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="222" name="return" description="- true if document was changed, false otherwise" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="239" package="">
        <name>setInternalId</name>
        <type>function</type>
        <docblock line="231">
          <description><![CDATA[Set the internal document id
This will throw if the id of an existing document gets updated to some other id]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="231" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="231" name="param" description="- internal document id" type="string" variable="$id">
            <type by_reference="false">string</type>
          </tag>
          <tag line="231" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="239">
          <name>$id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="258" package="">
        <name>getInternalId</name>
        <type>function</type>
        <docblock line="251">
          <description><![CDATA[Get the internal document id (if already known)
Document ids are generated on the server only. Document ids consist of collection id and
document id, in the format collectionid/documentid]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="251" name="return" description="- internal document id, might be NULL if document does not yet have an id" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="269" package="">
        <name>getId</name>
        <type>function</type>
        <docblock line="262">
          <description><![CDATA[Get the document id (if already known)
Document ids are generated on the server only. Document ids are numeric but might be
bigger than PHP_INT_MAX. To reliably store a document id elsewhere, a PHP string should be used]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="262" name="return" description="- document id, might be NULL if document does not yet have an id" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="282" package="">
        <name>getCollectionId</name>
        <type>function</type>
        <docblock line="275">
          <description><![CDATA[Get the collection id (if already known)
Collection ids are generated on the server only. Collection ids are numeric but might be
bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="275" name="return" description="- collection id, might be NULL if document does not yet have an id" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="296" package="">
        <name>setRevision</name>
        <type>function</type>
        <docblock line="288">
          <description><![CDATA[Set the document revision
Revision ids are generated on the server only. Document ids are numeric but might be
bigger than PHP_INT_MAX. To reliably store a document id elsewhere, a PHP string should be used]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="288" name="param" description="- revision id" type="mixed" variable="$rev">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="288" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="296">
          <name>$rev</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="305" package="">
        <name>getRevision</name>
        <type>function</type>
        <docblock line="300">
          <description><![CDATA[Get the document revision (if already known)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="300" name="return" description="- revision id, might be NULL if document does not yet have an id" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="triagens/ArangoDb/ClientException.php" hash="4874b58155e639258e2a239ae37b0a74" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: client exception]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>ClientException</name>
      <full_name>\triagens\ArangoDb\ClientException</full_name>
      <extends>\triagens\ArangoDb\Exception</extends>
      <docblock line="13">
        <description><![CDATA[This exception type will be thrown by the client when there is an error
on the client side, i.e. something the server is not involved in.]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
    </class>
  </file>
  <file path="triagens/ArangoDb/HttpResponse.php" hash="74bb682476350913867d8189ced7dc18" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: HTTP response]]></description>
      <long-description><![CDATA[]]></long-description>
      <tag line="3" name="package" description="ArangoDbPhpClient"/>
      <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="ArangoDbPhpClient">
      <name>HttpResponse</name>
      <full_name>\triagens\ArangoDb\HttpResponse</full_name>
      <extends/>
      <docblock line="13">
        <description><![CDATA[Container class for HTTP responses]]></description>
        <long-description><![CDATA[]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="52" package="Default">
        <name>HEADER_LOCATION</name>
        <value><![CDATA['location']]></value>
        <docblock line="49">
          <description><![CDATA[HTTP location header]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="23" package="Default">
        <name>$_header</name>
        <default><![CDATA['']]></default>
        <docblock line="19">
          <description><![CDATA[The header retrieved]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="19" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="29" package="Default">
        <name>$_body</name>
        <default><![CDATA['']]></default>
        <docblock line="25">
          <description><![CDATA[The body retrieved]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="25" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="35" package="Default">
        <name>$_headers</name>
        <default><![CDATA[array()]]></default>
        <docblock line="31">
          <description><![CDATA[All headers retrieved as an assoc array]]></description>
          <long-description><![CDATA[]]></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="41" package="Default">
        <name>$_result</name>
        <default><![CDATA['']]></default>
        <docblock line="37">
          <description><![CDATA[The result statusline (first line of HTTP response header)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="37" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="47" package="Default">
        <name>$_httpCode</name>
        <default><![CDATA[]]></default>
        <docblock line="43">
          <description><![CDATA[The HTTP status code of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="43" name="var" description="" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="61" package="">
        <name>__construct</name>
        <type>function</type>
        <docblock line="54">
          <description><![CDATA[Set up the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="54" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="54" name="param" description="- the complete HTTP response as supplied by the server" type="string" variable="$responseString">
            <type by_reference="false">string</type>
          </tag>
          <tag line="54" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="61">
          <name>$responseString</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="81" package="">
        <name>getHttpCode</name>
        <type>function</type>
        <docblock line="76">
          <description><![CDATA[Return the HTTP status code of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="76" name="return" description="- HTTP status code of response" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="91" package="">
        <name>getHeader</name>
        <type>function</type>
        <docblock line="85">
          <description><![CDATA[Return an individual HTTP headers of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="85" name="param" description="- name of header" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="85" name="return" description="- header value, NULL if header wasn't set in response" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="91">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="108" package="">
        <name>getHeaders</name>
        <type>function</type>
        <docblock line="103">
          <description><![CDATA[Return the HTTP headers of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="103" name="return" description="- array of all headers with 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="117" package="">
        <name>getLocationHeader</name>
        <type>function</type>
        <docblock line="112">
          <description><![CDATA[Return the location HTTP header of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="112" name="return" description="- header value, NULL is header wasn't set in response" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="126" package="">
        <name>getBody</name>
        <type>function</type>
        <docblock line="121">
          <description><![CDATA[Return the body of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="121" name="return" description="- body of the response" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="135" package="">
        <name>getResult</name>
        <type>function</type>
        <docblock line="130">
          <description><![CDATA[Return the result line (first header line) of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="130" name="return" description="- the result line (first line of header)" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="145" package="">
        <name>getJson</name>
        <type>function</type>
        <docblock line="139">
          <description><![CDATA[Return the data from the JSON-encoded body]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="139" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="139" name="return" description="- array of values from the JSON-encoded response body" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="162" package="">
        <name>setupHeaders</name>
        <type>function</type>
        <docblock line="157">
          <description><![CDATA[Set up an array of HTTP headers]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="157" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <package name="" full_name=""/>
  <package name="ArangoDbPhpClient" full_name="ArangoDbPhpClient"/>
  <package name="Default" full_name="Default"/>
  <namespace name="triagens" full_name="triagens">
    <namespace name="ArangoDb" full_name="triagens\ArangoDb"/>
  </namespace>
  <marker>todo</marker>
  <marker>fixme</marker>
</project>
Return current item: ArangoDB-PHP