Location: PHPKode > projects > ArangoDB-PHP > triAGENS-ArangoDB-PHP-f618a05/docs/packages/db_ArangoDbPhpClient.html
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>ArangoDB PHP client API » ArangoDbPhpClient</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">ArangoDB PHP client API</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/db_triagens.html"><i class="icon-th"></i> triagens</a></li>
<li><a>Packages</a></li>
<li><a href="../packages/db_ArangoDbPhpClient.html"><i class="icon-folder-open"></i> ArangoDbPhpClient</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors</a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers (TODO/FIXME)</a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements</a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-map-marker"></i> Packages</li>
<li>
<a href="../packages/db_ArangoDbPhpClient.html" title="ArangoDbPhpClient"><i class="icon-folder-open"></i>ArangoDbPhpClient</a><ul class="nav nav-list nav-packages"></ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-class"></i> Classes</li>
<li><a href="#HttpHelper" title="Helper methods for HTTP request/response handling">HttpHelper</a></li>
<li><a href="#Scope" title="Executes a function on scope entry and executes another function
(cleanup) when the scope is exited">Scope</a></li>
<li><a href="#Exception" title="Exception base class used to throw Arango specific exceptions">Exception</a></li>
<li><a href="#Autoloader" title="Handles automatic loading of missing class files
The autoloader can be nested with other autoloaders. It will only
process classes from its own namespace and ignore all others.">Autoloader</a></li>
<li><a href="#Collection" title="Value object representing a collection">Collection</a></li>
<li><a href="#DefaultValues" title="Contains default values used by the client">DefaultValues</a></li>
<li><a href="#ServerException" title="This exception type will be thrown by the client when the server returns an
error in response to a client request.">ServerException</a></li>
<li><a href="#Connection" title="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.">Connection</a></li>
<li><a href="#UpdatePolicy" title="Document update policies">UpdatePolicy</a></li>
<li><a href="#ValueValidator" title="A simple validator for values to be stored in the database">ValueValidator</a></li>
<li><a href="#CollectionHandler" title="A collection handler that fetches collection data from the server and
creates collections on the server. It does so by issueing the
appropriate HTTP requests to the server.">CollectionHandler</a></li>
<li><a href="#URLHelper" title="Some helper methods to construct and process URLs">URLHelper</a></li>
<li><a href="#Handler" title="A base class for REST-based handlers">Handler</a></li>
<li><a href="#Statement" title='Container for a read-only ("select") statement
A statement is an AQL query that can be issued to the
server. Optional bind parameters can be used when issueing the
statement to separate the statement from the values.'>Statement</a></li>
<li><a href="#Cursor" title="Provides access to the results of a read-only statement
The cursor might not contain all results in the beginning.">Cursor</a></li>
<li><a href="#DocumentHandler" title="A document handler that fetches documents from the server and
persists them on the server. It does so by issueing the
appropriate HTTP requests to the server.">DocumentHandler</a></li>
<li><a href="#BindVars" title="A simple container for bind variables
This container also handles validation of the bind values.">BindVars</a></li>
<li><a href="#URLs" title="Some basic URLs">URLs</a></li>
<li><a href="#ConnectionOptions" title="Simple container class for connection options.">ConnectionOptions</a></li>
<li><a href="#ConnectException" title="This exception type will be thrown by the client when there is an error
during connecting to the server">ConnectException</a></li>
<li><a href="#Document" title="Value object representing a single collection-based document">Document</a></li>
<li><a href="#ClientException" title="This exception type will be thrown by the client when there is an error
on the client side, i.e. something the server is not involved in.">ClientException</a></li>
<li><a href="#HttpResponse" title="Container class for HTTP responses">HttpResponse</a></li>
</ul>
</div>
<div class="span8 package-contents">
<ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span>
</li>
<li class="active"><a href="../packages/db_ArangoDbPhpClient.html">ArangoDbPhpClient</a></li>
</ul>
<div class="package-indent">
<div class="alert alert-info">This package does not contain any documentable elements</div>
<h3>
<i class="icon-custom icon-class"></i> Classes and interfaces</h3>
<a name="Autoloader" id="Autoloader"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CAutoloader.html">
<h1>Autoloader<a href="../classes/db_%5Ctriagens%5CArangoDb%5CAutoloader.html">¶</a>
</h1>
<p class="short_description">Handles automatic loading of missing class files
The autoloader can be nested with other autoloaders. It will only
process classes from its own namespace and ignore all others.</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CAutoloader.html" class="more">« More »</a>
</div>
<a name="BindVars" id="BindVars"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CBindVars.html">
<h1>BindVars<a href="../classes/db_%5Ctriagens%5CArangoDb%5CBindVars.html">¶</a>
</h1>
<p class="short_description">A simple container for bind variables
This container also handles validation of the bind values.</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CBindVars.html" class="more">« More »</a>
</div>
<a name="ClientException" id="ClientException"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CClientException.html">
<h1>ClientException<a href="../classes/db_%5Ctriagens%5CArangoDb%5CClientException.html">¶</a>
</h1>
<p class="short_description">This exception type will be thrown by the client when there is an error
on the client side, i.e. something the server is not involved in.</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CClientException.html" class="more">« More »</a>
</div>
<a name="Collection" id="Collection"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CCollection.html">
<h1>Collection<a href="../classes/db_%5Ctriagens%5CArangoDb%5CCollection.html">¶</a>
</h1>
<p class="short_description">Value object representing a collection</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CCollection.html" class="more">« More »</a>
</div>
<a name="CollectionHandler" id="CollectionHandler"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CCollectionHandler.html">
<h1>CollectionHandler<a href="../classes/db_%5Ctriagens%5CArangoDb%5CCollectionHandler.html">¶</a>
</h1>
<p class="short_description">A collection handler that fetches collection data from the server and
creates collections on the server. It does so by issueing the
appropriate HTTP requests to the server.</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CCollectionHandler.html" class="more">« More »</a>
</div>
<a name="ConnectException" id="ConnectException"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CConnectException.html">
<h1>ConnectException<a href="../classes/db_%5Ctriagens%5CArangoDb%5CConnectException.html">¶</a>
</h1>
<p class="short_description">This exception type will be thrown by the client when there is an error
during connecting to the server</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CConnectException.html" class="more">« More »</a>
</div>
<a name="Connection" id="Connection"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CConnection.html">
<h1>Connection<a href="../classes/db_%5Ctriagens%5CArangoDb%5CConnection.html">¶</a>
</h1>
<p class="short_description">Provides access to the ArangoDB server
As all access is done using HTTP, we do not need to establish a
persistent connection and keep its state.</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CConnection.html" class="more">« More »</a>
</div>
<a name="ConnectionOptions" id="ConnectionOptions"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CConnectionOptions.html">
<h1>ConnectionOptions<a href="../classes/db_%5Ctriagens%5CArangoDb%5CConnectionOptions.html">¶</a>
</h1>
<p class="short_description">Simple container class for connection options.</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CConnectionOptions.html" class="more">« More »</a>
</div>
<a name="Cursor" id="Cursor"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CCursor.html">
<h1>Cursor<a href="../classes/db_%5Ctriagens%5CArangoDb%5CCursor.html">¶</a>
</h1>
<p class="short_description">Provides access to the results of a read-only statement
The cursor might not contain all results in the beginning.</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CCursor.html" class="more">« More »</a>
</div>
<a name="DefaultValues" id="DefaultValues"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CDefaultValues.html">
<h1>DefaultValues<a href="../classes/db_%5Ctriagens%5CArangoDb%5CDefaultValues.html">¶</a>
</h1>
<p class="short_description">Contains default values used by the client</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CDefaultValues.html" class="more">« More »</a>
</div>
<a name="Document" id="Document"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CDocument.html">
<h1>Document<a href="../classes/db_%5Ctriagens%5CArangoDb%5CDocument.html">¶</a>
</h1>
<p class="short_description">Value object representing a single collection-based document</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CDocument.html" class="more">« More »</a>
</div>
<a name="DocumentHandler" id="DocumentHandler"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CDocumentHandler.html">
<h1>DocumentHandler<a href="../classes/db_%5Ctriagens%5CArangoDb%5CDocumentHandler.html">¶</a>
</h1>
<p class="short_description">A document handler that fetches documents from the server and
persists them on the server. It does so by issueing the
appropriate HTTP requests to the server.</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CDocumentHandler.html" class="more">« More »</a>
</div>
<a name="Exception" id="Exception"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CException.html">
<h1>Exception<a href="../classes/db_%5Ctriagens%5CArangoDb%5CException.html">¶</a>
</h1>
<p class="short_description">Exception base class used to throw Arango specific exceptions</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CException.html" class="more">« More »</a>
</div>
<a name="Handler" id="Handler"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CHandler.html">
<h1>Handler<a href="../classes/db_%5Ctriagens%5CArangoDb%5CHandler.html">¶</a>
</h1>
<p class="short_description">A base class for REST-based handlers</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CHandler.html" class="more">« More »</a>
</div>
<a name="HttpHelper" id="HttpHelper"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CHttpHelper.html">
<h1>HttpHelper<a href="../classes/db_%5Ctriagens%5CArangoDb%5CHttpHelper.html">¶</a>
</h1>
<p class="short_description">Helper methods for HTTP request/response handling</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CHttpHelper.html" class="more">« More »</a>
</div>
<a name="HttpResponse" id="HttpResponse"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CHttpResponse.html">
<h1>HttpResponse<a href="../classes/db_%5Ctriagens%5CArangoDb%5CHttpResponse.html">¶</a>
</h1>
<p class="short_description">Container class for HTTP responses</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CHttpResponse.html" class="more">« More »</a>
</div>
<a name="Scope" id="Scope"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CScope.html">
<h1>Scope<a href="../classes/db_%5Ctriagens%5CArangoDb%5CScope.html">¶</a>
</h1>
<p class="short_description">Executes a function on scope entry and executes another function
(cleanup) when the scope is exited</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CScope.html" class="more">« More »</a>
</div>
<a name="ServerException" id="ServerException"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CServerException.html">
<h1>ServerException<a href="../classes/db_%5Ctriagens%5CArangoDb%5CServerException.html">¶</a>
</h1>
<p class="short_description">This exception type will be thrown by the client when the server returns an
error in response to a client request.</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CServerException.html" class="more">« More »</a>
</div>
<a name="Statement" id="Statement"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CStatement.html">
<h1>Statement<a href="../classes/db_%5Ctriagens%5CArangoDb%5CStatement.html">¶</a>
</h1>
<p class="short_description">Container for a read-only ("select") statement
A statement is an AQL query that can be issued to the
server. Optional bind parameters can be used when issueing the
statement to separate the statement from the values.</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CStatement.html" class="more">« More »</a>
</div>
<a name="URLHelper" id="URLHelper"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CURLHelper.html">
<h1>URLHelper<a href="../classes/db_%5Ctriagens%5CArangoDb%5CURLHelper.html">¶</a>
</h1>
<p class="short_description">Some helper methods to construct and process URLs</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CURLHelper.html" class="more">« More »</a>
</div>
<a name="URLs" id="URLs"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CURLs.html">
<h1>URLs<a href="../classes/db_%5Ctriagens%5CArangoDb%5CURLs.html">¶</a>
</h1>
<p class="short_description">Some basic URLs</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CURLs.html" class="more">« More »</a>
</div>
<a name="UpdatePolicy" id="UpdatePolicy"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CUpdatePolicy.html">
<h1>UpdatePolicy<a href="../classes/db_%5Ctriagens%5CArangoDb%5CUpdatePolicy.html">¶</a>
</h1>
<p class="short_description">Document update policies</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CUpdatePolicy.html" class="more">« More »</a>
</div>
<a name="ValueValidator" id="ValueValidator"></a><div class="element ajax clickable class" href="../classes/db_%5Ctriagens%5CArangoDb%5CValueValidator.html">
<h1>ValueValidator<a href="../classes/db_%5Ctriagens%5CArangoDb%5CValueValidator.html">¶</a>
</h1>
<p class="short_description">A simple validator for values to be stored in the database</p>
<div class="details collapse"></div>
<a href="../classes/db_%5Ctriagens%5CArangoDb%5CValueValidator.html" class="more">« More »</a>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a1</a> and<br>
            generated on 2012-05-11T09:21:21+02:00.<br></footer></div>
</div>
</body>
</html>
Return current item: ArangoDB-PHP