Merge pull request #8 from qkdreyer/doc

doc: update

Author: sandvige

ext/doc/Cassandra.php

@@ -379,12 +379,12 @@ final class Cassandra
     /**
      * The current version of the extension.
      */
-    const VERSION = '1.4.0';
+    const VERSION = '1.5.0';
 
     /**
      * The version of the cpp-driver the extension is compiled against.
      */
-    const CPP_DRIVER_VERSION = '2.16.2';
+    const CPP_DRIVER_VERSION = '2.17.1';
 
     /**
      * Creates a new cluster builder for constructing a Cluster object.

ext/doc/Cassandra/BatchStatement.php

@@ -44,7 +44,7 @@ final class BatchStatement implements Statement
      *
      * @param int $type must be one of \Cassandra::BATCH_* (default: \Cassandra::BATCH_LOGGED).
      */
-    public function __construct(int $type = null)
+    public function __construct(?int $type = null)
     {
     }
 

ext/doc/Cassandra/Cluster.php

@@ -31,7 +31,7 @@ interface Cluster
      *
      * @return \Cassandra\Session Session instance
      */
-    public function connect(string $keyspace = null, int $timeout = null): \Cassandra\Session;
+    public function connect(?string $keyspace = null, ?int $timeout = null): \Cassandra\Session;
 
     /**
      * Creates a new Session instance.
@@ -40,5 +40,5 @@ public function connect(string $keyspace = null, int $timeout = null): \Cassandr
      *
      * @return \Cassandra\Future A Future Session instance
      */
-    public function connectAsync(string $keyspace = null): \Cassandra\Future;
+    public function connectAsync(?string $keyspace = null): \Cassandra\Future;
 }

ext/doc/Cassandra/Cluster/Builder.php

@@ -176,7 +176,7 @@ public function withWhiteListDCs(string $dcs): \Cassandra\Cluster\Builder
      *
      * @return \Cassandra\Cluster\Builder self
      */
-    public function withTokenAwareRouting(bool $enabled = null): \Cassandra\Cluster\Builder
+    public function withTokenAwareRouting(?bool $enabled = null): \Cassandra\Cluster\Builder
     {
     }
 
@@ -232,7 +232,7 @@ public function withSSL(\Cassandra\SSLOptions $options): \Cassandra\Cluster\Buil
      *
      * @return \Cassandra\Cluster\Builder self
      */
-    public function withPersistentSessions(bool $enabled = null): \Cassandra\Cluster\Builder
+    public function withPersistentSessions(?bool $enabled = null): \Cassandra\Cluster\Builder
     {
     }
 
@@ -281,7 +281,7 @@ public function withIOThreads(int $count): \Cassandra\Cluster\Builder
      *
      * @return \Cassandra\Cluster\Builder self
      */
-    public function withConnectionsPerHost(int $core, int $max = null): \Cassandra\Cluster\Builder
+    public function withConnectionsPerHost(int $core, ?int $max = null): \Cassandra\Cluster\Builder
     {
     }
 
@@ -304,7 +304,7 @@ public function withReconnectInterval(float $interval): \Cassandra\Cluster\Build
      *
      * @return \Cassandra\Cluster\Builder self
      */
-    public function withLatencyAwareRouting(bool $enabled = null): \Cassandra\Cluster\Builder
+    public function withLatencyAwareRouting(?bool $enabled = null): \Cassandra\Cluster\Builder
     {
     }
 
@@ -315,7 +315,7 @@ public function withLatencyAwareRouting(bool $enabled = null): \Cassandra\Cluste
      *
      * @return \Cassandra\Cluster\Builder self
      */
-    public function withTCPNodelay(bool $enabled = null): \Cassandra\Cluster\Builder
+    public function withTCPNodelay(?bool $enabled = null): \Cassandra\Cluster\Builder
     {
     }
 
@@ -368,7 +368,7 @@ public function withTimestampGenerator(\Cassandra\TimestampGenerator $generator)
      *
      * @return \Cassandra\Cluster\Builder self
      */
-    public function withSchemaMetadata(bool $enabled = null): \Cassandra\Cluster\Builder
+    public function withSchemaMetadata(?bool $enabled = null): \Cassandra\Cluster\Builder
     {
     }
 
