ArangoDB-PHP API Documentation
  • Namespace
  • Class
  • Deprecated

Namespaces

  • triagens
    • ArangoDb

Classes

  • triagens\ArangoDb\AdminHandler
  • triagens\ArangoDb\AqlUserFunction
  • triagens\ArangoDb\Autoloader
  • triagens\ArangoDb\Batch
  • triagens\ArangoDb\BatchPart
  • triagens\ArangoDb\BindVars
  • triagens\ArangoDb\Collection
  • triagens\ArangoDb\CollectionHandler
  • triagens\ArangoDb\Connection
  • triagens\ArangoDb\ConnectionOptions
  • triagens\ArangoDb\Cursor
  • triagens\ArangoDb\Database
  • triagens\ArangoDb\DefaultValues
  • triagens\ArangoDb\Document
  • triagens\ArangoDb\DocumentHandler
  • triagens\ArangoDb\Edge
  • triagens\ArangoDb\EdgeDefinition
  • triagens\ArangoDb\EdgeHandler
  • triagens\ArangoDb\Endpoint
  • triagens\ArangoDb\Export
  • triagens\ArangoDb\ExportCursor
  • triagens\ArangoDb\Graph
  • triagens\ArangoDb\GraphHandler
  • triagens\ArangoDb\Handler
  • triagens\ArangoDb\HttpHelper
  • triagens\ArangoDb\HttpResponse
  • triagens\ArangoDb\QueryCacheHandler
  • triagens\ArangoDb\QueryHandler
  • triagens\ArangoDb\Statement
  • triagens\ArangoDb\TraceRequest
  • triagens\ArangoDb\TraceResponse
  • triagens\ArangoDb\Transaction
  • triagens\ArangoDb\Traversal
  • triagens\ArangoDb\UpdatePolicy
  • triagens\ArangoDb\UrlHelper
  • triagens\ArangoDb\Urls
  • triagens\ArangoDb\User
  • triagens\ArangoDb\UserHandler
  • triagens\ArangoDb\ValueValidator
  • triagens\ArangoDb\Vertex
  • triagens\ArangoDb\VertexHandler

