feat: Explicitly mark formatter as nullable

exaby73 · exaby73 · commit a25cbccfc55b · 2024-10-30T12:46:42.000+05:30
diff --git a/src/Bolt/BoltDriver.php b/src/Bolt/BoltDriver.php
@@ -65,7 +65,7 @@ public function __construct(
      *
      * @psalm-suppress MixedReturnTypeCoercion
      */
-    public static function create(string|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, FormatterInterface $formatter = null): self
+    public static function create(string|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, ?FormatterInterface $formatter = null): self
     {
         if (is_string($uri)) {
             $uri = Uri::create($uri);
diff --git a/src/Bolt/Session.php b/src/Bolt/Session.php
@@ -76,7 +76,7 @@ public function runStatements(iterable $statements, ?TransactionConfiguration $c
     /**
      * @param iterable<Statement>|null $statements
      */
-    public function openTransaction(iterable $statements = null, ?TransactionConfiguration $config = null): UnmanagedTransactionInterface
+    public function openTransaction(?iterable $statements = null, ?TransactionConfiguration $config = null): UnmanagedTransactionInterface
     {
         return $this->beginTransaction($statements, $this->mergeTsxConfig($config));
     }
diff --git a/src/Common/GeneratorHelper.php b/src/Common/GeneratorHelper.php
@@ -30,7 +30,7 @@ final class GeneratorHelper
      *
      * @return T
      */
-    public static function getReturnFromGenerator(Generator $generator, float $timeout = null)
+    public static function getReturnFromGenerator(Generator $generator, ?float $timeout = null)
     {
         $start = microtime(true);
         while ($generator->valid()) {
diff --git a/src/Databags/HttpPsrBindings.php b/src/Databags/HttpPsrBindings.php
@@ -47,7 +47,7 @@ final class HttpPsrBindings
      * @param callable():StreamFactoryInterface|StreamFactoryInterface|null   $streamFactory
      * @param callable():RequestFactoryInterface|RequestFactoryInterface|null $requestFactory
      */
-    public function __construct(callable|ClientInterface|null $client = null, callable|StreamFactoryInterface $streamFactory = null, callable|RequestFactoryInterface $requestFactory = null)
+    public function __construct(callable|ClientInterface|null $client = null, callable|StreamFactoryInterface|null $streamFactory = null, callable|RequestFactoryInterface|null $requestFactory = null)
     {
         $this->client = $client ?? static fn (): ClientInterface => Psr18ClientDiscovery::find();
         $this->streamFactory = $streamFactory ?? static fn (): StreamFactoryInterface => Psr17FactoryDiscovery::findStreamFactory();
@@ -61,7 +61,7 @@ public function __construct(callable|ClientInterface|null $client = null, callab
      * @param callable():StreamFactoryInterface|StreamFactoryInterface|null   $streamFactory
      * @param callable():RequestFactoryInterface|RequestFactoryInterface|null $requestFactory
      */
-    public static function create(callable|ClientInterface $client = null, callable|StreamFactoryInterface $streamFactory = null, callable|RequestFactoryInterface $requestFactory = null): self
+    public static function create(callable|ClientInterface|null $client = null, callable|StreamFactoryInterface|null $streamFactory = null, callable|RequestFactoryInterface|null $requestFactory = null): self
     {
         return new self($client, $streamFactory, $requestFactory);
     }
diff --git a/src/DriverFactory.php b/src/DriverFactory.php
@@ -45,7 +45,7 @@ final class DriverFactory
      *           : DriverInterface<OGMResults>
      *           )
      */
-    public static function create(string|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, FormatterInterface $formatter = null): DriverInterface
+    public static function create(string|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, ?FormatterInterface $formatter = null): DriverInterface
     {
         if (is_string($uri)) {
             $uri = Uri::create($uri);
@@ -76,7 +76,7 @@ public static function create(string|UriInterface $uri, ?DriverConfiguration $co
      *           : DriverInterface<OGMResults>
      *           )
      */
-    private static function createBoltDriver(string|UriInterface $uri, ?DriverConfiguration $configuration, ?AuthenticateInterface $authenticate, FormatterInterface $formatter = null): DriverInterface
+    private static function createBoltDriver(string|UriInterface $uri, ?DriverConfiguration $configuration, ?AuthenticateInterface $authenticate, ?FormatterInterface $formatter = null): DriverInterface
     {
         if ($formatter !== null) {
             return BoltDriver::create($uri, $configuration, $authenticate, $formatter);
@@ -96,7 +96,7 @@ private static function createBoltDriver(string|UriInterface $uri, ?DriverConfig
      *           : DriverInterface<OGMResults>
      *           )
      */
-    private static function createNeo4jDriver(string|UriInterface $uri, ?DriverConfiguration $configuration, ?AuthenticateInterface $authenticate, FormatterInterface $formatter = null): DriverInterface
+    private static function createNeo4jDriver(string|UriInterface $uri, ?DriverConfiguration $configuration, ?AuthenticateInterface $authenticate, ?FormatterInterface $formatter = null): DriverInterface
     {
         if ($formatter !== null) {
             return Neo4jDriver::create($uri, $configuration, $authenticate, $formatter);
@@ -118,7 +118,7 @@ private static function createNeo4jDriver(string|UriInterface $uri, ?DriverConfi
      *
      * @pure
      */
-    private static function createHttpDriver(string|UriInterface $uri, ?DriverConfiguration $configuration, ?AuthenticateInterface $authenticate, FormatterInterface $formatter = null): DriverInterface
+    private static function createHttpDriver(string|UriInterface $uri, ?DriverConfiguration $configuration, ?AuthenticateInterface $authenticate, ?FormatterInterface $formatter = null): DriverInterface
     {
         if ($formatter !== null) {
             return HttpDriver::create($uri, $configuration, $authenticate, $formatter);
diff --git a/src/Exception/Neo4jException.php b/src/Exception/Neo4jException.php
@@ -34,7 +34,7 @@ final class Neo4jException extends RuntimeException
     /**
      * @param non-empty-list<Neo4jError> $errors
      */
-    public function __construct(array $errors, Throwable $previous = null)
+    public function __construct(array $errors, ?Throwable $previous = null)
     {
         $error = $errors[0];
         $message = sprintf(self::MESSAGE_TEMPLATE, $error->getCode(), $error->getMessage() ?? 'NULL');
diff --git a/src/Http/HttpDriver.php b/src/Http/HttpDriver.php
@@ -70,7 +70,7 @@ public function __construct(
      *
      * @pure
      */
-    public static function create(string|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, FormatterInterface $formatter = null): self
+    public static function create(string|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, ?FormatterInterface $formatter = null): self
     {
         if (is_string($uri)) {
             $uri = Uri::create($uri);
diff --git a/src/Neo4j/Neo4jDriver.php b/src/Neo4j/Neo4jDriver.php
@@ -68,7 +68,7 @@ public function __construct(
      *
      * @psalm-suppress MixedReturnTypeCoercion
      */
-    public static function create(string|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, FormatterInterface $formatter = null, ?AddressResolverInterface $resolver = null): self
+    public static function create(string|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, ?FormatterInterface $formatter = null, ?AddressResolverInterface $resolver = null): self
     {
         if (is_string($uri)) {
             $uri = Uri::create($uri);
diff --git a/src/Neo4j/RoutingTable.php b/src/Neo4j/RoutingTable.php
@@ -45,7 +45,7 @@ public function getTtl(): int
      *
      * @return list<string>
      */
-    public function getWithRole(RoutingRoles $role = null): array
+    public function getWithRole(?RoutingRoles $role = null): array
     {
         /** @psalm-var list<string> $tbr */
         $tbr = [];
diff --git a/src/Types/AbstractCypherSequence.php b/src/Types/AbstractCypherSequence.php
@@ -248,7 +248,7 @@ public function reversed(): self
      *
      * @psalm-mutation-free
      */
-    public function slice(int $offset, int $length = null): self
+    public function slice(int $offset, ?int $length = null): self
     {
         return $this->withOperation(function () use ($offset, $length) {
             if ($length !== 0) {
diff --git a/src/Types/Map.php b/src/Types/Map.php
@@ -186,7 +186,7 @@ public function pairs(): ArrayList
      *
      * @return static<TValue>
      */
-    public function ksorted(callable $comparator = null): Map
+    public function ksorted(?callable $comparator = null): Map
     {
         return $this->withOperation(function () use ($comparator) {
             $pairs = $this->pairs()->sorted(static function (Pair $x, Pair $y) use ($comparator) {

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public function __construct(`
`65`	`65`	`*`
`66`	`66`	`* @psalm-suppress MixedReturnTypeCoercion`
`67`	`67`	`*/`
`68`		`- public static function create(string\|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, FormatterInterface $formatter = null): self`
	`68`	`+ public static function create(string\|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, ?FormatterInterface $formatter = null): self`
`69`	`69`	`{`
`70`	`70`	`if (is_string($uri)) {`
`71`	`71`	`$uri = Uri::create($uri);`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ public function runStatements(iterable $statements, ?TransactionConfiguration $c`
`76`	`76`	`/**`
`77`	`77`	`* @param iterable<Statement>\|null $statements`
`78`	`78`	`*/`
`79`		`- public function openTransaction(iterable $statements = null, ?TransactionConfiguration $config = null): UnmanagedTransactionInterface`
	`79`	`+ public function openTransaction(?iterable $statements = null, ?TransactionConfiguration $config = null): UnmanagedTransactionInterface`
`80`	`80`	`{`
`81`	`81`	`return $this->beginTransaction($statements, $this->mergeTsxConfig($config));`
`82`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ final class GeneratorHelper`
`30`	`30`	`*`
`31`	`31`	`* @return T`
`32`	`32`	`*/`
`33`		`- public static function getReturnFromGenerator(Generator $generator, float $timeout = null)`
	`33`	`+ public static function getReturnFromGenerator(Generator $generator, ?float $timeout = null)`
`34`	`34`	`{`
`35`	`35`	`$start = microtime(true);`
`36`	`36`	`while ($generator->valid()) {`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ final class HttpPsrBindings`
`47`	`47`	`* @param callable():StreamFactoryInterface\|StreamFactoryInterface\|null $streamFactory`
`48`	`48`	`* @param callable():RequestFactoryInterface\|RequestFactoryInterface\|null $requestFactory`
`49`	`49`	`*/`
`50`		`- public function __construct(callable\|ClientInterface\|null $client = null, callable\|StreamFactoryInterface $streamFactory = null, callable\|RequestFactoryInterface $requestFactory = null)`
	`50`	`+ public function __construct(callable\|ClientInterface\|null $client = null, callable\|StreamFactoryInterface\|null $streamFactory = null, callable\|RequestFactoryInterface\|null $requestFactory = null)`
`51`	`51`	`{`
`52`	`52`	`$this->client = $client ?? static fn (): ClientInterface => Psr18ClientDiscovery::find();`
`53`	`53`	`$this->streamFactory = $streamFactory ?? static fn (): StreamFactoryInterface => Psr17FactoryDiscovery::findStreamFactory();`
`@@ -61,7 +61,7 @@ public function __construct(callable\|ClientInterface\|null $client = null, callab`
`61`	`61`	`* @param callable():StreamFactoryInterface\|StreamFactoryInterface\|null $streamFactory`
`62`	`62`	`* @param callable():RequestFactoryInterface\|RequestFactoryInterface\|null $requestFactory`
`63`	`63`	`*/`
`64`		`- public static function create(callable\|ClientInterface $client = null, callable\|StreamFactoryInterface $streamFactory = null, callable\|RequestFactoryInterface $requestFactory = null): self`
	`64`	`+ public static function create(callable\|ClientInterface\|null $client = null, callable\|StreamFactoryInterface\|null $streamFactory = null, callable\|RequestFactoryInterface\|null $requestFactory = null): self`
`65`	`65`	`{`
`66`	`66`	`return new self($client, $streamFactory, $requestFactory);`
`67`	`67`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ final class Neo4jException extends RuntimeException`
`34`	`34`	`/**`
`35`	`35`	`* @param non-empty-list<Neo4jError> $errors`
`36`	`36`	`*/`
`37`		`- public function __construct(array $errors, Throwable $previous = null)`
	`37`	`+ public function __construct(array $errors, ?Throwable $previous = null)`
`38`	`38`	`{`
`39`	`39`	`$error = $errors[0];`
`40`	`40`	`$message = sprintf(self::MESSAGE_TEMPLATE, $error->getCode(), $error->getMessage() ?? 'NULL');`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public function __construct(`
`70`	`70`	`*`
`71`	`71`	`* @pure`
`72`	`72`	`*/`
`73`		`- public static function create(string\|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, FormatterInterface $formatter = null): self`
	`73`	`+ public static function create(string\|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, ?FormatterInterface $formatter = null): self`
`74`	`74`	`{`
`75`	`75`	`if (is_string($uri)) {`
`76`	`76`	`$uri = Uri::create($uri);`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ public function __construct(`
`68`	`68`	`*`
`69`	`69`	`* @psalm-suppress MixedReturnTypeCoercion`
`70`	`70`	`*/`
`71`		`- public static function create(string\|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, FormatterInterface $formatter = null, ?AddressResolverInterface $resolver = null): self`
	`71`	`+ public static function create(string\|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null, ?FormatterInterface $formatter = null, ?AddressResolverInterface $resolver = null): self`
`72`	`72`	`{`
`73`	`73`	`if (is_string($uri)) {`
`74`	`74`	`$uri = Uri::create($uri);`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public function getTtl(): int`
`45`	`45`	`*`
`46`	`46`	`* @return list<string>`
`47`	`47`	`*/`
`48`		`- public function getWithRole(RoutingRoles $role = null): array`
	`48`	`+ public function getWithRole(?RoutingRoles $role = null): array`
`49`	`49`	`{`
`50`	`50`	`/** @psalm-var list<string> $tbr */`
`51`	`51`	`$tbr = [];`
Original file line number	Diff line number	Diff line change
`@@ -248,7 +248,7 @@ public function reversed(): self`
`248`	`248`	`*`
`249`	`249`	`* @psalm-mutation-free`
`250`	`250`	`*/`
`251`		`- public function slice(int $offset, int $length = null): self`
	`251`	`+ public function slice(int $offset, ?int $length = null): self`
`252`	`252`	`{`
`253`	`253`	`return $this->withOperation(function () use ($offset, $length) {`
`254`	`254`	`if ($length !== 0) {`