First working version

Author: TeddyBear06

.gitignore

@@ -0,0 +1,5 @@
+composer.lock
+phpunit
+.phpunit*
+phpunit.xml
+vendor/

README.md

@@ -0,0 +1,66 @@
+# Unofficial EdgeDB PHP client
+
+Not - yet - ready for production as it needs review from the community.
+
+## Quickstart
+
+Add this package to your project:
+
+```bash
+$ composer require teddybear06/edgedb-php
+```
+
+Require Composer's autoloader (if it's not already done):
+
+```php
+require 'vendor/autoload.php';
+```
+
+Require two needed classes:
+
+```php
+use TeddyBear06\EdgeDbPhp\EdgeDbClient;
+use TeddyBear06\EdgeDbPhp\EdgeDbQuery;
+```
+
+Create an new EdgeDbClient with your EdgeDB server configuration:
+
+```php
+$edgeDbClient = new EdgeDbClient('127.0.0.1', '10700', 'edgedb');
+```
+
+Create an EdgeDbQuery:
+
+```php
+$edgeDbQuery = new EdgeDbQuery('select Author {firstname} filter .firstname = <str>$firstname;', ['firstname' => 'John']);
+```
+
+Get the response:
+
+```php
+$edgeDbResponse = $edgeDbClient->send($edgeDbQuery);
+```
+
+Use the response with your own logic:
+
+```php
+if (isset($edgeDbResponse['data'])) {
+    echo $edgeDbResponse['data'][0]['firstname'];
+} else {
+    echo 'No matches...';
+}
+```
+
+## Debug
+
+If needed, you can set an extra parameter to the EdgeDbClient constructor like so:
+
+```php
+$edgeDbClient = new EdgeDbClient('127.0.0.1', '10700', 'edgedb', true);
+```
+
+You will get an extra response index 'debug' and it will activate Guzzle debug mode:
+
+```php
+var_dump($edgeDbResponse['debug']);
+```

composer.json

@@ -6,7 +6,11 @@
         "edgedb"
     ],
     "require": {
-        "php": ">=8.0"
+        "php": ">=8.0",
+        "guzzlehttp/guzzle": "^7.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9"
     },
     "autoload": {
         "psr-4": {

src/EdgeDbClient.php

@@ -0,0 +1,98 @@
+<?php declare(strict_types=1);
+
+namespace TeddyBear06\EdgeDbPhp;
+
+use TeddyBear06\EdgeDbPhp\EdgeDbQuery;
+use GuzzleHttp\Client;
+
+/**
+ * An unofficial naive EdgeDB PHP client using EdgeDB HTTP protocol.
+ * 
+ * See https://www.edgedb.com/docs/clients/90_edgeql/index for more informations about
+ * how to activate it on your EdgeDB instance.
+ */
+class EdgeDbClient {
+
+    /**
+     * EdgeDB hostname (or IP).
+     * 
+     * @var string
+     */
+    private string $hostname;
+
+    /**
+     * EdgeDB port.
+     * 
+     * @var integer
+     */
+    private int $port;
+
+    /**
+     * EdgeDB database name.
+     * 
+     * @var string
+     */
+    private string $database;
+
+    /**
+     * Indicates whether or not the client should display debug infos.
+     * 
+     * @var bool
+     */
+    private bool $debug;
+
+    /**
+     * Guzzle client.
+     * 
+     * @var Client
+     */
+    private $client;
+
+    /**
+     * Creates an EdgeDB PHP client instance.
+     * 
+     * @var string $hostname The EdgeDB server hostname (or IP).
+     * @var int $port The EdgeDB server port.
+     * @var string $database The EdgeDB database name.
+     * @var bool $debug Indicates whether or not the client should display debug infos.
+     */
+    public function __construct(string $hostname = '127.0.0.1', int $port = 10700, string $database = 'edgedb', bool $debug = false)
+    {
+        $this->hostname = $hostname;
+        $this->port = $port;
+        $this->database = $database;
+        $this->debug = $debug;
+        $this->client = new Client([
+            'base_uri' => sprintf('http://%s:%d/db/%s/edgeql', $this->hostname, $this->port, $this->database)
+        ]);
+    }
+
+    /**
+     * Send an HTTP request against an EdgeDB server instance.
+     * 
+     * @var EdgeDbQuery $query The EdgeDB query.
+     * @return array
+     */
+    public function send(EdgeDbQuery $query): array
+    {
+        $options = [
+            'json' => $query->getQuery(),
+            'debug' => $this->debug
+        ];
+
+        $response = $this->client->request('POST', '', $options);
+
+        $body = $response->getBody();
+
+        $json = json_decode($body->__toString(), true);
+
+        if ($this->debug) {
+            $json['debug'] = [
+                'jsonQuery' => $query->getQuery()
+            ];
+        }
+
+        return $json;
+    }
+
+}

src/EdgeDbQuery.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types=1);
+
+namespace TeddyBear06\EdgeDbPhp;
+
+/**
+ * An EdgeDB query helper.
+ */
+class EdgeDbQuery {
+
+    /**
+     * EdgeDB query
+     * @var string
+     */
+    private string $query;
+
+    /**
+     * EdgeDB query's variables
+     * @var \stdClass
+     */
+    private \stdClass $variables;
+
+    /**
+     * Creates an EdgeDB PHP query instance
+     * 
+     * @var string $query The query (see https://www.edgedb.com/docs/edgeql/index)
+     * @var array $variables The variables required by your query
+     */
+    public function __construct(string $query, array $variables = [])
+    {
+        $this->query = $query;
+        $this->variables = (Object) $variables;
+    }
+
+    /**
+     * Generate an array with required EdgeDB fields.
+     * 
+     * @return array
+     */
+    public function getQuery(): array
+    {
+        return [
+            'query' => $this->query,
+            'variables' => $this->variables
+        ];
+    }
+
+}

tests/EdgeDbQueryTest.php

@@ -0,0 +1,24 @@
+<?php declare(strict_types=1);
+
+namespace TeddyBear06\EdgeDbPhp;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+use TeddyBear06\EdgeDbPhp\EdgeDbQuery;
+use PHPUnit\Framework\TestCase;
+
+final class EdgeDbQueryTest extends TestCase
+{
+    public function testSimpleEdgeQueryIsValid(): void
+    {
+        $edgeDbQuery = new EdgeDbQuery('select Author {firstname};');
+
+        $this->assertEquals(
+            $edgeDbQuery->getQuery(),
+            [
+                'query' => 'select Author {firstname};',
+                'variables' => (Object) []
+            ]
+        );
+    }
+}