cleaning up getters

Author: 123kiran17

README.md

@@ -8,7 +8,7 @@ The Neo4j QueryAPI client is for developers and data engineers who want to inter
 - Built and tested under close collaboration with the official Neo4j driver team
 - Easier to start with, just need a client to any neo4j instance
 - Fully typed with Psalm and CS fixed for code quality
-- It does not Supports Bolt, Rather compatible with HTTP, and auto-routed drivers
+- It does not supports Bolt, Rather compatible with HTTP, and auto-routed drivers
 
 
 

src/Neo4jQueryAPI.php

@@ -4,7 +4,6 @@
 
 use Http\Discovery\Psr17FactoryDiscovery;
 use Http\Discovery\Psr18ClientDiscovery;
-use http\Exception\RuntimeException;
 use InvalidArgumentException;
 use Neo4j\QueryAPI\Exception\Neo4jException;
 use Psr\Http\Client\ClientInterface;

src/Objects/Authentication.php

@@ -7,9 +7,6 @@
 use Neo4j\QueryAPI\Authentication\BearerAuthentication;
 use Neo4j\QueryAPI\Authentication\NoAuth;
 
-/**
- *  @api
- */
 class Authentication
 {
     public static function basic(string $username, string $password): AuthenticateInterface
@@ -32,9 +29,6 @@ public static function fromEnvironment(): AuthenticateInterface
         );
     }
 
-
-
-
     public static function noAuth(): AuthenticateInterface
     {
         return new NoAuth();

src/Objects/Bookmarks.php

@@ -4,10 +4,7 @@
 
 use JsonSerializable;
 
-/**
- * @api
- */
-class Bookmarks implements \Countable, JsonSerializable
+final class Bookmarks implements \Countable, JsonSerializable
 {
     public function __construct(private array $bookmarks)
     {

src/Objects/Node.php

@@ -6,9 +6,6 @@
  * Represents a Neo4j Node with labels and properties.
  */
 
-/**
- *  @api
- */
 class Node
 {
     /**
@@ -35,7 +32,6 @@ public function __construct(array $labels, array $properties)
 
     /**
      * Get the labels of the node.
-     * @api
      * @return string[] Array of labels.
      */
     public function getLabels(): array
@@ -45,7 +41,6 @@ public function getLabels(): array
 
     /**
      * Get the properties of the node.
-     * @api
      * @return array<string, mixed> Associative array of properties.
      */
     public function getProperties(): array
@@ -55,7 +50,6 @@ public function getProperties(): array
 
     /**
      * Convert the Node object to an array representation.
-     * @api
      * @return array Node data as an array.
      */
     public function toArray(): array

src/Objects/Path.php

@@ -6,20 +6,17 @@
  * Represents a path in a Neo4j graph, consisting of nodes and relationships.
  */
 
-/**
- *  @api
- */
 class Path
 {
     /**
      * @var Node[] Array of nodes in the path.
      */
-    private array $nodes;
+    public readonly array $nodes;
 
     /**
      * @var Relationship[] Array of relationships in the path.
      */
-    private array $relationships;
+    public readonly array $relationships;
 
     /**
      * Path constructor.
@@ -33,23 +30,4 @@ public function __construct(array $nodes, array $relationships)
         $this->relationships = $relationships;
     }
 
-    /**
-     * Get the nodes in the path.
-     * @api
-     * @return Node[] Array of nodes.
-     */
-    public function getNodes(): array
-    {
-        return $this->nodes;
-    }
-
-    /**
-     * Get the relationships in the path.
-     * @api
-     * @return Relationship[] Array of relationships.
-     */
-    public function getRelationships(): array
-    {
-        return $this->relationships;
-    }
 }

src/Objects/Person.php

@@ -6,9 +6,6 @@
  * @psalm-suppress UnusedClass
  * Represents a Person node in the Neo4j graph.
  */
-/**
- *  @api
- */
 class Person extends Node
 {
     /**

src/Objects/Point.php

@@ -5,10 +5,6 @@
 /**
  * Represents a point with x, y, z coordinates, and SRID (Spatial Reference System Identifier).
  */
-/**
- *  @api
- */
-
 class Point
 {
     /**
@@ -25,46 +21,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * Get the x coordinate of the point.
-     * @api
-     * @return float x coordinate value.
-     */
-    public function getX(): float
-    {
-        return $this->x;
-    }
-
-    /**
-     * Get the y coordinate of the point.
-     * @api
-     * @return float y coordinate value.
-     */
-    public function getY(): float
-    {
-        return $this->y;
-    }
-
-    /**
-     * Get the z coordinate of the point.
-     * @api
-     * @return float|null z coordinate value, or null if not applicable.
-     */
-    public function getZ(): float|null
-    {
-        return $this->z;
-    }
-
-    /**
-     * Get the SRID (Spatial Reference System Identifier) of the point.
-     * @api
-     * @return int SRID value.
-     */
-    public function getSrid(): int
-    {
-        return $this->srid;
-    }
-
     /**
      * Convert the Point object to a string representation.
      *

src/Objects/ProfiledQueryPlanArguments.php

@@ -2,9 +2,6 @@
 
 namespace Neo4j\QueryAPI\Objects;
 
-/**
- *  @api
- */
 class ProfiledQueryPlanArguments
 {
     public function __construct(

src/Objects/Relationship.php

@@ -6,20 +6,17 @@
  * Represents a relationship in a Neo4j graph, with a type and associated properties.
  */
 
-/**
- *  @api
- */
 class Relationship
 {
     /**
      * @var string The type of the relationship (e.g., "FRIENDS_WITH", "WORKS_FOR").
      */
-    private string $type;
+    public readonly string $type;
 
     /**
      * @var array<string, mixed> Associative array of properties for the relationship.
      */
-    private array $properties;
+    public readonly array $properties;
 
     /**
      * Relationship constructor.
@@ -33,23 +30,4 @@ public function __construct(string $type, array $properties = [])
         $this->properties = $properties;
     }
 
-    /**
-     * Get the type of the relationship.
-     * @api
-     * @return string The type of the relationship.
-     */
-    public function getType(): string
-    {
-        return $this->type;
-    }
-
-    /**
-     * Get the properties of the relationship.
-     * @api
-     * @return array<string, mixed> Associative array of properties.
-     */
-    public function getProperties(): array
-    {
-        return $this->properties;
-    }
 }