Skip to content

Commit 8de9e04

Browse files
author
Jan Steemann
committed
more formatting [skip ci]
1 parent 1856563 commit 8de9e04

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ Please take a look [here](https://github.com/arangodb/arangodb-php/wiki/Importan
4848
# Description
4949

5050
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.
5252
There is an example for REST-based documents access in the file examples/document.php.
5353

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.
5555
There is an example for this kind of statements in the file examples/select.php.
5656

5757
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
6868
<a name="requirements"></a>
6969
# Requirements
7070

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)
7272

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)
7474

7575
<br>
7676

@@ -319,7 +319,7 @@ var_dump($id);
319319

320320
Document properties can be set by using the set() method, or by directly manipulating the document properties.
321321

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.
323323

324324
<a name="adding_exception_handling"></a>
325325
## Adding exception handling
@@ -359,7 +359,7 @@ try {
359359
<a name="retrieving_document"></a>
360360
## Retrieving a document
361361

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().
363363

364364
```php
365365
// get the document back from the server
@@ -415,7 +415,7 @@ Note that getByExample() might return multiple documents if the example is ambig
415415
## Updating a document
416416

417417

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.
419419

420420
```php
421421
// update a document
@@ -443,7 +443,7 @@ var_dump($result);
443443
<a name="deleting_document"></a>
444444
## Deleting a document
445445

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:
447447

448448
```php
449449
// remove a document on the server, using a document object
@@ -465,7 +465,7 @@ var_dump($result);
465465
## Running an AQL query
466466

467467

468-
To run an AQL query, use the Statement class:
468+
To run an AQL query, use the *Statement* class:
469469

470470

471471
```php
@@ -502,8 +502,8 @@ var_dump($cursor->getExtra());
502502
## Exporting data
503503

504504

505-
To export the contents of a collection to PHP, use the Export class.
506-
The Export class will create a light-weight cursor over all documents
505+
To export the contents of a collection to PHP, use the *Export* class.
506+
The *Export* class will create a light-weight cursor over all documents
507507
of the specified collection. The results can be transferred to PHP
508508
in chunks incrementally. This is the most efficient way of iterating
509509
over all documents in a collection.
@@ -579,7 +579,7 @@ var_dump($result);
579579
## Dropping a collection
580580

581581

582-
To drop an existing collection on the server, use the drop() method of the CollectionHandler class.
582+
To drop an existing collection on the server, use the drop() method of the *CollectionHandler* class.
583583
drop() just needs the name of the collection name to be dropped:
584584

585585
```php

0 commit comments

Comments
 (0)