User Guide - DB Driver Reference
First stab at DB driver reference. Methods are listed in order encountered in the source file.
Parameter or return types in DB_driver updated as needed, and reflected here.
TOC entry added to bottom of database index page.
Signed-off-by:James L Parry <jim_parry@bcit.ca>
diff --git a/system/database/DB_driver.php b/system/database/DB_driver.php
index 7c3df42..fdd9916 100644
--- a/system/database/DB_driver.php
+++ b/system/database/DB_driver.php
@@ -964,7 +964,7 @@
* Calculate the aggregate query elapsed time
*
* @param int The number of decimal places
- * @return int
+ * @return string
*/
public function elapsed_time($decimals = 6)
{
@@ -1034,7 +1034,7 @@
/**
* Escape String
*
- * @param string $str
+ * @param string|string[] $str
* @param bool $like Whether or not the string will be used in a LIKE condition
* @return string
*/
@@ -1103,7 +1103,7 @@
* position is the primary key
*
* @param string the table name
- * @return string
+ * @return mixed
*/
public function primary($table = '')
{
@@ -1146,7 +1146,7 @@
* Returns an array of table names
*
* @param string $constrain_by_prefix = FALSE
- * @return array
+ * @return mixed
*/
public function list_tables($constrain_by_prefix = FALSE)
{
@@ -1214,7 +1214,7 @@
* Fetch Field Names
*
* @param string the table name
- * @return array
+ * @return mixed
*/
public function list_fields($table = '')
{