PCBC-1010: use explicit nullable types where applicable

Otherwise PHP 8.4 will emit deprecation warning
couchbase · Oct 2, 2024 · 6c788db · 6c788db
1 parent 166e242
commit 6c788db
Show file tree

Hide file tree

Showing 59 changed files with 454 additions and 300 deletions.
diff --git a/Couchbase/AnalyticsOptions.php b/Couchbase/AnalyticsOptions.php
@@ -204,7 +204,7 @@ public static function getTranscoder(?AnalyticsOptions $options): Transcoder
         return $options->transcoder;
     }
 
-    public static function export(?AnalyticsOptions $options, string $scopeName = null, string $bucketName = null): array
+    public static function export(?AnalyticsOptions $options, ?string $scopeName = null, ?string $bucketName = null): array
     {
         if ($options == null) {
             return [

diff --git a/Couchbase/BinaryCollection.php b/Couchbase/BinaryCollection.php
@@ -78,7 +78,7 @@ public function name(): string
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function append(string $id, string $value, AppendOptions $options = null): MutationResult
+    public function append(string $id, string $value, ?AppendOptions $options = null): MutationResult
     {
         $response = Extension\documentAppend(
             $this->core,
@@ -105,7 +105,7 @@ public function append(string $id, string $value, AppendOptions $options = null)
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function prepend(string $id, string $value, PrependOptions $options = null): MutationResult
+    public function prepend(string $id, string $value, ?PrependOptions $options = null): MutationResult
     {
         $response = Extension\documentPrepend(
             $this->core,
@@ -131,7 +131,7 @@ public function prepend(string $id, string $value, PrependOptions $options = nul
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function increment(string $id, IncrementOptions $options = null): CounterResult
+    public function increment(string $id, ?IncrementOptions $options = null): CounterResult
     {
         $response = Extension\documentIncrement(
             $this->core,
@@ -156,7 +156,7 @@ public function increment(string $id, IncrementOptions $options = null): Counter
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function decrement(string $id, DecrementOptions $options = null): CounterResult
+    public function decrement(string $id, ?DecrementOptions $options = null): CounterResult
     {
         $response = Extension\documentDecrement(
             $this->core,

diff --git a/Couchbase/BinaryCollectionInterface.php b/Couchbase/BinaryCollectionInterface.php
@@ -24,11 +24,11 @@ interface BinaryCollectionInterface
 {
     public function name(): string;
 
-    public function append(string $id, string $value, AppendOptions $options = null): MutationResult;
+    public function append(string $id, string $value, ?AppendOptions $options = null): MutationResult;
 
-    public function prepend(string $id, string $value, PrependOptions $options = null): MutationResult;
+    public function prepend(string $id, string $value, ?PrependOptions $options = null): MutationResult;
 
-    public function increment(string $id, IncrementOptions $options = null): CounterResult;
+    public function increment(string $id, ?IncrementOptions $options = null): CounterResult;
 
-    public function decrement(string $id, DecrementOptions $options = null): CounterResult;
+    public function decrement(string $id, ?DecrementOptions $options = null): CounterResult;
 }
diff --git a/Couchbase/Bucket.php b/Couchbase/Bucket.php
@@ -123,7 +123,7 @@ public function name(): string
      * @return ViewResult
      * @since 4.0.0
      */
-    public function viewQuery(string $designDoc, string $viewName, ViewOptions $options = null): ViewResult
+    public function viewQuery(string $designDoc, string $viewName, ?ViewOptions $options = null): ViewResult
     {
         $opts = ViewOptions::export($options);
         $namespace = $opts["namespace"];
@@ -195,7 +195,7 @@ public function ping($services = null, $reportId = null)
      * @deprecated - see cluster->diagnostics
      * @since 4.0.0
      */
-    public function diagnostics(string $reportId = null)
+    public function diagnostics(?string $reportId = null)
     {
         if ($reportId == null) {
             $reportId = uniqid();

diff --git a/Couchbase/BucketInterface.php b/Couchbase/BucketInterface.php
@@ -30,5 +30,5 @@ public function scope(string $name): ScopeInterface;
 
     public function name(): string;
 
-    public function viewQuery(string $designDoc, string $viewName, ViewOptions $options = null): ViewResult;
+    public function viewQuery(string $designDoc, string $viewName, ?ViewOptions $options = null): ViewResult;
 }
diff --git a/Couchbase/Cluster.php b/Couchbase/Cluster.php
@@ -184,7 +184,7 @@ public function query(string $statement, ?QueryOptions $options = null): QueryRe
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function analyticsQuery(string $statement, AnalyticsOptions $options = null): AnalyticsResult
+    public function analyticsQuery(string $statement, ?AnalyticsOptions $options = null): AnalyticsResult
     {
         $result = Extension\analyticsQuery($this->core, $statement, AnalyticsOptions::export($options));
 
@@ -202,7 +202,7 @@ public function analyticsQuery(string $statement, AnalyticsOptions $options = nu
      * @return SearchResult
      * @since 4.0.0
      */
-    public function searchQuery(string $indexName, SearchQuery $query, SearchOptions $options = null): SearchResult
+    public function searchQuery(string $indexName, SearchQuery $query, ?SearchOptions $options = null): SearchResult
     {
         $result = Extension\searchQuery($this->core, $indexName, json_encode($query), SearchOptions::export($options));
 
@@ -222,7 +222,7 @@ public function searchQuery(string $indexName, SearchQuery $query, SearchOptions
      * @throws InvalidArgumentException
      * @since 4.1.7
      */
-    public function search(string $indexName, SearchRequest $request, SearchOptions $options = null): SearchResult
+    public function search(string $indexName, SearchRequest $request, ?SearchOptions $options = null): SearchResult
     {
         $exportedRequest = SearchRequest::export($request);
         $exportedOptions = SearchOptions::export($options);
@@ -329,7 +329,7 @@ public function ping($services = null, $reportId = null)
      *
      * @since 4.0.0
      */
-    public function diagnostics(string $reportId = null)
+    public function diagnostics(?string $reportId = null)
     {
         if ($reportId == null) {
             $reportId = uniqid();

diff --git a/Couchbase/ClusterInterface.php b/Couchbase/ClusterInterface.php
@@ -26,7 +26,7 @@ public function bucket(string $name): BucketInterface;
 
     public function query(string $statement, ?QueryOptions $options = null): QueryResult;
 
-    public function analyticsQuery(string $statement, AnalyticsOptions $options = null): AnalyticsResult;
+    public function analyticsQuery(string $statement, ?AnalyticsOptions $options = null): AnalyticsResult;
 
-    public function searchQuery(string $indexName, SearchQuery $query, SearchOptions $options = null): SearchResult;
+    public function searchQuery(string $indexName, SearchQuery $query, ?SearchOptions $options = null): SearchResult;
 }
diff --git a/Couchbase/Collection.php b/Couchbase/Collection.php
@@ -113,7 +113,7 @@ public function name(): string
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function get(string $id, GetOptions $options = null): GetResult
+    public function get(string $id, ?GetOptions $options = null): GetResult
     {
         $response = Extension\documentGet(
             $this->core,
@@ -137,7 +137,7 @@ public function get(string $id, GetOptions $options = null): GetResult
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function exists(string $id, ExistsOptions $options = null): ExistsResult
+    public function exists(string $id, ?ExistsOptions $options = null): ExistsResult
     {
         $response = Extension\documentExists(
             $this->core,
@@ -164,7 +164,7 @@ public function exists(string $id, ExistsOptions $options = null): ExistsResult
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function getAndLock(string $id, int $lockTimeSeconds, GetAndLockOptions $options = null): GetResult
+    public function getAndLock(string $id, int $lockTimeSeconds, ?GetAndLockOptions $options = null): GetResult
     {
         $response = Extension\documentGetAndLock(
             $this->core,
@@ -191,7 +191,7 @@ public function getAndLock(string $id, int $lockTimeSeconds, GetAndLockOptions $
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function getAndTouch(string $id, $expiry, GetAndTouchOptions $options = null): GetResult
+    public function getAndTouch(string $id, $expiry, ?GetAndTouchOptions $options = null): GetResult
     {
         if ($expiry instanceof DateTimeInterface) {
             $expirySeconds = $expiry->getTimestamp();
@@ -223,7 +223,7 @@ public function getAndTouch(string $id, $expiry, GetAndTouchOptions $options = n
      * @throws TimeoutException
      * @since 4.0.1
      */
-    public function getAnyReplica(string $id, GetAnyReplicaOptions $options = null): GetReplicaResult
+    public function getAnyReplica(string $id, ?GetAnyReplicaOptions $options = null): GetReplicaResult
     {
         $response = Extension\documentGetAnyReplica(
             $this->core,
@@ -248,7 +248,7 @@ public function getAnyReplica(string $id, GetAnyReplicaOptions $options = null):
      * @throws TimeoutException
      * @since 4.0.0
      */
-    public function getAllReplicas(string $id, GetAllReplicasOptions $options = null): array
+    public function getAllReplicas(string $id, ?GetAllReplicasOptions $options = null): array
     {
         $responses = Extension\documentGetAllReplicas(
             $this->core,
@@ -278,7 +278,7 @@ function (array $response) use ($options) {
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function upsert(string $id, $value, UpsertOptions $options = null): MutationResult
+    public function upsert(string $id, $value, ?UpsertOptions $options = null): MutationResult
     {
         $encoded = UpsertOptions::encodeDocument($options, $value);
         $response = Extension\documentUpsert(
@@ -307,7 +307,7 @@ public function upsert(string $id, $value, UpsertOptions $options = null): Mutat
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function insert(string $id, $value, InsertOptions $options = null): MutationResult
+    public function insert(string $id, $value, ?InsertOptions $options = null): MutationResult
     {
         $encoded = InsertOptions::encodeDocument($options, $value);
         $response = Extension\documentInsert(
@@ -337,7 +337,7 @@ public function insert(string $id, $value, InsertOptions $options = null): Mutat
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function replace(string $id, $value, ReplaceOptions $options = null): MutationResult
+    public function replace(string $id, $value, ?ReplaceOptions $options = null): MutationResult
     {
         $encoded = ReplaceOptions::encodeDocument($options, $value);
         $response = Extension\documentReplace(
@@ -366,7 +366,7 @@ public function replace(string $id, $value, ReplaceOptions $options = null): Mut
      * @throws DocumentNotFoundException
      * @since 4.0.0
      */
-    public function remove(string $id, RemoveOptions $options = null): MutationResult
+    public function remove(string $id, ?RemoveOptions $options = null): MutationResult
     {
         $response = Extension\documentRemove(
             $this->core,
@@ -394,7 +394,7 @@ public function remove(string $id, RemoveOptions $options = null): MutationResul
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function unlock(string $id, string $cas, UnlockOptions $options = null): Result
+    public function unlock(string $id, string $cas, ?UnlockOptions $options = null): Result
     {
         $response = Extension\documentUnlock(
             $this->core,
@@ -421,7 +421,7 @@ public function unlock(string $id, string $cas, UnlockOptions $options = null):
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function touch(string $id, $expiry, TouchOptions $options = null): MutationResult
+    public function touch(string $id, $expiry, ?TouchOptions $options = null): MutationResult
     {
         if ($expiry instanceof DateTimeInterface) {
             $expirySeconds = $expiry->getTimestamp();
@@ -453,7 +453,7 @@ public function touch(string $id, $expiry, TouchOptions $options = null): Mutati
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function lookupIn(string $id, array $specs, LookupInOptions $options = null): LookupInResult
+    public function lookupIn(string $id, array $specs, ?LookupInOptions $options = null): LookupInResult
     {
         $encoded = array_map(
             function (LookupInSpec $item) {
@@ -489,7 +489,7 @@ function (LookupInSpec $item) {
      * @throws CouchbaseException
      * @since 4.1.6
      */
-    public function lookupInAnyReplica(string $id, array $specs, LookupInAnyReplicaOptions $options = null): LookupInReplicaResult
+    public function lookupInAnyReplica(string $id, array $specs, ?LookupInAnyReplicaOptions $options = null): LookupInReplicaResult
     {
         $encoded = array_map(
             function (LookupInSpec $item) {
@@ -526,7 +526,7 @@ function (LookupInSpec $item) {
      * @throws CouchbaseException
      * @since 4.1.6
      */
-    public function lookupInAllReplicas(string $id, array $specs, LookupInAllReplicasOptions $options = null): array
+    public function lookupInAllReplicas(string $id, array $specs, ?LookupInAllReplicasOptions $options = null): array
     {
         $encoded = array_map(
             function (LookupInSpec $item) {
@@ -568,7 +568,7 @@ function (array $response) use ($options) {
      * @throws CouchbaseException
      * @since 4.0.0
      */
-    public function mutateIn(string $id, array $specs, MutateInOptions $options = null): MutateInResult
+    public function mutateIn(string $id, array $specs, ?MutateInOptions $options = null): MutateInResult
     {
         $encoded = array_map(
             function (MutateInSpec $item) use ($options) {
@@ -598,7 +598,7 @@ function (MutateInSpec $item) use ($options) {
      * @return array<GetResult> array of GetResult, one for each of the entries
      * @since 4.0.0
      */
-    public function getMulti(array $ids, GetOptions $options = null): array
+    public function getMulti(array $ids, ?GetOptions $options = null): array
     {
         $responses = Extension\documentGetMulti(
             $this->core,
@@ -630,7 +630,7 @@ function (array $response) use ($options) {
      * @throws InvalidArgumentException
      * @since 4.1.6
      */
-    public function scan(ScanType $scanType, ScanOptions $options = null): ScanResults
+    public function scan(ScanType $scanType, ?ScanOptions $options = null): ScanResults
     {
         if ($scanType instanceof RangeScan) {
             $type = RangeScan::export($scanType);
@@ -664,7 +664,7 @@ public function scan(ScanType $scanType, ScanOptions $options = null): ScanResul
      * @throws UnsupportedOperationException
      * @since 4.0.0
      */
-    public function removeMulti(array $entries, RemoveOptions $options = null): array
+    public function removeMulti(array $entries, ?RemoveOptions $options = null): array
     {
         $responses = Extension\documentRemoveMulti(
             $this->core,
@@ -693,7 +693,7 @@ function (array $response) {
      * @throws InvalidArgumentException
      * @since 4.0.0
      */
-    public function upsertMulti(array $entries, UpsertOptions $options = null): array
+    public function upsertMulti(array $entries, ?UpsertOptions $options = null): array
     {
         $encodedEntries = array_map(
             function (array $entry) use ($options) {

diff --git a/Couchbase/CollectionInterface.php b/Couchbase/CollectionInterface.php
@@ -28,33 +28,33 @@ public function scopeName(): string;
 
     public function name(): string;
 
-    public function get(string $id, GetOptions $options = null): GetResult;
+    public function get(string $id, ?GetOptions $options = null): GetResult;
 
-    public function exists(string $id, ExistsOptions $options = null): ExistsResult;
+    public function exists(string $id, ?ExistsOptions $options = null): ExistsResult;
 
-    public function getAndLock(string $id, int $lockTimeSeconds, GetAndLockOptions $options = null): GetResult;
+    public function getAndLock(string $id, int $lockTimeSeconds, ?GetAndLockOptions $options = null): GetResult;
 
-    public function getAndTouch(string $id, $expiry, GetAndTouchOptions $options = null): GetResult;
+    public function getAndTouch(string $id, $expiry, ?GetAndTouchOptions $options = null): GetResult;
 
-    public function getAnyReplica(string $id, GetAnyReplicaOptions $options = null): GetReplicaResult;
+    public function getAnyReplica(string $id, ?GetAnyReplicaOptions $options = null): GetReplicaResult;
 
-    public function getAllReplicas(string $id, GetAllReplicasOptions $options = null): array;
+    public function getAllReplicas(string $id, ?GetAllReplicasOptions $options = null): array;
 
-    public function upsert(string $id, $value, UpsertOptions $options = null): MutationResult;
+    public function upsert(string $id, $value, ?UpsertOptions $options = null): MutationResult;
 
-    public function insert(string $id, $value, InsertOptions $options = null): MutationResult;
+    public function insert(string $id, $value, ?InsertOptions $options = null): MutationResult;
 
-    public function replace(string $id, $value, ReplaceOptions $options = null): MutationResult;
+    public function replace(string $id, $value, ?ReplaceOptions $options = null): MutationResult;
 
-    public function remove(string $id, RemoveOptions $options = null): MutationResult;
+    public function remove(string $id, ?RemoveOptions $options = null): MutationResult;
 
-    public function unlock(string $id, string $cas, UnlockOptions $options = null): Result;
+    public function unlock(string $id, string $cas, ?UnlockOptions $options = null): Result;
 
-    public function touch(string $id, $expiry, TouchOptions $options = null): MutationResult;
+    public function touch(string $id, $expiry, ?TouchOptions $options = null): MutationResult;
 
-    public function lookupIn(string $id, array $specs, LookupInOptions $options = null): LookupInResult;
+    public function lookupIn(string $id, array $specs, ?LookupInOptions $options = null): LookupInResult;
 
-    public function mutateIn(string $id, array $specs, MutateInOptions $options = null): MutateInResult;
+    public function mutateIn(string $id, array $specs, ?MutateInOptions $options = null): MutateInResult;
 
     public function binary(): BinaryCollectionInterface;
 }
diff --git a/Couchbase/Exception/CouchbaseException.php b/Couchbase/Exception/CouchbaseException.php
@@ -30,7 +30,7 @@ class CouchbaseException extends Exception
 {
     private ?array $context;
 
-    public function __construct($message = "", $code = 0, Throwable $previous = null, array $context = null)
+    public function __construct($message = "", $code = 0, ?Throwable $previous = null, ?array $context = null)
     {
         parent::__construct($message, $code, $previous);
         $this->context = $context;

diff --git a/Couchbase/GeoDistanceSearchQuery.php b/Couchbase/GeoDistanceSearchQuery.php
@@ -42,7 +42,7 @@ class GeoDistanceSearchQuery implements JsonSerializable, SearchQuery
      *
      * @since 4.0.0
      */
-    public function __construct(float $longitude, float $latitude, string $distance = null)
+    public function __construct(float $longitude, float $latitude, ?string $distance = null)
     {
         $this->longitude = $longitude;
         $this->latitude = $latitude;
@@ -59,7 +59,7 @@ public function __construct(float $longitude, float $latitude, string $distance
      * @return GeoDistanceSearchQuery
      * @since 4.1.7
      */
-    public static function build(float $longitude, float $latitude, string $distance = null): GeoDistanceSearchQuery
+    public static function build(float $longitude, float $latitude, ?string $distance = null): GeoDistanceSearchQuery
     {
         return new GeoDistanceSearchQuery($longitude, $latitude, $distance);
     }