Skip to content

Commit 617a36c

Browse files
maxkernbachmaxkernbach
authored
Update README.md
1 parent 58a9311 commit 617a36c

File tree

1 file changed

+80
-6
lines changed

1 file changed

+80
-6
lines changed

‎docs/Drivers/PHP/GettingStarted/README.md

Lines changed: 80 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,10 @@ The autoloader will care about loading additionally required classes on the fly.
1313

1414
The ArangoDB PHP client is an API that allows you to send and retrieve documents from ArangoDB from out of your PHP application. The client library itself is written in PHP and has no further dependencies but just plain PHP 5.6 (or higher).
1515

16-
The client library provides document and collection classes you can use to work with documents and collections in an OO fashion. When exchanging document data with the server, the library internally will use the [HTTP REST interface of ArangoDB](https://docs.arangodb.com/HttpApi/index.html). The library user does not have to care about this fact as all the details of the REST interface are abstracted by the client library.
16+
The client library provides document and collection classes you can use to work with documents and collections in an OO fashion. When exchanging document data with the server, the library internally will use the [HTTP REST interface of ArangoDB](../../../HTTP/index.html). The library user does not have to care about this fact as all the details of the REST interface are abstracted by the client library.
1717

1818
## Requirements
1919

20-
* ArangoDB database server version 3.0 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)
21-
2220
* PHP version 5.6 or higher (Travis-tested with PHP 5.6, 7.0, 7.1 and hhvm)
2321

2422
Note on PHP version support:
@@ -27,6 +25,82 @@ This driver will cease to support old PHP versions as soon as they have reached
2725

2826
In general, it is recommended to always use the latest PHP versions (currently those in the PHP 7 line) in order to take advantage of all the improvements (especially in performance).
2927

28+
### Important version information on ArangoDB-PHP
29+
30+
Since version 1.0 of this client, it will closely follow the ArangoDB versioning.
31+
That means that:
32+
33+
- ArangoDB-PHP 3.1.x is on par with the functionality of ArangoDB 3.0.y
34+
- ArangoDB-PHP 3.2.x is on par with the functionality of ArangoDB 3.1.y
35+
etc...
36+
37+
Notice: The third level number of the version is not associated to ArangoDB's third level number, as it states minor updates, bugfixes and patches to the client itself.
38+
39+
40+
<br>
41+
<br>
42+
43+
<a name="interoperability_matrix"></a>
44+
45+
### ArangoDB-PHP Client to ArangoDB Server interoperability matrix ##
46+
#### Current Versions (3.x)
47+
48+
<table>
49+
<tr>
50+
<th width="25%">ArangoDB-PHP&nbsp;Version</th><th width="25%">ArangoDB&nbsp;Version</th><th width="50%">Comments</th>
51+
</tr>
52+
<tr>
53+
<td>3.0.x</td><td>3.0.x through 3.0.x</td><td>This version is not backwards compatible due to changes in ArangoDB's API</td>
54+
</tr>
55+
<tr>
56+
<td>3.1.x</td><td>3.1.x through 3.1.x</td><td>This version is not backwards compatible due to changes in ArangoDB's API</td>
57+
</tr>
58+
<tr>
59+
<td>3.2.x</td><td>3.2.x through 3.2.x</td><td>This version is not backwards compatible due to changes in ArangoDB's API</td>
60+
</tr>
61+
<tr>
62+
<td>3.3.x</td><td>3.3.x through 3.3.x</td><td>This version is not backwards compatible due to changes in ArangoDB's API</td>
63+
</tr>
64+
</table>
65+
<br>
66+
67+
#### Older Versions
68+
69+
<table>
70+
<tr>
71+
<th width="25%">ArangoDB-PHP&nbsp;Version</th><th width="25%">ArangoDB&nbsp;Version</th><th width="100%">Comments</th>
72+
</tr>
73+
<tr>
74+
<td>1.0.0</td><td>1.0.0 through 1.0.4</td><td></td>
75+
</tr>
76+
<tr>
77+
<td>1.0.1</td><td>1.0.0 through 1.0.4</td><td></td>
78+
</tr>
79+
<tr>
80+
<td>1.1.0</td><td>1.1.0 through 1.1.3</td><td></td>
81+
</tr>
82+
<tr>
83+
<td>1.2.0</td><td>1.2.0 through 1.2.1</td><td></td>
84+
</tr>
85+
<tr>
86+
<td>1.2.1</td><td>1.2.2 through 1.2.3</td><td>This client version provides support for ArangoDB's autoincrement functionality. (ArangoDB Version 1.2.2+)</td>
87+
</tr>
88+
<tr>
89+
<td>1.3.0</td><td>1.3.0 through 1.3.3</td><td>Provides support for Transactions, Auto-Increment, AQL User Functions and the new statistics interface.</td>
90+
</tr>
91+
<tr>
92+
<td>1.3.1</td><td>1.3.0 through 1.3.3</td><td>Added Tracer & simple/all API equvalent. Some Performance fixes. improved docs</td>
93+
</tr>
94+
<tr>
95+
<td>1.4.0</td><td>1.4.0 through 1.4.x</td><td>Multi-Database, Traversal API + others</td>
96+
</tr>
97+
<tr>
98+
<td>2.x.x</td><td>2.0.0 through 2.x.x</td><td></td>
99+
</tr>
100+
</table>
101+
102+
103+
30104
### Installing the PHP client
31105

32106
To get started you need PHP 5.6 or higher plus an ArangoDB server running on any host that you can access.
@@ -36,12 +110,12 @@ There are two alternative ways to get the ArangoDB PHP client:
36110
* Using Composer
37111
* Cloning the git repository
38112

39-
### Alternative 1: Using Composer
113+
#### Alternative 1: Using Composer
40114

41115
```
42116
composer require triagens/arangodb
43117
```
44-
### Alternative 2: Cloning the git repository
118+
#### Alternative 2: Cloning the git repository
45119

46120
When preferring this alternative, you need to have a git client installed. To clone the ArangoDB PHP client repository from github, execute the following command in your project directory:
47121

@@ -58,7 +132,7 @@ require 'arangodb-php/autoload.php';
58132

59133
The ArangoDB PHP client's autoloader will only care about its own class files and will not handle any other files. That means it is fully nestable with other autoloaders.
60134

61-
### Alternative 3: Invoking the autoloader directly
135+
#### Alternative 3: Invoking the autoloader directly
62136

63137
If you do not wish to include autoload.php to load and setup the autoloader, you can invoke the autoloader directly:
64138

0 commit comments

Comments
 (0)