PHPC-157: Consolidate CommandResult and QueryResult classes

bjori · bjori · commit 481600d990c5 · 2015-02-18T11:09:36.000-08:00
diff --git a/config.m4 b/config.m4
@@ -173,13 +173,12 @@ if test "$PHONGO" != "no"; then
   ";
   PHONGO_MONGODB_CLASSES="\
       src/MongoDB/Command.c \
-      src/MongoDB/CommandResult.c \
       src/MongoDB/Cursor.c \
       src/MongoDB/CursorId.c \
       src/MongoDB/Manager.c \
       src/MongoDB/Query.c \
-      src/MongoDB/QueryResult.c \
       src/MongoDB/ReadPreference.c \
+      src/MongoDB/Result.c \
       src/MongoDB/Server.c \
       src/MongoDB/WriteBatch.c \
       src/MongoDB/WriteConcern.c \
diff --git a/docs/crud.md b/docs/crud.md
@@ -75,7 +75,7 @@ $query = new MongoDB\Driver\Query(array());
 try {
 	/* Full namespace as the first argument (dbname.collname), and the query object
 	 * to execute as the second.
-	 * Returns MongoDB\Driver\QueryResult on success, throws exception on failure
+	 * Returns MongoDB\Driver\Result on success, throws exception on failure
 	 */
 	$cursor = $manager->executeQuery("db.collection", $query, $rp);
 
diff --git a/php_phongo.c b/php_phongo.c
@@ -636,7 +636,7 @@ int phongo_execute_query(mongoc_client_t *client, char *namespace, php_phongo_qu
 		return true;
 	}
 
-	phongo_result_init(return_value, php_phongo_queryresult_ce, cursor, doc, 0, 0 TSRMLS_CC);
+	phongo_result_init(return_value, php_phongo_result_ce, cursor, doc, 0, 0 TSRMLS_CC);
 	return true;
 } /* }}} */
 
@@ -686,15 +686,15 @@ int phongo_execute_command(mongoc_client_t *client, char *db, bson_t *command, m
 						_mongoc_cursor_cursorid_init(cursor);
 						cursor->limit = 0;
 						cursor->is_command = false;
-						phongo_result_init(return_value, php_phongo_commandresult_ce, cursor, &first_batch, mongoc_cursor_get_hint(cursor), 1 TSRMLS_CC);
+						phongo_result_init(return_value, php_phongo_result_ce, cursor, &first_batch, mongoc_cursor_get_hint(cursor), 1 TSRMLS_CC);
 						return true;
 					}
 				}
 			}
 		}
 	}
 
-	phongo_result_init(return_value, php_phongo_commandresult_ce, cursor, doc, mongoc_cursor_get_hint(cursor), 0 TSRMLS_CC);
+	phongo_result_init(return_value, php_phongo_result_ce, cursor, doc, mongoc_cursor_get_hint(cursor), 0 TSRMLS_CC);
 	return true;
 } /* }}} */
 
@@ -1587,13 +1587,12 @@ PHP_MINIT_FUNCTION(phongo)
 	PHP_MINIT(bson)(INIT_FUNC_ARGS_PASSTHRU);
 
 	PHP_MINIT(Command)(INIT_FUNC_ARGS_PASSTHRU);
-	PHP_MINIT(CommandResult)(INIT_FUNC_ARGS_PASSTHRU);
 	PHP_MINIT(Cursor)(INIT_FUNC_ARGS_PASSTHRU);
 	PHP_MINIT(CursorId)(INIT_FUNC_ARGS_PASSTHRU);
 	PHP_MINIT(Manager)(INIT_FUNC_ARGS_PASSTHRU);
 	PHP_MINIT(Query)(INIT_FUNC_ARGS_PASSTHRU);
-	PHP_MINIT(QueryResult)(INIT_FUNC_ARGS_PASSTHRU);
 	PHP_MINIT(ReadPreference)(INIT_FUNC_ARGS_PASSTHRU);
+	PHP_MINIT(Result)(INIT_FUNC_ARGS_PASSTHRU);
 	PHP_MINIT(Server)(INIT_FUNC_ARGS_PASSTHRU);
 	PHP_MINIT(WriteBatch)(INIT_FUNC_ARGS_PASSTHRU);
 	PHP_MINIT(WriteConcern)(INIT_FUNC_ARGS_PASSTHRU);
diff --git a/php_phongo_classes.h b/php_phongo_classes.h
@@ -55,10 +55,6 @@ typedef struct {
 	php_phongo_bson_state    visitor_data;
 } php_phongo_result_t;
 
