PHPC-2351: Remove CursorId class

Author: alcaeus

UPGRADE-2.0.md

@@ -15,3 +15,7 @@ UPGRADE FROM 1.x to 2.0
    implementing classes to also implement iterator methods. The return types for
    the `key` and `current` methods have been narrowed to the types returned by
    cursor instances.
+ * The `MongoDB\Driver\CursorId` class was removed. 
+   `MongoDB\Driver\Cursor::getId()` and
+   `MongoDB\Driver\CursorInterface::getId()` now return a `MongoDB\BSON\Int64`
+   instance.

config.m4

@@ -169,7 +169,6 @@ if test "$PHP_MONGODB" != "no"; then
     src/MongoDB/ClientEncryption.c \
     src/MongoDB/Command.c \
     src/MongoDB/Cursor.c \
-    src/MongoDB/CursorId.c \
     src/MongoDB/CursorInterface.c \
     src/MongoDB/Manager.c \
     src/MongoDB/Query.c \

config.w32

@@ -116,7 +116,7 @@ if (PHP_MONGODB != "no") {
   EXTENSION("mongodb", "php_phongo.c", null, PHP_MONGODB_CFLAGS);
   MONGODB_ADD_SOURCES("/src", "phongo_apm.c phongo_bson.c phongo_bson_encode.c phongo_client.c phongo_compat.c phongo_error.c phongo_execute.c phongo_ini.c phongo_log.c phongo_util.c");
   MONGODB_ADD_SOURCES("/src/BSON", "Binary.c BinaryInterface.c Document.c Iterator.c DBPointer.c Decimal128.c Decimal128Interface.c Int64.c Javascript.c JavascriptInterface.c MaxKey.c MaxKeyInterface.c MinKey.c MinKeyInterface.c ObjectId.c ObjectIdInterface.c PackedArray.c Persistable.c Regex.c RegexInterface.c Serializable.c Symbol.c Timestamp.c TimestampInterface.c Type.c Undefined.c Unserializable.c UTCDateTime.c UTCDateTimeInterface.c");
-  MONGODB_ADD_SOURCES("/src/MongoDB", "BulkWrite.c ClientEncryption.c Command.c Cursor.c CursorId.c CursorInterface.c Manager.c Query.c ReadConcern.c ReadPreference.c Server.c ServerApi.c ServerDescription.c Session.c TopologyDescription.c WriteConcern.c WriteConcernError.c WriteError.c WriteResult.c");
+  MONGODB_ADD_SOURCES("/src/MongoDB", "BulkWrite.c ClientEncryption.c Command.c Cursor.c CursorInterface.c Manager.c Query.c ReadConcern.c ReadPreference.c Server.c ServerApi.c ServerDescription.c Session.c TopologyDescription.c WriteConcern.c WriteConcernError.c WriteError.c WriteResult.c");
   MONGODB_ADD_SOURCES("/src/MongoDB/Exception", "AuthenticationException.c BulkWriteException.c CommandException.c ConnectionException.c ConnectionTimeoutException.c EncryptionException.c Exception.c ExecutionTimeoutException.c InvalidArgumentException.c LogicException.c RuntimeException.c ServerException.c SSLConnectionException.c UnexpectedValueException.c WriteException.c");
   MONGODB_ADD_SOURCES("/src/MongoDB/Monitoring", "CommandFailedEvent.c CommandStartedEvent.c CommandSubscriber.c CommandSucceededEvent.c LogSubscriber.c SDAMSubscriber.c Subscriber.c ServerChangedEvent.c ServerClosedEvent.c ServerHeartbeatFailedEvent.c ServerHeartbeatStartedEvent.c ServerHeartbeatSucceededEvent.c ServerOpeningEvent.c TopologyChangedEvent.c TopologyClosedEvent.c TopologyOpeningEvent.c functions.c");
   MONGODB_ADD_SOURCES("/src/libmongoc/src/common", PHP_MONGODB_COMMON_SOURCES);

php_phongo.c

@@ -254,7 +254,6 @@ PHP_MINIT_FUNCTION(mongodb) /* {{{ */
 	php_phongo_clientencryption_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_command_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_cursor_init_ce(INIT_FUNC_ARGS_PASSTHRU);
-	php_phongo_cursorid_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_manager_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_query_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_readconcern_init_ce(INIT_FUNC_ARGS_PASSTHRU);

src/MongoDB/Cursor.c

@@ -115,17 +115,6 @@ static int php_phongo_cursor_to_array_apply(zend_object_iterator* iter, void* pu
 	return ZEND_HASH_APPLY_KEEP;
 }
 
-static void php_phongo_cursor_id_new_from_id(zval* object, int64_t cursorid)
-{
-	php_phongo_cursorid_t* intern;
-
-	object_init_ex(object, php_phongo_cursorid_ce);
-
-	intern              = Z_CURSORID_OBJ_P(object);
-	intern->id          = cursorid;
-	intern->initialized = true;
-}
-
 /* Returns an array of all result documents for this cursor */
 static PHP_METHOD(MongoDB_Driver_Cursor, toArray)
 {
@@ -143,22 +132,12 @@ static PHP_METHOD(MongoDB_Driver_Cursor, toArray)
 static PHP_METHOD(MongoDB_Driver_Cursor, getId)
 {
 	php_phongo_cursor_t* intern;
-	zend_bool            asInt64 = false;
 
 	intern = Z_CURSOR_OBJ_P(getThis());
 
-	PHONGO_PARSE_PARAMETERS_START(0, 1)
-	Z_PARAM_OPTIONAL
-	Z_PARAM_BOOL(asInt64)
-	PHONGO_PARSE_PARAMETERS_END();
-
-	if (asInt64) {
-		phongo_int64_new(return_value, mongoc_cursor_get_id(intern->cursor));
-	} else {
-		php_error_docref(NULL, E_DEPRECATED, "The method \"MongoDB\\Driver\\Cursor::getId\" will no longer return a \"MongoDB\\Driver\\CursorId\" instance in the future. Pass \"true\" as argument to change to the new behavior and receive a \"MongoDB\\BSON\\Int64\" instance instead.");
+	PHONGO_PARSE_PARAMETERS_NONE();
 
-		php_phongo_cursor_id_new_from_id(return_value, mongoc_cursor_get_id(intern->cursor));
-	}
+	phongo_int64_new(return_value, mongoc_cursor_get_id(intern->cursor));
 }
 
 /* Returns the Server object to which this cursor is attached */

src/MongoDB/Cursor.stub.php

@@ -14,7 +14,7 @@ final private function __construct() {}
 
     public function current(): array|object|null {}
 
-    final public function getId(bool $asInt64 = false): CursorId|\MongoDB\BSON\Int64 {}
+    final public function getId(): \MongoDB\BSON\Int64 {}
 
     final public function getServer(): Server {}