@@ -387,7 +387,7 @@ public function withSchemaMetadata(bool $enabled = null): \Cassandra\Cluster\Bui
      *
      * @return \Cassandra\Cluster\Builder self
      */
-    public function withHostnameResolution(bool $enabled = null): \Cassandra\Cluster\Builder
+    public function withHostnameResolution(?bool $enabled = null): \Cassandra\Cluster\Builder
     {
     }
 
@@ -404,7 +404,7 @@ public function withHostnameResolution(bool $enabled = null): \Cassandra\Cluster
      *
      * @return \Cassandra\Cluster\Builder self
      */
-    public function withRandomizedContactPoints(bool $enabled = null): \Cassandra\Cluster\Builder
+    public function withRandomizedContactPoints(?bool $enabled = null): \Cassandra\Cluster\Builder
     {
     }
 

ext/doc/Cassandra/Column.php

@@ -40,6 +40,8 @@ public function type(): \Cassandra\Type;
     /**
      * Returns whether the column is in descending or ascending order.
      *
+     * @deprecated
+     *
      * @return bool Whether the column is stored in descending order.
      */
     public function isReversed(): bool;
@@ -61,13 +63,17 @@ public function isFrozen(): bool;
     /**
      * Returns name of the index if defined.
      *
+     * @deprecated
+     *
      * @return string Name of the index if defined or null
      */
     public function indexName(): string;
 
     /**
      * Returns index options if present.
      *
+     * @deprecated
+     *
      * @return string Index options if present or null
      */
     public function indexOptions(): string;

ext/doc/Cassandra/Date.php

@@ -28,7 +28,7 @@ final class Date implements \Stringable, Value
      *
      * @param int $seconds Absolute seconds from epoch (1970, 1, 1), can be negative, defaults to current time.
      */
-    public function __construct(int $seconds = null)
+    public function __construct(?int $seconds = null)
     {
     }
 
@@ -55,7 +55,7 @@ public function seconds(): int
      *
      * @return \DateTime PHP representation
      */
-    public function toDateTime(\Cassandra\Time $time = null): \DateTime
+    public function toDateTime(?\Cassandra\Time $time = null): \DateTime
     {
     }
 

ext/doc/Cassandra/DefaultCluster.php

@@ -33,7 +33,7 @@ final class DefaultCluster implements Cluster
      *
      * @return \Cassandra\Session Session instance
      */
-    public function connect(string $keyspace = null, int $timeout = null): \Cassandra\Session
+    public function connect(?string $keyspace = null, ?int $timeout = null): \Cassandra\Session
     {
     }
 
@@ -44,7 +44,7 @@ public function connect(string $keyspace = null, int $timeout = null): \Cassandr
      *
      * @return \Cassandra\Future A Future Session instance
      */
-    public function connectAsync(string $keyspace = null): \Cassandra\Future
+    public function connectAsync(?string $keyspace = null): \Cassandra\Future
     {
     }
 }

ext/doc/Cassandra/DefaultColumn.php

@@ -44,6 +44,8 @@ public function type(): \Cassandra\Type
     /**
      * Returns whether the column is in descending or ascending order.
      *
+     * @deprecated
+     *
      * @return bool Whether the column is stored in descending order.
      */
     public function isReversed(): bool
@@ -71,6 +73,8 @@ public function isFrozen(): bool
     /**
      * Returns name of the index if defined.
      *
+     * @deprecated
+     *
      * @return string Name of the index if defined or null
      */
     public function indexName(): string
@@ -80,6 +84,8 @@ public function indexName(): string
     /**
      * Returns index options if present.
      *
+     * @deprecated
+     *
      * @return string Index options if present or null
      */
     public function indexOptions(): string

ext/doc/Cassandra/DefaultKeyspace.php

@@ -127,7 +127,7 @@ public function materializedViews(): array
      *
      * @return \Cassandra\Function_|null A function or null
      */
-    public function function_(string $name, ...$params)
+    public function function(string $name, ...$params)
     {
     }
 

ext/doc/Cassandra/DefaultSchema.php

@@ -28,7 +28,7 @@ final class DefaultSchema implements Schema
      *
      * @param string $name Name of the keyspace to get
      *
-     * @return \Cassandra\Keyspace Keyspace instance or null
+     * @return \Cassandra\Keyspace
      */
     public function keyspace(string $name): \Cassandra\Keyspace
     {