Merge pull request hkulekci#35 from NiCr42/use-php-feature-constructor-property-promotion

hkulekci · web-flow · commit 96e2dde88f97 · 2023-10-20T09:49:48.000+03:00
Use php feature constructor property promotion
diff --git a/src/Config.php b/src/Config.php
@@ -10,15 +10,11 @@
 
 class Config
 {
-    protected string $host;
 
-    protected string $port;
     protected ?string $apiKey = null;
 
-    public function __construct($host, $port = 6333)
+    public function __construct(protected string $host, protected int $port = 6333)
     {
-        $this->host = $host;
-        $this->port = $port;
     }
 
     public function getDomain(): string
diff --git a/src/Endpoints/AbstractEndpoint.php b/src/Endpoints/AbstractEndpoint.php
@@ -15,13 +15,10 @@
 
 abstract class AbstractEndpoint
 {
-    protected HttpClientInterface $client;
-
     protected ?string $collectionName = null;
 
-    public function __construct(HttpClientInterface $client)
+    public function __construct(protected HttpClientInterface $client)
     {
-        $this->client = $client;
     }
 
     public function setCollectionName(?string $collectionName): static
diff --git a/src/Http/GuzzleClient.php b/src/Http/GuzzleClient.php
@@ -18,12 +18,10 @@
 
 class GuzzleClient implements HttpClientInterface
 {
-    protected Config $config;
     protected Client $client;
 
-    public function __construct(Config $config)
+    public function __construct(protected Config $config)
     {
-        $this->config = $config;
         $this->client = new Client([
             'base_uri' => $this->config->getDomain(),
             'http_errors' => true,
diff --git a/src/Models/Filter/Condition/AbstractCondition.php b/src/Models/Filter/Condition/AbstractCondition.php
@@ -8,10 +8,7 @@
 
 class AbstractCondition
 {
-    protected string $key;
-
-    public function __construct(string $key)
+    public function __construct(protected string $key)
     {
-        $this->key = $key;
     }
 }
diff --git a/src/Models/Filter/Condition/FullTextMatch.php b/src/Models/Filter/Condition/FullTextMatch.php
@@ -8,12 +8,9 @@
 
 class FullTextMatch extends AbstractCondition implements ConditionInterface
 {
-    protected string $text;
-
-    public function __construct(string $key, string $text)
+    public function __construct(string $key, protected string $text)
     {
         parent::__construct($key);
-        $this->text = $text;
     }
 
     public function toArray(): array
diff --git a/src/Models/Filter/Condition/GeoBoundingBox.php b/src/Models/Filter/Condition/GeoBoundingBox.php
@@ -11,9 +11,8 @@
 class GeoBoundingBox extends AbstractCondition implements ConditionInterface
 {
     protected const CONDITIONS = ['bottom_right', 'top_left'];
-    protected array $boundingBox;
 
-    public function __construct(string $key, array $boundingBox)
+    public function __construct(string $key, protected array $boundingBox)
     {
         parent::__construct($key);
         Assert::keysExists(
@@ -25,7 +24,6 @@ public function __construct(string $key, array $boundingBox)
         Assert::allKeyExists(array_values($boundingBox), 'lat', 'All geo locations need to provide "lat" key');
         Assert::allKeyExists(array_values($boundingBox), 'lon', 'All geo locations need to provide "lon" key');
 
-        $this->boundingBox = $boundingBox;
     }
 
     public function toArray(): array
diff --git a/src/Models/Filter/Condition/GeoRadius.php b/src/Models/Filter/Condition/GeoRadius.php
@@ -7,14 +7,12 @@
 namespace Qdrant\Models\Filter\Condition;
 
 use Qdrant\Domain\Assert;
-use Qdrant\Exception\InvalidArgumentException;
 
 class GeoRadius extends AbstractCondition implements ConditionInterface
 {
     protected const CONDITIONS = ['center', 'radius'];
-    protected array $radius;
 
-    public function __construct(string $key, array $radius)
+    public function __construct(string $key, protected array $radius)
     {
         parent::__construct($key);
         Assert::keysExists(
@@ -23,7 +21,6 @@ public function __construct(string $key, array $radius)
 
         Assert::keysExists($radius['center'], ['lat', 'lon'], 'Radius center parameter expected lat and lon');
 
-        $this->radius = $radius;
     }
 
     public function toArray(): array
diff --git a/src/Models/Filter/Condition/HasId.php b/src/Models/Filter/Condition/HasId.php
@@ -8,11 +8,8 @@
 
 class HasId implements ConditionInterface
 {
-    protected array $ids;
-
-    public function __construct(array $ids)
+    public function __construct(protected array $ids)
     {
-        $this->ids = $ids;
     }
 
     public function toArray(): array
diff --git a/src/Models/Filter/Condition/MatchAny.php b/src/Models/Filter/Condition/MatchAny.php
@@ -8,12 +8,9 @@
 
 class MatchAny extends AbstractCondition implements ConditionInterface
 {
-    protected array $values = [];
-
-    public function __construct(string $key, array $values)
+    public function __construct(string $key, protected array $values = [])
     {
         parent::__construct($key);
-        $this->values = $values;
     }
 
     public function toArray(): array
diff --git a/src/Models/Filter/Condition/MatchBool.php b/src/Models/Filter/Condition/MatchBool.php
@@ -8,12 +8,9 @@
 
 class MatchBool extends AbstractCondition implements ConditionInterface
 {
-    protected bool $value;
-
-    public function __construct(string $key, bool $value)
+    public function __construct(string $key, protected bool $value)
     {
         parent::__construct($key);
-        $this->value = $value;
     }
 
     public function toArray(): array
diff --git a/src/Models/Filter/Condition/MatchExcept.php b/src/Models/Filter/Condition/MatchExcept.php
@@ -8,12 +8,9 @@
 
 class MatchExcept extends AbstractCondition implements ConditionInterface
 {
-    protected array $values = [];
-
-    public function __construct(string $key, array $values)
+    public function __construct(string $key, protected array $values = [])
     {
         parent::__construct($key);
-        $this->values = $values;
     }
 
     public function toArray(): array
diff --git a/src/Models/Filter/Condition/MatchInt.php b/src/Models/Filter/Condition/MatchInt.php
@@ -8,12 +8,9 @@
 
 class MatchInt extends AbstractCondition implements ConditionInterface
 {
-    protected int $value;
-
-    public function __construct(string $key, int $value)
+    public function __construct(string $key, protected int $value)
     {
         parent::__construct($key);
-        $this->value = $value;
     }
 
     public function toArray(): array
diff --git a/src/Models/Filter/Condition/MatchString.php b/src/Models/Filter/Condition/MatchString.php
@@ -8,12 +8,9 @@
 
 class MatchString extends AbstractCondition implements ConditionInterface
 {
-    protected string $value;
-
-    public function __construct(string $key, string $value)
+    public function __construct(string $key, protected string $value)
     {
         parent::__construct($key);
-        $this->value = $value;
     }
 
     public function toArray(): array
diff --git a/src/Models/Filter/Condition/Range.php b/src/Models/Filter/Condition/Range.php
@@ -7,22 +7,19 @@
 namespace Qdrant\Models\Filter\Condition;
 
 use Qdrant\Domain\Assert;
-use Qdrant\Exception\InvalidArgumentException;
 
 class Range extends AbstractCondition implements ConditionInterface
 {
     protected const CONDITIONS = ['gt', 'gte', 'lt', 'lte'];
-    protected array $ranges;
 
-    public function __construct(string $key, array $ranges)
+    public function __construct(string $key, protected array $ranges)
     {
         parent::__construct($key);
         Assert::keysExistsAtLeastOne(
             $ranges,
             self::CONDITIONS,
             'Range expects at least one of %s keys'
         );
-        $this->ranges = $ranges;
     }
 
     public function toArray(): array
diff --git a/src/Models/Filter/Condition/ValueCount.php b/src/Models/Filter/Condition/ValueCount.php
@@ -12,17 +12,14 @@ class ValueCount extends AbstractCondition implements ConditionInterface
 {
     protected const CONDITIONS = ['gt', 'gte', 'lt', 'lte'];
 
-    protected array $valueCount;
-
-    public function __construct(string $key, array $valueCount)
+    public function __construct(string $key, protected array $valueCount)
     {
         parent::__construct($key);
         Assert::keysExistsAtLeastOne(
             $valueCount,
             self::CONDITIONS,
             'ValueCount expects at least one of %s key'
         );
-        $this->valueCount = $valueCount;
     }
 
     public function toArray(): array
diff --git a/src/Models/PointStruct.php b/src/Models/PointStruct.php
@@ -15,15 +15,11 @@ class PointStruct
 {
     use ProtectedPropertyAccessor;
 
-    protected int|string $id;
-    protected ?array $payload = null;
-    protected VectorStructInterface $vector;
-
-    public function __construct(int|string $id, VectorStructInterface $vector, array $payload = null)
-    {
-        $this->id = $id;
-        $this->vector = $vector;
-        $this->payload = $payload;
+    public function __construct(
+        protected int|string $id,
+        protected VectorStructInterface $vector,
+        protected ?array $payload = null
+    ) {
     }
 
     public static function createFromArray(array $pointArray): PointStruct
diff --git a/src/Models/Request/CreateIndex.php b/src/Models/Request/CreateIndex.php
@@ -8,15 +8,8 @@
 
 class CreateIndex implements RequestModel
 {
-    protected string $fieldName;
-    protected string $fieldSchema;
-    protected array $schemaParams = [];
-
-    public function __construct(string $fieldName, string $fieldSchema, array $schemaParams = [])
+    public function __construct(protected string $fieldName, protected string $fieldSchema, protected array $schemaParams = [])
     {
-        $this->fieldName = $fieldName;
-        $this->fieldSchema = $fieldSchema;
-        $this->schemaParams = $schemaParams;
     }
 
     public function toArray(): array
diff --git a/src/Models/Request/InitFrom.php b/src/Models/Request/InitFrom.php
@@ -10,11 +10,8 @@
 
 class InitFrom implements RequestModel
 {
-    protected string $collection;
-
-    public function __construct(string $collection)
+    public function __construct(protected string $collection)
     {
-        $this->collection = $collection;
     }
 
     public function toArray(): array
diff --git a/src/Models/Request/Point.php b/src/Models/Request/Point.php
@@ -8,29 +8,20 @@
 
 namespace Qdrant\Models\Request;
 
-use Qdrant\Models\MultiVectorStruct;
 use Qdrant\Models\VectorStruct;
 use Qdrant\Models\VectorStructInterface;
 
 class Point implements RequestModel
 {
-    protected string $id;
     protected VectorStructInterface $vector;
 
-    /**
-     * @var array|null Payload values (optional)
-     */
-    protected ?array $payload = null;
-
-    public function __construct(string $id, VectorStructInterface|array $vector, array $payload = null)
+    public function __construct(protected string $id, VectorStructInterface|array $vector, protected ?array $payload = null)
     {
         if(is_array($vector)) {
             $vector = new VectorStruct($vector);
         }
 
-        $this->id = $id;
         $this->vector = $vector;
-        $this->payload = $payload;
     }
 
     public function toArray(): array
diff --git a/src/Models/Request/PointsBatch.php b/src/Models/Request/PointsBatch.php
@@ -14,16 +14,11 @@
 
 class PointsBatch implements RequestModel
 {
-    protected array $batchPoints;
-
-    public function __construct()
-    {
-        $this->batchPoints = [
-            'ids' => [],
-            'payloads' => [],
-            'vectors' => [],
-        ];
-    }
+    protected array $batchPoints = [
+        'ids' => [],
+        'payloads' => [],
+        'vectors' => [],
+    ];
 
     public function addPoint(PointStruct $point): void
     {
diff --git a/src/Models/Request/RecommendRequest.php b/src/Models/Request/RecommendRequest.php
@@ -15,17 +15,13 @@ class RecommendRequest
     use ProtectedPropertyAccessor;
 
     protected ?Filter $filter = null;
-    protected array $positive;
-    protected array $negative;
     protected ?string $using = null;
     protected ?int $limit = null;
     protected ?int $offset = null;
     protected ?float $scoreThreshold = null;
 
-    public function __construct(array $positive, array $negative = [])
+    public function __construct(protected array $positive, protected array $negative = [])
     {
-        $this->positive = $positive;
-        $this->negative = $negative;
     }
 
     public function setFilter(Filter $filter): static
diff --git a/src/Models/Request/SearchRequest.php b/src/Models/Request/SearchRequest.php
@@ -19,8 +19,6 @@ class SearchRequest
 
     protected array $params = [];
 
-    protected VectorStructInterface $vector;
-
     protected ?int $limit = null;
 
     protected ?int $offset = null;
@@ -33,9 +31,8 @@ class SearchRequest
 
     protected ?string $name = null;
 
-    public function __construct(VectorStructInterface $vector)
+    public function __construct(protected VectorStructInterface $vector)
     {
-        $this->vector = $vector;
     }
 
     public function setName(string $name): static
diff --git a/src/Models/Request/ServiceLock.php b/src/Models/Request/ServiceLock.php
@@ -8,13 +8,9 @@
 
 class ServiceLock implements RequestModel
 {
-    protected ?string $errorMessage;
-    protected bool $write;
 
-    public function __construct(bool $write, string $errorMessage = null)
+    public function __construct(protected bool $write, protected ?string $errorMessage = null)
     {
-        $this->write = $write;
-        $this->errorMessage = $errorMessage;
     }
 
     public function toArray(): array
diff --git a/src/Models/Request/VectorParams.php b/src/Models/Request/VectorParams.php
diff --git a/src/Models/VectorStruct.php b/src/Models/VectorStruct.php
diff --git a/src/Qdrant.php b/src/Qdrant.php
diff --git a/src/Response.php b/src/Response.php
diff --git a/tests/Unit/Models/Request/PointTest.php b/tests/Unit/Models/Request/PointTest.php

Original file line number	Diff line number	Diff line change
`@@ -10,15 +10,11 @@`
`10`	`10`
`11`	`11`	`class Config`
`12`	`12`	`{`
`13`		`- protected string $host;`
`14`	`13`
`15`		`- protected string $port;`
`16`	`14`	`protected ?string $apiKey = null;`
`17`	`15`
`18`		`- public function __construct($host, $port = 6333)`
	`16`	`+ public function __construct(protected string $host, protected int $port = 6333)`
`19`	`17`	`{`
`20`		`- $this->host = $host;`
`21`		`- $this->port = $port;`
`22`	`18`	`}`
`23`	`19`
`24`	`20`	`public function getDomain(): string`
Original file line number	Diff line number	Diff line change
`@@ -15,13 +15,10 @@`
`15`	`15`
`16`	`16`	`abstract class AbstractEndpoint`
`17`	`17`	`{`
`18`		`- protected HttpClientInterface $client;`
`19`		`-`
`20`	`18`	`protected ?string $collectionName = null;`
`21`	`19`
`22`		`- public function __construct(HttpClientInterface $client)`
	`20`	`+ public function __construct(protected HttpClientInterface $client)`
`23`	`21`	`{`
`24`		`- $this->client = $client;`
`25`	`22`	`}`
`26`	`23`
`27`	`24`	`public function setCollectionName(?string $collectionName): static`
Original file line number	Diff line number	Diff line change
`@@ -18,12 +18,10 @@`
`18`	`18`
`19`	`19`	`class GuzzleClient implements HttpClientInterface`
`20`	`20`	`{`
`21`		`- protected Config $config;`
`22`	`21`	`protected Client $client;`
`23`	`22`
`24`		`- public function __construct(Config $config)`
	`23`	`+ public function __construct(protected Config $config)`
`25`	`24`	`{`
`26`		`- $this->config = $config;`
`27`	`25`	`$this->client = new Client([`
`28`	`26`	`'base_uri' => $this->config->getDomain(),`
`29`	`27`	`'http_errors' => true,`
Original file line number	Diff line number	Diff line change
`@@ -8,10 +8,7 @@`
`8`	`8`
`9`	`9`	`class AbstractCondition`
`10`	`10`	`{`
`11`		`- protected string $key;`
`12`		`-`
`13`		`- public function __construct(string $key)`
	`11`	`+ public function __construct(protected string $key)`
`14`	`12`	`{`
`15`		`- $this->key = $key;`
`16`	`13`	`}`
`17`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,12 +8,9 @@`
`8`	`8`
`9`	`9`	`class FullTextMatch extends AbstractCondition implements ConditionInterface`
`10`	`10`	`{`
`11`		`- protected string $text;`
`12`		`-`
`13`		`- public function __construct(string $key, string $text)`
	`11`	`+ public function __construct(string $key, protected string $text)`
`14`	`12`	`{`
`15`	`13`	`parent::__construct($key);`
`16`		`- $this->text = $text;`
`17`	`14`	`}`
`18`	`15`
`19`	`16`	`public function toArray(): array`
Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,8 @@`
`11`	`11`	`class GeoBoundingBox extends AbstractCondition implements ConditionInterface`
`12`	`12`	`{`
`13`	`13`	`protected const CONDITIONS = ['bottom_right', 'top_left'];`
`14`		`- protected array $boundingBox;`
`15`	`14`
`16`		`- public function __construct(string $key, array $boundingBox)`
	`15`	`+ public function __construct(string $key, protected array $boundingBox)`
`17`	`16`	`{`
`18`	`17`	`parent::__construct($key);`
`19`	`18`	`Assert::keysExists(`
`@@ -25,7 +24,6 @@ public function __construct(string $key, array $boundingBox)`
`25`	`24`	`Assert::allKeyExists(array_values($boundingBox), 'lat', 'All geo locations need to provide "lat" key');`
`26`	`25`	`Assert::allKeyExists(array_values($boundingBox), 'lon', 'All geo locations need to provide "lon" key');`
`27`	`26`
`28`		`- $this->boundingBox = $boundingBox;`
`29`	`27`	`}`
`30`	`28`
`31`	`29`	`public function toArray(): array`
Original file line number	Diff line number	Diff line change
`@@ -7,14 +7,12 @@`
`7`	`7`	`namespace Qdrant\Models\Filter\Condition;`
`8`	`8`
`9`	`9`	`use Qdrant\Domain\Assert;`
`10`		`-use Qdrant\Exception\InvalidArgumentException;`
`11`	`10`
`12`	`11`	`class GeoRadius extends AbstractCondition implements ConditionInterface`
`13`	`12`	`{`
`14`	`13`	`protected const CONDITIONS = ['center', 'radius'];`
`15`		`- protected array $radius;`
`16`	`14`
`17`		`- public function __construct(string $key, array $radius)`
	`15`	`+ public function __construct(string $key, protected array $radius)`
`18`	`16`	`{`
`19`	`17`	`parent::__construct($key);`
`20`	`18`	`Assert::keysExists(`
`@@ -23,7 +21,6 @@ public function __construct(string $key, array $radius)`
`23`	`21`
`24`	`22`	`Assert::keysExists($radius['center'], ['lat', 'lon'], 'Radius center parameter expected lat and lon');`
`25`	`23`
`26`		`- $this->radius = $radius;`
`27`	`24`	`}`
`28`	`25`
`29`	`26`	`public function toArray(): array`
Original file line number	Diff line number	Diff line change
`@@ -8,11 +8,8 @@`
`8`	`8`
`9`	`9`	`class HasId implements ConditionInterface`
`10`	`10`	`{`
`11`		`- protected array $ids;`
`12`		`-`
`13`		`- public function __construct(array $ids)`
	`11`	`+ public function __construct(protected array $ids)`
`14`	`12`	`{`
`15`		`- $this->ids = $ids;`
`16`	`13`	`}`
`17`	`14`
`18`	`15`	`public function toArray(): array`
Original file line number	Diff line number	Diff line change
`@@ -8,12 +8,9 @@`
`8`	`8`
`9`	`9`	`class MatchAny extends AbstractCondition implements ConditionInterface`
`10`	`10`	`{`
`11`		`- protected array $values = [];`
`12`		`-`
`13`		`- public function __construct(string $key, array $values)`
	`11`	`+ public function __construct(string $key, protected array $values = [])`
`14`	`12`	`{`
`15`	`13`	`parent::__construct($key);`
`16`		`- $this->values = $values;`
`17`	`14`	`}`
`18`	`15`
`19`	`16`	`public function toArray(): array`
Original file line number	Diff line number	Diff line change
`@@ -8,12 +8,9 @@`
`8`	`8`
`9`	`9`	`class MatchBool extends AbstractCondition implements ConditionInterface`
`10`	`10`	`{`
`11`		`- protected bool $value;`
`12`		`-`
`13`		`- public function __construct(string $key, bool $value)`
	`11`	`+ public function __construct(string $key, protected bool $value)`
`14`	`12`	`{`
`15`	`13`	`parent::__construct($key);`
`16`		`- $this->value = $value;`
`17`	`14`	`}`
`18`	`15`
`19`	`16`	`public function toArray(): array`