Location: PHPKode > projects > ArangoDB-PHP > ArangoDB-PHP-1.0.1/docs/structure.xml
<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a10" title="ArangoDB PHP client API">
  <file path="ValueValidator.php" hash="5f2942053025277e2f49ba2a6cae6596" 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">
      <extends/>
      <name>ValueValidator</name>
      <full_name>\triagens\ArangoDb\ValueValidator</full_name>
      <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="28" package="ArangoDbPhpClient">
        <name>validate</name>
        <full_name>validate</full_name>
        <docblock line="19">
          <description><![CDATA[Validate the value of a variable]]></description>
          <long-description><![CDATA[<p>Allowed value types are string, integer, double and booleans. Arrays are also allowed if they contain only one of the former types.</p>]]></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="28">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="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">
      <extends>\Exception</extends>
      <name>Exception</name>
      <full_name>\triagens\ArangoDb\Exception</full_name>
      <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="BindVars.php" hash="0c5168233d433d001c02c2e9acb783ff" 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">
      <extends/>
      <name>BindVars</name>
      <full_name>\triagens\ArangoDb\BindVars</full_name>
      <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" namespace="triagens\ArangoDb" 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="ArangoDbPhpClient">
        <name>getAll</name>
        <full_name>getAll</full_name>
        <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="ArangoDbPhpClient">
        <name>getCount</name>
        <full_name>getCount</full_name>
        <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="ArangoDbPhpClient">
        <name>get</name>
        <full_name>get</full_name>
        <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="72" package="ArangoDbPhpClient">
        <name>set</name>
        <full_name>set</full_name>
        <docblock line="58">
          <description><![CDATA[Set the value of a single bind variable or set all bind variables at once]]></description>
          <long-description><![CDATA[<p>This will also validate the bind values.</p>

<p>Allowed value types for bind parameters are string, int,
double, bool and array. Arrays must not contain any other
than these types.</p>]]></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="72">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="72">
          <name>$value</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="Scope.php" hash="53cd4f43707aa72b05ae7752398693ba" 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">
      <extends/>
      <name>Scope</name>
      <full_name>\triagens\ArangoDb\Scope</full_name>
      <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="51" package="ArangoDbPhpClient">
        <name>STATE_NONE</name>
        <full_name>STATE_NONE</full_name>
        <value><![CDATA[0]]></value>
        <docblock line="48">
          <description><![CDATA[Scope has not been entered]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="56" package="ArangoDbPhpClient">
        <name>STATE_ENTERED</name>
        <full_name>STATE_ENTERED</full_name>
        <value><![CDATA[1]]></value>
        <docblock line="53">
          <description><![CDATA[Scope has been entered but not left]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="61" package="ArangoDbPhpClient">
        <name>STATE_LEFT</name>
        <full_name>STATE_LEFT</full_name>
        <value><![CDATA[2]]></value>
        <docblock line="58">
          <description><![CDATA[Scope has been entered and left]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="25" namespace="triagens\ArangoDb" 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="callable">
            <type by_reference="false">callable</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="32" namespace="triagens\ArangoDb" package="Default">
        <name>$_exitFunc</name>
        <default><![CDATA[]]></default>
        <docblock line="27">
          <description><![CDATA[Exit function (called when scope is left)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="27" name="var" description="" type="callable">
            <type by_reference="false">callable</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="39" namespace="triagens\ArangoDb" package="Default">
        <name>$_value</name>
        <default><![CDATA[]]></default>
        <docblock line="34">
          <description><![CDATA[Value returned by call to init function]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="34" name="var" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="46" namespace="triagens\ArangoDb" package="Default">
        <name>$_state</name>
        <default><![CDATA[self::STATE_NONE]]></default>
        <docblock line="41">
          <description><![CDATA[Current scope state]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="41" 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="70" package="ArangoDbPhpClient">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="63">
          <description><![CDATA[Initialise the scope]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="63" name="param" description="- function to be called when scope is entered" type="callable" variable="$initFunc">
            <type by_reference="false">callable</type>
          </tag>
          <tag line="63" name="param" description="- function to be called when scope if left" type="callable" variable="$exitFunc">
            <type by_reference="false">callable</type>
          </tag>
          <tag line="63" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="70">
          <name>$initFunc</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="70">
          <name>$exitFunc</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="87" package="ArangoDbPhpClient">
        <name>__destruct</name>
        <full_name>__destruct</full_name>
        <docblock line="80">
          <description><![CDATA[Destroy the scope]]></description>
          <long-description><![CDATA[<p>This will call leave() to ensure the scope is definitely left</p>]]></long-description>
          <tag line="80" 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="101" package="ArangoDbPhpClient">
        <name>leave</name>
        <full_name>leave</full_name>
        <docblock line="91">
          <description><![CDATA[Leave the scope]]></description>
          <long-description><![CDATA[<p>This will execute the exit func with the value returned by the
call to the init func.
leave() will check whether the scope has already been left to avoid
duplicate execution of the exit func.</p>]]></long-description>
          <tag line="91" 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="120" package="ArangoDbPhpClient">
        <name>enter</name>
        <full_name>enter</full_name>
        <docblock line="113">
          <description><![CDATA[Enter the scope]]></description>
          <long-description><![CDATA[<p>This will call the init func and store its result value</p>]]></long-description>
          <tag line="113" 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="136" package="ArangoDbPhpClient">
        <name>__clone</name>
        <full_name>__clone</full_name>
        <docblock line="128">
          <description><![CDATA[Clone function]]></description>
          <long-description><![CDATA[<p>Scopes should never be cloned so this is private</p>]]></long-description>
          <tag line="128" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="128" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="ConnectionOptions.php" hash="de936fed1d8d28122533674c713a1ad5" 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">
      <extends/>
      <implements>\ArrayAccess</implements>
      <name>ConnectionOptions</name>
      <full_name>\triagens\ArangoDb\ConnectionOptions</full_name>
      <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="37" package="ArangoDbPhpClient">
        <name>OPTION_ENDPOINT</name>
        <full_name>OPTION_ENDPOINT</full_name>
        <value><![CDATA['endpoint']]></value>
        <docblock line="34">
          <description><![CDATA[Endpoint string index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="42" package="ArangoDbPhpClient">
        <name>OPTION_HOST</name>
        <full_name>OPTION_HOST</full_name>
        <value><![CDATA['host']]></value>
        <docblock line="39">
          <description><![CDATA[Host name string index constant (deprecated, use endpoint instead)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="47" package="ArangoDbPhpClient">
        <name>OPTION_PORT</name>
        <full_name>OPTION_PORT</full_name>
        <value><![CDATA['port']]></value>
        <docblock line="44">
          <description><![CDATA[Port number index constant (deprecated, use endpoint instead)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="52" package="ArangoDbPhpClient">
        <name>OPTION_TIMEOUT</name>
        <full_name>OPTION_TIMEOUT</full_name>
        <value><![CDATA['timeout']]></value>
        <docblock line="49">
          <description><![CDATA[Timeout value index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="57" package="ArangoDbPhpClient">
        <name>OPTION_TRACE</name>
        <full_name>OPTION_TRACE</full_name>
        <value><![CDATA['trace']]></value>
        <docblock line="54">
          <description><![CDATA[Trace function index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="62" package="ArangoDbPhpClient">
        <name>OPTION_CREATE</name>
        <full_name>OPTION_CREATE</full_name>
        <value><![CDATA['createCollection']]></value>
        <docblock line="59">
          <description><![CDATA["Create collections if they don't exist" index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="67" package="ArangoDbPhpClient">
        <name>OPTION_REVISION</name>
        <full_name>OPTION_REVISION</full_name>
        <value><![CDATA['rev']]></value>
        <docblock line="64">
          <description><![CDATA[Update revision constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="72" package="ArangoDbPhpClient">
        <name>OPTION_UPDATE_POLICY</name>
        <full_name>OPTION_UPDATE_POLICY</full_name>
        <value><![CDATA['policy']]></value>
        <docblock line="69">
          <description><![CDATA[Update policy index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="77" package="ArangoDbPhpClient">
        <name>OPTION_UPDATE_KEEPNULL</name>
        <full_name>OPTION_UPDATE_KEEPNULL</full_name>
        <value><![CDATA['keepNull']]></value>
        <docblock line="74">
          <description><![CDATA[Update keepnull constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="82" package="ArangoDbPhpClient">
        <name>OPTION_REPLACE_POLICY</name>
        <full_name>OPTION_REPLACE_POLICY</full_name>
        <value><![CDATA['policy']]></value>
        <docblock line="79">
          <description><![CDATA[Replace policy index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="87" package="ArangoDbPhpClient">
        <name>OPTION_DELETE_POLICY</name>
        <full_name>OPTION_DELETE_POLICY</full_name>
        <value><![CDATA['policy']]></value>
        <docblock line="84">
          <description><![CDATA[Delete policy index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="92" package="ArangoDbPhpClient">
        <name>OPTION_WAIT_SYNC</name>
        <full_name>OPTION_WAIT_SYNC</full_name>
        <value><![CDATA['waitForSync']]></value>
        <docblock line="89">
          <description><![CDATA[Wait for sync index constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="97" package="ArangoDbPhpClient">
        <name>OPTION_AUTH_USER</name>
        <full_name>OPTION_AUTH_USER</full_name>
        <value><![CDATA['AuthUser']]></value>
        <docblock line="94">
          <description><![CDATA[Authentication user name]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="102" package="ArangoDbPhpClient">
        <name>OPTION_AUTH_PASSWD</name>
        <full_name>OPTION_AUTH_PASSWD</full_name>
        <value><![CDATA['AuthPasswd']]></value>
        <docblock line="99">
          <description><![CDATA[Authentication password]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="107" package="ArangoDbPhpClient">
        <name>OPTION_AUTH_TYPE</name>
        <full_name>OPTION_AUTH_TYPE</full_name>
        <value><![CDATA['AuthType']]></value>
        <docblock line="104">
          <description><![CDATA[Authentication type]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="112" package="ArangoDbPhpClient">
        <name>OPTION_CONNECTION</name>
        <full_name>OPTION_CONNECTION</full_name>
        <value><![CDATA['Connection']]></value>
        <docblock line="109">
          <description><![CDATA[Connection]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="117" package="ArangoDbPhpClient">
        <name>OPTION_RECONNECT</name>
        <full_name>OPTION_RECONNECT</full_name>
        <value><![CDATA['Reconnect']]></value>
        <docblock line="114">
          <description><![CDATA[Reconnect flag]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="26" namespace="triagens\ArangoDb" 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>
      <property final="false" static="false" visibility="private" line="32" namespace="triagens\ArangoDb" package="Default">
        <name>$_endpoint</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="28">
          <description><![CDATA[The connection endpoint object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="28" name="var" description="" type="\triagens\ArangoDb\Endpoint">
            <type by_reference="false">\triagens\ArangoDb\Endpoint</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="126" package="ArangoDbPhpClient">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="119">
          <description><![CDATA[Set defaults, use options provided by client and validate them]]></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="- initial options" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="119" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="126">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="136" package="ArangoDbPhpClient">
        <name>getAll</name>
        <full_name>getAll</full_name>
        <docblock line="131">
          <description><![CDATA[Get all options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="131" 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="148" package="ArangoDbPhpClient">
        <name>offsetSet</name>
        <full_name>offsetSet</full_name>
        <docblock line="140">
          <description><![CDATA[Set and validate a specific option, necessary for ArrayAccess]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="140" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="140" name="param" description="- name of option" type="string" variable="$offset">
            <type by_reference="false">string</type>
          </tag>
          <tag line="140" name="param" description="- value for option" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="140" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="148">
          <name>$offset</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="148">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="159" package="ArangoDbPhpClient">
        <name>offsetExists</name>
        <full_name>offsetExists</full_name>
        <docblock line="153">
          <description><![CDATA[Check whether an option exists, necessary for ArrayAccess]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="153" name="param" description="-name of option" type="string" variable="$offset">
            <type by_reference="false">string</type>
          </tag>
          <tag line="153" name="return" description="- true if option exists, false otherwise" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="159">
          <name>$offset</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="170" package="ArangoDbPhpClient">
        <name>offsetUnset</name>
        <full_name>offsetUnset</full_name>
        <docblock line="163">
          <description><![CDATA[Remove an option and validate, necessary for ArrayAccess]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="163" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="163" name="param" description="- name of option" type="string" variable="$offset">
            <type by_reference="false">string</type>
          </tag>
          <tag line="163" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="170">
          <name>$offset</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="182" package="ArangoDbPhpClient">
        <name>offsetGet</name>
        <full_name>offsetGet</full_name>
        <docblock line="175">
          <description><![CDATA[Get a specific option, necessary for ArrayAccess]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="175" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="175" name="param" description="- name of option" type="string" variable="$offset">
            <type by_reference="false">string</type>
          </tag>
          <tag line="175" 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="182">
          <name>$offset</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="196" package="ArangoDbPhpClient">
        <name>getEndpoint</name>
        <full_name>getEndpoint</full_name>
        <docblock line="190">
          <description><![CDATA[Get the endpoint object for the connection]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="190" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="190" name="return" description="- endpoint object" type="\triagens\ArangoDb\Endpoint">
            <type by_reference="false">\triagens\ArangoDb\Endpoint</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="triagens\ArangoDb" line="210" package="ArangoDbPhpClient">
        <name>getDefaults</name>
        <full_name>getDefaults</full_name>
        <docblock line="205">
          <description><![CDATA[Get the default values for the options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="205" name="return" description="- array of default connection options" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="triagens\ArangoDb" line="236" package="ArangoDbPhpClient">
        <name>getSupportedAuthTypes</name>
        <full_name>getSupportedAuthTypes</full_name>
        <docblock line="231">
          <description><![CDATA[Return the supported authorization types]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="231" name="return" description="- array with supported authorization types" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="triagens\ArangoDb" line="245" package="ArangoDbPhpClient">
        <name>getSupportedConnectionTypes</name>
        <full_name>getSupportedConnectionTypes</full_name>
        <docblock line="240">
          <description><![CDATA[Return the supported connection types]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="240" name="return" description="- array with supported connection types" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="255" package="ArangoDbPhpClient">
        <name>validate</name>
        <full_name>validate</full_name>
        <docblock line="249">
          <description><![CDATA[Validate the options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="249" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="249" name="return" description="- will throw if an invalid option value is found" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="Statement.php" hash="d479adc12bd7e9e0cdfa6e5597600bef" 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">
      <extends/>
      <name>Statement</name>
      <full_name>\triagens\ArangoDb\Statement</full_name>
      <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.]]></description>
        <long-description><![CDATA[<p>Optional bind parameters can be used when issuing the
statement to separate the statement from the values.
Executing a statement will result in a cursor being created.</p>]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="68" package="ArangoDbPhpClient">
        <name>ENTRY_QUERY</name>
        <full_name>ENTRY_QUERY</full_name>
        <value><![CDATA['query']]></value>
        <docblock line="65">
          <description><![CDATA[Query string index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="73" package="ArangoDbPhpClient">
        <name>ENTRY_COUNT</name>
        <full_name>ENTRY_COUNT</full_name>
        <value><![CDATA['count']]></value>
        <docblock line="70">
          <description><![CDATA[Count option index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="78" package="ArangoDbPhpClient">
        <name>ENTRY_BATCHSIZE</name>
        <full_name>ENTRY_BATCHSIZE</full_name>
        <value><![CDATA['batchSize']]></value>
        <docblock line="75">
          <description><![CDATA[Batch size index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="83" package="ArangoDbPhpClient">
        <name>ENTRY_BINDVARS</name>
        <full_name>ENTRY_BINDVARS</full_name>
        <value><![CDATA['bindVars']]></value>
        <docblock line="80">
          <description><![CDATA[Bind variables index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="28" namespace="triagens\ArangoDb" 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="35" namespace="triagens\ArangoDb" package="Default">
        <name>$_bindVars</name>
        <default><![CDATA[]]></default>
        <docblock line="30">
          <description><![CDATA[The bind variables and values used for the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="30" 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="42" namespace="triagens\ArangoDb" package="Default">
        <name>$_batchSize</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="37">
          <description><![CDATA[The current batch size (number of result documents retrieved per roundtrip)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="37" name="var" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="49" namespace="triagens\ArangoDb" package="Default">
        <name>$_doCount</name>
        <default><![CDATA[false]]></default>
        <docblock line="44">
          <description><![CDATA[The count flag (should server return total number of results)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="44" name="var" description="" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="56" namespace="triagens\ArangoDb" package="Default">
        <name>$_query</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="51">
          <description><![CDATA[The query string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="51" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="63" namespace="triagens\ArangoDb" package="Default">
        <name>$_sanitize</name>
        <default><![CDATA[false]]></default>
        <docblock line="58">
          <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="58" 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="93" package="ArangoDbPhpClient">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="85">
          <description><![CDATA[Initialise the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="85" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="85" 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="85" name="param" description="- statement initialization data" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
          <tag line="85" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="93">
          <name>$connection</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Connection</type>
        </argument>
        <argument line="93">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="125" package="ArangoDbPhpClient">
        <name>execute</name>
        <full_name>execute</full_name>
        <docblock line="116">
          <description><![CDATA[Execute the statement]]></description>
          <long-description><![CDATA[<p>This will post the query to the server and return the results as
a Cursor. The cursor can then be used to iterate the results.</p>]]></long-description>
          <tag line="116" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="116" 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="140" package="ArangoDbPhpClient">
        <name>explain</name>
        <full_name>explain</full_name>
        <docblock line="132">
          <description><![CDATA[Explain the statement's execution plan]]></description>
          <long-description><![CDATA[<p>This will post the query to the server and return the execution plan as an array.</p>]]></long-description>
          <tag line="132" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="132" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="155" package="ArangoDbPhpClient">
        <name>validate</name>
        <full_name>validate</full_name>
        <docblock line="147">
          <description><![CDATA[Validates the statement]]></description>
          <long-description><![CDATA[<p>This will post the query to the server for validation and return the validation result as an array.</p>]]></long-description>
          <tag line="147" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="147" name="return" description="" type="Array">
            <type by_reference="false">Array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="171" package="ArangoDbPhpClient">
        <name>__invoke</name>
        <full_name>__invoke</full_name>
        <docblock line="162">
          <description><![CDATA[Invoke the statement]]></description>
          <long-description><![CDATA[<p>This will simply call execute(). Arguments are ignored.</p>]]></long-description>
          <tag line="162" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="162" name="param" description="- arguments for invocation, will be ignored" type="mixed" variable="$args">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="162" name="return" description="- the result cursor" type="\triagens\ArangoDb\Cursor">
            <type by_reference="false">\triagens\ArangoDb\Cursor</type>
          </tag>
        </docblock>
        <argument line="171">
          <name>$args</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="180" package="ArangoDbPhpClient">
        <name>__toString</name>
        <full_name>__toString</full_name>
        <docblock line="175">
          <description><![CDATA[Return a string representation of the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="175" 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="200" package="ArangoDbPhpClient">
        <name>bind</name>
        <full_name>bind</full_name>
        <docblock line="184">
          <description><![CDATA[Bind a parameter to the statement]]></description>
          <long-description><![CDATA[<p>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.</p>

<p>Allowed value types for bind parameters are string, int,
double, bool and array. Arrays must not contain any other
than these types.</p>]]></long-description>
          <tag line="184" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="184" 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="184" name="param" description="- value for bind variable" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="184" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="200">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="200">
          <name>$value</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="209" package="ArangoDbPhpClient">
        <name>getBindVars</name>
        <full_name>getBindVars</full_name>
        <docblock line="204">
          <description><![CDATA[Get all bind parameters as an array]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="204" 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="220" package="ArangoDbPhpClient">
        <name>setQuery</name>
        <full_name>setQuery</full_name>
        <docblock line="213">
          <description><![CDATA[Set the query string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="213" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="213" name="param" description="- query string" type="string" variable="$query">
            <type by_reference="false">string</type>
          </tag>
          <tag line="213" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="220">
          <name>$query</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="233" package="ArangoDbPhpClient">
        <name>getQuery</name>
        <full_name>getQuery</full_name>
        <docblock line="228">
          <description><![CDATA[Get the query string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="228" 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="243" package="ArangoDbPhpClient">
        <name>setCount</name>
        <full_name>setCount</full_name>
        <docblock line="237">
          <description><![CDATA[Set the count option for the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="237" name="param" description="- value for count option" type="bool" variable="$value">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="237" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="243">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="252" package="ArangoDbPhpClient">
        <name>getCount</name>
        <full_name>getCount</full_name>
        <docblock line="247">
          <description><![CDATA[Get the count option value of the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="247" 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="270" package="ArangoDbPhpClient">
        <name>setBatchSize</name>
        <full_name>setBatchSize</full_name>
        <docblock line="256">
          <description><![CDATA[Set the batch size for the statement]]></description>
          <long-description><![CDATA[<p>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.</p>

<p>The server-side cursor can be accessed by the client with subsequent HTTP requests.</p>]]></long-description>
          <tag line="256" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="256" name="param" description="- batch size value" type="int" variable="$value">
            <type by_reference="false">int</type>
          </tag>
          <tag line="256" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="270">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="283" package="ArangoDbPhpClient">
        <name>getBatchSize</name>
        <full_name>getBatchSize</full_name>
        <docblock line="278">
          <description><![CDATA[Get the batch size for the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="278" 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="292" package="ArangoDbPhpClient">
        <name>buildData</name>
        <full_name>buildData</full_name>
        <docblock line="287">
          <description><![CDATA[Build an array of data to be posted to the server when issuing the statement]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="287" 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="314" package="ArangoDbPhpClient">
        <name>getCursorOptions</name>
        <full_name>getCursorOptions</full_name>
        <docblock line="309">
          <description><![CDATA[Return an array of cursor options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="309" name="return" description="- array of options" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="DocumentHandler.php" hash="c51c10739c12dc3d283127815158f7ae" 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="author" description="Frank Mayer"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="22" package="ArangoDbPhpClient">
      <extends>\triagens\ArangoDb\Handler</extends>
      <name>DocumentHandler</name>
      <full_name>\triagens\ArangoDb\DocumentHandler</full_name>
      <docblock line="15">
        <description><![CDATA[A document handler that fetches documents from the server and
persists them on the server.]]></description>
        <long-description><![CDATA[<p>It does so by issuing the
appropriate HTTP requests to the server.</p>]]></long-description>
        <tag line="15" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="26" package="ArangoDbPhpClient">
        <name>ENTRY_DOCUMENTS</name>
        <full_name>ENTRY_DOCUMENTS</full_name>
        <value><![CDATA['documents']]></value>
        <docblock line="23">
          <description><![CDATA[documents array index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="31" package="ArangoDbPhpClient">
        <name>OPTION_COLLECTION</name>
        <full_name>OPTION_COLLECTION</full_name>
        <value><![CDATA['collection']]></value>
        <docblock line="28">
          <description><![CDATA[collection parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="36" package="ArangoDbPhpClient">
        <name>OPTION_EXAMPLE</name>
        <full_name>OPTION_EXAMPLE</full_name>
        <value><![CDATA['example']]></value>
        <docblock line="33">
          <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="54" package="ArangoDbPhpClient">
        <name>get</name>
        <full_name>get</full_name>
        <docblock line="39">
          <description><![CDATA[Get a single document from a collection]]></description>
          <long-description><![CDATA[<p>Alias method for getById()</p>]]></long-description>
          <tag line="39" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="39" name="param" description="- collection id as a string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="39" name="param" description="- document identifier" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="39" name="param" description="- optional, array of options &lt;p&gt;Options are : &lt;li&gt;'includeInternals' - true to include the internal attributes. Defaults to false&lt;/li&gt; &lt;li&gt;'ignoreHiddenAttributes' - true to show hidden attributes. Defaults to false&lt;/li&gt; &lt;/p&gt;" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="39" 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="54">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="54">
          <name>$documentId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="54">
          <name>$options</name>
          <default><![CDATA[array()]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="74" package="ArangoDbPhpClient">
        <name>getById</name>
        <full_name>getById</full_name>
        <docblock line="59">
          <description><![CDATA[Get a single document from a collection]]></description>
          <long-description><![CDATA[<p>This will throw if the document cannot be fetched from the server</p>]]></long-description>
          <tag line="59" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="59" name="param" description="- collection id as a string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="59" name="param" description="- document identifier" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="59" name="param" description="- optional, array of options &lt;p&gt;Options are : &lt;li&gt;'includeInternals' - true to include the internal attributes. Defaults to false&lt;/li&gt; &lt;li&gt;'ignoreHiddenAttributes' - true to show hidden attributes. Defaults to false&lt;/li&gt; &lt;/p&gt;" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="59" 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="74">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="74">
          <name>$documentId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="74">
          <name>$options</name>
          <default><![CDATA[array()]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="96" package="ArangoDbPhpClient">
        <name>getAllIds</name>
        <full_name>getAllIds</full_name>
        <docblock line="84">
          <description><![CDATA[Get the list of all documents' ids from a collection]]></description>
          <long-description><![CDATA[<p>This will throw if the list cannot be fetched from the server</p>]]></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="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="84" name="return" description="- ids of documents in the collection" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="84" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by  CollectionHandler::getAllIds()"/>
        </docblock>
        <argument line="96">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="115" package="ArangoDbPhpClient">
        <name>getByExample</name>
        <full_name>getByExample</full_name>
        <docblock line="102">
          <description><![CDATA[Get document(s) by specifying an example]]></description>
          <long-description><![CDATA[<p>This will throw if the list cannot be fetched from the server</p>]]></long-description>
          <tag line="102" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="102" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="102" 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="102" name="param" description="- remove _id and _rev attributes from result documents" type="bool" variable="$sanitize">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="102" name="return" description="- documents matching the example [0...n]" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="102" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by CollectionHandler::byExample()"/>
        </docblock>
        <argument line="115">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="115">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="115">
          <name>$sanitize</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="138" package="ArangoDbPhpClient">
        <name>add</name>
        <full_name>add</full_name>
        <docblock line="121">
          <description><![CDATA[Add a document to a collection]]></description>
          <long-description><![CDATA[<p>This will add the document to the collection and return the document's id</p>

<p>This will throw if the document cannot be created</p>]]></long-description>
          <tag line="121" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="121" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="121" 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="121" 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="121" name="return" description="- id of document created \" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="121" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by save()"/>
        </docblock>
        <argument line="138">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="138">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="138">
          <name>$create</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="157" package="ArangoDbPhpClient">
        <name>save</name>
        <full_name>save</full_name>
        <docblock line="143">
          <description><![CDATA[save a document to a collection]]></description>
          <long-description><![CDATA[<p>This will add the document to the collection and return the document's id</p>

<p>This will throw if the document cannot be saved</p>]]></long-description>
          <tag line="143" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="143" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="143" 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="143" 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="143" name="return" description="- id of document created" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="143" name="since" description="1.0"/>
        </docblock>
        <argument line="157">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="157">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="157">
          <name>$create</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="206" package="ArangoDbPhpClient">
        <name>update</name>
        <full_name>update</full_name>
        <docblock line="185">
          <description><![CDATA[Update an existing document in a collection, identified by the including _id and optionally _rev in the patch document.]]></description>
          <long-description><![CDATA[<p>Attention - The behavior of this method has changed since version 1.1</p>

<p>This will update the document on the server</p>

<p>This will throw if the document cannot be updated</p>

<p>If policy is set to error (locally or globally through the connectionoptions)
and the passed document has a _rev value set, the database will check
that the revision of the to-be-replaced document is the same as the one given.</p>]]></long-description>
          <tag line="185" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="185" name="param" description="- The patch document that will update the document in question" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="185" name="param" description="- optional, array of options (see below) or the boolean value for $policy (for compatibility prior to version 1.1 of this method) &lt;p&gt;Options are : &lt;li&gt;'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])&lt;/li&gt; &lt;li&gt;'keepNull' - can be used to instruct ArangoDB to delete existing attributes instead setting their values to null. Defaults to true (keep attributes when set to null)&lt;/li&gt; &lt;/p&gt;" type="mixed" variable="$options">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="185" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="206">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="206">
          <name>$options</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="230" package="ArangoDbPhpClient">
        <name>replace</name>
        <full_name>replace</full_name>
        <docblock line="214">
          <description><![CDATA[Replace an existing document in a collection, identified by the document itself]]></description>
          <long-description><![CDATA[<p>This will update the document on the server</p>

<p>This will throw if the document cannot be updated</p>

<p>If policy is set to error (locally or globally through the connectionoptions)
and the passed document has a _rev value set, the database will check
that the revision of the to-be-replaced document is the same as the one given.</p>]]></long-description>
          <tag line="214" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="214" name="param" description="- document to be updated" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="214" name="param" description="- update policy to be used in case of conflict" type="mixed" variable="$policy">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="214" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="230">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="230">
          <name>$policy</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="261" package="ArangoDbPhpClient">
        <name>updateById</name>
        <full_name>updateById</full_name>
        <docblock line="238">
          <description><![CDATA[Update an existing document in a collection, identified by collection id and document id
Attention - The behavior of this method has changed since version 1.1]]></description>
          <long-description><![CDATA[<p>This will update the document on the server</p>

<p>This will throw if the document cannot be updated</p>

<p>If policy is set to error (locally or globally through the connectionoptions)
and the passed document has a _rev value set, the database will check
that the revision of the to-be-replaced document is the same as the one given.</p>]]></long-description>
          <tag line="238" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="238" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="238" name="param" description="- document id as string or number" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="238" name="param" description="- patch document which contains the attributes and values to be updated" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="238" name="param" description="- optional, array of options (see below) or the boolean value for $policy (for compatibility prior to version 1.1 of this method) &lt;p&gt;Options are : &lt;li&gt;'policy' - update policy to be used in case of conflict ('error', 'last' or NULL [use default])&lt;/li&gt; &lt;li&gt;'keepNull' - can be used to instruct ArangoDB to delete existing attributes instead setting their values to null. Defaults to true (keep attributes when set to null)&lt;/li&gt; &lt;/p&gt;" type="mixed" variable="$options">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="238" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="261">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="261">
          <name>$documentId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="261">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="261">
          <name>$options</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="314" package="ArangoDbPhpClient">
        <name>replaceById</name>
        <full_name>replaceById</full_name>
        <docblock line="296">
          <description><![CDATA[Replace an existing document in a collection, identified by collection id and document id]]></description>
          <long-description><![CDATA[<p>This will update the document on the server</p>

<p>This will throw if the document cannot be Replaced</p>

<p>If policy is set to error (locally or globally through the connectionoptions)
and the passed document has a _rev value set, the database will check
that the revision of the to-be-replaced document is the same as the one given.</p>]]></long-description>
          <tag line="296" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="296" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="296" name="param" description="- document id as string or number" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="296" name="param" description="- document to be updated" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="296" name="param" description="- update policy to be used in case of conflict" type="mixed" variable="$policy">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="296" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="314">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="314">
          <name>$documentId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="314">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="314">
          <name>$policy</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="347" package="ArangoDbPhpClient">
        <name>delete</name>
        <full_name>delete</full_name>
        <docblock line="336">
          <description><![CDATA[Delete a document from a collection, identified by the document itself]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="336" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="336" name="param" description="- document to be updated" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="336" name="param" description="- policy to be used in case of conflict" type="mixed" variable="$policy">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="336" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="336" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by remove()"/>
        </docblock>
        <argument line="347">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="347">
          <name>$policy</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="360" package="ArangoDbPhpClient">
        <name>remove</name>
        <full_name>remove</full_name>
        <docblock line="352">
          <description><![CDATA[Remove a document from a collection, identified by the document itself]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="352" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="352" name="param" description="- document to be removed" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="352" name="param" description="- policy to be used in case of conflict" type="mixed" variable="$policy">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="352" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="360">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="360">
          <name>$policy</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="382" package="ArangoDbPhpClient">
        <name>deleteById</name>
        <full_name>deleteById</full_name>
        <docblock line="370">
          <description><![CDATA[Delete a document from a collection, identified by the collection id and document id]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="370" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="370" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="370" name="param" description="- document id as string or number" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="370" name="param" description="- optional revision of the document to be deleted" type="mixed" variable="$revision">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="370" name="param" description="- policy to be used in case of conflict" type="mixed" variable="$policy">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="370" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="370" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by removeById()"/>
        </docblock>
        <argument line="382">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="382">
          <name>$documentId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="382">
          <name>$revision</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
        <argument line="382">
          <name>$policy</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="399" package="ArangoDbPhpClient">
        <name>removeById</name>
        <full_name>removeById</full_name>
        <docblock line="389">
          <description><![CDATA[Remove a document from a collection, identified by the collection id and document id]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="389" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="389" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="389" name="param" description="- document id as string or number" type="mixed" variable="$documentId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="389" name="param" description="- optional revision of the document to be deleted" type="mixed" variable="$revision">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="389" name="param" description="- policy to be used in case of conflict" type="mixed" variable="$policy">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="389" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="399">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="399">
          <name>$documentId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="399">
          <name>$revision</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
        <argument line="399">
          <name>$policy</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="425" package="ArangoDbPhpClient">
        <name>getDocumentId</name>
        <full_name>getDocumentId</full_name>
        <docblock line="418">
          <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="418" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="418" name="param" description="- document id OR document to be updated" type="mixed" variable="$document">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="418" name="return" description="- document id, will throw if there is an error" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="425">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="448" package="ArangoDbPhpClient">
        <name>getRevision</name>
        <full_name>getRevision</full_name>
        <docblock line="441">
          <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="441" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="441" name="param" description="- document id OR document to be updated" type="mixed" variable="$document">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="441" name="return" description="- document id, will throw if there is an error" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="448">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="467" package="ArangoDbPhpClient">
        <name>getCollectionId</name>
        <full_name>getCollectionId</full_name>
        <docblock line="460">
          <description><![CDATA[Helper function to get a collection id from a document]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="460" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="460" name="param" description="- document id" type="\triagens\ArangoDb\Document" variable="$document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
          <tag line="460" name="return" description="- collection id, will throw if there is an error" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="467">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
      </method>
    </class>
  </file>
  <file path="Connection.php" hash="0965199c88329aace1e54d7276d553e8" 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">
      <extends/>
      <name>Connection</name>
      <full_name>\triagens\ArangoDb\Connection</full_name>
      <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="true" visibility="public" line="28" namespace="triagens\ArangoDb" package="Default">
        <name>$_apiVersion</name>
        <default><![CDATA['1.0.0']]></default>
        <docblock line="23">
          <description><![CDATA[Api Version]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="23" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="35" namespace="triagens\ArangoDb" package="Default">
        <name>$_options</name>
        <default><![CDATA[]]></default>
        <docblock line="30">
          <description><![CDATA[Connection options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="30" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="42" namespace="triagens\ArangoDb" package="Default">
        <name>$_handle</name>
        <default><![CDATA[]]></default>
        <docblock line="37">
          <description><![CDATA[Connection handle, used in case of keep-alive]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="37" name="var" description="" type="resource">
            <type by_reference="false">resource</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="49" namespace="triagens\ArangoDb" package="Default">
        <name>$_useKeepAlive</name>
        <default><![CDATA[]]></default>
        <docblock line="44">
          <description><![CDATA[Flag if keep-alive connections are used]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="44" 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="ArangoDbPhpClient">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="51">
          <description><![CDATA[Set up the connection object, validate the options provided]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="51" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="51" name="param" description="- initial connection options" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="51" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="58">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="68" package="ArangoDbPhpClient">
        <name>__destruct</name>
        <full_name>__destruct</full_name>
        <docblock line="63">
          <description><![CDATA[Close existing connection handle if a keep-alive connection was used]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="63" 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="81" package="ArangoDbPhpClient">
        <name>getOption</name>
        <full_name>getOption</full_name>
        <docblock line="74">
          <description><![CDATA[Get an option set for the connection]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="74" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="74" name="param" description="name - name of option" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="74" name="return" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="81">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="94" package="ArangoDbPhpClient">
        <name>get</name>
        <full_name>get</full_name>
        <docblock line="87">
          <description><![CDATA[Issue an HTTP GET request]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="87" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="87" name="param" description="- GET URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="87" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="94">
          <name>$url</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="107" package="ArangoDbPhpClient">
        <name>post</name>
        <full_name>post</full_name>
        <docblock line="99">
          <description><![CDATA[Issue an HTTP POST request with the data provided]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="99" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="99" name="param" description="- POST URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="99" name="param" description="- body to post" type="string" variable="$data">
            <type by_reference="false">string</type>
          </tag>
          <tag line="99" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="107">
          <name>$url</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="107">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="120" package="ArangoDbPhpClient">
        <name>put</name>
        <full_name>put</full_name>
        <docblock line="112">
          <description><![CDATA[Issue an HTTP PUT request with the data provided]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="112" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="112" name="param" description="- PUT URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="112" name="param" description="- body to post" type="string" variable="$data">
            <type by_reference="false">string</type>
          </tag>
          <tag line="112" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="120">
          <name>$url</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="120">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="133" package="ArangoDbPhpClient">
        <name>patch</name>
        <full_name>patch</full_name>
        <docblock line="125">
          <description><![CDATA[Issue an HTTP PATCH request with the data provided]]></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="- PATCH URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="125" name="param" description="- patch body" type="string" variable="$data">
            <type by_reference="false">string</type>
          </tag>
          <tag line="125" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="133">
          <name>$url</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="133">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="145" package="ArangoDbPhpClient">
        <name>delete</name>
        <full_name>delete</full_name>
        <docblock line="138">
          <description><![CDATA[Issue an HTTP DELETE request with the data provided]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="138" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="138" name="param" description="- DELETE URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="138" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="145">
          <name>$url</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="158" package="ArangoDbPhpClient">
        <name>getHandle</name>
        <full_name>getHandle</full_name>
        <docblock line="151">
          <description><![CDATA[Get a connection handle]]></description>
          <long-description><![CDATA[<p>If keep-alive connections are used, the handle will be stored and re-used</p>]]></long-description>
          <tag line="151" name="return" description="- connection handle" type="resource">
            <type by_reference="false">resource</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="196" package="ArangoDbPhpClient">
        <name>parseResponse</name>
        <full_name>parseResponse</full_name>
        <docblock line="189">
          <description><![CDATA[Parse the response return the body values as an assoc array]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="189" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="189" name="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="189" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="196">
          <name>$response</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\HttpResponse</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="237" package="ArangoDbPhpClient">
        <name>executeRequest</name>
        <full_name>executeRequest</full_name>
        <docblock line="222">
          <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.</p>

<p>The function might temporarily alter the value of the php.ini value 'default_socket_timeout' but
will restore it.</p>]]></long-description>
          <tag line="222" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="222" name="param" description="- HTTP request method" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="222" name="param" description="- HTTP URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="222" name="param" description="- data to post in body" type="string" variable="$data">
            <type by_reference="false">string</type>
          </tag>
          <tag line="222" name="return" description="" type="\triagens\ArangoDb\HttpResponse">
            <type by_reference="false">\triagens\ArangoDb\HttpResponse</type>
          </tag>
        </docblock>
        <argument line="237">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="237">
          <name>$url</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="237">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="289" package="ArangoDbPhpClient">
        <name>getVersion</name>
        <full_name>getVersion</full_name>
        <docblock line="284">
          <description><![CDATA[Get the client api version]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="284" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="DefaultValues.php" hash="0af0043bb0d3a0bc1f2e52edcb4073d0" 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="true" abstract="true" namespace="triagens\ArangoDb" line="18" package="ArangoDbPhpClient">
      <extends/>
      <name>DefaultValues</name>
      <full_name>\triagens\ArangoDb\DefaultValues</full_name>
      <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="ArangoDbPhpClient">
        <name>DEFAULT_PORT</name>
        <full_name>DEFAULT_PORT</full_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="ArangoDbPhpClient">
        <name>DEFAULT_TIMEOUT</name>
        <full_name>DEFAULT_TIMEOUT</full_name>
        <value><![CDATA[5]]></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="ArangoDbPhpClient">
        <name>DEFAULT_WAIT_SYNC</name>
        <full_name>DEFAULT_WAIT_SYNC</full_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="ArangoDbPhpClient">
        <name>DEFAULT_CREATE</name>
        <full_name>DEFAULT_CREATE</full_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="ArangoDbPhpClient">
        <name>DEFAULT_CONNECTION</name>
        <full_name>DEFAULT_CONNECTION</full_name>
        <value><![CDATA["Close"]]></value>
        <docblock line="39">
          <description><![CDATA[Default value for HTTP Connection header]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="47" package="ArangoDbPhpClient">
        <name>DEFAULT_UPDATE_POLICY</name>
        <full_name>DEFAULT_UPDATE_POLICY</full_name>
        <value><![CDATA[\triagens\ArangoDb\UpdatePolicy::ERROR]]></value>
        <docblock line="44">
          <description><![CDATA[Default update policy]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="52" package="ArangoDbPhpClient">
        <name>DEFAULT_REPLACE_POLICY</name>
        <full_name>DEFAULT_REPLACE_POLICY</full_name>
        <value><![CDATA[\triagens\ArangoDb\UpdatePolicy::ERROR]]></value>
        <docblock line="49">
          <description><![CDATA[Default replace policy]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="57" package="ArangoDbPhpClient">
        <name>DEFAULT_DELETE_POLICY</name>
        <full_name>DEFAULT_DELETE_POLICY</full_name>
        <value><![CDATA[\triagens\ArangoDb\UpdatePolicy::ERROR]]></value>
        <docblock line="54">
          <description><![CDATA[Default delete policy]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
    </class>
  </file>
  <file path="ConnectException.php" hash="d4f81caa20520e1f19b579838628612a" 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">
      <extends>\triagens\ArangoDb\Exception</extends>
      <name>ConnectException</name>
      <full_name>\triagens\ArangoDb\ConnectException</full_name>
      <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>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="25" package="ArangoDbPhpClient">
        <name>__toString</name>
        <full_name>__toString</full_name>
        <docblock line="20">
          <description><![CDATA[Return a string representation of the exception]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="20" name="return" description="- string representation" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="ClientException.php" hash="332e8d5f314b4f8e191d18d33a84f794" 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">
      <extends>\triagens\ArangoDb\Exception</extends>
      <name>ClientException</name>
      <full_name>\triagens\ArangoDb\ClientException</full_name>
      <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.]]></description>
        <long-description><![CDATA[<p>something the server is not involved in.</p>]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="25" package="ArangoDbPhpClient">
        <name>__toString</name>
        <full_name>__toString</full_name>
        <docblock line="20">
          <description><![CDATA[Return a string representation of the exception]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="20" name="return" description="- string representation" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="ServerException.php" hash="f53785919223f58c50f78e4b4bbcd183" 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="24" package="ArangoDbPhpClient">
      <extends>\triagens\ArangoDb\Exception</extends>
      <name>ServerException</name>
      <full_name>\triagens\ArangoDb\ServerException</full_name>
      <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="35" package="ArangoDbPhpClient">
        <name>ENTRY_CODE</name>
        <full_name>ENTRY_CODE</full_name>
        <value><![CDATA['errorNum']]></value>
        <docblock line="32">
          <description><![CDATA[Error number index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="40" package="ArangoDbPhpClient">
        <name>ENTRY_MESSAGE</name>
        <full_name>ENTRY_MESSAGE</full_name>
        <value><![CDATA['errorMessage']]></value>
        <docblock line="37">
          <description><![CDATA[Error message index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="30" namespace="triagens\ArangoDb" package="Default">
        <name>$_details</name>
        <default><![CDATA[array()]]></default>
        <docblock line="25">
          <description><![CDATA[Optional details for the exception]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="25" name="param" description="array" type="" variable=""/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="47" package="ArangoDbPhpClient">
        <name>__toString</name>
        <full_name>__toString</full_name>
        <docblock line="42">
          <description><![CDATA[Return a string representation of the exception]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="42" name="return" description="- string representation" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="60" package="ArangoDbPhpClient">
        <name>setDetails</name>
        <full_name>setDetails</full_name>
        <docblock line="51">
          <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="51" name="param" description="- array of exception details" type="array" variable="$details">
            <type by_reference="false">array</type>
          </tag>
          <tag line="51" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="60">
          <name>$details</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="72" package="ArangoDbPhpClient">
        <name>getDetails</name>
        <full_name>getDetails</full_name>
        <docblock line="64">
          <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="64" 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="84" package="ArangoDbPhpClient">
        <name>getServerCode</name>
        <full_name>getServerCode</full_name>
        <docblock line="76">
          <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="76" 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="100" package="ArangoDbPhpClient">
        <name>getServerMessage</name>
        <full_name>getServerMessage</full_name>
        <docblock line="92">
          <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="92" name="return" description="- server error message" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="HttpResponse.php" hash="4a2f99487c3f3571f465367de9928447" 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">
      <extends/>
      <name>HttpResponse</name>
      <full_name>\triagens\ArangoDb\HttpResponse</full_name>
      <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="57" package="ArangoDbPhpClient">
        <name>HEADER_LOCATION</name>
        <full_name>HEADER_LOCATION</full_name>
        <value><![CDATA['location']]></value>
        <docblock line="54">
          <description><![CDATA[HTTP location header]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="24" namespace="triagens\ArangoDb" 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="31" namespace="triagens\ArangoDb" package="Default">
        <name>$_body</name>
        <default><![CDATA['']]></default>
        <docblock line="26">
          <description><![CDATA[The body retrieved]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="26" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="38" namespace="triagens\ArangoDb" package="Default">
        <name>$_headers</name>
        <default><![CDATA[array()]]></default>
        <docblock line="33">
          <description><![CDATA[All headers retrieved as an assoc array]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="33" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="45" namespace="triagens\ArangoDb" package="Default">
        <name>$_result</name>
        <default><![CDATA['']]></default>
        <docblock line="40">
          <description><![CDATA[The result statusline (first line of HTTP response header)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="40" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="52" namespace="triagens\ArangoDb" package="Default">
        <name>$_httpCode</name>
        <default><![CDATA[]]></default>
        <docblock line="47">
          <description><![CDATA[The HTTP status code of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="47" 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="66" package="ArangoDbPhpClient">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="59">
          <description><![CDATA[Set up the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="59" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="59" 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="59" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="66">
          <name>$responseString</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="86" package="ArangoDbPhpClient">
        <name>getHttpCode</name>
        <full_name>getHttpCode</full_name>
        <docblock line="81">
          <description><![CDATA[Return the HTTP status code of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="81" 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="96" package="ArangoDbPhpClient">
        <name>getHeader</name>
        <full_name>getHeader</full_name>
        <docblock line="90">
          <description><![CDATA[Return an individual HTTP headers of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="90" name="param" description="- name of header" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="90" 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="96">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="113" package="ArangoDbPhpClient">
        <name>getHeaders</name>
        <full_name>getHeaders</full_name>
        <docblock line="108">
          <description><![CDATA[Return the HTTP headers of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="108" 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="122" package="ArangoDbPhpClient">
        <name>getLocationHeader</name>
        <full_name>getLocationHeader</full_name>
        <docblock line="117">
          <description><![CDATA[Return the location HTTP header of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="117" 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="131" package="ArangoDbPhpClient">
        <name>getBody</name>
        <full_name>getBody</full_name>
        <docblock line="126">
          <description><![CDATA[Return the body of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="126" 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="140" package="ArangoDbPhpClient">
        <name>getResult</name>
        <full_name>getResult</full_name>
        <docblock line="135">
          <description><![CDATA[Return the result line (first header line) of the response]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="135" 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="150" package="ArangoDbPhpClient">
        <name>getJson</name>
        <full_name>getJson</full_name>
        <docblock line="144">
          <description><![CDATA[Return the data from the JSON-encoded body]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="144" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="144" 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="167" package="ArangoDbPhpClient">
        <name>setupHeaders</name>
        <full_name>setupHeaders</full_name>
        <docblock line="162">
          <description><![CDATA[Set up an array of HTTP headers]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="162" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="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">
      <extends/>
      <name>UpdatePolicy</name>
      <full_name>\triagens\ArangoDb\UpdatePolicy</full_name>
      <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="ArangoDbPhpClient">
        <name>LAST</name>
        <full_name>LAST</full_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="ArangoDbPhpClient">
        <name>ERROR</name>
        <full_name>ERROR</full_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="ArangoDbPhpClient">
        <name>validate</name>
        <full_name>validate</full_name>
        <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="CollectionHandler.php" hash="a05e04f551c83f51a7aa803d7b47b613" 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">
      <extends>\triagens\ArangoDb\Handler</extends>
      <name>CollectionHandler</name>
      <full_name>\triagens\ArangoDb\CollectionHandler</full_name>
      <docblock line="13">
        <description><![CDATA[A collection handler that fetches collection data from the server and
creates collections on the server.]]></description>
        <long-description><![CDATA[<p>It does so by issuing the
appropriate HTTP requests to the server.</p>]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="25" package="ArangoDbPhpClient">
        <name>ENTRY_DOCUMENTS</name>
        <full_name>ENTRY_DOCUMENTS</full_name>
        <value><![CDATA['documents']]></value>
        <docblock line="22">
          <description><![CDATA[documents array index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="30" package="ArangoDbPhpClient">
        <name>OPTION_COLLECTION</name>
        <full_name>OPTION_COLLECTION</full_name>
        <value><![CDATA['collection']]></value>
        <docblock line="27">
          <description><![CDATA[collection parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="35" package="ArangoDbPhpClient">
        <name>OPTION_EXAMPLE</name>
        <full_name>OPTION_EXAMPLE</full_name>
        <value><![CDATA['example']]></value>
        <docblock line="32">
          <description><![CDATA[example parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="40" package="ArangoDbPhpClient">
        <name>OPTION_ATTRIBUTE</name>
        <full_name>OPTION_ATTRIBUTE</full_name>
        <value><![CDATA['attribute']]></value>
        <docblock line="37">
          <description><![CDATA[attribute parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="45" package="ArangoDbPhpClient">
        <name>OPTION_LEFT</name>
        <full_name>OPTION_LEFT</full_name>
        <value><![CDATA['left']]></value>
        <docblock line="42">
          <description><![CDATA[left parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="50" package="ArangoDbPhpClient">
        <name>OPTION_RIGHT</name>
        <full_name>OPTION_RIGHT</full_name>
        <value><![CDATA['right']]></value>
        <docblock line="47">
          <description><![CDATA[right parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="55" package="ArangoDbPhpClient">
        <name>OPTION_CLOSED</name>
        <full_name>OPTION_CLOSED</full_name>
        <value><![CDATA['closed']]></value>
        <docblock line="52">
          <description><![CDATA[closed parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="60" package="ArangoDbPhpClient">
        <name>OPTION_LATITUDE</name>
        <full_name>OPTION_LATITUDE</full_name>
        <value><![CDATA['latitude']]></value>
        <docblock line="57">
          <description><![CDATA[latidude parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="65" package="ArangoDbPhpClient">
        <name>OPTION_LONGITUDE</name>
        <full_name>OPTION_LONGITUDE</full_name>
        <value><![CDATA['longitude']]></value>
        <docblock line="62">
          <description><![CDATA[longitude parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="70" package="ArangoDbPhpClient">
        <name>OPTION_DISTANCE</name>
        <full_name>OPTION_DISTANCE</full_name>
        <value><![CDATA['distance']]></value>
        <docblock line="67">
          <description><![CDATA[distance parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="75" package="ArangoDbPhpClient">
        <name>OPTION_RADIUS</name>
        <full_name>OPTION_RADIUS</full_name>
        <value><![CDATA['radius']]></value>
        <docblock line="72">
          <description><![CDATA[radius parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="80" package="ArangoDbPhpClient">
        <name>OPTION_SKIP</name>
        <full_name>OPTION_SKIP</full_name>
        <value><![CDATA['skip']]></value>
        <docblock line="77">
          <description><![CDATA[skip parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="85" package="ArangoDbPhpClient">
        <name>OPTION_LIMIT</name>
        <full_name>OPTION_LIMIT</full_name>
        <value><![CDATA['limit']]></value>
        <docblock line="82">
          <description><![CDATA[limit parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="90" package="ArangoDbPhpClient">
        <name>OPTION_FIELDS</name>
        <full_name>OPTION_FIELDS</full_name>
        <value><![CDATA['fields']]></value>
        <docblock line="87">
          <description><![CDATA[count fields]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="95" package="ArangoDbPhpClient">
        <name>OPTION_UNIQUE</name>
        <full_name>OPTION_UNIQUE</full_name>
        <value><![CDATA['unique']]></value>
        <docblock line="92">
          <description><![CDATA[count unique]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="100" package="ArangoDbPhpClient">
        <name>OPTION_TYPE</name>
        <full_name>OPTION_TYPE</full_name>
        <value><![CDATA['type']]></value>
        <docblock line="97">
          <description><![CDATA[count unique]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="105" package="ArangoDbPhpClient">
        <name>OPTION_COUNT</name>
        <full_name>OPTION_COUNT</full_name>
        <value><![CDATA['count']]></value>
        <docblock line="102">
          <description><![CDATA[count option]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="110" package="ArangoDbPhpClient">
        <name>OPTION_FIGURES</name>
        <full_name>OPTION_FIGURES</full_name>
        <value><![CDATA['figures']]></value>
        <docblock line="107">
          <description><![CDATA[figures option]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="115" package="ArangoDbPhpClient">
        <name>OPTION_TRUNCATE</name>
        <full_name>OPTION_TRUNCATE</full_name>
        <value><![CDATA['truncate']]></value>
        <docblock line="112">
          <description><![CDATA[truncate option]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="120" package="ArangoDbPhpClient">
        <name>OPTION_RENAME</name>
        <full_name>OPTION_RENAME</full_name>
        <value><![CDATA['rename']]></value>
        <docblock line="117">
          <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="131" package="ArangoDbPhpClient">
        <name>get</name>
        <full_name>get</full_name>
        <docblock line="122">
          <description><![CDATA[Get information about a collection]]></description>
          <long-description><![CDATA[<p>This will throw if the collection cannot be fetched from the server</p>]]></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 a string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="122" 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="131">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="151" package="ArangoDbPhpClient">
        <name>getCount</name>
        <full_name>getCount</full_name>
        <docblock line="140">
          <description><![CDATA[Get the number of documents in a collection]]></description>
          <long-description><![CDATA[<p>This will throw if the collection cannot be fetched from the server</p>]]></long-description>
          <tag line="140" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="140" name="param" description="- collection id as a string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="140" name="return" description="- the number of documents in the collection" type="int">
            <type by_reference="false">int</type>
          </tag>
          <tag line="140" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by count()"/>
        </docblock>
        <argument line="151">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="166" package="ArangoDbPhpClient">
        <name>count</name>
        <full_name>count</full_name>
        <docblock line="157">
          <description><![CDATA[Get the number of documents in a collection]]></description>
          <long-description><![CDATA[<p>This will throw if the collection cannot be fetched from the server</p>]]></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="- collection id as a string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="157" name="return" description="- the number of documents in the collection" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="166">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="187" package="ArangoDbPhpClient">
        <name>getFigures</name>
        <full_name>getFigures</full_name>
        <docblock line="176">
          <description><![CDATA[Get figures for a collection]]></description>
          <long-description><![CDATA[<p>This will throw if the collection cannot be fetched from the server</p>]]></long-description>
          <tag line="176" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="176" name="param" description="- collection id as a string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="176" name="return" description="- the figures for the collection" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="176" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by figures()"/>
        </docblock>
        <argument line="187">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="200" package="ArangoDbPhpClient">
        <name>figures</name>
        <full_name>figures</full_name>
        <docblock line="191">
          <description><![CDATA[Get figures for a collection]]></description>
          <long-description><![CDATA[<p>This will throw if the collection cannot be fetched from the server</p>]]></long-description>
          <tag line="191" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="191" name="param" description="- collection id as a string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="191" name="return" description="- the figures for the collection" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="200">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="223" package="ArangoDbPhpClient">
        <name>add</name>
        <full_name>add</full_name>
        <docblock line="210">
          <description><![CDATA[Adds a new collection on the server]]></description>
          <long-description><![CDATA[<p>This will add the collection on the server and return its id</p>

<p>This will throw if the collection cannot be created</p>]]></long-description>
          <tag line="210" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="210" 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="210" name="return" description="- id of collection created" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="210" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by create()"/>
        </docblock>
        <argument line="223">
          <name>$collection</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Collection</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="238" package="ArangoDbPhpClient">
        <name>create</name>
        <full_name>create</full_name>
        <docblock line="227">
          <description><![CDATA[Creates a new collection on the server]]></description>
          <long-description><![CDATA[<p>This will add the collection on the server and return its id</p>

<p>This will throw if the collection cannot be created</p>]]></long-description>
          <tag line="227" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="227" 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="227" name="return" description="- id of collection created" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="238">
          <name>$collection</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Collection</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="272" package="ArangoDbPhpClient">
        <name>index</name>
        <full_name>index</full_name>
        <docblock line="258">
          <description><![CDATA[Creates an index on a collection on the server]]></description>
          <long-description><![CDATA[<p>This will create an index on the collection on the server and return its id</p>

<p>This will throw if the index cannot be created</p>]]></long-description>
          <tag line="258" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="258" name="param" description="- The id of the collection where the index is to be created" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="258" name="param" description="- index type: hash, skiplist or geo" type="string" variable="$type">
            <type by_reference="false">string</type>
          </tag>
          <tag line="258" name="param" description="- an array of attributes that can be defined like array('a') or array('a', 'b.c')" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="258" name="param" description="- true/false to create a unique index" type="boolean" variable="$unique">
            <type by_reference="false">boolean</type>
          </tag>
          <tag line="258" name="return" description="- id of collection created" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="272">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="272">
          <name>$type</name>
          <default><![CDATA[""]]></default>
          <type/>
        </argument>
        <argument line="272">
          <name>$attributes</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
        <argument line="272">
          <name>$unique</name>
          <default><![CDATA[false]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="303" package="ArangoDbPhpClient">
        <name>delete</name>
        <full_name>delete</full_name>
        <docblock line="294">
          <description><![CDATA[Delete a collection]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="294" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="294" 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="294" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="294" name="deprecated" description="to be removed in version 2.0 - This function is being replaced by drop()"/>
        </docblock>
        <argument line="303">
          <name>$collection</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="314" package="ArangoDbPhpClient">
        <name>drop</name>
        <full_name>drop</full_name>
        <docblock line="307">
          <description><![CDATA[Drop a collection]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="307" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="307" 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="307" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="314">
          <name>$collection</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="339" package="ArangoDbPhpClient">
        <name>rename</name>
        <full_name>rename</full_name>
        <docblock line="331">
          <description><![CDATA[Rename a collection]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="331" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="331" 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="331" name="param" description="- new name for collection" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="331" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="339">
          <name>$collection</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="339">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="366" package="ArangoDbPhpClient">
        <name>truncate</name>
        <full_name>truncate</full_name>
        <docblock line="357">
          <description><![CDATA[Truncate a collection]]></description>
          <long-description><![CDATA[<p>This will remove all documents from the collection but will leave the metadata and indexes intact.</p>]]></long-description>
          <tag line="357" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="357" 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="357" name="return" description="- always true, will throw if there is an error" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="366">
          <name>$collection</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="406" package="ArangoDbPhpClient">
        <name>byExample</name>
        <full_name>byExample</full_name>
        <docblock line="383">
          <description><![CDATA[Get document(s) by specifying an example]]></description>
          <long-description><![CDATA[<p>This will throw if the list cannot be fetched from the server</p>]]></long-description>
          <tag line="383" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="383" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="383" 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="383" name="param" description="- optional, prior to v1.0.0 this was a boolean value for sanitize, since v1.0.0 it's an array of options. &lt;p&gt;Options are : &lt;li&gt;'sanitize' - true to remove _id and _rev attributes from result documents. Defaults to false.&lt;/li&gt; &lt;li&gt;'hiddenAttributes' - set an array of hidden attributes for created documents. &lt;p&gt; This is actually the same as setting hidden attributes using setHiddenAttributes() on a document. The difference is, that if you're returning a resultset of documents, the getall() is already called and the hidden attributes would not be applied to the attributes. &lt;/p&gt; &lt;/li&gt; &lt;/p&gt;" type="bool|array" variable="$options">
            <type by_reference="false">bool</type>
            <type by_reference="false">array</type>
          </tag>
          <tag line="383" name="return" description="- documents matching the example [0...n]" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="406">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="406">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="406">
          <name>$options</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="461" package="ArangoDbPhpClient">
        <name>range</name>
        <full_name>range</full_name>
        <docblock line="432">
          <description><![CDATA[Get document(s) by specifying range]]></description>
          <long-description><![CDATA[<p>This will throw if the list cannot be fetched from the server</p>]]></long-description>
          <tag line="432" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="432" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="432" name="param" description="- the attribute path , like 'a', 'a.b', etc..." type="string" variable="$attribute">
            <type by_reference="false">string</type>
          </tag>
          <tag line="432" name="param" description="- The lower bound." type="mixed" variable="$left">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="432" name="param" description="- The upper bound." type="mixed" variable="$right">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="432" name="param" description="- optional array of options. &lt;p&gt;Options are : &lt;li&gt;'sanitize' - True to remove _id and _rev attributes from result documents. Defaults to false.&lt;/li&gt; &lt;li&gt;'hiddenAttributes' - Set an array of hidden attributes for created documents. &lt;p&gt; This is actually the same as setting hidden attributes using setHiddenAttributes() on a document. The difference is, that if you're returning a resultset of documents, the getall() is already called and the hidden attributes would not be applied to the attributes. &lt;/p&gt; &lt;li&gt;'closed' - If true, use interval including left and right, otherwise exclude right, but include left. &lt;li&gt;'skip' - The documents to skip in the query. &lt;li&gt;'limit' - The maximal amount of documents to return. &lt;/li&gt; &lt;/p&gt;" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="432" name="return" description="- documents matching the example [0...n]" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="461">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="461">
          <name>$attribute</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="461">
          <name>$left</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="461">
          <name>$right</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="461">
          <name>$options</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="512" package="ArangoDbPhpClient">
        <name>near</name>
        <full_name>near</full_name>
        <docblock line="484">
          <description><![CDATA[Get document(s) by specifying near]]></description>
          <long-description><![CDATA[<p>This will throw if the list cannot be fetched from the server</p>]]></long-description>
          <tag line="484" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="484" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="484" name="param" description="- The latitude of the coordinate." type="double" variable="$latitude">
            <type by_reference="false">double</type>
          </tag>
          <tag line="484" name="param" description="- The longitude of the coordinate." type="double" variable="$longitude">
            <type by_reference="false">double</type>
          </tag>
          <tag line="484" name="param" description="- optional array of options. &lt;p&gt;Options are : &lt;li&gt;'sanitize' - True to remove _id and _rev attributes from result documents. Defaults to false.&lt;/li&gt; &lt;li&gt;'hiddenAttributes' - Set an array of hidden attributes for created documents. &lt;p&gt; This is actually the same as setting hidden attributes using setHiddenAttributes() on a document. The difference is, that if you're returning a resultset of documents, the getall() is already called and the hidden attributes would not be applied to the attributes. &lt;/p&gt; &lt;li&gt;'distance' - If given, the attribute key used to store the distance. (optional) &lt;li&gt;'skip' - The documents to skip in the query. &lt;li&gt;'limit' - The maximal amount of documents to return. &lt;/li&gt; &lt;/p&gt;" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="484" name="return" description="- documents matching the example [0...n]" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="512">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="512">
          <name>$latitude</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="512">
          <name>$longitude</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="512">
          <name>$options</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="559" package="ArangoDbPhpClient">
        <name>within</name>
        <full_name>within</full_name>
        <docblock line="530">
          <description><![CDATA[Get document(s) by specifying within]]></description>
          <long-description><![CDATA[<p>This will throw if the list cannot be fetched from the server</p>]]></long-description>
          <tag line="530" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="530" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="530" name="param" description="- The latitude of the coordinate." type="double" variable="$latitude">
            <type by_reference="false">double</type>
          </tag>
          <tag line="530" name="param" description="- The longitude of the coordinate." type="double" variable="$longitude">
            <type by_reference="false">double</type>
          </tag>
          <tag line="530" name="param" description="- The maximal radius (in meters)." type="int" variable="$radius">
            <type by_reference="false">int</type>
          </tag>
          <tag line="530" name="param" description="- optional array of options. &lt;p&gt;Options are : &lt;li&gt;'sanitize' - True to remove _id and _rev attributes from result documents. Defaults to false.&lt;/li&gt; &lt;li&gt;'hiddenAttributes' - Set an array of hidden attributes for created documents. &lt;p&gt; This is actually the same as setting hidden attributes using setHiddenAttributes() on a document. The difference is, that if you're returning a resultset of documents, the getall() is already called and the hidden attributes would not be applied to the attributes. &lt;/p&gt; &lt;li&gt;'distance' - If given, the attribute key used to store the distance. (optional) &lt;li&gt;'skip' - The documents to skip in the query. &lt;li&gt;'limit' - The maximal amount of documents to return. &lt;/li&gt; &lt;/p&gt;" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="530" name="return" description="- documents matching the example [0...n]" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="559">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="559">
          <name>$latitude</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="559">
          <name>$longitude</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="559">
          <name>$radius</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="559">
          <name>$options</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="586" package="ArangoDbPhpClient">
        <name>getAllIds</name>
        <full_name>getAllIds</full_name>
        <docblock line="577">
          <description><![CDATA[Get the list of all documents' ids from a collection]]></description>
          <long-description><![CDATA[<p>This will throw if the list cannot be fetched from the server</p>]]></long-description>
          <tag line="577" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="577" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="577" name="return" description="- ids of documents in the collection" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="586">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="609" package="ArangoDbPhpClient">
        <name>getCursorOptions</name>
        <full_name>getCursorOptions</full_name>
        <docblock line="603">
          <description><![CDATA[Return an array of cursor options]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="603" name="param" description="- sanitize flag" type="bool" variable="$sanitize">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="603" name="return" description="- array of options" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="609">
          <name>$sanitize</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="Endpoint.php" hash="4e96bcf9063ee24e72d25d683a57cfe4" package="ArangoDbPhpClient">
    <docblock line="3">
      <description><![CDATA[ArangoDB PHP client: endpoint]]></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="26" package="ArangoDbPhpClient">
      <extends/>
      <name>Endpoint</name>
      <full_name>\triagens\ArangoDb\Endpoint</full_name>
      <docblock line="13">
        <description><![CDATA[Endpoint specification]]></description>
        <long-description><![CDATA[<p>An endpoint contains the server location the client connects to
the following endpoint types are currently supported (more to be added later):
- tcp://host:port for tcp connections
- unix://socket for UNIX sockets (provided the server supports this)
- ssl://host:port for SSL connections (provided the server supports this)</p>

<p>Note: SSL support is added in ArangoDB server 1.1</p>]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="36" package="ArangoDbPhpClient">
        <name>TYPE_TCP</name>
        <full_name>TYPE_TCP</full_name>
        <value><![CDATA['tcp']]></value>
        <docblock line="33">
          <description><![CDATA[TCP endpoint type]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="41" package="ArangoDbPhpClient">
        <name>TYPE_SSL</name>
        <full_name>TYPE_SSL</full_name>
        <value><![CDATA['ssl']]></value>
        <docblock line="38">
          <description><![CDATA[SSL endpoint type]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="46" package="ArangoDbPhpClient">
        <name>TYPE_UNIX</name>
        <full_name>TYPE_UNIX</full_name>
        <value><![CDATA['unix']]></value>
        <docblock line="43">
          <description><![CDATA[UNIX socket endpoint type]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="51" package="ArangoDbPhpClient">
        <name>REGEXP_TCP</name>
        <full_name>REGEXP_TCP</full_name>
        <value><![CDATA['/^tcp:\/\/(.+?):(\d+)\/?$/']]></value>
        <docblock line="48">
          <description><![CDATA[Regexp for TCP endpoints]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="56" package="ArangoDbPhpClient">
        <name>REGEXP_SSL</name>
        <full_name>REGEXP_SSL</full_name>
        <value><![CDATA['/^ssl:\/\/(.+?):(\d+)\/?$/']]></value>
        <docblock line="53">
          <description><![CDATA[Regexp for SSL endpoints]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="61" package="ArangoDbPhpClient">
        <name>REGEXP_UNIX</name>
        <full_name>REGEXP_UNIX</full_name>
        <value><![CDATA['/^unix:\/\/(.+)$/']]></value>
        <docblock line="58">
          <description><![CDATA[Regexp for UNIX socket endpoints]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="31" namespace="triagens\ArangoDb" package="Default">
        <name>$_value</name>
        <default><![CDATA[]]></default>
        <docblock line="27">
          <description><![CDATA[Current endpoint value]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="27" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="70" package="ArangoDbPhpClient">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="63">
          <description><![CDATA[Create a new endpoint]]></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="- endpoint specification" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="63" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="70">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="83" package="ArangoDbPhpClient">
        <name>__toString</name>
        <full_name>__toString</full_name>
        <docblock line="78">
          <description><![CDATA[Return a string representation of the endpoint]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="78" name="return" description="- string representation of the endpoint" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="93" package="ArangoDbPhpClient">
        <name>getType</name>
        <full_name>getType</full_name>
        <docblock line="87">
          <description><![CDATA[Return the type of an endpoint]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="87" name="param" description="- endpoint specification value" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="87" name="return" description="- endpoint type" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="93">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="115" package="ArangoDbPhpClient">
        <name>getHost</name>
        <full_name>getHost</full_name>
        <docblock line="109">
          <description><![CDATA[Return the host name of an endpoint]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="109" name="param" description="- endpoint specification value" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="109" name="return" description="- host name" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="115">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="133" package="ArangoDbPhpClient">
        <name>isValid</name>
        <full_name>isValid</full_name>
        <docblock line="127">
          <description><![CDATA[check whether an endpoint specification is valid]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="127" name="param" description="- endpoint specification value" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="127" name="return" description="- true if endpoint specification is valid, false otherwise" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="133">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="Collection.php" hash="fcae5c6e371f5ae6014c749312328044" 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">
      <extends/>
      <name>Collection</name>
      <full_name>\triagens\ArangoDb\Collection</full_name>
      <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="46" package="ArangoDbPhpClient">
        <name>ENTRY_ID</name>
        <full_name>ENTRY_ID</full_name>
        <value><![CDATA['id']]></value>
        <docblock line="43">
          <description><![CDATA[Collection id index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="51" package="ArangoDbPhpClient">
        <name>ENTRY_NAME</name>
        <full_name>ENTRY_NAME</full_name>
        <value><![CDATA['name']]></value>
        <docblock line="48">
          <description><![CDATA[Collection name index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="56" package="ArangoDbPhpClient">
        <name>ENTRY_TYPE</name>
        <full_name>ENTRY_TYPE</full_name>
        <value><![CDATA['type']]></value>
        <docblock line="53">
          <description><![CDATA[Collection type index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="61" package="ArangoDbPhpClient">
        <name>ENTRY_WAIT_SYNC</name>
        <full_name>ENTRY_WAIT_SYNC</full_name>
        <value><![CDATA['waitForSync']]></value>
        <docblock line="58">
          <description><![CDATA[Collection 'waitForSync' index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="66" package="ArangoDbPhpClient">
        <name>OPTION_PROPERTIES</name>
        <full_name>OPTION_PROPERTIES</full_name>
        <value><![CDATA['properties']]></value>
        <docblock line="63">
          <description><![CDATA[properties option]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="71" package="ArangoDbPhpClient">
        <name>TYPE_DOCUMENT</name>
        <full_name>TYPE_DOCUMENT</full_name>
        <value><![CDATA[2]]></value>
        <docblock line="68">
          <description><![CDATA[document collection type]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="76" package="ArangoDbPhpClient">
        <name>TYPE_EDGE</name>
        <full_name>TYPE_EDGE</full_name>
        <value><![CDATA[3]]></value>
        <docblock line="73">
          <description><![CDATA[edge collection type]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="23" namespace="triagens\ArangoDb" 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" namespace="triagens\ArangoDb" 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" namespace="triagens\ArangoDb" package="Default">
        <name>$_type</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="31">
          <description><![CDATA[The collection type (might be NULL for new collections)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="31" name="var" description="- collection type" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="41" namespace="triagens\ArangoDb" package="Default">
        <name>$_waitForSync</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="37">
          <description><![CDATA[The collection waitForSync value (might be NULL for new collections)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="37" 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="83" package="ArangoDbPhpClient">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="78">
          <description><![CDATA[Constructs an empty collection]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="78" 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="93" package="ArangoDbPhpClient">
        <name>createFromArray</name>
        <full_name>createFromArray</full_name>
        <docblock line="86">
          <description><![CDATA[Factory method to construct a new collection]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="86" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="86" name="param" description="- initial values for collection" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="86" name="return" description="" type="\triagens\ArangoDb\Collection">
            <type by_reference="false">\triagens\ArangoDb\Collection</type>
          </tag>
        </docblock>
        <argument line="93">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="108" package="ArangoDbPhpClient">
        <name>getDefaultType</name>
        <full_name>getDefaultType</full_name>
        <docblock line="103">
          <description><![CDATA[Get the default collection type]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="103" 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="119" package="ArangoDbPhpClient">
        <name>__clone</name>
        <full_name>__clone</full_name>
        <docblock line="112">
          <description><![CDATA[Clone a collection]]></description>
          <long-description><![CDATA[<p>Returns the clone</p>]]></long-description>
          <tag line="112" 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="132" package="ArangoDbPhpClient">
        <name>__toString</name>
        <full_name>__toString</full_name>
        <docblock line="125">
          <description><![CDATA[Get a string representation of the collection]]></description>
          <long-description><![CDATA[<p>Returns the collection as JSON-encoded string</p>]]></long-description>
          <tag line="125" 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="141" package="ArangoDbPhpClient">
        <name>toJson</name>
        <full_name>toJson</full_name>
        <docblock line="136">
          <description><![CDATA[Returns the collection as JSON-encoded string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="136" 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="150" package="ArangoDbPhpClient">
        <name>toSerialized</name>
        <full_name>toSerialized</full_name>
        <docblock line="145">
          <description><![CDATA[Returns the collection as a serialized string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="145" 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="159" package="ArangoDbPhpClient">
        <name>getAll</name>
        <full_name>getAll</full_name>
        <docblock line="154">
          <description><![CDATA[Get all collection attributes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="154" 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="181" package="ArangoDbPhpClient">
        <name>set</name>
        <full_name>set</full_name>
        <docblock line="168">
          <description><![CDATA[Set a collection attribute]]></description>
          <long-description><![CDATA[<p>The key (attribute name) must be a string.</p>

<p>This will validate the value of the attribute and might throw an
exception if the value is invalid.</p>]]></long-description>
          <tag line="168" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="168" name="param" description="- attribute name" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="168" name="param" description="- value for attribute" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="168" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="181">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="181">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="218" package="ArangoDbPhpClient">
        <name>setId</name>
        <full_name>setId</full_name>
        <docblock line="209">
          <description><![CDATA[Set the collection id]]></description>
          <long-description><![CDATA[<p>This will throw if the id of an existing collection gets updated to some other id</p>]]></long-description>
          <tag line="209" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="209" name="param" description="- collection id" type="mixed" variable="$id">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="209" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="218">
          <name>$id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="236" package="ArangoDbPhpClient">
        <name>getId</name>
        <full_name>getId</full_name>
        <docblock line="226">
          <description><![CDATA[Get the collection id (if already known)]]></description>
          <long-description><![CDATA[<p>Collection ids are generated on the server only.</p>

<p>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</p>]]></long-description>
          <tag line="226" 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="247" package="ArangoDbPhpClient">
        <name>setName</name>
        <full_name>setName</full_name>
        <docblock line="240">
          <description><![CDATA[Set the collection name]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="240" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="240" name="param" description="- name" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="240" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="247">
          <name>$name</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="262" package="ArangoDbPhpClient">
        <name>getName</name>
        <full_name>getName</full_name>
        <docblock line="257">
          <description><![CDATA[Get the collection name (if already known)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="257" 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="276" package="ArangoDbPhpClient">
        <name>setType</name>
        <full_name>setType</full_name>
        <docblock line="266">
          <description><![CDATA[Set the collection type.]]></description>
          <long-description><![CDATA[<p>This is useful before a collection is create() 'ed in order to set a different type than the normal one.
For example this must be set to 3 in order to create an edge-collection.</p>]]></long-description>
          <tag line="266" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="266" name="param" description="- type = 2 -&gt; normal collection, type = 3 -&gt; edge-collection" type="int" variable="$type">
            <type by_reference="false">int</type>
          </tag>
          <tag line="266" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="276">
          <name>$type</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="295" package="ArangoDbPhpClient">
        <name>getType</name>
        <full_name>getType</full_name>
        <docblock line="290">
          <description><![CDATA[Get the collection type (if already known)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="290" 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="305" package="ArangoDbPhpClient">
        <name>setWaitForSync</name>
        <full_name>setWaitForSync</full_name>
        <docblock line="299">
          <description><![CDATA[Set the waitForSync value]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="299" name="param" description="- waitForSync value" type="bool" variable="$value">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="299" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="305">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="315" package="ArangoDbPhpClient">
        <name>getWaitForSync</name>
        <full_name>getWaitForSync</full_name>
        <docblock line="310">
          <description><![CDATA[Get the waitForSync value (if already known)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="310" name="return" description="- waitForSync value" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="HttpHelper.php" hash="290218deb808f5ef45404b56eeed744f" 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">
      <extends/>
      <name>HttpHelper</name>
      <full_name>\triagens\ArangoDb\HttpHelper</full_name>
      <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="ArangoDbPhpClient">
        <name>METHOD_POST</name>
        <full_name>METHOD_POST</full_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="ArangoDbPhpClient">
        <name>METHOD_PUT</name>
        <full_name>METHOD_PUT</full_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="ArangoDbPhpClient">
        <name>METHOD_DELETE</name>
        <full_name>METHOD_DELETE</full_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="ArangoDbPhpClient">
        <name>METHOD_GET</name>
        <full_name>METHOD_GET</full_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="ArangoDbPhpClient">
        <name>METHOD_HEAD</name>
        <full_name>METHOD_HEAD</full_name>
        <value><![CDATA['HEAD']]></value>
        <docblock line="39">
          <description><![CDATA[HTTP HEAD string constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="47" package="ArangoDbPhpClient">
        <name>METHOD_PATCH</name>
        <full_name>METHOD_PATCH</full_name>
        <value><![CDATA['PATCH']]></value>
        <docblock line="44">
          <description><![CDATA[HTTP PATCH string constant]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="52" package="ArangoDbPhpClient">
        <name>CHUNK_SIZE</name>
        <full_name>CHUNK_SIZE</full_name>
        <value><![CDATA[8192]]></value>
        <docblock line="49">
          <description><![CDATA[Chunk size (number of bytes processed in one batch)]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="57" package="ArangoDbPhpClient">
        <name>EOL</name>
        <full_name>EOL</full_name>
        <value><![CDATA["\r\n"]]></value>
        <docblock line="54">
          <description><![CDATA[End of line mark used in HTTP]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="62" package="ArangoDbPhpClient">
        <name>PROTOCOL</name>
        <full_name>PROTOCOL</full_name>
        <value><![CDATA['HTTP/1.1']]></value>
        <docblock line="59">
          <description><![CDATA[HTTP protocol version used, hard-coded to version 1.1]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="71" package="ArangoDbPhpClient">
        <name>validateMethod</name>
        <full_name>validateMethod</full_name>
        <docblock line="64">
          <description><![CDATA[Validate an HTTP request method name]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="64" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="64" name="param" description="- method name" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="64" 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="71">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="93" package="ArangoDbPhpClient">
        <name>buildRequest</name>
        <full_name>buildRequest</full_name>
        <docblock line="84">
          <description><![CDATA[Create a request string (header and body)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="84" name="param" description="- connection options" type="\triagens\ArangoDb\ConnectionOptions" variable="$options">
            <type by_reference="false">\triagens\ArangoDb\ConnectionOptions</type>
          </tag>
          <tag line="84" name="param" description="- HTTP method" type="string" variable="$method">
            <type by_reference="false">string</type>
          </tag>
          <tag line="84" name="param" description="- HTTP URL" type="string" variable="$url">
            <type by_reference="false">string</type>
          </tag>
          <tag line="84" name="param" description="- optional body to post" type="string" variable="$body">
            <type by_reference="false">string</type>
          </tag>
          <tag line="84" name="return" description="- assembled HTTP request string" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="93">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\ConnectionOptions</type>
        </argument>
        <argument line="93">
          <name>$method</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="93">
          <name>$url</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="93">
          <name>$body</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="143" package="ArangoDbPhpClient">
        <name>transfer</name>
        <full_name>transfer</full_name>
        <docblock line="134">
          <description><![CDATA[Execute an HTTP request on an opened socket]]></description>
          <long-description><![CDATA[<p>It is the caller's responsibility to close the socket</p>]]></long-description>
          <tag line="134" name="param" description="- connection socket (must be open)" type="resource" variable="$socket">
            <type by_reference="false">resource</type>
          </tag>
          <tag line="134" name="param" description="- complete HTTP request as a string" type="string" variable="$request">
            <type by_reference="false">string</type>
          </tag>
          <tag line="134" name="return" description="- HTTP response string as provided by the server" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="143">
          <name>$socket</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="143">
          <name>$request</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="195" package="ArangoDbPhpClient">
        <name>createConnection</name>
        <full_name>createConnection</full_name>
        <docblock line="186">
          <description><![CDATA[Create a one-time HTTP connection by opening a socket to the server]]></description>
          <long-description><![CDATA[<p>It is the caller's responsibility to close the socket</p>]]></long-description>
          <tag line="186" name="throws" description="" type="\triagens\ArangoDb\ConnectException">
            <type by_reference="false">\triagens\ArangoDb\ConnectException</type>
          </tag>
          <tag line="186" name="param" description="- connection options" type="\triagens\ArangoDb\ConnectionOptions" variable="$options">
            <type by_reference="false">\triagens\ArangoDb\ConnectionOptions</type>
          </tag>
          <tag line="186" 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="195">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\ConnectionOptions</type>
        </argument>
      </method>
    </class>
  </file>
  <file path="Document.php" hash="fce30ef6b4d41d8bab7e2867ce62ac94" 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">
      <extends/>
      <name>Document</name>
      <full_name>\triagens\ArangoDb\Document</full_name>
      <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="52" package="ArangoDbPhpClient">
        <name>ENTRY_ID</name>
        <full_name>ENTRY_ID</full_name>
        <value><![CDATA['_id']]></value>
        <docblock line="49">
          <description><![CDATA[Document id index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="57" package="ArangoDbPhpClient">
        <name>ENTRY_REV</name>
        <full_name>ENTRY_REV</full_name>
        <value><![CDATA['_rev']]></value>
        <docblock line="54">
          <description><![CDATA[Revision id index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="62" package="ArangoDbPhpClient">
        <name>ENTRY_HIDDEN</name>
        <full_name>ENTRY_HIDDEN</full_name>
        <value><![CDATA['_hidden']]></value>
        <docblock line="59">
          <description><![CDATA[hidden atttribute index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="protected" line="23" namespace="triagens\ArangoDb" 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="protected" line="29" namespace="triagens\ArangoDb" 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="protected" line="35" namespace="triagens\ArangoDb" 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="protected" line="41" namespace="triagens\ArangoDb" 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>
      <property final="false" static="false" visibility="protected" line="47" namespace="triagens\ArangoDb" package="Default">
        <name>$_hidden</name>
        <default><![CDATA[array()]]></default>
        <docblock line="43">
          <description><![CDATA[Flag to indicate whether document was changed locally]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="43" 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="70" package="ArangoDbPhpClient">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="64">
          <description><![CDATA[Constructs an empty document]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="64" name="param" description="- optional, initial $options for document" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="64" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="70">
          <name>$options</name>
          <default><![CDATA[array()]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="83" package="ArangoDbPhpClient">
        <name>createFromArray</name>
        <full_name>createFromArray</full_name>
        <docblock line="75">
          <description><![CDATA[Factory method to construct a new document using the values passed to populate it]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="75" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="75" name="param" description="- initial values for document" type="array" variable="$values">
            <type by_reference="false">array</type>
          </tag>
          <tag line="75" name="param" description="- optional, initial options for document" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="75" name="return" description="" type="\triagens\ArangoDb\Document">
            <type by_reference="false">\triagens\ArangoDb\Document</type>
          </tag>
        </docblock>
        <argument line="83">
          <name>$values</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
        <argument line="83">
          <name>$options</name>
          <default><![CDATA[array()]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="102" package="ArangoDbPhpClient">
        <name>__clone</name>
        <full_name>__clone</full_name>
        <docblock line="95">
          <description><![CDATA[Clone a document]]></description>
          <long-description><![CDATA[<p>Returns the clone</p>]]></long-description>
          <tag line="95" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="118" package="ArangoDbPhpClient">
        <name>__toString</name>
        <full_name>__toString</full_name>
        <docblock line="109">
          <description><![CDATA[Get a string representation of the document.]]></description>
          <long-description><![CDATA[<p>It will not output hidden attributes.</p>

<p>Returns the document as JSON-encoded string</p>]]></long-description>
          <tag line="109" 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="133" package="ArangoDbPhpClient">
        <name>toJson</name>
        <full_name>toJson</full_name>
        <docblock line="122">
          <description><![CDATA[Returns the document as JSON-encoded string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="122" name="param" description="- optional, array of options that will be passed to the getAll function &lt;p&gt;Options are : &lt;li&gt;'includeInternals' - true to include the internal attributes. Defaults to false&lt;/li&gt; &lt;li&gt;'ignoreHiddenAttributes' - true to show hidden attributes. Defaults to false&lt;/li&gt; &lt;/p&gt;" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="122" name="return" description="- JSON-encoded document" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="133">
          <name>$options</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="148" package="ArangoDbPhpClient">
        <name>toSerialized</name>
        <full_name>toSerialized</full_name>
        <docblock line="137">
          <description><![CDATA[Returns the document as a serialized string]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="137" name="param" description="- optional, array of options that will be passed to the getAll function &lt;p&gt;Options are : &lt;li&gt;'includeInternals' - true to include the internal attributes. Defaults to false&lt;/li&gt; &lt;li&gt;'ignoreHiddenAttributes' - true to show hidden attributes. Defaults to false&lt;/li&gt; &lt;/p&gt;" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="137" name="return" description="- PHP serialized document" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="148">
          <name>$options</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="158" package="ArangoDbPhpClient">
        <name>filterHiddenAttributes</name>
        <full_name>filterHiddenAttributes</full_name>
        <docblock line="152">
          <description><![CDATA[Returns the attributes with the hidden ones removed]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="152" name="param" description="- attributes array" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="152" name="return" description="- attributes array" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="158">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="185" package="ArangoDbPhpClient">
        <name>set</name>
        <full_name>set</full_name>
        <docblock line="173">
          <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="173" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="173" name="param" description="- attribute name" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="173" name="param" description="- value for attribute" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="173" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="185">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="185">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="226" package="ArangoDbPhpClient">
        <name>__set</name>
        <full_name>__set</full_name>
        <docblock line="214">
          <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="214" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="214" name="param" description="- attribute name" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="214" name="param" description="- value for attribute" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="214" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="226">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="226">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="236" package="ArangoDbPhpClient">
        <name>get</name>
        <full_name>get</full_name>
        <docblock line="230">
          <description><![CDATA[Get a document attribute]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="230" name="param" description="- name of attribute" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="230" name="return" description="- value of attribute, NULL if attribute is not set" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="236">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="252" package="ArangoDbPhpClient">
        <name>__get</name>
        <full_name>__get</full_name>
        <docblock line="244">
          <description><![CDATA[Get a document attribute, magic method]]></description>
          <long-description><![CDATA[<p>This function is mapped to get() internally.</p>]]></long-description>
          <tag line="244" name="param" description="- name of attribute" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="244" name="return" description="- value of attribute, NULL if attribute is not set" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
        <argument line="252">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="266" package="ArangoDbPhpClient">
        <name>getAll</name>
        <full_name>getAll</full_name>
        <docblock line="256">
          <description><![CDATA[Get all document attributes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="256" name="param" description="- optional, array of options for the getAll function, or the boolean value for $includeInternals &lt;p&gt;Options are : &lt;li&gt;'includeInternals' - true to include the internal attributes. Defaults to false&lt;/li&gt; &lt;li&gt;'ignoreHiddenAttributes' - true to show hidden attributes. Defaults to false&lt;/li&gt; &lt;/p&gt;" type="mixed" variable="$options">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="256" name="return" description="- array of all document attributes/values" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="266">
          <name>$options</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="302" package="ArangoDbPhpClient">
        <name>setHiddenAttributes</name>
        <full_name>setHiddenAttributes</full_name>
        <docblock line="296">
          <description><![CDATA[Set the hidden attributes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="296" name="param" description="- array of attributes" type="array" variable="$attributes">
            <type by_reference="false">array</type>
          </tag>
          <tag line="296" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="302">
          <name>$attributes</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="311" package="ArangoDbPhpClient">
        <name>getHiddenAttributes</name>
        <full_name>getHiddenAttributes</full_name>
        <docblock line="306">
          <description><![CDATA[Get the hidden attributes]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="306" name="return" description="$attributes - array of 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="321" package="ArangoDbPhpClient">
        <name>setChanged</name>
        <full_name>setChanged</full_name>
        <docblock line="315">
          <description><![CDATA[Set the changed flag]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="315" name="param" description="- change flag" type="bool" variable="$value">
            <type by_reference="false">bool</type>
          </tag>
          <tag line="315" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="321">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="330" package="ArangoDbPhpClient">
        <name>getChanged</name>
        <full_name>getChanged</full_name>
        <docblock line="325">
          <description><![CDATA[Get the changed flag]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="325" 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="343" package="ArangoDbPhpClient">
        <name>setInternalId</name>
        <full_name>setInternalId</full_name>
        <docblock line="334">
          <description><![CDATA[Set the internal document id]]></description>
          <long-description><![CDATA[<p>This will throw if the id of an existing document gets updated to some other id</p>]]></long-description>
          <tag line="334" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="334" name="param" description="- internal document id" type="string" variable="$id">
            <type by_reference="false">string</type>
          </tag>
          <tag line="334" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="343">
          <name>$id</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="363" package="ArangoDbPhpClient">
        <name>getInternalId</name>
        <full_name>getInternalId</full_name>
        <docblock line="355">
          <description><![CDATA[Get the internal document id (if already known)]]></description>
          <long-description><![CDATA[<p>Document ids are generated on the server only. Document ids consist of collection id and
document id, in the format collectionid/documentid</p>]]></long-description>
          <tag line="355" 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="375" package="ArangoDbPhpClient">
        <name>getHandle</name>
        <full_name>getHandle</full_name>
        <docblock line="367">
          <description><![CDATA[Convenience function to get the document handle (if already known) - is an alias to getInternalId()]]></description>
          <long-description><![CDATA[<p>Document handles are generated on the server only. Document handles consist of collection id and
document id, in the format collectionid/documentid</p>]]></long-description>
          <tag line="367" 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="387" package="ArangoDbPhpClient">
        <name>getId</name>
        <full_name>getId</full_name>
        <docblock line="379">
          <description><![CDATA[Get the document id (if already known)]]></description>
          <long-description><![CDATA[<p>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</p>]]></long-description>
          <tag line="379" 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="401" package="ArangoDbPhpClient">
        <name>getCollectionId</name>
        <full_name>getCollectionId</full_name>
        <docblock line="393">
          <description><![CDATA[Get the collection id (if already known)]]></description>
          <long-description><![CDATA[<p>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</p>]]></long-description>
          <tag line="393" 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="418" package="ArangoDbPhpClient">
        <name>setRevision</name>
        <full_name>setRevision</full_name>
        <docblock line="407">
          <description><![CDATA[Set the document revision]]></description>
          <long-description><![CDATA[<p>Revision ids are generated on the server only.</p>

<p>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</p>]]></long-description>
          <tag line="407" name="param" description="- revision id" type="mixed" variable="$rev">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="407" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="418">
          <name>$rev</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="427" package="ArangoDbPhpClient">
        <name>getRevision</name>
        <full_name>getRevision</full_name>
        <docblock line="422">
          <description><![CDATA[Get the document revision (if already known)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="422" 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="UrlHelper.php" hash="bf02ce1d620a61c223fd780633d83eee" 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="true" abstract="true" namespace="triagens\ArangoDb" line="18" package="ArangoDbPhpClient">
      <extends/>
      <name>URLHelper</name>
      <full_name>\triagens\ArangoDb\URLHelper</full_name>
      <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="ArangoDbPhpClient">
        <name>getDocumentIdFromLocation</name>
        <full_name>getDocumentIdFromLocation</full_name>
        <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="36" package="ArangoDbPhpClient">
        <name>getCollectionIdFromLocation</name>
        <full_name>getCollectionIdFromLocation</full_name>
        <docblock line="30">
          <description><![CDATA[Get the collection id from a location header]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="30" name="param" description="- HTTP response location header" type="string" variable="$location">
            <type by_reference="false">string</type>
          </tag>
          <tag line="30" name="return" description="- collection id parsed from header" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="36">
          <name>$location</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="49" package="ArangoDbPhpClient">
        <name>buildUrl</name>
        <full_name>buildUrl</full_name>
        <docblock line="41">
          <description><![CDATA[Construct a URL from a base URL and additional parts, seperated with '/' each]]></description>
          <long-description><![CDATA[<p>This function accepts variable arguments.</p>]]></long-description>
          <tag line="41" name="param" description="- base URL" type="string" variable="$baseUrl">
            <type by_reference="false">string</type>
          </tag>
          <tag line="41" name="return" description="- assembled URL" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="49">
          <name>$baseUrl</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="72" package="ArangoDbPhpClient">
        <name>appendParamsUrl</name>
        <full_name>appendParamsUrl</full_name>
        <docblock line="63">
          <description><![CDATA[Append parameters to a URL]]></description>
          <long-description><![CDATA[<p>Parameter values will be URL-encoded</p>]]></long-description>
          <tag line="63" name="param" description="- base URL" type="string" variable="$baseUrl">
            <type by_reference="false">string</type>
          </tag>
          <tag line="63" name="param" description="- an array of parameters" type="array" variable="$params">
            <type by_reference="false">array</type>
          </tag>
          <tag line="63" name="return" description="- the assembled URL" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="72">
          <name>$baseUrl</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="72">
          <name>$params</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="public" namespace="triagens\ArangoDb" line="84" package="ArangoDbPhpClient">
        <name>getBoolString</name>
        <full_name>getBoolString</full_name>
        <docblock line="78">
          <description><![CDATA[Get a string from a boolean value]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="78" name="param" description="- the value" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="78" 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="84">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="Handler.php" hash="be13f3045f83332bb0d02a9a6c4c635a" 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="true" abstract="true" namespace="triagens\ArangoDb" line="18" package="ArangoDbPhpClient">
      <extends/>
      <name>Handler</name>
      <full_name>\triagens\ArangoDb\Handler</full_name>
      <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="24" namespace="triagens\ArangoDb" 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="32" package="ArangoDbPhpClient">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="26">
          <description><![CDATA[Construct a new handler]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="26" name="param" description="- connection to be used" type="\triagens\ArangoDb\Connection" variable="$connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
          <tag line="26" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="32">
          <name>$connection</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Connection</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="triagens\ArangoDb" line="41" package="ArangoDbPhpClient">
        <name>getConnection</name>
        <full_name>getConnection</full_name>
        <docblock line="36">
          <description><![CDATA[Return the connection object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="36" 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="Edge.php" hash="6f93621f74b68074d0a6fe25af30a6aa" 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">
      <extends>\triagens\ArangoDb\Document</extends>
      <name>Edge</name>
      <full_name>\triagens\ArangoDb\Edge</full_name>
      <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="35" package="ArangoDbPhpClient">
        <name>ENTRY_FROM</name>
        <full_name>ENTRY_FROM</full_name>
        <value><![CDATA['_from']]></value>
        <docblock line="31">
          <description><![CDATA[Document _from index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="40" package="ArangoDbPhpClient">
        <name>ENTRY_TO</name>
        <full_name>ENTRY_TO</full_name>
        <value><![CDATA['_to']]></value>
        <docblock line="37">
          <description><![CDATA[Revision _to index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="protected" line="23" namespace="triagens\ArangoDb" package="Default">
        <name>$_from</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="19">
          <description><![CDATA[The edge's from (might be NULL for new documents)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="19" name="var" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="protected" line="29" namespace="triagens\ArangoDb" package="Default">
        <name>$_to</name>
        <default><![CDATA[NULL]]></default>
        <docblock line="25">
          <description><![CDATA[The edge's to (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>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="50" package="ArangoDbPhpClient">
        <name>__clone</name>
        <full_name>__clone</full_name>
        <docblock line="43">
          <description><![CDATA[Clone a document]]></description>
          <long-description><![CDATA[<p>Returns the clone</p>]]></long-description>
          <tag line="43" 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="71" package="ArangoDbPhpClient">
        <name>set</name>
        <full_name>set</full_name>
        <docblock line="58">
          <description><![CDATA[Set a document attribute]]></description>
          <long-description><![CDATA[<p>The key (attribute name) must be a string.</p>

<p>This will validate the value of the attribute and might throw an
exception if the value is invalid.</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="- attribute name" type="string" variable="$key">
            <type by_reference="false">string</type>
          </tag>
          <tag line="58" name="param" description="- value for attribute" type="mixed" variable="$value">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="58" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="71">
          <name>$key</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="71">
          <name>$value</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="116" package="ArangoDbPhpClient">
        <name>getFrom</name>
        <full_name>getFrom</full_name>
        <docblock line="111">
          <description><![CDATA[Get the 'from' vertex document-handler (if already known)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="111" name="return" description="- document-handler" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="125" package="ArangoDbPhpClient">
        <name>getTo</name>
        <full_name>getTo</full_name>
        <docblock line="120">
          <description><![CDATA[Get the 'to' vertex document-handler (if already known)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="120" name="return" description="- document-handler" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="135" package="ArangoDbPhpClient">
        <name>setFrom</name>
        <full_name>setFrom</full_name>
        <docblock line="129">
          <description><![CDATA[Set the 'from' vertex document-handler]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="129" name="param" description="- from vertex" type="mixed" variable="$from">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="129" name="return" description="- edge object" type="\triagens\ArangoDb\Edge">
            <type by_reference="false">\triagens\ArangoDb\Edge</type>
          </tag>
        </docblock>
        <argument line="135">
          <name>$from</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="146" package="ArangoDbPhpClient">
        <name>setTo</name>
        <full_name>setTo</full_name>
        <docblock line="140">
          <description><![CDATA[Set the 'to' vertex document-handler]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="140" name="param" description="- to vertex" type="mixed" variable="$to">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="140" name="return" description="- edge object" type="\triagens\ArangoDb\Edge">
            <type by_reference="false">\triagens\ArangoDb\Edge</type>
          </tag>
        </docblock>
        <argument line="146">
          <name>$to</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="EdgeHandler.php" hash="42ca972756598c81bd6cca8c44e8cf16" 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="author" description="Frank Mayer"/>
      <tag line="3" name="copyright" description="Copyright 2012, triagens GmbH, Cologne, Germany"/>
    </docblock>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="21" package="ArangoDbPhpClient">
      <extends>\triagens\ArangoDb\DocumentHandler</extends>
      <name>EdgeHandler</name>
      <full_name>\triagens\ArangoDb\EdgeHandler</full_name>
      <docblock line="14">
        <description><![CDATA[An edge-document handler that fetches edges from the server and
persists them on the server.]]></description>
        <long-description><![CDATA[<p>It does so by issuing the
appropriate HTTP requests to the server.</p>]]></long-description>
        <tag line="14" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="25" package="ArangoDbPhpClient">
        <name>ENTRY_DOCUMENTS</name>
        <full_name>ENTRY_DOCUMENTS</full_name>
        <value><![CDATA['edge']]></value>
        <docblock line="22">
          <description><![CDATA[documents array index]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="30" package="ArangoDbPhpClient">
        <name>OPTION_COLLECTION</name>
        <full_name>OPTION_COLLECTION</full_name>
        <value><![CDATA['collection']]></value>
        <docblock line="27">
          <description><![CDATA[collection parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="35" package="ArangoDbPhpClient">
        <name>OPTION_EXAMPLE</name>
        <full_name>OPTION_EXAMPLE</full_name>
        <value><![CDATA['example']]></value>
        <docblock line="32">
          <description><![CDATA[example parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="40" package="ArangoDbPhpClient">
        <name>OPTION_FROM</name>
        <full_name>OPTION_FROM</full_name>
        <value><![CDATA['from']]></value>
        <docblock line="37">
          <description><![CDATA[example parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="45" package="ArangoDbPhpClient">
        <name>OPTION_TO</name>
        <full_name>OPTION_TO</full_name>
        <value><![CDATA['to']]></value>
        <docblock line="42">
          <description><![CDATA[example parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="50" package="ArangoDbPhpClient">
        <name>OPTION_VERTEX</name>
        <full_name>OPTION_VERTEX</full_name>
        <value><![CDATA['vertex']]></value>
        <docblock line="47">
          <description><![CDATA[vertex parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="55" package="ArangoDbPhpClient">
        <name>OPTION_DIRECTION</name>
        <full_name>OPTION_DIRECTION</full_name>
        <value><![CDATA['direction']]></value>
        <docblock line="52">
          <description><![CDATA[direction parameter]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="68" package="ArangoDbPhpClient">
        <name>add</name>
        <full_name>add</full_name>
        <docblock line="58">
          <description><![CDATA[Just throw an exception if add() is called on edges.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="58" name="internal" 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 string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="58" 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="58" name="param" description="- create the collection if it does not yet exist" type="bool" variable="$create">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="68">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="68">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="68">
          <name>$create</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="80" package="ArangoDbPhpClient">
        <name>save</name>
        <full_name>save</full_name>
        <docblock line="71">
          <description><![CDATA[Just throw an exception if save() is called on edges.]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="71" name="internal" description=""/>
          <tag line="71" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="71" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="71" 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="71" name="param" description="- create the collection if it does not yet exist" type="bool" variable="$create">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="80">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="80">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="80">
          <name>$create</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="102" package="ArangoDbPhpClient">
        <name>saveEdge</name>
        <full_name>saveEdge</full_name>
        <docblock line="86">
          <description><![CDATA[save an edge to an edge-collection]]></description>
          <long-description><![CDATA[<p>This will save the edge to the collection and return the edges-document's id</p>

<p>This will throw if the document cannot be saved</p>]]></long-description>
          <tag line="86" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="86" name="param" description="- collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="86" name="param" description="- from vertex" type="mixed" variable="$from">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="86" name="param" description="- to vertex" type="mixed" variable="$to">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="86" 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="86" 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="86" name="return" description="- id of document created" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="86" name="since" description="1.0"/>
        </docblock>
        <argument line="102">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="102">
          <name>$from</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="102">
          <name>$to</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="102">
          <name>$document</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Document</type>
        </argument>
        <argument line="102">
          <name>$create</name>
          <default><![CDATA[NULL]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="142" package="ArangoDbPhpClient">
        <name>edges</name>
        <full_name>edges</full_name>
        <docblock line="132">
          <description><![CDATA[Get edges for a given vertex]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="132" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="132" name="param" description="- edge-collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="132" name="param" description="- the vertex involved" type="mixed" variable="$vertexHandle">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="132" name="param" description="- optional defaults to 'any'. Other possible Values 'in' &amp; 'out'" type="string" variable="$direction">
            <type by_reference="false">string</type>
          </tag>
          <tag line="132" name="return" description="- array of cursors" type="array">
            <type by_reference="false">array</type>
          </tag>
          <tag line="132" name="since" description="1.0"/>
        </docblock>
        <argument line="142">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="142">
          <name>$vertexHandle</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="142">
          <name>$direction</name>
          <default><![CDATA['any']]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="159" package="ArangoDbPhpClient">
        <name>inEdges</name>
        <full_name>inEdges</full_name>
        <docblock line="151">
          <description><![CDATA[Get inbound edges for a given vertex]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="151" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="151" name="param" description="- edge-collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="151" name="param" description="- the vertex involved" type="mixed" variable="$vertexHandle">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="151" name="return" description="- array of cursors" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="159">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="159">
          <name>$vertexHandle</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="171" package="ArangoDbPhpClient">
        <name>outEdges</name>
        <full_name>outEdges</full_name>
        <docblock line="163">
          <description><![CDATA[Get outbound edges for a given vertex]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="163" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="163" name="param" description="- edge-collection id as string or number" type="mixed" variable="$collectionId">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="163" name="param" description="- the vertex involved" type="mixed" variable="$vertexHandle">
            <type by_reference="false">mixed</type>
          </tag>
          <tag line="163" name="return" description="- array of cursors" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="171">
          <name>$collectionId</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
        <argument line="171">
          <name>$vertexHandle</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
    </class>
  </file>
  <file path="Autoloader.php" hash="8b04c56ca645c6548f2332c41e02c8d7" 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>
    <include line="65" type="Require" package="Default">
      <name/>
    </include>
    <class final="false" abstract="false" namespace="triagens\ArangoDb" line="20" package="ArangoDbPhpClient">
      <extends/>
      <name>Autoloader</name>
      <full_name>\triagens\ArangoDb\Autoloader</full_name>
      <docblock line="13">
        <description><![CDATA[Handles automatic loading of missing class files
The autoloader can be nested with other autoloaders.]]></description>
        <long-description><![CDATA[<p>It will only
process classes from its own namespace and ignore all others.</p>]]></long-description>
        <tag line="13" name="package" description="ArangoDbPhpClient"/>
      </docblock>
      <constant namespace="triagens\ArangoDb" line="30" package="ArangoDbPhpClient">
        <name>EXTENSION</name>
        <full_name>EXTENSION</full_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" namespace="triagens\ArangoDb" 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="ArangoDbPhpClient">
        <name>init</name>
        <full_name>init</full_name>
        <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="54" package="ArangoDbPhpClient">
        <name>load</name>
        <full_name>load</full_name>
        <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.</p>

<p>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="54">
          <name>$className</name>
          <default><![CDATA[]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="true" visibility="private" namespace="triagens\ArangoDb" line="77" package="ArangoDbPhpClient">
        <name>checkEnvironment</name>
        <full_name>checkEnvironment</full_name>
        <docblock line="68">
          <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="68" name="throws" description="" type="\triagens\ArangoDb\ClientException">
            <type by_reference="false">\triagens\ArangoDb\ClientException</type>
          </tag>
          <tag line="68" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="Urls.php" hash="d913745be05bd4f5fd0af6feee224407" 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="true" abstract="true" namespace="triagens\ArangoDb" line="18" package="ArangoDbPhpClient">
      <extends/>
      <name>URLs</name>
      <full_name>\triagens\ArangoDb\URLs</full_name>
      <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="ArangoDbPhpClient">
        <name>URL_DOCUMENT</name>
        <full_name>URL_DOCUMENT</full_name>
        <value><![CDATA['/_api/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="ArangoDbPhpClient">
        <name>URL_EDGE</name>
        <full_name>URL_EDGE</full_name>
        <value><![CDATA['/_api/edge']]></value>
        <docblock line="24">
          <description><![CDATA[URL base part for all document-related REST calls]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="32" package="ArangoDbPhpClient">
        <name>URL_COLLECTION</name>
        <full_name>URL_COLLECTION</full_name>
        <value><![CDATA['/_api/collection']]></value>
        <docblock line="29">
          <description><![CDATA[URL base part for all collection-related REST calls]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="37" package="ArangoDbPhpClient">
        <name>URL_INDEX</name>
        <full_name>URL_INDEX</full_name>
        <value><![CDATA['/_api/index']]></value>
        <docblock line="34">
          <description><![CDATA[URL base part for all index-related REST calls]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="42" package="ArangoDbPhpClient">
        <name>URL_CURSOR</name>
        <full_name>URL_CURSOR</full_name>
        <value><![CDATA['/_api/cursor']]></value>
        <docblock line="39">
          <description><![CDATA[base URL part for cursor related operations]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="47" package="ArangoDbPhpClient">
        <name>URL_EXPLAIN</name>
        <full_name>URL_EXPLAIN</full_name>
        <value><![CDATA['/_api/explain']]></value>
        <docblock line="44">
          <description><![CDATA[base URL part for aql explain related operations]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="52" package="ArangoDbPhpClient">
        <name>URL_QUERY</name>
        <full_name>URL_QUERY</full_name>
        <value><![CDATA['/_api/query']]></value>
        <docblock line="49">
          <description><![CDATA[base URL part for aql query validation related operations]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="57" package="ArangoDbPhpClient">
        <name>URL_EXAMPLE</name>
        <full_name>URL_EXAMPLE</full_name>
        <value><![CDATA['/_api/simple/by-example']]></value>
        <docblock line="54">
          <description><![CDATA[base URL part for select-by-example]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="62" package="ArangoDbPhpClient">
        <name>URL_RANGE</name>
        <full_name>URL_RANGE</full_name>
        <value><![CDATA['/_api/simple/range']]></value>
        <docblock line="59">
          <description><![CDATA[base URL part for select-range]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="66" package="ArangoDbPhpClient">
        <name>URL_NEAR</name>
        <full_name>URL_NEAR</full_name>
        <value><![CDATA['/_api/simple/near']]></value>
        <docblock line="63">
          <description><![CDATA[base URL part for select-range]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="70" package="ArangoDbPhpClient">
        <name>URL_WITHIN</name>
        <full_name>URL_WITHIN</full_name>
        <value><![CDATA['/_api/simple/within']]></value>
        <docblock line="67">
          <description><![CDATA[base URL part for select-range]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
    </class>
  </file>
  <file path="Cursor.php" hash="d7da62aeec15cf3e2424cf1e1b1e9a8c" 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="24" package="ArangoDbPhpClient">
      <extends/>
      <implements>\Iterator</implements>
      <name>Cursor</name>
      <full_name>\triagens\ArangoDb\Cursor</full_name>
      <docblock line="13">
        <description><![CDATA[Provides access to the results of a read-only statement]]></description>
        <long-description><![CDATA[<p>The cursor might not contain all results in the beginning.</p>

<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="71" package="ArangoDbPhpClient">
        <name>ENTRY_ID</name>
        <full_name>ENTRY_ID</full_name>
        <value><![CDATA['id']]></value>
        <docblock line="68">
          <description><![CDATA[result entry for cursor id]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="76" package="ArangoDbPhpClient">
        <name>ENTRY_HASMORE</name>
        <full_name>ENTRY_HASMORE</full_name>
        <value><![CDATA['hasMore']]></value>
        <docblock line="73">
          <description><![CDATA[result entry for "hasMore" flag]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="81" package="ArangoDbPhpClient">
        <name>ENTRY_RESULT</name>
        <full_name>ENTRY_RESULT</full_name>
        <value><![CDATA['result']]></value>
        <docblock line="78">
          <description><![CDATA[result entry for result documents]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <constant namespace="triagens\ArangoDb" line="86" package="ArangoDbPhpClient">
        <name>ENTRY_SANITIZE</name>
        <full_name>ENTRY_SANITIZE</full_name>
        <value><![CDATA['sanitize']]></value>
        <docblock line="83">
          <description><![CDATA[sanitize option entry]]></description>
          <long-description><![CDATA[]]></long-description>
        </docblock>
      </constant>
      <property final="false" static="false" visibility="private" line="29" namespace="triagens\ArangoDb" package="Default">
        <name>$_connection</name>
        <default><![CDATA[]]></default>
        <docblock line="25">
          <description><![CDATA[The connection object]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="25" 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="35" namespace="triagens\ArangoDb" package="Default">
        <name>$_options</name>
        <default><![CDATA[]]></default>
        <docblock line="31">
          <description><![CDATA[Cursor options]]></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" namespace="triagens\ArangoDb" package="Default">
        <name>$_result</name>
        <default><![CDATA[]]></default>
        <docblock line="37">
          <description><![CDATA[The result set]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="37" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="47" namespace="triagens\ArangoDb" package="Default">
        <name>$_hasMore</name>
        <default><![CDATA[]]></default>
        <docblock line="43">
          <description><![CDATA["has more" indicator - if true, the server has more results]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="43" name="var" description="" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="53" namespace="triagens\ArangoDb" package="Default">
        <name>$_id</name>
        <default><![CDATA[]]></default>
        <docblock line="49">
          <description><![CDATA[cursor id - might be NULL if cursor does not have an id]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="49" name="var" description="" type="mixed">
            <type by_reference="false">mixed</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="59" namespace="triagens\ArangoDb" package="Default">
        <name>$_position</name>
        <default><![CDATA[]]></default>
        <docblock line="55">
          <description><![CDATA[current position in result set iteration (zero-based)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="55" name="var" description="" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="65" namespace="triagens\ArangoDb" package="Default">
        <name>$_length</name>
        <default><![CDATA[]]></default>
        <docblock line="61">
          <description><![CDATA[total length of result set (in number of documents)]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="61" 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="96" package="ArangoDbPhpClient">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="88">
          <description><![CDATA[Initialise the cursor with the first results and some metadata]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="88" name="param" description="- connection to be used" type="\triagens\ArangoDb\Connection" variable="$connection">
            <type by_reference="false">\triagens\ArangoDb\Connection</type>
          </tag>
          <tag line="88" name="param" description="- initial result data as returned by the server" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
          <tag line="88" name="param" description="- cursor options" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="88" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="96">
          <name>$connection</name>
          <default><![CDATA[]]></default>
          <type>\triagens\ArangoDb\Connection</type>
        </argument>
        <argument line="96">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
        <argument line="96">
          <name>$options</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="triagens\ArangoDb" line="125" package="ArangoDbPhpClient">
        <name>delete</name>
        <full_name>delete</full_name>
        <docblock line="116">
          <description><![CDATA[Explicitly delete the cursor]]></description>
          <long-description><![CDATA[<p>This might issue an HTTP DELETE request to inform the server about
the deletion.</p>]]></long-description>
          <tag line="116" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="116" 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="147" package="ArangoDbPhpClient">
        <name>getCount</name>
        <full_name>getCount</full_name>
        <docblock line="138">
          <description><![CDATA[Get the total number of results in the cursor]]></description>
          <long-description><![CDATA[<p>This might issue additional HTTP requests to fetch any outstanding
results from the server</p>]]></long-description>
          <tag line="138" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="138" 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="164" package="ArangoDbPhpClient">
        <name>getAll</name>
        <full_name>getAll</full_name>
        <docblock line="155">
          <description><![CDATA[Get all results as an array]]></description>
          <long-description><![CDATA[<p>This might issue additional HTTP requests to fetch any outstanding
results from the server</p>]]></long-description>
          <tag line="155" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="155" 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="177" package="ArangoDbPhpClient">
        <name>rewind</name>
        <full_name>rewind</full_name>
        <docblock line="172">
          <description><![CDATA[Rewind the cursor, necessary for Iterator]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="172" 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="186" package="ArangoDbPhpClient">
        <name>current</name>
        <full_name>current</full_name>
        <docblock line="181">
          <description><![CDATA[Return the current result row, necessary for Iterator]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="181" 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="195" package="ArangoDbPhpClient">
        <name>key</name>
        <full_name>key</full_name>
        <docblock line="190">
          <description><![CDATA[Return the index of the current result row, necessary for Iterator]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="190" 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="204" package="ArangoDbPhpClient">
        <name>next</name>
        <full_name>next</full_name>
        <docblock line="199">
          <description><![CDATA[Advance the cursor, necessary for Iterator]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="199" 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="217" package="ArangoDbPhpClient">
        <name>valid</name>
        <full_name>valid</full_name>
        <docblock line="208">
          <description><![CDATA[Check if cursor can be advanced further, necessary for Iterator]]></description>
          <long-description><![CDATA[<p>This might issue additional HTTP requests to fetch any outstanding
results from the server</p>]]></long-description>
          <tag line="208" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="208" 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="241" package="ArangoDbPhpClient">
        <name>addDocumentsFromArray</name>
        <full_name>addDocumentsFromArray</full_name>
        <docblock line="234">
          <description><![CDATA[Create an array of documents from the input array]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="234" name="param" description="- array of incoming &quot;document&quot; arrays" type="array" variable="$data">
            <type by_reference="false">array</type>
          </tag>
          <tag line="234" name="param" description="- array of document options" type="array" variable="$options">
            <type by_reference="false">array</type>
          </tag>
          <tag line="234" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
        <argument line="241">
          <name>$data</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
        <argument line="241">
          <name>$options</name>
          <default><![CDATA[array()]]></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="257" package="ArangoDbPhpClient">
        <name>sanitize</name>
        <full_name>sanitize</full_name>
        <docblock line="248">
          <description><![CDATA[Sanitize the result set rows]]></description>
          <long-description><![CDATA[<p>This will remove the _id and _rev attributes from the results if the
"sanitize" option is set</p>]]></long-description>
          <tag line="248" name="param" description="- array of rows to be sanitized" type="array" variable="$rows">
            <type by_reference="false">array</type>
          </tag>
          <tag line="248" name="return" description="- sanitized rows" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="257">
          <name>$rows</name>
          <default><![CDATA[]]></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="private" namespace="triagens\ArangoDb" line="273" package="ArangoDbPhpClient">
        <name>fetchOutstanding</name>
        <full_name>fetchOutstanding</full_name>
        <docblock line="267">
          <description><![CDATA[Fetch outstanding results from the server]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="267" name="throws" description="" type="\triagens\ArangoDb\Exception">
            <type by_reference="false">\triagens\ArangoDb\Exception</type>
          </tag>
          <tag line="267" 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="294" package="ArangoDbPhpClient">
        <name>updateLength</name>
        <full_name>updateLength</full_name>
        <docblock line="289">
          <description><![CDATA[Set the length of the (fetched) result set]]></description>
          <long-description><![CDATA[]]></long-description>
          <tag line="289" name="return" description="" type="void">
            <type by_reference="false">void</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <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 count="0">todo</marker>
  <marker count="0">fixme</marker>
  <deprecated count="9"/>
</project>
Return current item: ArangoDB-PHP