PHPC-1137: Deprecate maxScan option

derickr · Apr 25, 2018 · f34ecdb · f34ecdb
1 parent c75f89b
commit f34ecdb
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 8 deletions.
diff --git a/src/MongoDB/Query.c b/src/MongoDB/Query.c
@@ -100,14 +100,20 @@ static bool php_phongo_query_opts_append_document(bson_t* opts, const char* opts
 /* Note: handling of integer options will depend on SIZEOF_ZEND_LONG and we
 	 * are not converting strings to 64-bit integers for 32-bit platforms. */
 
-#define PHONGO_QUERY_OPT_INT64(opt, zarr, key)                                                                       \
-	if ((zarr) && php_array_existsc((zarr), (key))) {                                                                \
-		if (!BSON_APPEND_INT64(intern->opts, (opt), php_array_fetchc_long((zarr), (key)))) {                         \
-			phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Error appending \"%s\" option", (opt)); \
-			return false;                                                                                            \
-		}                                                                                                            \
+#define PHONGO_QUERY_OPT_INT64_EX(opt, zarr, key, deprecated)                                                                             \
+	if ((zarr) && php_array_existsc((zarr), (key))) {                                                                                     \
+		if ((deprecated)) {                                                                                                               \
+			php_error_docref(NULL TSRMLS_CC, E_DEPRECATED, "The \"%s\" option is deprecated and will be removed in a future release", key); \
+		}                                                                                                                                 \
+		if (!BSON_APPEND_INT64(intern->opts, (opt), php_array_fetchc_long((zarr), (key)))) {                                              \
+			phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Error appending \"%s\" option", (opt));                      \
+			return false;                                                                                                                 \
+		}                                                                                                                                 \
 	}
 
+#define PHONGO_QUERY_OPT_INT64(opt, zarr, key) PHONGO_QUERY_OPT_INT64_EX((opt), (zarr), (key), 0)
+#define PHONGO_QUERY_OPT_INT64_DEPRECATED(opt, zarr, key) PHONGO_QUERY_OPT_INT64_EX((opt), (zarr), (key), 1)
+
 #define PHONGO_QUERY_OPT_STRING(opt, zarr, key)                                                   \
 	if ((zarr) && php_array_existsc((zarr), (key))) {                                             \
 		if (!php_phongo_query_opts_append_string(intern->opts, (opt), (zarr), (key) TSRMLS_CC)) { \
@@ -277,8 +283,8 @@ static bool php_phongo_query_init(php_phongo_query_t* intern, zval* filter, zval
 	PHONGO_QUERY_OPT_BOOL("exhaust", options, "exhaust");
 	PHONGO_QUERY_OPT_DOCUMENT("max", options, "max")
 	else PHONGO_QUERY_OPT_DOCUMENT("max", modifiers, "$max");
-	PHONGO_QUERY_OPT_INT64("maxScan", options, "maxScan")
-	else PHONGO_QUERY_OPT_INT64("maxScan", modifiers, "$maxScan");
+	PHONGO_QUERY_OPT_INT64_DEPRECATED("maxScan", options, "maxScan")
+	else PHONGO_QUERY_OPT_INT64_DEPRECATED("maxScan", modifiers, "$maxScan");
 	PHONGO_QUERY_OPT_INT64("maxTimeMS", options, "maxTimeMS")
 	else PHONGO_QUERY_OPT_INT64("maxTimeMS", modifiers, "$maxTimeMS");
 	PHONGO_QUERY_OPT_DOCUMENT("min", options, "min")

diff --git a/tests/query/query-ctor-002.phpt b/tests/query/query-ctor-002.phpt
@@ -49,6 +49,7 @@ var_dump(new MongoDB\Driver\Query(
 ===DONE===
 <?php exit(0); ?>
 --EXPECTF--
+Deprecated: MongoDB\Driver\Query::__construct(): The "maxScan" option is deprecated and will be removed in a future release in %s on line %d
 object(MongoDB\Driver\Query)#%d (%d) {
   ["filter"]=>
   object(stdClass)#%d (%d) {

diff --git a/tests/query/query-ctor-003.phpt b/tests/query/query-ctor-003.phpt
@@ -39,6 +39,7 @@ var_dump(new MongoDB\Driver\Query(
 ===DONE===
 <?php exit(0); ?>
 --EXPECTF--
+Deprecated: MongoDB\Driver\Query::__construct(): The "$maxScan" option is deprecated and will be removed in a future release in %s on line %d
 object(MongoDB\Driver\Query)#%d (%d) {
   ["filter"]=>
   object(stdClass)#%d (%d) {

diff --git a/tests/query/query-ctor-004.phpt b/tests/query/query-ctor-004.phpt
@@ -49,6 +49,7 @@ var_dump(new MongoDB\Driver\Query(
 ===DONE===
 <?php exit(0); ?>
 --EXPECTF--
+Deprecated: MongoDB\Driver\Query::__construct(): The "maxScan" option is deprecated and will be removed in a future release in %s on line %d
 object(MongoDB\Driver\Query)#%d (%d) {
   ["filter"]=>
   object(stdClass)#%d (%d) {