Merge pull request #36 from neo4j-php/feature/ogm-formatter

OGM Formatter - Graph Data Types

Despite a small bug in the CI, everything works perfectly. Great work!

Author: transistive

.github/workflows/tests.yml

@@ -108,9 +108,10 @@ jobs:
             zip \
             unzip \
             wget \
+            git \
             && docker-php-ext-install -j$(nproc) gd sockets bcmath \
-            && pecl install ds \
-            && docker-php-ext-enable ds
+            && pecl install ds xdebug \
+            && docker-php-ext-enable ds xdebug
       - name: Install Composer
         run: curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
       - name: Install dependencies
@@ -125,7 +126,7 @@ jobs:
               && mv test-reporter-latest-linux-amd64 /usr/bin/cc-test-reporter  \
               && chmod +x /usr/bin/cc-test-reporter \
               && cc-test-reporter before-build \
-              && vendor/bin/phpunit --config phpunit.coverage.xml.dist -d memory_limit=1024M \
+              && XDEBUG_MODE=coverage vendor/bin/phpunit --config phpunit.coverage.xml.dist -d memory_limit=1024M \
               && mkdir -p out/phpunit \
               && cp out/phpunit/clover.xml clover.xml \
               && cc-test-reporter after-build --id ec331dd009edca126a4c27f4921c129de840c8a117643348e3b75ec547661f28 --exit-code 0

.gitignore

@@ -7,3 +7,4 @@ phpunit.xml
 clover.xml
 cc-test-reporter
 /run-pipeline.sh
+composer.lock

.php-cs-fixer.php

@@ -11,6 +11,8 @@
  * file that was distributed with this source code.
  */
 
+use PhpCsFixer\Config;
+
 $header = <<<'EOF'
 This file is part of the Laudis Neo4j package.
 
@@ -30,7 +32,7 @@
     exit(1);
 }
 
-return PhpCsFixer\Config::create()
+return (new Config())
     ->setRules([
         '@Symfony' => true,
 

Dockerfile

@@ -10,14 +10,14 @@ RUN apt-get update && apt-get install -y \
         git \
         wget \
     && docker-php-ext-install -j$(nproc) gd sockets bcmath \
-    && pecl install ds pcov xdebug \
-    && docker-php-ext-enable ds xdebug \
+    && pecl install ds pcov \
+    && docker-php-ext-enable ds \
     && wget https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 \
     && mv test-reporter-latest-linux-amd64 /usr/bin/cc-test-reporter  \
-    && chmod +x /usr/bin/cc-test-reporter \
-    && echo "xdebug.mode=debug" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
-    && echo "xdebug.client_host=127.0.0.1" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
-    && echo "xdebug.client_port=9003" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
+    && chmod +x /usr/bin/cc-test-reporter
+
+RUN pecl install xdebug \
+    && docker-php-ext-enable xdebug
 
 RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 

README.md

@@ -190,7 +190,66 @@ $tsx->commit([Statement::create('MATCH (x) RETURN x LIMIT 100')]);
 
 ## Accessing the results
 
-> TODO: Rewrite this as the new standard will be the OGM.
+Results are returned in a standard format of rows and columns:
+
+```php
+// Results are a CypherList
+$results = $client->run('MATCH (node:Node) RETURN node, node.id AS id');
+
+// A row is a CypherMap
+foreach ($results as $result) {
+    // Returns a Node
+    $node = $result->get('node');
+
+    echo $node->getAttribute('id');
+    echo $result->get('id');
+}
+```
+
+Cypher values and types are mapped to php types and classes:
+
+|Cypher|Php|
+|---|---|
+|null|`null`|
+|string|`string`|
+|integer|`int`|
+|float|`float`|
+|boolean|`bool`|
+|Map|`\Laudis\Neo4j\Types\CypherMap`|
+|List|`\Laudis\Neo4j\Types\CypherList`|
+|Point|`\Laudis\Neo4j\Contracts\PointInterface` *|
+|Date|`\Laudis\Neo4j\Types\Date`|
+|Time|`\Laudis\Neo4j\Types\Time`|
+|LocalTime|`\Laudis\Neo4j\Types\LocalTime`|
+|DateTime|`\Laudis\Neo4j\Types\DateTime`|
+|LocalDateTime|`\Laudis\Neo4j\Types\LocalDateTime`|
+|Duration|`\Laudis\Neo4j\Types\Duration`|
+|Node|`\Laudis\Neo4j\Types\Node`|
+|Relationship|`\Laudis\Neo4j\Types\Relationship`|
+|Path|`\Laudis\Neo4j\Types\Path`|
+
+(*) A point can be one of four types implementing PointInterface: `\Laudis\Neo4j\Types\CartesianPoint` `\Laudis\Neo4j\Types\Cartesian3DPoint` `\Laudis\Neo4j\Types\WGS84Point` `\Laudis\Neo4j\Types\WGS843DPoint`
+
+If you want the results to be just a set of rows, columns, arrays and scalar types you can use a BasicFormatter:
+
+```php
+use Laudis\Neo4j\ClientBuilder;
+use Laudis\Neo4j\Formatter\BasicFormatter;
+
+$client = ClientBuilder::create()->withFormatter(BasicFormatter::class)->build();
+
+// Results are a CypherList
+$results = $client->run('MATCH (node:Node) RETURN node, node.id AS id');
+
+// A row is a CypherMap
+foreach ($results as $result) {
+    // Returns an array of attributes instead of a Node.
+    $node = $result->get('node');
+
+    echo $node['id'];
+    echo $result->get('id');
+}
+```
 
 ## Diving Deeper