refactor: unified package api. Manager classes can now be called through helper functions on the client (i.e. schema())

feat: added query statement handling

fix: improved exception handling

build: removed unnecessary dto package.

docs: updated README.md

Author: LaravelFreelancerNL

README.md

@@ -1,6 +1,6 @@
 # ArangoDB PHP client
 
-Low level PHP client for ArangoDB. Supports PHP versions 7 & 8.
+Low level PHP client for ArangoDB. Supports PHP versions 7.4 & ^8.0
 
 ![Github CI tests](https://github.com/LaravelFreelancerNL/arangodb-php-client/workflows/CI%20tests/badge.svg)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/LaravelFreelancerNL/arangodb-php-client/badges/quality-score.png?b=next)](https://scrutinizer-ci.com/g/LaravelFreelancerNL/arangodb-php-client/?branch=next)
@@ -16,27 +16,56 @@ composer require laravel-freelancer-nl/arangodb-php-client
 ```
 ## Quickstart
 
+### Create a new client
+``` 
+$client = new ArangoClient($config);
 ``` 
-// Create a new connector        
-$this->connector = new Connector($config);
 
-//Create the domain clients that suit your purpose and pass the connector to the client.
-$this->schemaClient = new SchemaClient($this->connector);
+### Create a collection
+Use the schemaManager to create a new collection.
+``` 
+$client->schema()->createCollection('users');
+``` 
 
-//Create a database
-$this->schemaClient->createDatabase('MyKillahProject');
+### Get documents from the collection
+``` 
+$statement = $client->prepare('FOR user in Users RETURN user');
+$statement->execute();
+$users = $statement->fetchAll(); 
 ```
+As there are no users yet in the above example this will yield an empty result.
+Note that this client does not have any preconceptions about the data structure 
+and thus everything is returned as raw arrays.
 
 ### config
 The connector has a default configuration for a local ArangoDB instance at it's default port (8529).
 
-## Client domains
-### AdministrationClient
-Manages administrative functions
+## AQL statements
+To run AQL queries you prepare a query, execute it and fetch the results. Much like PHP's PDO extension.
+
+``` 
+$statement = $client->prepare('FOR user in users RETURN user');
+$statement->execute();
+$users = $statement->fetchAll(); 
+```
 
+## Managers
+You have access to several managers that allow you to perform specific tasks on your ArangoDB instance(s).
 
-### SchemaClient
-Manages schema related tasks like creating databases, collections, indexes, views and graphs
+(ArangoDB's endpoints are mapped to these managers in a semantically functional manner. Therefore a manager
+may have functionality from different endpoints within ArangoDB's HTTP API.)
+
+### Admin
+Manages administrative functions to manage the server/cluster and retrieve server level information. 
+``` 
+$client->admin()->getVersion();
+``` 
+
+### Schema
+The schema manager allows you perform tasks like creating databases, collections, indexes, views and graphs
+``` 
+$client->schema()->createCollection('users');
+``` 
 
 ## Related packages
 [AQL query builder](https://github.com/LaravelFreelancerNL/fluentaql)

composer.json

@@ -19,16 +19,14 @@
         "php": "^7.4|^8.0",
         "ext-json": "*",
         "guzzlehttp/guzzle": "^7.2",
-        "spatie/data-transfer-object": "^2.8",
         "halaxa/json-machine": "^0.6.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
         "phpstan/phpstan": "^0.12.82",
         "phpmd/phpmd": "^2.9",
         "vimeo/psalm": "^4.6",
-        "squizlabs/php_codesniffer": "^3.5",
-        "sebastian/phpcpd": "^6.0"
+        "squizlabs/php_codesniffer": "^3.5"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -2,26 +2,26 @@
 
 declare(strict_types=1);
 
-namespace ArangoClient\Administration;
+namespace ArangoClient\Admin;
 
-use ArangoClient\Connector;
+use ArangoClient\ArangoClient;
 use ArangoClient\Exceptions\ArangoException;
-use GuzzleHttp\Exception\GuzzleException;
+use ArangoClient\Manager;
 
-class AdministrationClient
+class AdminManager extends Manager
 {
     /**
-     * @var Connector
+     * @var ArangoClient
      */
-    protected Connector $connector;
+    protected ArangoClient $arangoClient;
 
     /**
      * Documents constructor.
-     * @param  Connector  $connector
+     * @param  ArangoClient  $arangoClient
      */
-    public function __construct(Connector $connector)
+    public function __construct(ArangoClient $arangoClient)
     {
-        $this->connector = $connector;
+        $this->arangoClient = $arangoClient;
     }
 
     /**
@@ -32,11 +32,10 @@ public function __construct(Connector $connector)
      * @return array<mixed>
      *
      * @throws ArangoException
-     * @throws GuzzleException
      */
-    public function version(bool $details = false): array
+    public function getVersion(bool $details = false): array
     {
-        return (array) $this->connector->request(
+        return $this->arangoClient->request(
             'get',
             '/_api/version',
             [