You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,10 +48,10 @@ Please take a look [here](https://github.com/arangodb/arangodb-php/wiki/Importan
48
48
# Description
49
49
50
50
This PHP client allows REST-based access to documents on the server.
51
-
The ArangoDocumentHandler class should be used for these purposes.
51
+
The *DocumentHandler* class should be used for these purposes.
52
52
There is an example for REST-based documents access in the file examples/document.php.
53
53
54
-
Furthermore, the PHP client also allows to issue more AQL complex queries using the ArangoStatement class.
54
+
Furthermore, the PHP client also allows to issue more AQL complex queries using the *Statement* class.
55
55
There is an example for this kind of statements in the file examples/select.php.
56
56
57
57
To use the PHP client, you must include the file autoloader.php from the main directory.
@@ -68,9 +68,9 @@ The client library provides document and collection classes you can use to work
68
68
<aname="requirements"></a>
69
69
# Requirements
70
70
71
-
* ArangoDB database server version 1.4 or higher. Detailed info [here](https://github.com/arangodb/arangodb-php/wiki/Important-versioning-information-on-ArangoDB-PHP#arangodb-php-client-to-arangodb-server-interoperability-matrix))
71
+
* ArangoDB database server version 1.4 or higher. Detailed info [here](https://github.com/arangodb/arangodb-php/wiki/Important-versioning-information-on-ArangoDB-PHP#arangodb-php-client-to-arangodb-server-interoperability-matrix)
72
72
73
-
* PHP version 5.3 or higher (Travis-tested with 5.4, 5.5, 5.6, 7 and hhvm)
73
+
* PHP version 5.3 or higher (Travis-tested with PHP 5.3, 5.4, 5.5, 5.6, 7 and hhvm)
74
74
75
75
<br>
76
76
@@ -319,7 +319,7 @@ var_dump($id);
319
319
320
320
Document properties can be set by using the set() method, or by directly manipulating the document properties.
321
321
322
-
As you can see, sending a document to the server is achieved by calling the add() method on the client library's DocumentHandler class. It needs the collection name ("users" in this case") plus the document object to be added. add() will return the document id as created by the server. The id is a numeric value that might or might not fit in a PHP integer.
322
+
As you can see, sending a document to the server is achieved by calling the add() method on the client library's *DocumentHandler* class. It needs the collection name ("users" in this case") plus the document object to be added. add() will return the document id as created by the server. The id is a numeric value that might or might not fit in a PHP integer.
323
323
324
324
<aname="adding_exception_handling"></a>
325
325
## Adding exception handling
@@ -359,7 +359,7 @@ try {
359
359
<aname="retrieving_document"></a>
360
360
## Retrieving a document
361
361
362
-
To retrieve a document from the server, the get() method of the DocumentHandler class can be used. It needs the collection name plus a document id. There is also the getById() method which is an alias for get().
362
+
To retrieve a document from the server, the get() method of the *DocumentHandler* class can be used. It needs the collection name plus a document id. There is also the getById() method which is an alias for get().
363
363
364
364
```php
365
365
// get the document back from the server
@@ -415,7 +415,7 @@ Note that getByExample() might return multiple documents if the example is ambig
415
415
## Updating a document
416
416
417
417
418
-
To update an existing document, the update() method of the DocumentHandler class can be used.
418
+
To update an existing document, the update() method of the *DocumentHandler* class can be used.
419
419
420
420
```php
421
421
// update a document
@@ -443,7 +443,7 @@ var_dump($result);
443
443
<aname="deleting_document"></a>
444
444
## Deleting a document
445
445
446
-
To remove an existing document on the server, the remove() method of the DocumentHandler class will do. remove() just needs the document to be removed as a parameter:
446
+
To remove an existing document on the server, the remove() method of the *DocumentHandler* class will do. remove() just needs the document to be removed as a parameter:
447
447
448
448
```php
449
449
// remove a document on the server, using a document object
0 commit comments