From 13b576f6a02ddcafe9cf3d7fed68b5e5847dc2c5 Mon Sep 17 00:00:00 2001
From: webchick <webchick@24967.no-reply.drupal.org>
Date: Wed, 5 Oct 2011 07:53:30 -0700
Subject: [PATCH] Issue #1167218 by droplet, kathyh: Fixed
DatabaseStatementInterface::fetch* - document what empty return value is.
---
includes/database/database.inc | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/includes/database/database.inc b/includes/database/database.inc
index f7021bb9ecde..70c440690f47 100644
--- a/includes/database/database.inc
+++ b/includes/database/database.inc
@@ -1994,7 +1994,7 @@ public function rowCount();
* The numeric index of the field to return. Defaults to the first field.
*
* @return
- * A single field from the next record.
+ * A single field from the next record, or FALSE if there is no next record.
*/
public function fetchField($index = 0);
@@ -2014,7 +2014,7 @@ public function fetchField($index = 0);
* helper method, so one is added.
*
* @return
- * An associative array.
+ * An associative array, or FALSE if there is no next row.
*/
public function fetchAssoc();
@@ -2042,7 +2042,7 @@ public function fetchAssoc();
* The index of the column number to fetch.
*
* @return
- * An indexed array.
+ * An indexed array, or an empty array if there is no result set.
*/
public function fetchCol($index = 0);
@@ -2062,7 +2062,7 @@ public function fetchCol($index = 0);
* The numeric index of the field to use as the array value.
*
* @return
- * An associative array.
+ * An associative array, or an empty array if there is no result set.
*/
public function fetchAllKeyed($key_index = 0, $value_index = 1);
@@ -2081,7 +2081,7 @@ public function fetchAllKeyed($key_index = 0, $value_index = 1);
* set for the query will be used.
*
* @return
- * An associative array.
+ * An associative array, or an empty array if there is no result set.
*/
public function fetchAllAssoc($key, $fetch = NULL);
}
--
GitLab