WIP

Author: exaby73

README.md

@@ -308,21 +308,16 @@ composer require nyholm/psr7 nyholm/psr7-server kriswallsmith/buzz
 
 ## Result formats/hydration
 
-In order to make the results of the bolt protocol and the http uniform, the driver provides result formatters (aka hydrators). The client is configurable with these formatters. You can even implement your own.
+In order to make the results of the bolt protocol and the http uniform, the driver provides a summarizes the results.
 
-The default formatter is the `\Laudis\Neo4j\Formatters\OGMFormatter`, which is explained extensively in [the result format section](#accessing-the-results).
+The default formatter is the `\Laudis\Neo4j\Formatters\SummarizedResultFormatter`, which is explained extensively in [the result format section](#accessing-the-results).
 
-The driver provides three formatters by default, which are all found in the Formatter namespace:
- - `\Laudis\Neo4j\Formatter\BasicFormatter` which erases all the Cypher types and simply returns every value in the resulting map as a [scalar](https://www.php.net/manual/en/function.is-scalar.php), null or array value.
- - `\Laudis\Neo4j\Formatter\OGMFormatter` which maps the cypher types to php types as explained [here](#accessing-the-results).
- - `\Laudis\Neo4j\Formatter\SummarizedResultFormatter` which decorates any formatter and adds an extensive result summary.
+`\Laudis\Neo4j\Formatter\SummarizedResultFormatter` adds an extensive result summary.
 
 The client builder provides an easy way to change the formatter:
 
 ```php
-$client = \Laudis\Neo4j\ClientBuilder::create()
-    ->withFormatter(\Laudis\Neo4j\Formatter\SummarizedResultFormatter::create())
-    ->build();
+$client = \Laudis\Neo4j\ClientBuilder::create()->build();
 
 /**
  * The client will now return a result, decorated with a summary.
@@ -339,8 +334,6 @@ $summary = $summarisedResult->getSummary();
 $result = $summarisedResult->getResult();
 ```
 
-In order to use a custom formatter, implement the `Laudis\Neo4j\Contracts\FormatterInterface` and provide it when using the client builder.
-
 ## Concepts
 
 The driver API described [here](https://neo4j.com/docs/driver-manual/current/) is the main target of the driver. Because of this, the client is nothing more than a driver manager. The driver creates sessions. A session runs queries through a transaction.

src/Basic/UnmanagedTransaction.php

@@ -33,17 +33,12 @@ public function __construct(
 
     /**
      * @param iterable<string, mixed> $parameters
-     *
-     * @return SummarizedResult<CypherMap>
      */
     public function run(string $statement, iterable $parameters = []): SummarizedResult
     {
         return $this->tsx->run($statement, $parameters);
     }
 
-    /**
-     * @return SummarizedResult<CypherMap>
-     */
     public function runStatement(Statement $statement): SummarizedResult
     {
         return $this->tsx->runStatement($statement);
@@ -52,7 +47,7 @@ public function runStatement(Statement $statement): SummarizedResult
     /**
      * @param iterable<Statement> $statements
      *
-     * @return CypherList<SummarizedResult<CypherMap>>
+     * @return CypherList<SummarizedResult>
      */
     public function runStatements(iterable $statements): CypherList
     {
@@ -62,7 +57,7 @@ public function runStatements(iterable $statements): CypherList
     /**
      * @param iterable<Statement> $statements
      *
-     * @return CypherList<SummarizedResult<CypherMap>>
+     * @return CypherList<SummarizedResult>
      */
     public function commit(iterable $statements = []): CypherList
     {

src/Bolt/BoltConnection.php

@@ -27,13 +27,13 @@
 use Laudis\Neo4j\Common\Neo4jLogger;
 use Laudis\Neo4j\Contracts\AuthenticateInterface;
 use Laudis\Neo4j\Contracts\ConnectionInterface;
-use Laudis\Neo4j\Contracts\FormatterInterface;
 use Laudis\Neo4j\Databags\BookmarkHolder;
 use Laudis\Neo4j\Databags\DatabaseInfo;
 use Laudis\Neo4j\Databags\Neo4jError;
 use Laudis\Neo4j\Enum\AccessMode;
 use Laudis\Neo4j\Enum\ConnectionProtocol;
 use Laudis\Neo4j\Exception\Neo4jException;
+use Laudis\Neo4j\Formatter\SummarizedResultFormatter;
 use Laudis\Neo4j\Types\CypherList;
 use Psr\Http\Message\UriInterface;
 use Psr\Log\LogLevel;
@@ -42,7 +42,7 @@
 /**
  * @implements ConnectionInterface<array{0: V4_4|V5|V5_1|V5_2|V5_3|V5_4|null, 1: Connection}>
  *
- * @psalm-import-type BoltMeta from FormatterInterface
+ * @psalm-import-type BoltMeta from SummarizedResultFormatter
  */
 class BoltConnection implements ConnectionInterface
 {

src/Bolt/BoltUnmanagedTransaction.php

@@ -14,14 +14,14 @@
 namespace Laudis\Neo4j\Bolt;
 
 use Bolt\enum\ServerState;
-use Laudis\Neo4j\Contracts\FormatterInterface;
 use Laudis\Neo4j\Contracts\UnmanagedTransactionInterface;
 use Laudis\Neo4j\Databags\BookmarkHolder;
 use Laudis\Neo4j\Databags\SessionConfiguration;
 use Laudis\Neo4j\Databags\Statement;
 use Laudis\Neo4j\Databags\TransactionConfiguration;
 use Laudis\Neo4j\Enum\TransactionState;
 use Laudis\Neo4j\Exception\ClientException;
+use Laudis\Neo4j\Formatter\SummarizedResultFormatter;
 use Laudis\Neo4j\ParameterHelper;
 use Laudis\Neo4j\Types\AbstractCypherSequence;
 use Laudis\Neo4j\Types\CypherList;
@@ -37,22 +37,19 @@
  *
  * @implements UnmanagedTransactionInterface<T>
  *
- * @psalm-import-type BoltMeta from FormatterInterface
+ * @psalm-import-type BoltMeta from SummarizedResultFormatter
  */
 final class BoltUnmanagedTransaction implements UnmanagedTransactionInterface
 {
     private TransactionState $state = TransactionState::ACTIVE;
 
-    /**
-     * @param FormatterInterface<T> $formatter
-     */
     public function __construct(
         /** @psalm-readonly */
         private readonly ?string $database,
         /**
          * @psalm-readonly
          */
-        private readonly FormatterInterface $formatter,
+        private readonly SummarizedResultFormatter $formatter,
         /** @psalm-readonly */
         private readonly BoltConnection $connection,
         private readonly SessionConfiguration $config,

src/Bolt/Session.php

@@ -18,27 +18,24 @@
 use Laudis\Neo4j\Common\Neo4jLogger;
 use Laudis\Neo4j\Common\TransactionHelper;
 use Laudis\Neo4j\Contracts\ConnectionPoolInterface;
-use Laudis\Neo4j\Contracts\FormatterInterface;
 use Laudis\Neo4j\Contracts\SessionInterface;
 use Laudis\Neo4j\Contracts\TransactionInterface;
 use Laudis\Neo4j\Contracts\UnmanagedTransactionInterface;
 use Laudis\Neo4j\Databags\Bookmark;
 use Laudis\Neo4j\Databags\BookmarkHolder;
 use Laudis\Neo4j\Databags\SessionConfiguration;
 use Laudis\Neo4j\Databags\Statement;
+use Laudis\Neo4j\Databags\SummarizedResult;
 use Laudis\Neo4j\Databags\TransactionConfiguration;
 use Laudis\Neo4j\Enum\AccessMode;
 use Laudis\Neo4j\Exception\Neo4jException;
+use Laudis\Neo4j\Formatter\SummarizedResultFormatter;
 use Laudis\Neo4j\Neo4j\Neo4jConnectionPool;
 use Laudis\Neo4j\Types\CypherList;
 use Psr\Log\LogLevel;
 
 /**
  * A session using bolt connections.
- *
- * @template ResultFormat
- *
- * @implements SessionInterface<ResultFormat>
  */
 final class Session implements SessionInterface
 {
@@ -47,7 +44,6 @@ final class Session implements SessionInterface
 
     /**
      * @param ConnectionPool|Neo4jConnectionPool $pool
-     * @param FormatterInterface<ResultFormat>   $formatter
      *
      * @psalm-mutation-free
      */
@@ -58,7 +54,7 @@ public function __construct(
         /**
          * @psalm-readonly
          */
-        private readonly FormatterInterface $formatter
+        private readonly SummarizedResultFormatter $formatter
     ) {
         $this->bookmarkHolder = new BookmarkHolder(Bookmark::from($config->getBookmarks()));
     }
@@ -84,12 +80,12 @@ public function openTransaction(?iterable $statements = null, ?TransactionConfig
         return $this->beginTransaction($statements, $this->mergeTsxConfig($config));
     }
 
-    public function runStatement(Statement $statement, ?TransactionConfiguration $config = null)
+    public function runStatement(Statement $statement, ?TransactionConfiguration $config = null): SummarizedResult
     {
         return $this->runStatements([$statement], $config)->first();
     }
 
-    public function run(string $statement, iterable $parameters = [], ?TransactionConfiguration $config = null)
+    public function run(string $statement, iterable $parameters = [], ?TransactionConfiguration $config = null): SummarizedResult
     {
         return $this->runStatement(new Statement($statement, $parameters), $config);
     }
@@ -133,7 +129,7 @@ public function beginTransaction(?iterable $statements = null, ?TransactionConfi
     }
 
     /**
-     * @return UnmanagedTransactionInterface<ResultFormat>
+     * @return UnmanagedTransactionInterface
      */
     private function beginInstantTransaction(
         SessionConfiguration $config,

src/Common/DriverSetupManager.php

@@ -22,11 +22,11 @@
 use InvalidArgumentException;
 use Laudis\Neo4j\Authentication\Authenticate;
 use Laudis\Neo4j\Contracts\DriverInterface;
-use Laudis\Neo4j\Contracts\FormatterInterface;
 use Laudis\Neo4j\Databags\DriverConfiguration;
 use Laudis\Neo4j\Databags\DriverSetup;
 use Laudis\Neo4j\Databags\SessionConfiguration;
 use Laudis\Neo4j\DriverFactory;
+use Laudis\Neo4j\Formatter\SummarizedResultFormatter;
 
 use const PHP_INT_MIN;
 
@@ -51,11 +51,9 @@ class DriverSetupManager implements Countable
 
     /**
      * @psalm-mutation-free
-     *
-     * @param FormatterInterface<ResultFormat> $formatter
      */
     public function __construct(
-        private FormatterInterface $formatter,
+        private SummarizedResultFormatter $formatter,
         private DriverConfiguration $configuration
     ) {}
 
@@ -193,7 +191,7 @@ public function count(): int
      *
      * @psalm-mutation-free
      */
-    public function withFormatter(FormatterInterface $formatter): self
+    public function withFormatter(SummarizedResultFormatter $formatter): self
     {
         $tbr = clone $this;
         $tbr->formatter = $formatter;

src/Contracts/ClientInterface.php

@@ -14,15 +14,11 @@
 namespace Laudis\Neo4j\Contracts;
 
 use Laudis\Neo4j\Databags\Statement;
+use Laudis\Neo4j\Databags\SummarizedResult;
 use Laudis\Neo4j\Databags\TransactionConfiguration;
 use Laudis\Neo4j\Exception\Neo4jException;
 use Laudis\Neo4j\Types\CypherList;
 
-/**
- * @template ResultFormat
- *
- * @extends TransactionInterface<ResultFormat>
- */
 interface ClientInterface extends TransactionInterface
 {
     /**
@@ -31,19 +27,15 @@ interface ClientInterface extends TransactionInterface
      * @param iterable<string, mixed> $parameters
      *
      * @throws Neo4jException
-     *
-     * @return ResultFormat
      */
-    public function run(string $statement, iterable $parameters = [], ?string $alias = null);
+    public function run(string $statement, iterable $parameters = [], ?string $alias = null): SummarizedResult;
 
     /**
      * Runs a one off transaction with the provided statement over the connection with the provided alias or the master alias otherwise.
      *
      * @throws Neo4jException
-     *
-     * @return ResultFormat
      */
-    public function runStatement(Statement $statement, ?string $alias = null);
+    public function runStatement(Statement $statement, ?string $alias = null): SummarizedResult;
 
     /**
      * Runs a one off transaction with the provided statements over the connection with the provided alias or the master alias otherwise.
@@ -52,7 +44,7 @@ public function runStatement(Statement $statement, ?string $alias = null);
      *
      * @throws Neo4jException
      *
-     * @return CypherList<ResultFormat>
+     * @return CypherList<mixed>
      */
     public function runStatements(iterable $statements, ?string $alias = null): CypherList;
 
@@ -62,17 +54,13 @@ public function runStatements(iterable $statements, ?string $alias = null): Cyph
      * @param iterable<Statement>|null $statements
      *
      * @throws Neo4jException
-     *
-     * @return UnmanagedTransactionInterface<ResultFormat>
      */
     public function beginTransaction(?iterable $statements = null, ?string $alias = null, ?TransactionConfiguration $config = null): UnmanagedTransactionInterface;
 
     /**
      * Gets the driver with the provided alias. Gets the default driver if no alias is provided.
      *
      * The driver is guaranteed to have its connectivity verified at least once during its lifetime.
-     *
-     * @return DriverInterface<ResultFormat>
      */
     public function getDriver(?string $alias): DriverInterface;
 
@@ -84,7 +72,7 @@ public function hasDriver(string $alias): bool;
     /**
      * @template U
      *
-     * @param callable(TransactionInterface<ResultFormat>):U $tsxHandler
+     * @param callable(TransactionInterface):U $tsxHandler
      *
      * @return U
      */
@@ -93,7 +81,7 @@ public function writeTransaction(callable $tsxHandler, ?string $alias = null, ?T
     /**
      * @template U
      *
-     * @param callable(TransactionInterface<ResultFormat>):U $tsxHandler
+     * @param callable(TransactionInterface):U $tsxHandler
      *
      * @return U
      */
@@ -104,7 +92,7 @@ public function readTransaction(callable $tsxHandler, ?string $alias = null, ?Tr
      *
      * @template U
      *
-     * @param callable(TransactionInterface<ResultFormat>):U $tsxHandler
+     * @param callable(TransactionInterface):U $tsxHandler
      *
      * @return U
      */