Exceptions

  • triagens\ArangoDb\ClientException
  • triagens\ArangoDb\ConnectException
  • triagens\ArangoDb\Exception
  • triagens\ArangoDb\ServerException
  1 <?php
  2 
  3 /**
  4  * ArangoDB PHP client: Base URLs
  5  *
  6  * @package   triagens\ArangoDb
  7  * @author    Jan Steemann
  8  * @copyright Copyright 2012, triagens GmbH, Cologne, Germany
  9  */
 10 
 11 namespace triagens\ArangoDb;
 12 
 13 /**
 14  * Some basic URLs
 15  *
 16  * @package triagens\ArangoDb
 17  * @since   0.2
 18  */
 19 abstract class Urls
 20 {
 21     /**
 22      * URL base part for document-related CRUD operations REST calls
 23      */
 24     const URL_DOCUMENT = '/_api/document';
 25 
 26     /**
 27      * URL base part for edge-related CRUD operations REST calls
 28      */
 29     const URL_EDGE = '/_api/document';
 30 
 31     /**
 32      * URL base part for all retrieving connected edges
 33      */
 34     const URL_EDGES = '/_api/edges';
 35 
 36     /**
 37      * URL base part for all graph-related REST calls
 38      */
 39     const URL_GRAPH = '/_api/gharial';
 40 
 41     /**
 42      * URL part vertex-related graph REST calls
 43      */
 44     const URLPART_VERTEX = 'vertex';
 45 
 46     /**
 47      * URL part for edge-related graph REST calls
 48      */
 49     const URLPART_EDGE = 'edge';
 50 
 51     /**
 52      * URL base part for all collection-related REST calls
 53      */
 54     const URL_COLLECTION = '/_api/collection';
 55 
 56     /**
 57      * URL base part for all index-related REST calls
 58      */
 59     const URL_INDEX = '/_api/index';
 60 
 61     /**
 62      * base URL part for cursor related operations
 63      */
 64     const URL_CURSOR = '/_api/cursor';
 65 
 66     /**
 67      * URL for export related operations
 68      */
 69     const URL_EXPORT = '/_api/export';
 70 
 71     /**
 72      * URL for AQL explain-related operations
 73      */
 74     const URL_EXPLAIN = '/_api/explain';
 75 
 76     /**
 77      * URL for AQL query validation-related operations
 78      */
 79     const URL_QUERY = '/_api/query';
 80 
 81     /**
 82      * URL for select-by-example
 83      */
 84     const URL_EXAMPLE = '/_api/simple/by-example';
 85 
 86     /**
 87      * URL for first-example
 88      */
 89     const URL_FIRST_EXAMPLE = '/_api/simple/first-example';
 90 
 91     /**
 92      * URL for any
 93      */
 94     const URL_ANY = '/_api/simple/any';
 95 
 96     /**
 97      * URL for fulltext
 98      */
 99     const URL_FULLTEXT = '/_api/simple/fulltext';
100 
101     /**
102      * URL remove-by-example
103      */
104     const URL_REMOVE_BY_EXAMPLE = '/_api/simple/remove-by-example';
105 
106     /**
107      * URL for remove-by-keys
108      */
109     const URL_REMOVE_BY_KEYS = '/_api/simple/remove-by-keys';
110 
111     /**
112      * URL for update-by-example
113      */
114     const URL_UPDATE_BY_EXAMPLE = '/_api/simple/update-by-example';
115 
116     /**
117      * URL for replace-by-example
118      */
119     const URL_REPLACE_BY_EXAMPLE = '/_api/simple/replace-by-example';
120 
121     /**
122      * URL for lookup-by-keys
123      */
124     const URL_LOOKUP_BY_KEYS = '/_api/simple/lookup-by-keys';
125 
126     /**
127      * URL for select-range
128      */
129     const URL_RANGE = '/_api/simple/range';
130 
131     /**
132      * URL for select-all
133      */
134     const URL_ALL = '/_api/simple/all';
135 
136     /**
137      * URL for select-all-keys
138      */
139     const URL_ALL_KEYS = '/_api/simple/all-keys';
140 
141     /**
142      * URL for select-range
143      */
144     const URL_NEAR = '/_api/simple/near';
145 
146     /**
147      * URL for select-range
148      */
149     const URL_WITHIN = '/_api/simple/within';
150 
151     /**
152      * URL for document import
153      */
154     const URL_IMPORT = '/_api/import';
155 
156     /**
157      * URL for batch processing
158      */
159     const URL_BATCH = '/_api/batch';
160 
161     /**
162      * URL for transactions
163      */
164     const URL_TRANSACTION = '/_api/transaction';
165 
166     /**
167      * URL for admin version
168      */
169     const URL_ADMIN_VERSION = '/_admin/version';
170 
171     /**
172      * URL for server role
173      */
174     const URL_ADMIN_SERVER_ROLE = '/_admin/server/role';
175 
176     /**
177      * URL for admin time
178      */
179     const URL_ADMIN_TIME = '/_admin/time';
180 
181     /**
182      * URL for admin log
183      */
184     const URL_ADMIN_LOG = '/_admin/log';
185 
186     /**
187      * base URL part for admin routing reload
188      */
189     const URL_ADMIN_ROUTING_RELOAD = '/_admin/routing/reload';
190 
191     /**
192      * base URL part for admin statistics
193      */
194     const URL_ADMIN_STATISTICS = '/_admin/statistics';
195 
196     /**
197      * base URL part for admin statistics-description
198      */
199     const URL_ADMIN_STATISTICS_DESCRIPTION = '/_admin/statistics-description';
200 
201     /**
202      * base URL part for AQL user functions statistics
203      */
204     const URL_AQL_USER_FUNCTION = '/_api/aqlfunction';
205 
206     /**
207      * base URL part for user management
208      */
209     const URL_USER = '/_api/user';
210 
211     /**
212      * base URL part for user management
213      */
214     const URL_TRAVERSAL = '/_api/traversal';
215 
216     /**
217      * base URL part for endpoint management
218      */
219     const URL_ENDPOINT = '/_api/endpoint';
220 
221     /**
222      * base URL part for database management
223      */
224     const URL_DATABASE = '/_api/database';
225 
226     /**
227      * URL for AQL query result cache
228      */
229     const URL_QUERY_CACHE = '/_api/query-cache';
230 
231 }
232 
ArangoDB-PHP API Documentation API documentation generated by ApiGen