-typedef struct {
-	php_phongo_result_t      result;
-} php_phongo_commandresult_t;
-
 typedef struct {
 	zend_object_iterator   iterator;
 	bson_iter_t            first_batch_iter;
@@ -91,10 +87,6 @@ typedef struct {
 	uint32_t                 batch_size;
 } php_phongo_query_t;
 
-typedef struct {
-	php_phongo_result_t      result;
-} php_phongo_queryresult_t;
-
 typedef struct {
 	zend_object              std;
 	mongoc_read_prefs_t     *read_preference;
@@ -194,13 +186,12 @@ typedef struct {
 } php_phongo_utcdatetime_t;
 
 extern PHONGO_API zend_class_entry *php_phongo_command_ce;
-extern PHONGO_API zend_class_entry *php_phongo_commandresult_ce;
 extern PHONGO_API zend_class_entry *php_phongo_cursor_ce;
 extern PHONGO_API zend_class_entry *php_phongo_cursorid_ce;
 extern PHONGO_API zend_class_entry *php_phongo_manager_ce;
 extern PHONGO_API zend_class_entry *php_phongo_query_ce;
-extern PHONGO_API zend_class_entry *php_phongo_queryresult_ce;
 extern PHONGO_API zend_class_entry *php_phongo_readpreference_ce;
+extern PHONGO_API zend_class_entry *php_phongo_result_ce;
 extern PHONGO_API zend_class_entry *php_phongo_server_ce;
 extern PHONGO_API zend_class_entry *php_phongo_writebatch_ce;
 extern PHONGO_API zend_class_entry *php_phongo_writeconcern_ce;
@@ -234,13 +225,12 @@ extern PHONGO_API zend_class_entry *php_phongo_timestamp_ce;
 extern PHONGO_API zend_class_entry *php_phongo_utcdatetime_ce;
 
 PHP_MINIT_FUNCTION(Command);
-PHP_MINIT_FUNCTION(CommandResult);
 PHP_MINIT_FUNCTION(Cursor);
 PHP_MINIT_FUNCTION(CursorId);
 PHP_MINIT_FUNCTION(Manager);
 PHP_MINIT_FUNCTION(Query);
-PHP_MINIT_FUNCTION(QueryResult);
 PHP_MINIT_FUNCTION(ReadPreference);
+PHP_MINIT_FUNCTION(Result);
 PHP_MINIT_FUNCTION(Server);
 PHP_MINIT_FUNCTION(WriteBatch);
 PHP_MINIT_FUNCTION(WriteConcern);
diff --git a/src/MongoDB/Manager.c b/src/MongoDB/Manager.c
@@ -117,7 +117,7 @@ PHP_METHOD(Manager, __construct)
 	mongoc_client_set_stream_initiator(intern->client, phongo_stream_initiator, ctx);
 }
 /* }}} */
-/* {{{ proto MongoDB\Driver\CommandResult Manager::executeCommand(string $db, MongoDB\Driver\Command $command[, MongoDB\Driver\ReadPreference $readPreference = null])
+/* {{{ proto MongoDB\Driver\Result Manager::executeCommand(string $db, MongoDB\Driver\Command $command[, MongoDB\Driver\ReadPreference $readPreference = null])
    Execute a command */
 PHP_METHOD(Manager, executeCommand)
 {
@@ -144,7 +144,7 @@ PHP_METHOD(Manager, executeCommand)
 	phongo_execute_command(intern->client, db, cmd->bson, phongo_read_preference_from_zval(readPreference TSRMLS_CC), return_value, return_value_used TSRMLS_CC);
 }
 /* }}} */
-/* {{{ proto MongoDB\Driver\QueryResult Manager::executeQuery(string $namespace, MongoDB\Driver\Query $zquery[, MongoDB\Driver\ReadPreference $readPreference = null])
+/* {{{ proto MongoDB\Driver\Result Manager::executeQuery(string $namespace, MongoDB\Driver\Query $zquery[, MongoDB\Driver\ReadPreference $readPreference = null])
    Execute a Query */
 PHP_METHOD(Manager, executeQuery)
 {
diff --git a/src/MongoDB/Server.c b/src/MongoDB/Server.c
@@ -99,7 +99,7 @@ PHP_METHOD(Server, __construct)
 	mongoc_uri_destroy(uri);
 }
 /* }}} */
-/* {{{ proto MongoDB\Driver\CommandResult Server::executeCommand(string $db, MongoDB\Driver\Command $command)
+/* {{{ proto MongoDB\Driver\Result Server::executeCommand(string $db, MongoDB\Driver\Command $command)
    Executes a command on this server */
 PHP_METHOD(Server, executeCommand)
 {
@@ -125,7 +125,7 @@ PHP_METHOD(Server, executeCommand)
 	phongo_execute_command(intern->client, db, cmd->bson, NULL, return_value, return_value_used TSRMLS_CC);
 }
 /* }}} */
-/* {{{ proto MongoDB\Driver\QueryResult Server::executeQuery(string $namespace, MongoDB\Driver\Query $zquery)
+/* {{{ proto MongoDB\Driver\Result Server::executeQuery(string $namespace, MongoDB\Driver\Query $zquery)
    Executes a Query */
 PHP_METHOD(Server, executeQuery)
 {
diff --git a/tests/functional/query-sort-003.phpt b/tests/functional/query-sort-003.phpt
@@ -56,7 +56,7 @@ object(MongoDB\Driver\Query)#%d (6) {
   ["batch_size"]=>
   int(0)
 }
-string(26) "MongoDB\Driver\Result"
+string(21) "MongoDB\Driver\Result"
 string(21) "MongoDB\Driver\Cursor"
 abernathy.audrey
 alda.murray

Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ PHP_METHOD(Manager, __construct)`
`117`	`117`	`mongoc_client_set_stream_initiator(intern->client, phongo_stream_initiator, ctx);`
`118`	`118`	`}`
`119`	`119`	`/* }}} */`
`120`		`-/* {{{ proto MongoDB\Driver\CommandResult Manager::executeCommand(string $db, MongoDB\Driver\Command $command[, MongoDB\Driver\ReadPreference $readPreference = null])`
	`120`	`+/* {{{ proto MongoDB\Driver\Result Manager::executeCommand(string $db, MongoDB\Driver\Command $command[, MongoDB\Driver\ReadPreference $readPreference = null])`
`121`	`121`	`Execute a command */`
`122`	`122`	`PHP_METHOD(Manager, executeCommand)`
`123`	`123`	`{`
`@@ -144,7 +144,7 @@ PHP_METHOD(Manager, executeCommand)`
`144`	`144`	`phongo_execute_command(intern->client, db, cmd->bson, phongo_read_preference_from_zval(readPreference TSRMLS_CC), return_value, return_value_used TSRMLS_CC);`
`145`	`145`	`}`
`146`	`146`	`/* }}} */`
`147`		`-/* {{{ proto MongoDB\Driver\QueryResult Manager::executeQuery(string $namespace, MongoDB\Driver\Query $zquery[, MongoDB\Driver\ReadPreference $readPreference = null])`
	`147`	`+/* {{{ proto MongoDB\Driver\Result Manager::executeQuery(string $namespace, MongoDB\Driver\Query $zquery[, MongoDB\Driver\ReadPreference $readPreference = null])`
`148`	`148`	`Execute a Query */`
`149`	`149`	`PHP_METHOD(Manager, executeQuery)`
`150`	`150`	`{`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ PHP_METHOD(Server, __construct)`
`99`	`99`	`mongoc_uri_destroy(uri);`
`100`	`100`	`}`
`101`	`101`	`/* }}} */`
`102`		`-/* {{{ proto MongoDB\Driver\CommandResult Server::executeCommand(string $db, MongoDB\Driver\Command $command)`
	`102`	`+/* {{{ proto MongoDB\Driver\Result Server::executeCommand(string $db, MongoDB\Driver\Command $command)`
`103`	`103`	`Executes a command on this server */`
`104`	`104`	`PHP_METHOD(Server, executeCommand)`
`105`	`105`	`{`
`@@ -125,7 +125,7 @@ PHP_METHOD(Server, executeCommand)`
`125`	`125`	`phongo_execute_command(intern->client, db, cmd->bson, NULL, return_value, return_value_used TSRMLS_CC);`
`126`	`126`	`}`
`127`	`127`	`/* }}} */`
`128`		`-/* {{{ proto MongoDB\Driver\QueryResult Server::executeQuery(string $namespace, MongoDB\Driver\Query $zquery)`
	`128`	`+/* {{{ proto MongoDB\Driver\Result Server::executeQuery(string $namespace, MongoDB\Driver\Query $zquery)`
`129`	`129`	`Executes a Query */`
`130`	`130`	`PHP_METHOD(Server, executeQuery)`
`131`	`131`	`{`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ object(MongoDB\Driver\Query)#%d (6) {`
`56`	`56`	`["batch_size"]=>`
`57`	`57`	`int(0)`
`58`	`58`	`}`
`59`		`-string(26) "MongoDB\Driver\Result"`
	`59`	`+string(21) "MongoDB\Driver\Result"`
`60`	`60`	`string(21) "MongoDB\Driver\Cursor"`
`61`	`61`	`abernathy.audrey`
`62`	`62`	`alda.murray`